steem-ruby 0.9.1 → 0.9.6

data/lib/steem/operation/delete_comment.rb

@@ -0,0 +1,4 @@
+class Steem::Operation::DeleteComment < Steem::Operation
+  def_attr author: :string
+  def_attr permlink: :string
+end

data/lib/steem/operation/escrow_approve.rb

@@ -0,0 +1,8 @@
+class Steem::Operation::EscrowApprove < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr agent: :string
+  def_attr who: :string
+  def_attr escrow_id: :uint32
+  def_attr approve: :boolean
+end

data/lib/steem/operation/escrow_dispute.rb

@@ -0,0 +1,7 @@
+class Steem::Operation::EscrowDispute < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr agent: :string
+  def_attr who: :string
+  def_attr escrow_id: :uint32
+end

data/lib/steem/operation/escrow_release.rb

@@ -0,0 +1,10 @@
+class Steem::Operation::EscrowRelease < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr agent: :string
+  def_attr who: :string
+  def_attr receiver: :string
+  def_attr escrow_id: :uint32
+  def_attr sbd_amount: :amount
+  def_attr steem_amount: :amount
+end

data/lib/steem/operation/escrow_transfer.rb

@@ -0,0 +1,12 @@
+class Steem::Operation::EscrowTransfer < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr sbd_amount: :amount
+  def_attr steem_amount: :amount
+  def_attr escrow_id: :uint32
+  def_attr agent: :string
+  def_attr fee: :amount
+  def_attr json_metadata: :string
+  def_attr ratification_deadline: :point_in_time
+  def_attr escrow_expiration: :point_in_time
+end

data/lib/steem/operation/feed_publish.rb

@@ -0,0 +1,4 @@
+class Steem::Operation::FeedPublish < Steem::Operation
+  def_attr publisher: :string
+  def_attr exchange_rate: :price
+end

data/lib/steem/operation/limit_order_cancel.rb

@@ -0,0 +1,4 @@
+class Steem::Operation::LimitOrderCancel < Steem::Operation
+  def_attr owner: :string
+  def_attr orderid: :uint32
+end

data/lib/steem/operation/limit_order_create.rb

@@ -0,0 +1,8 @@
+class Steem::Operation::LimitOrderCreate < Steem::Operation
+  def_attr owner: :string
+  def_attr orderid: :uint32
+  def_attr amount_to_sell: :amount
+  def_attr min_to_receive: :amount
+  def_attr fill_or_kill: :boolean
+  def_attr expiration: :point_in_time
+end

data/lib/steem/operation/limit_order_create2.rb

@@ -0,0 +1,8 @@
+class Steem::Operation::LimitOrderCreate2 < Steem::Operation
+  def_attr owner: :string
+  def_attr orderid: :uint32
+  def_attr amount_to_sell: :amount
+  def_attr fill_or_kill: :boolean
+  def_attr exchange_rate: :price
+  def_attr expiration: :point_in_time
+end

data/lib/steem/operation/prove_authority.rb

@@ -0,0 +1,4 @@
+class Steem::Operation::ProveAuthority < Steem::Operation
+  def_attr challenged: :string
+  def_attr require_owner: :boolean
+end

data/lib/steem/operation/recover_account.rb

@@ -0,0 +1,6 @@
+class Steem::Operation::RecoverAccount < Steem::Operation
+  def_attr account_to_recover: :string
+  def_attr new_owner_authority: :authority
+  def_attr recent_owner_authority: :authority
+  def_attr extensions: :empty_array
+end

data/lib/steem/operation/report_over_production.rb

@@ -0,0 +1,5 @@
+class Steem::Operation::ReportOverProduction < Steem::Operation
+  def_attr reporter: :string
+  def_attr first_block: :string # FIXME signed_block_header
+  def_attr second_block: :string # FIXME signed_block_header
+end

data/lib/steem/operation/request_account_recovery.rb

@@ -0,0 +1,6 @@
+class Steem::Operation::RequestAccountRecovery < Steem::Operation
+  def_attr recovery_account: :string
+  def_attr account_to_recover: :string
+  def_attr new_owner_authority: :authority
+  def_attr extensions: :empty_array
+end

data/lib/steem/operation/reset_account.rb

@@ -0,0 +1,5 @@
+class Steem::Operation::ResetAccount < Steem::Operation
+  def_attr reset_account: :string
+  def_attr account_to_reset: :string
+  def_attr new_owner_authority: :authority
+end

data/lib/steem/operation/set_reset_account.rb

