steem-ruby 0.9.0 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4c0d2e4cfae2885bc24acaa7d2a5f046e73a1505
-  data.tar.gz: ddfdd7c5505ada6ea5e67584e51f6b5241e74bb6
+SHA256:
+  metadata.gz: 6ee068c00342f904efe37abe6e2cafa9332b1221cac3598071aefab473cfe996
+  data.tar.gz: b84eb953f450d52ebabfb1417b2e46a0154aeb8a1066981dcee937480b761632
 SHA512:
-  metadata.gz: ec9da3a5222a1ef5bf503ab496eeb12b88609ff1b76d0fd888ca10a355fa3bf0c1bea497a75327a5922a7b002d7b8f19d38eb9b047b431d5fa532eea740c3fa3
-  data.tar.gz: 3a3aac4b912eeb02c92c97b9e74be3c747595b0acfffd75318258d4b89b99b1569776ff9aa4d7393aa0176b45b2170f5723195aafc87729ae7e22f9cb733d944
+  metadata.gz: 824809d5a78d22ac1d15c812537e4c6fa11e85e56920cee365c18c18efc932ba7b265f049462407dd3acae1f460e912f0f582d6f2b05f07ebae8075a8c25b02a
+  data.tar.gz: b5fd1bb775ec114939ac338e9f4a83dee337af072b17d435475c420b84b272880bc5847ab3cb8b88f6f689e661fb2897ac729cc6d540ea8ac1fff1073bba69bc

data/.gitignore

@@ -43,7 +43,7 @@ build-iPhoneSimulator/
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
+Gemfile.lock
 # .ruby-version
 # .ruby-gemset
 

data/README.md

