QuorumSdk

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add quorum_sdk

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install quorum_sdk

LightNode Usage

Initilize

# Initilize by seed url
node = QuorumSdk::Node.new seed: "rum://...."

Send a trx

# build a message
msg = {
  type: 'Note',
  name: 'A title',
  content: 'Something awesome'
}

# prepare an ETH account
account = QuorumSdk::Account.new

# Or use a existed account
# account = QuorumSdk::Account.new priv: private_key

# build trx
trx = node.build_trx data: msg, private_key: account.private_hex

# push trx to chain
node.send_trx trx
# output: { trx_id: '...' }

Build a activity message

# build a Note type object
note = {
  type: 'Note',
  name: 'A title',
  content: 'Something awesome.'
}

# build Activity object, wrapping Note object
activity = { type: 'Create', object: note }

# build Trx
trx = rum.build_trx data: activity, private_key: account.private_hex

# push trx to chain
node.send_trx trx
# output: { trx_id: '...' }

# list Trx in the group on chain
node.list_trx
# output: [{ trx_id: '...', Data: { type: 'Create', object: { type: 'Note', name: 'A title', content: 'Something awesome' }}}]

FullNode Usage

Initilize

chain = QuorumSdk::Chain.new chain_url: 'http://127.0.0.1:8002', jwt: ''

# list joined groups
chain.groups

# network
chain.network

Proto

Check all available proto types in chain_pb.rb.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/an-lee/quorum_sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the QuorumSdk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.