Steem-ruby is the official Ruby library for the Steem blockchain
Clone or download
inertia186 Merge pull request #11 from Steemhunt/master
Fix method mis-match on create_claimed_account operation
Latest commit 58c66e4 Oct 12, 2018

README.md

Gem Version Inline docs

steem-ruby

Steem-ruby the Ruby API for Steem blockchain.

Full documentation: http://www.rubydoc.info/gems/steem-ruby

Note: This library depends on AppBase methods that are a work in progress.

radiator vs. steem-ruby

The steem-ruby gem was written from the ground up by @inertia, who is also the author of radiator.

"I intend to continue work on radiator indefinitely. But in radiator-0.5, I intend to refactor radiator so that is uses steem-ruby as its core. This means that some features of radiator like Serialization will become redundant. I think it's still useful for radiator to do its own serialization because it reduces the number of API requests." - @inertia

radiator steem-ruby
Has internal failover logic Can have failover delegated externally
Passes error responses to the caller Handles error responses and raises exceptions
Supports tx signing, does its own serialization Also supports tx signing, but delegates serialization to database_api.get_transaction_hex
All apis and methods are hardcoded Asks jsonrpc what apis and methods are available from the node
(radiator-0.4.x) Only supports AppBase but relies on condenser_api Only supports AppBase but does not rely on condenser_api (WIP)
Small list of helper methods for select ops (in addition to build your own transaction) Complete implementation of helper methods for every op (in addition to build your own transaction)
Does not (yet) support json-rpc-batch requests Supports json-rpc-batch requests

Getting Started

The steem-ruby gem is compatible with Ruby 2.2.5 or later.

Install the gem for your project

(Assuming that Ruby is installed on your computer, as well as RubyGems)

To install the gem on your computer, run in shell:

gem install steem-ruby

... then add in your code:

require 'steem'

To add the gem as a dependency to your project with Bundler, you can add this line in your Gemfile:

gem 'steem-ruby', require: 'steem'

Examples

Broadcast Vote

params = {
  voter: voter,
  author: author,
  permlink: permlink,
  weight: weight
}

Steem::Broadcast.vote(wif: wif, params: params) do |result|
  puts result
end

See: Broadcast

Streaming

The value passed to the block is an object, with the keys: :type and :value.

stream = Steem::Stream.new

stream.operations do |op|
  puts "#{op.type}: #{op.value}"
end

To start a stream from a specific block number, pass it as an argument:

stream = Steem::Stream.new

stream.operations(at_block_num: 9001) do |op|
  puts "#{op.type}: #{op.value}"
end

You can also grab the related transaction id and block number for each operation:

stream = Steem::Stream.new

stream.operations do |op, trx_id, block_num|
  puts "#{block_num} :: #{trx_id}"
  puts "#{op.type}: #{op.value}"
end

To stream only certain operations:

stream = Steem::Stream.new

stream.operations(types: :vote_operation) do |op|
  puts "#{op.type}: #{op.value}"
end

Or pass an array of certain operations:

stream = Steem::Stream.new

stream.operations(types: [:comment_operation, :vote_operation]) do |op|
  puts "#{op.type}: #{op.value}"
end

Or (optionally) just pass the operation(s) you want as the only arguments. This is semantic sugar for when you want specific types and take all of the defaults.

stream = Steem::Stream.new

stream.operations(:vote_operation) do |op|
  puts "#{op.type}: #{op.value}"
end

To also include virtual operations:

stream = Steem::Stream.new

stream.operations(include_virtual: true) do |op|
  puts "#{op.type}: #{op.value}"
end

Multisig

You can use multisignature to broadcast an operation.

params = {
  voter: voter,
  author: author,
  permlink: permlink,
  weight: weight
}

Steem::Broadcast.vote(wif: [wif1, wif2], params: params) do |result|
  puts result
end

In addition to signing with multiple wif private keys, it is possible to also export a partially signed transaction to have signing completed by someone else.

builder = Steem::TransactionBuilder.new(wif: wif1)

builder.put(vote: {
  voter: voter,
  author: author,
  permlink: permlink,
  weight: weight
})

trx = builder.sign.to_json

File.open('trx.json', 'w') do |f|
  f.write(trx)
end

Then send the contents of trx.json to the other signing party so they can privately sign and broadcast the transaction.

trx = open('trx.json').read
builder = Steem::TransactionBuilder.new(wif: wif2, trx: trx)
api = Steem::CondenserApi.new
trx = builder.transaction
api.broadcast_transaction_synchronous(trx: trx)

Get Accounts

api = Steem::DatabaseApi.new

api.find_accounts(accounts: ['steemit', 'alice']) do |result|
  puts result.accounts
end

See: Api

Reputation Formatter

rep = Steem::Formatter.reputation(account.reputation)
puts rep

Tests

  • Clone the client repository into a directory of your choice:
    • git clone https://github.com/steemit/steem-ruby.git
  • Navigate into the new folder
    • cd steem-ruby
  • All tests can be invoked as follows:
    • bundle exec rake test
  • To run static tests:
    • bundle exec rake test:static
  • To run broadcast tests (broadcast is simulated, only verify is actually used):
    • bundle exec rake test:broadcast
  • To run threads tests (which quickly verifies thread safety):
    • bundle exec rake test:threads
  • To run testnet tests (which does actual broadcasts)
    • TEST_NODE=https://testnet.steemitdev.com bundle exec rake test:testnet

You can also run other tests that are not part of the above test execution:

  • To run block_range, which streams blocks (using json-rpc-batch)
    • bundle exec rake stream:block_range

If you want to point to any node for tests, instead of letting the test suite pick the default, set the environment variable to TEST_NODE, e.g.:

$ TEST_NODE=https://api.steemitdev.com bundle exec rake test

Contributions

Patches are welcome! Contributors are listed in the steem-ruby.gemspec file. Please run the tests (rake test) before opening a pull request and make sure that you are passing all of them. If you would like to contribute, but don't know what to work on, check the issues list.

Issues

When you find issues, please report them!

License

MIT