@@ -13,17 +13,17 @@ Full documentation: http://www.rubydoc.info/gems/steem-ruby
 
 The `steem-ruby` gem was written from the ground up by `@inertia`, who is also the author of [`radiator`](https://github.com/inertia186/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 serialzation 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 |
+> "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`, then deserializes to verify
+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
 
@@ -70,6 +70,79 @@ end
 
 *See: [Broadcast](https://www.rubydoc.info/gems/steem-ruby/Steem/Broadcast)*
 
+### Streaming
+
+The value passed to the block is an object, with the keys: `:type` and `:value`.
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+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:
+
+```ruby
+stream = Steem::Stream.new
+
+stream.operations(types: :vote_operation) do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+Or pass an array of certain operations:
+
+```ruby
+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.
+
+```ruby
+stream = Steem::Stream.new
+
+stream.operations(:vote_operation) do |op|
+  puts "#{op.type}: #{op.value}"
+end
+```
+
+To also include virtual operations:
+
+```ruby
+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.
@@ -90,7 +163,7 @@ 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.
 
 ```ruby
-builder = TransactionBuilder.new(wif: wif1)
+builder = Steem::TransactionBuilder.new(wif: wif1)
 
 builder.put(vote: {
   voter: voter,
@@ -110,10 +183,10 @@ Then send the contents of `trx.json` to the other signing party so they can priv
 
 ```ruby
 trx = open('trx.json').read
-builder = TransactionBuilder.new(wif: wif2, trx: trx)
-api = Steem::NetworkBroadcastApi.new
+builder = Steem::TransactionBuilder.new(wif: wif2, trx: trx)
+api = Steem::CondenserApi.new
 trx = builder.transaction
-api.broadcast_transaction_synchronous(trx: trx)
+api.broadcast_transaction_synchronous(trx)
 ```
 
 ### Get Accounts

data/Rakefile

@@ -138,44 +138,141 @@ end
   
 namespace :stream do
   desc 'Test the ability to stream a block range.'
-  task :block_range do
-    block_api = Steem::BlockApi.new(url: ENV['TEST_NODE'])
+  task :block_range, [:mode, :at_block_num] do |t, args|
+    mode = (args[:mode] || 'irreversible').to_sym
+    first_block_num = args[:at_block_num].to_i if !!args[:at_block_num]
+    stream = Steem::Stream.new(url: ENV['TEST_NODE'], mode: mode)
     api = Steem::Api.new(url: ENV['TEST_NODE'])
     last_block_num = nil
-    first_block_num = nil
     last_timestamp = nil
+    range_complete = false
     
-    loop do
-      api.get_dynamic_global_properties do |properties|
-        current_block_num = properties.last_irreversible_block_num
-        # First pass replays latest a random number of blocks to test chunking.
-        first_block_num ||= current_block_num - (rand * 200).to_i
+    api.get_dynamic_global_properties do |properties|
+      current_block_num = if mode == :head
+        properties.head_block_number
+      else
+        properties.last_irreversible_block_num
+      end
+      
+      # First pass replays latest a random number of blocks to test chunking.
+      first_block_num ||= current_block_num - (rand * 200).to_i
+      
+      range = first_block_num..current_block_num
+      puts "Initial block range: #{range.size}"
+      
+      stream.blocks(at_block_num: range.first) do |block, block_num|
+        current_timestamp = Time.parse(block.timestamp + 'Z')
         
-        if current_block_num >= first_block_num
-          range = first_block_num..current_block_num
-          puts "Got block range: #{range.size}"
-          block_api.get_blocks(block_range: range) do |block, block_num|
-            current_timestamp = Time.parse(block.timestamp + 'Z')
-            
-            if !!last_timestamp && block_num != last_block_num + 1
-              puts "Bug: Last block number was #{last_block_num} then jumped to: #{block_num}"
-              exit
-            end
-            
-            if !!last_timestamp && current_timestamp < last_timestamp
-              puts "Bug: Went back in time.  Last timestamp was #{last_timestamp}, then jumped back to #{current_timestamp}"
-              exit
-            end
-            
-            puts "\t#{block_num} Timestamp: #{current_timestamp}, witness: #{block.witness}"
-            last_block_num = block_num
-            last_timestamp = current_timestamp
-          end
-          
-          first_block_num = range.max + 1
+        if !range_complete && block_num > range.last
+          puts 'Done with initial range.'
+          range_complete = true
         end
         
-        sleep 3
+        if !!last_timestamp && block_num != last_block_num + 1
+          puts "Bug: Last block number was #{last_block_num} then jumped to: #{block_num}"
+          exit
+        end
+        
+        if !!last_timestamp && current_timestamp < last_timestamp
+          puts "Bug: Went back in time.  Last timestamp was #{last_timestamp}, then jumped back to #{current_timestamp}"
+          exit
+        end
+        
+        puts "\t#{block_num} Timestamp: #{current_timestamp}, witness: #{block.witness}"
+        last_block_num = block_num
+        last_timestamp = current_timestamp
+      end
+    end
+  end
+  
+  desc 'Test the ability to stream a block range of transactions.'
+  task :trx_range, [:mode, :at_block_num] do |t, args|
+    mode = (args[:mode] || 'irreversible').to_sym
+    first_block_num = args[:at_block_num].to_i if !!args[:at_block_num]
+    stream = Steem::Stream.new(url: ENV['TEST_NODE'], mode: mode)
+    api = Steem::Api.new(url: ENV['TEST_NODE'])
+    
+    api.get_dynamic_global_properties do |properties|
+      current_block_num = if mode == :head
+        properties.head_block_number
+      else
+        properties.last_irreversible_block_num
+      end
+      
+      # First pass replays latest a random number of blocks to test chunking.
+      first_block_num ||= current_block_num - (rand * 200).to_i
+      
+      stream.transactions(at_block_num: first_block_num) do |trx, trx_id, block_num|
+        puts "#{block_num} :: #{trx_id}; ops: #{trx.operations.map(&:type).join(', ')}"
+      end
+    end
+  end
+  
+  desc 'Test the ability to stream a block range of operations.'
+  task :op_range, [:mode, :at_block_num] do |t, args|
+    mode = (args[:mode] || 'irreversible').to_sym
+    first_block_num = args[:at_block_num].to_i if !!args[:at_block_num]
+    stream = Steem::Stream.new(url: ENV['TEST_NODE'], mode: mode)
+    api = Steem::Api.new(url: ENV['TEST_NODE'])
+    
+    api.get_dynamic_global_properties do |properties|
+      current_block_num = if mode == :head
+        properties.head_block_number
+      else
+        properties.last_irreversible_block_num
+      end
+      
+      # First pass replays latest a random number of blocks to test chunking.
+      first_block_num ||= current_block_num - (rand * 200).to_i
+      
+      stream.operations(at_block_num: first_block_num) do |op, trx_id, block_num|
+        puts "#{block_num} :: #{trx_id}; op: #{op.type}"
+      end
+    end
+  end
+  
+  desc 'Test the ability to stream a block range of virtual operations.'
+  task :vop_range, [:mode, :at_block_num] do |t, args|
+    mode = (args[:mode] || 'irreversible').to_sym
+    first_block_num = args[:at_block_num].to_i if !!args[:at_block_num]
+    stream = Steem::Stream.new(url: ENV['TEST_NODE'], mode: mode)
+    api = Steem::Api.new(url: ENV['TEST_NODE'])
+    
+    api.get_dynamic_global_properties do |properties|
+      current_block_num = if mode == :head
+        properties.head_block_number
+      else
+        properties.last_irreversible_block_num
+      end
+      
+      # First pass replays latest a random number of blocks to test chunking.
+      first_block_num ||= current_block_num - (rand * 200).to_i
+      
+      stream.operations(at_block_num: first_block_num, only_virtual: true) do |op, trx_id, block_num|
+        puts "#{block_num} :: #{trx_id}; op: #{op.type}"
+      end
+    end
+  end
+  
+  desc 'Test the ability to stream a block range of all operations (including virtual).'
+  task :all_op_range, [:mode, :at_block_num] do |t, args|
+    mode = (args[:mode] || 'irreversible').to_sym
+    first_block_num = args[:at_block_num].to_i if !!args[:at_block_num]
+    stream = Steem::Stream.new(url: ENV['TEST_NODE'], mode: mode)
+    api = Steem::Api.new(url: ENV['TEST_NODE'])
+    
+    api.get_dynamic_global_properties do |properties|
+      current_block_num = if mode == :head
+        properties.head_block_number
+      else
+        properties.last_irreversible_block_num
+      end
+      
+      # First pass replays latest a random number of blocks to test chunking.
+      first_block_num ||= current_block_num - (rand * 200).to_i
+      
+      stream.operations(at_block_num: first_block_num, include_virtual: true) do |op, trx_id, block_num|
+        puts "#{block_num} :: #{trx_id}; op: #{op.type}"
       end
     end
   end

data/lib/steem.rb

@@ -6,10 +6,58 @@ require 'hashie'
 require 'steem/version'
 require 'steem/utils'
 require 'steem/base_error'
+require 'steem/mixins/serializable'
+require 'steem/mixins/jsonable'
 require 'steem/mixins/retriable'
 require 'steem/chain_config'
 require 'steem/type/base_type'
 require 'steem/type/amount'
+require 'steem/operation'
+require 'steem/operation/account_create.rb'
+require 'steem/operation/account_create_with_delegation.rb'
+require 'steem/operation/account_update.rb'
+require 'steem/operation/account_witness_proxy.rb'
+require 'steem/operation/account_witness_vote.rb'
+require 'steem/operation/cancel_transfer_from_savings.rb'
+require 'steem/operation/challenge_authority.rb'
+require 'steem/operation/change_recovery_account.rb'
+require 'steem/operation/claim_account.rb'
+require 'steem/operation/claim_reward_balance.rb'
+require 'steem/operation/comment.rb'
+require 'steem/operation/comment_options.rb'
+require 'steem/operation/convert.rb'
+require 'steem/operation/create_claimed_account.rb'
+require 'steem/operation/custom.rb'
+require 'steem/operation/custom_binary.rb'
+require 'steem/operation/custom_json.rb'
+require 'steem/operation/decline_voting_rights.rb'
+require 'steem/operation/delegate_vesting_shares.rb'
+require 'steem/operation/delete_comment.rb'
+require 'steem/operation/escrow_approve.rb'
+require 'steem/operation/escrow_dispute.rb'
+require 'steem/operation/escrow_release.rb'
+require 'steem/operation/escrow_transfer.rb'
+require 'steem/operation/feed_publish.rb'
+require 'steem/operation/limit_order_cancel.rb'
+require 'steem/operation/limit_order_create.rb'
+require 'steem/operation/limit_order_create2.rb'
+require 'steem/operation/prove_authority.rb'
+require 'steem/operation/recover_account.rb'
+require 'steem/operation/report_over_production.rb'
+require 'steem/operation/request_account_recovery.rb'
+require 'steem/operation/reset_account.rb'
+require 'steem/operation/set_reset_account.rb'
+require 'steem/operation/set_withdraw_vesting_route.rb'
+require 'steem/operation/transfer.rb'
+require 'steem/operation/transfer_from_savings.rb'
+require 'steem/operation/transfer_to_savings.rb'
+require 'steem/operation/transfer_to_vesting.rb'
+require 'steem/operation/vote.rb'
+require 'steem/operation/withdraw_vesting.rb'
+require 'steem/operation/witness_update.rb'
+require 'steem/operation/witness_set_properties.rb'
+require 'steem/marshal'
+require 'steem/transaction'
 require 'steem/transaction_builder'
 require 'steem/rpc/base_client'
 require 'steem/rpc/http_client'
@@ -19,6 +67,7 @@ require 'steem/jsonrpc'
 require 'steem/block_api'
 require 'steem/formatter'
 require 'steem/broadcast'
+require 'steem/stream'
 
 module Steem
   def self.api_classes

data/lib/steem/api.rb

@@ -1,6 +1,6 @@
 module Steem
   # This ruby API works with
-  # {https://github.com/steemit/steem/releases steemd-0.19.4} and other AppBase
+  # {https://github.com/steemit/steem/releases steemd-0.19.10} and other AppBase
   # compatible upstreams.  To access different API namespaces, use the
   # following:
   #
@@ -36,10 +36,10 @@ module Steem
   #
   # Also see: {https://developers.steem.io/apidefinitions/ Complete API Definitions}
   class Api
-    attr_accessor :chain, :methods
+    attr_accessor :chain, :methods, :rpc_client
     
     # Use this for debugging naive thread handler.
-    # DEFAULT_RPC_CLIENT_CLASS = RPC::BaseClient
+    # DEFAULT_RPC_CLIENT_CLASS = RPC::HttpClient
     DEFAULT_RPC_CLIENT_CLASS = RPC::ThreadSafeHttpClient
     
     def self.api_name=(api_name)
@@ -57,17 +57,37 @@ module Steem
       @api_name.to_s.split('_').map(&:capitalize).join
     end
     
-    def self.jsonrpc=(jsonrpc)
-      @jsonrpc = jsonrpc
+    def self.jsonrpc=(jsonrpc, url = nil)
+      @jsonrpc ||= {}
+      @jsonrpc[url || jsonrpc.rpc_client.uri.to_s] = jsonrpc
     end
     
-    def self.jsonrpc
-      @jsonrpc
+    def self.jsonrpc(url = nil)
+      if @jsonrpc.size < 2 && url.nil?
+        @jsonrpc.values.first
+      else
+        @jsonrpc[url]
+      end
     end
     
-    # Override this if you want to use your own client.
+    # Override this if you want to just use your own client.  Otherwise, inject
+    # the default using:
+    #
+    #     Steem::Api.register default_rpc_client_class: MyClient
     def self.default_rpc_client_class
-      DEFAULT_RPC_CLIENT_CLASS
+      if !!@injected_dependencies && !!@injected_dependencies[:default_rpc_client_class]
+        @injected_dependencies[:default_rpc_client_class]
+      else
+        DEFAULT_RPC_CLIENT_CLASS
+      end
+    end
+    
+    # Used for dependency injection.  Currently, the only key supported is:
+    # 
+    # `default_rpc_client_class`
+    def self.register(register)
+      @injected_dependencies ||= {}
+      @injected_dependencies = @injected_dependencies.merge register
     end
     
     def initialize(options = {})
@@ -89,7 +109,7 @@ module Steem
         # have access to instance options until now.
         
         Api::jsonrpc = Jsonrpc.new(options)
-        @methods = Api::jsonrpc.get_api_methods
+        @methods = Api::jsonrpc(rpc_client.uri.to_s).get_api_methods
         
         unless !!@methods[@api_name]
           raise UnknownApiError, "#{@api_name} (known APIs: #{@methods.keys.join(' ')})"
@@ -115,28 +135,18 @@ module Steem
     end
   private
     # @private
-    def self.args_keys_to_s(rpc_method_name)
+    def args_keys_to_s(rpc_method_name)
       args = signature(rpc_method_name).args
       args_keys = JSON[args.to_json]
     end
     
     # @private
-    def self.signature(rpc_method_name)
-      @@signatures ||= {}
-      @@signatures[rpc_method_name] ||= jsonrpc.get_signature(method: rpc_method_name).result
-    end
-    
-    # @private
-    def self.raise_error_response(rpc_method_name, rpc_args, response)
-      raise UnknownError, "#{rpc_method_name}: #{response}" if response.error.nil?
-      
-      error = response.error
-      
-      if error.message == 'Invalid Request'
-        raise Steem::ArgumentError, "Unexpected arguments: #{rpc_args.inspect}.  Expected: #{rpc_method_name} (#{args_keys_to_s(rpc_method_name)})"
-      end
+    def signature(rpc_method_name)
+      url = rpc_client.uri.to_s
       
-      BaseError.build_error(error, rpc_method_name)
+      @@signatures ||= {}
+      @@signatures[url] ||= {}
+      @@signatures[url][rpc_method_name] ||= Api::jsonrpc(url).get_signature(method: rpc_method_name).result
     end
     
     # @private
@@ -153,9 +163,9 @@ module Steem
       when :condenser_api then args
       when :jsonrpc then args.first
       else
-        expected_args = Api::signature(rpc_method_name).args || []
+        expected_args = signature(rpc_method_name).args || []
         expected_args_key_string = if expected_args.size > 0
-          " (#{Api::args_keys_to_s(rpc_method_name)})"
+          " (#{args_keys_to_s(rpc_method_name)})"
         end
         expected_args_size = expected_args.size
         
@@ -178,15 +188,7 @@ module Steem
         args
       end
       
-      response = @rpc_client.rpc_execute(@api_name, m, rpc_args)
-      
-      if defined?(response.error) && !!response.error
-        if !!response.error.message
-          Api::raise_error_response rpc_method_name, rpc_args, response
-        else
-          raise Steem::ArgumentError, response.error.inspect
-        end
-      end
+      response = rpc_client.rpc_execute(@api_name, m, rpc_args)
       
       if !!block
         case response