@@ -0,0 +1,5 @@
+class Steem::Operation::SetResetAccount < Steem::Operation
+  def_attr account: :string
+  def_attr current_reset_account: :string
+  def_attr reset_account: :string
+end

data/lib/steem/operation/set_withdraw_vesting_route.rb

@@ -0,0 +1,6 @@
+class Steem::Operation::SetWithdrawVestingRoute < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr percent: :uint16
+  def_attr auto_vest: :boolean
+end

data/lib/steem/operation/transfer.rb

@@ -0,0 +1,6 @@
+class Steem::Operation::Transfer < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr amount: :amount
+  def_attr memo: :string
+end

data/lib/steem/operation/transfer_from_savings.rb

@@ -0,0 +1,7 @@
+class Steem::Operation::TransferFromSavings < Steem::Operation
+  def_attr from: :string
+  def_attr request_id: :uint32
+  def_attr to: :string
+  def_attr amount: :amount
+  def_attr memo: :string
+end

data/lib/steem/operation/transfer_to_savings.rb

@@ -0,0 +1,6 @@
+class Steem::Operation::TransferToSavings < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr amount: :amount
+  def_attr memo: :string
+end

data/lib/steem/operation/transfer_to_vesting.rb

@@ -0,0 +1,5 @@
+class Steem::Operation::TransferToVesting < Steem::Operation
+  def_attr from: :string
+  def_attr to: :string
+  def_attr amount: :amount
+end

data/lib/steem/operation/vote.rb

@@ -0,0 +1,6 @@
+class Steem::Operation::Vote < Steem::Operation
+  def_attr voter: :string
+  def_attr author: :string
+  def_attr permlink: :string
+  def_attr weight: :int16
+end

data/lib/steem/operation/withdraw_vesting.rb

@@ -0,0 +1,4 @@
+class Steem::Operation::WithdrawVesting < Steem::Operation
+  def_attr account: :string
+  def_attr vesting_shares: :amount
+end

data/lib/steem/operation/witness_set_properties.rb

@@ -0,0 +1,5 @@
+class Steem::Operation::WitnessSetProperties < Steem::Operation
+  def_attr owner: :string
+  def_attr props: :witness_properties
+  def_attr extensions: :empty_array
+end

data/lib/steem/operation/witness_update.rb

@@ -0,0 +1,7 @@
+class Steem::Operation::WitnessUpdate < Steem::Operation
+  def_attr owner: :string
+  def_attr url: :string
+  def_attr block_signing_key: :public_key
+  def_attr props: :chain_properties
+  def_attr fee: :amount
+end

data/lib/steem/rpc/base_client.rb

@@ -12,8 +12,7 @@ module Steem
       MAX_TIMEOUT_BACKOFF = 30
       
       # @private
-      TIMEOUT_ERRORS = [Net::ReadTimeout, Errno::EBADF, Errno::ECONNREFUSED,
-        IOError]
+      TIMEOUT_ERRORS = [Net::ReadTimeout, Errno::EBADF, IOError]
       
       def initialize(options = {})
         @chain = options[:chain] || :steem
@@ -162,6 +161,19 @@ module Steem
         
         sleep @backoff
       end
+      
+      # @private
+      def 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
+        
+        BaseError.build_error(error, rpc_method_name)
+      end
     end
   end
 end

data/lib/steem/rpc/http_client.rb

@@ -17,7 +17,7 @@ module Steem
       # 
       # @private
       TIMEOUT_ERRORS = [Net::OpenTimeout, JSON::ParserError, Net::ReadTimeout,
-        Errno::EBADF, Errno::ECONNREFUSED, IOError]
+        Errno::EBADF, IOError, Errno::ENETDOWN, Steem::RemoteDatabaseLockError]
       
       # @private
       POST_HEADERS = {
@@ -108,6 +108,22 @@ module Steem
             else; response
             end
             
+            [response].flatten.each_with_index do |r, i|
+              if defined?(r.error) && !!r.error
+                if !!r.error.message
+                  begin
+                    rpc_method_name = "#{api_name}.#{api_method}"
+                    rpc_args = [request_object].flatten[i]
+                    raise_error_response rpc_method_name, rpc_args, r
+                  rescue *TIMEOUT_ERRORS => e
+                    throw retry_timeout(:tota_cera_pila, e)
+                  end
+                else
+                  raise Steem::ArgumentError, r.error.inspect
+                end
+              end
+            end
+            
             yield_response response, &block
           when '504' # Gateway Timeout
             throw retry_timeout(:tota_cera_pila, response.body)

data/lib/steem/stream.rb

@@ -0,0 +1,385 @@
+module Steem
+  # Steem::Stream allows a live view of the STEEM blockchain.
+  # 
+  # Example streaming blocks:
+  # 
+  #     stream = Steem::Stream.new
+  #     
+  #     stream.blocks do |block, block_num|
+  #       puts "#{block_num} :: #{block.witness}"
+  #     end
+  # 
+  # Example streaming transactions:
+  # 
+  #     stream = Steem::Stream.new
+  #     
+  #     stream.transactions do |trx, trx_id, block_num|
+  #       puts "#{block_num} :: #{trx_id} :: operations: #{trx.operations.size}"
+  #     end
+  # 
+  # Example streaming operations:
+  # 
+  #     stream = Steem::Stream.new
+  #    
+  #     stream.operations do |op, trx_id, block_num|
+  #       puts "#{block_num} :: #{trx_id} :: #{op.type}: #{op.value.to_json}"
+  #     end
+  # 
+  # Allows streaming of block headers, full blocks, transactions, operations and
+  # virtual operations.
+  class Stream
+    attr_reader :database_api, :block_api, :account_history_api, :mode
+    
+    BLOCK_INTERVAL = 3
+    MAX_BACKOFF_BLOCK_INTERVAL = 30
+    MAX_RETRY_COUNT = 10
+    
+    VOP_TRX_ID = ('0' * 40).freeze
+
+    # @param options [Hash] additional options
+    # @option options [Steem::DatabaseApi] :database_api
+    # @option options [Steem::BlockApi] :block_api
+    # @option options [Steem::AccountHistoryApi || Steem::CondenserApi] :account_history_api
+    # @option options [Symbol] :mode we have the choice between
+    #   * :head the last block
+    #   * :irreversible the block that is confirmed by 2/3 of all block producers and is thus irreversible!
+    # @option options [Boolean] :no_warn do not generate warnings
+    def initialize(options = {mode: :irreversible})
+      @instance_options = options
+      @database_api = options[:database_api] || Steem::DatabaseApi.new(options)
+      @block_api = options[:block_api] || Steem::BlockApi.new(options)
+      @account_history_api = options[:account_history_api]
+      @mode = options[:mode] || :irreversible
+      @no_warn = !!options[:no_warn]
+    end
+    
+    # Use this method to stream block numbers.  This is significantly faster
+    # than requesting full blocks and even block headers.  Basically, the only
+    # thing this method does is call {Steem::Database#get_dynamic_global_properties} at 3 second
+    # intervals.
+    #
+    # @param options [Hash] additional options
+    # @option options [Integer] :at_block_num Starts the stream at the given block number.  Default: nil.
+    # @option options [Integer] :until_block_num Ends the stream at the given block number.  Default: nil.
+    def block_numbers(options = {}, &block)
+      block_objects(options.merge(object: :block_numbers), block)
+    end
+    
+    # Use this method to stream block headers.  This is quite a bit faster than
+    # requesting full blocks.
+    #
+    # @param options [Hash] additional options
+    # @option options [Integer] :at_block_num Starts the stream at the given block number.  Default: nil.
+    # @option options [Integer] :until_block_num Ends the stream at the given block number.  Default: nil.
+    def block_headers(options = {}, &block)
+      block_objects(options.merge(object: :block_headers), block)
+    end
+    
+    # Use this method to stream full blocks.
+    #
+    # @param options [Hash] additional options
+    # @option options [Integer] :at_block_num Starts the stream at the given block number.  Default: nil.
+    # @option options [Integer] :until_block_num Ends the stream at the given block number.  Default: nil.
+    def blocks(options = {}, &block)
+      block_objects(options.merge(object: :blocks), block)
+    end
+    
+    # Use this method to stream each transaction.
+    #
+    # @param options [Hash] additional options
+    # @option options [Integer] :at_block_num Starts the stream at the given block number.  Default: nil.
+    # @option options [Integer] :until_block_num Ends the stream at the given block number.  Default: nil.
+    def transactions(options = {}, &block)
+      blocks(options) do |block, block_num|
+        if block.nil?
+          warn "Batch missing block_num: #{block_num}, retrying ..."
+          
+          block = block_api.get_block(block_num: block_num) do |result|
+            result.block
+          end
+        end
+        
+        block.transactions.each_with_index do |transaction, index|
+          trx_id = block.transaction_ids[index]
+          
+          yield transaction, trx_id, block_num
+        end
+      end
+    end
+    
+    # Returns the latest operations from the blockchain.
+    #
+    #   stream = Steem::Stream.new
+    #   stream.operations do |op|
+    #     puts op.to_json
+    #   end
+    # 
+    # If symbol are passed to `types` option, then only that operation is
+    # returned.  Expected symbols are:
+    #
+    #   account_create_operation
+    #   account_create_with_delegation_operation
+    #   account_update_operation
+    #   account_witness_proxy_operation
+    #   account_witness_vote_operation
+    #   cancel_transfer_from_savings_operation
+    #   change_recovery_account_operation
+    #   claim_reward_balance_operation
+    #   comment_operation
+    #   comment_options_operation
+    #   convert_operation
+    #   custom_operation
+    #   custom_json_operation
+    #   decline_voting_rights_operation
+    #   delegate_vesting_shares_operation
+    #   delete_comment_operation
+    #   escrow_approve_operation
+    #   escrow_dispute_operation
+    #   escrow_release_operation
+    #   escrow_transfer_operation
+    #   feed_publish_operation
+    #   limit_order_cancel_operation
+    #   limit_order_create_operation
+    #   limit_order_create2_operation
+    #   pow_operation
+    #   pow2_operation
+    #   recover_account_operation
+    #   request_account_recovery_operation
+    #   set_withdraw_vesting_route_operation
+    #   transfer_operation
+    #   transfer_from_savings_operation
+    #   transfer_to_savings_operation
+    #   transfer_to_vesting_operation
+    #   vote_operation
+    #   withdraw_vesting_operation
+    #   witness_update_operation
+    #
+    # For example, to stream only votes:
+    #
+    #   stream = Steem::Stream.new
+    #   stream.operations(types: :vote_operation) do |vote|
+    #     puts vote.to_json
+    #   end
+    # 
+    # ... Or ...
+    # 
+    #   stream = Steem::Stream.new
+    #   stream.operations(:vote_operation) do |vote|
+    #     puts vote.to_json
+    #   end
+    #
+    # You can also stream virtual operations:
+    #
+    #   stream = Steem::Stream.new
+    #   stream.operations(types: :author_reward_operation, only_virtual: true) do |vop|
+    #     v = vop.value
+    #     puts "#{v.author} got paid for #{v.permlink}: #{[v.sbd_payout, v.steem_payout, v.vesting_payout]}"
+    #   end
+    #
+    # ... or multiple virtual operation types;
+    #
+    #   stream = Steem::Stream.new
+    #   stream.operations(types: [:producer_reward_operation, :author_reward_operation], only_virtual: true) do |vop|
+    #     puts vop.to_json
+    #   end
+    #
+    # ... or all types, including virtual operation types from the head block number:
+    #
+    #   stream = Steem::Stream.new(mode: :head)
+    #   stream.operations(include_virtual: true) do |op|
+    #     puts op.to_json
+    #   end
+    #
+    # Expected virtual operation types:
+    #
+    #   producer_reward_operation
+    #   author_reward_operation
+    #   curation_reward_operation
+    #   fill_convert_request_operation
+    #   fill_order_operation
+    #   fill_vesting_withdraw_operation
+    #   interest_operation
+    #   shutdown_witness_operation
+    #
+    # @param args [Symbol || Array<Symbol> || Hash] the type(s) of operation or hash of expanded options, optional.
+    # @option args [Integer] :at_block_num Starts the stream at the given block number.  Default: nil.
+    # @option args [Integer] :until_block_num Ends the stream at the given block number.  Default: nil.
+    # @option args [Symbol || Array<Symbol>] :types the type(s) of operation, optional.
+    # @option args [Boolean] :only_virtual Only stream virtual options.  Setting this true will improve performance because the stream only needs block numbers to then retrieve virtual operations.  Default: false.
+    # @option args [Boolean] :include_virtual Also stream virtual options.  Setting this true will impact performance.  Default: false.
+    # @param block the block to execute for each result.  Yields: |op, trx_id, block_num|
+    def operations(*args, &block)
+      options = {}
+      types = []
+      only_virtual = false
+      include_virtual = false
+      last_block_num = nil
+      
+      case args.first
+      when Hash
+        options = args.first
+        types = transform_types(options[:types])
+        only_virtual = !!options[:only_virtual] || false
+        include_virtual = !!options[:include_virtual] || only_virtual || false
+      when Symbol, Array then types = transform_types(args)
+      end
+      
+      if only_virtual
+        block_numbers(options) do |block_num|
+          get_virtual_ops(types, block_num, block)
+        end
+      else
+        transactions(options) do |transaction, trx_id, block_num|
+          transaction.operations.each do |op|
+            yield op, trx_id, block_num if types.none? || types.include?(op.type)
+            
+            next unless last_block_num != block_num
+            
+            last_block_num = block_num
+            
+            get_virtual_ops(types, block_num, block) if include_virtual
+          end
+        end
+      end
+    end
+    
+    def account_history_api
+      @account_history_api ||= begin
+        Steem::AccountHistoryApi.new(@instance_options)
+      rescue Steem::UnknownApiError => e
+        warn "#{e.inspect}, falling back to Steem::CondenserApi." unless @no_warn
+        Steem::CondenserApi.new(@instance_options)
+      end
+    end
+  private
+    # @private
+    def block_objects(options = {}, block)
+      object = options[:object]
+      object_method = "get_#{object}".to_sym
+      block_interval = BLOCK_INTERVAL
+      
+      at_block_num, until_block_num = if !!block_range = options[:block_range]
+        [block_range.first, block_range.last]
+      else
+        [options[:at_block_num], options[:until_block_num]]
+      end
+      
+      loop do
+        break if !!until_block_num && !!at_block_num && until_block_num < at_block_num
+        
+        database_api.get_dynamic_global_properties do |properties|
+          current_block_num = find_block_number(properties)
+          current_block_num = [current_block_num, until_block_num].compact.min
+          at_block_num ||= current_block_num
+          
+          if current_block_num >= at_block_num
+            range = at_block_num..current_block_num
+            
+            if object == :block_numbers
+              range.each do |n|
+                block.call n
+                block_interval = BLOCK_INTERVAL
+              end
+            else
+              block_api.send(object_method, block_range: range) do |b, n|
+                block.call b, n
+                block_interval = BLOCK_INTERVAL
+              end
+            end
+            
+            at_block_num = range.max + 1
+          else
+            # The stream has stalled, so let's back off and let the node sync
+            # up.  We'll catch up with a bigger batch in the next cycle.
+            block_interval = [block_interval * 2, MAX_BACKOFF_BLOCK_INTERVAL].min
+          end
+        end
+        
+        sleep block_interval
+      end
+    end
+    
+    # @private
+    def find_block_number(properties)
+      block_num = case mode
+      when :head then properties.head_block_number
+      when :irreversible then properties.last_irreversible_block_num
+      else; raise Steem::ArgumentError, "Unknown mode: #{mode}"
+      end
+      
+      block_num
+    end
+    
+    # @private
+    def transform_types(types)
+      [types].compact.flatten.map do |type|
+        type = type.to_s
+        
+        unless type.end_with? '_operation'
+          warn "Op type #{type} is deprecated.  Use #{type}_operation instead." unless @no_warn
+          type += '_operation'
+        end
+        
+        type
+      end
+    end
+    
+    # @private
+    def get_virtual_ops(types, block_num, block)
+      retries = 0
+      
+      loop do
+        get_ops_in_block_options = case account_history_api
+        when Steem::CondenserApi
+          [block_num, true]
+        when Steem::AccountHistoryApi
+          {
+            block_num: block_num,
+            only_virtual: true
+          }
+        end
+        
+        response = account_history_api.get_ops_in_block(*get_ops_in_block_options)
+        
+        if response.nil? || (result = response.result).nil?
+          if retries < MAX_RETRY_COUNT
+            warn "Retrying get_ops_in_block on block #{block_num}" unless @no_warn
+            retries = retries + 1
+            sleep 9
+            redo
+          else
+            raise TooManyRetriesError, "unable to get valid result while finding virtual operations for block: #{block_num}"
+          end
+        end
+        
+        ops = case account_history_api
+        when Steem::CondenserApi
+          result.map do |trx|
+            op = {type: trx.op[0] + '_operation', value: trx.op[1]}
+            op = Hashie::Mash.new(op)
+          end
+        when Steem::AccountHistoryApi then result.ops.map { |trx| trx.op }
+        end
+        
+        if ops.empty?
+          if retries < MAX_RETRY_COUNT
+            sleep 3
+            retries = retries + 1
+            redo
+          else
+            warn "unable to find virtual operations for block: #{block_num}"
+            # raise TooManyRetriesError, "unable to find virtual operations for block: #{block_num}"
+          end
+        end
+        
+        ops.each do |op|
+          next if types.any? && !types.include?(op.type)
+          
+          block.call op, VOP_TRX_ID, block_num
+        end
+        
+        break
+      end
+    end
+  end
+end