steem-ruby 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57f84dd9185bb2ad616730cb370450ff56816706a8ad5b26d452bf3a7921cd68
-  data.tar.gz: 59934f9af8d4e20da692c06b9d8b55b71c54aaead980bec892c400ef100cc77c
+  metadata.gz: 67cb40fbb1b8cf229d3b7fe3388ce1f9ea0b922b2f16f42d73873d965971e209
+  data.tar.gz: b687c618e644cf4a0128875b4e40d16407b3138d91d777c69879585b0c561a93
 SHA512:
-  metadata.gz: f909db06bc8e7db70da6180d385e0527e6153134b2535e275e6864f9c21511506bb93ae685fee51187024819dd9ad243939efa88213f29af8b51d28c6826290b
-  data.tar.gz: 1b9d47fbb3775b639c53fc767f4a71a7d19578ca848f9f196ce1fd53ffe09d2b4eabc90ce70404a9deb523b448d0e2c70ceff53f2058b708e1b9d6be7dd983a2
+  metadata.gz: 8235f9f83af323bce4df042c7eb2c6c504af5385cc137520b068c850ca5bc2f661e492ac547001dbb1892f6cc3dd053f1d1db8c9df3977b5ca0dcdb5ab7d31b9
+  data.tar.gz: 23948d457b71f64db355850214d61b8d5a61439b8ae7af3f60e8583a7cb3335af861572f21a0daba5ae218e92a60caeec1bb651ab64399de73ea88f47a6ab743

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    steem-ruby (0.9.3)
+    steem-ruby (0.9.4)
+      base58 (~> 0.2, >= 0.2.3)
+      bindata (~> 2.4, >= 2.4.4)
       bitcoin-ruby (~> 0.0, >= 0.0.18)
       ffi (~> 1.9, >= 1.9.23)
       hashie (~> 3.5, >= 3.5.7)
@@ -14,6 +16,8 @@ GEM
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     awesome_print (1.8.0)
+    base58 (0.2.3)
+    bindata (2.4.4)
     bitcoin-ruby (0.0.18)
     coderay (1.1.2)
     crack (0.4.3)
@@ -27,17 +31,17 @@ GEM
     logging (2.2.2)
       little-plugger (~> 1.1)
       multi_json (~> 1.10)
-    method_source (0.9.0)
+    method_source (0.9.1)
     minitest (5.11.3)
     minitest-line (0.6.5)
       minitest (~> 5.0)
     minitest-proveit (1.0.0)
       minitest (> 5, < 7)
     multi_json (1.13.1)
-    pry (0.11.3)
+    pry (0.12.0)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
-    public_suffix (3.0.2)
+    public_suffix (3.0.3)
     rake (12.3.1)
     safe_yaml (1.0.4)
     simplecov (0.16.1)
@@ -50,7 +54,7 @@ GEM
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
-    yard (0.9.15)
+    yard (0.9.16)
 
 PLATFORMS
   ruby

data/README.md

@@ -15,15 +15,15 @@ The `steem-ruby` gem was written from the ground up by `@inertia`, who is also t
 
 > "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 |
+`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
 
@@ -186,7 +186,7 @@ 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)
+api.broadcast_transaction_synchronous(trx)
 ```
 
 ### Get Accounts

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'

data/lib/steem/api.rb

@@ -149,19 +149,6 @@ module Steem
       @@signatures[url][rpc_method_name] ||= Api::jsonrpc(url).get_signature(method: rpc_method_name).result
     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
-    
     # @private
     def respond_to_missing?(m, include_private = false)
       methods.nil? ? false : methods.include?(m.to_sym)
@@ -203,14 +190,6 @@ module Steem
       
       response = rpc_client.rpc_execute(@api_name, m, rpc_args)
       
-      if defined?(response.error) && !!response.error
-        if !!response.error.message
-          raise_error_response rpc_method_name, rpc_args, response
-        else
-          raise Steem::ArgumentError, response.error.inspect
-        end
-      end
-      
       if !!block
         case response
         when Hashie::Mash then yield response.result, response.error, response.id

data/lib/steem/base_error.rb

@@ -10,7 +10,7 @@ module Steem
       detail[:error] = @error if !!@error
       detail[:cause] = @cause if !!@cause
       
-      JSON[detail] rescue detai.to_s
+      JSON[detail] rescue detail.to_s
     end
     
     def self.build_error(error, context)
@@ -19,11 +19,11 @@ module Steem
       end
       
       if error.message.include? 'Internal Error'
-        raise Steem::RemoteNodeError.new, error.message, build_backtrace(error)
+        raise Steem::RemoteNodeError, error.message, build_backtrace(error)
       end
       
       if error.message.include? 'Server error'
-        raise Steem::RemoteNodeError.new, error.message, build_backtrace(error)
+        raise Steem::RemoteNodeError, error.message, build_backtrace(error)
       end
       
       if error.message.include? 'plugin not enabled'
@@ -176,6 +176,8 @@ module Steem
     end
   end
   
+  class DeserializationError < BaseError; end
+  class SerializationMismatchError < BaseError; end
   class UnsupportedChainError < BaseError; end
   class ArgumentError < BaseError; end
   class TypeError < BaseError; end

data/lib/steem/broadcast.rb

@@ -197,13 +197,17 @@ module Steem
         permlink: params[:permlink],
         max_accepted_payout: max_accepted_payout,
         percent_steem_dollars: params[:percent_steem_dollars] || 10000,
+        # allow_replies: allow_replies,
         allow_votes: allow_votes,
         allow_curation_rewards: allow_curation_rewards,
         extensions: []
       }
       
       if !!params[:beneficiaries]
-        comment_options[:extensions] << [0, {beneficiaries: params[:beneficiaries]}]
+        comment_options[:extensions] << [
+          comment_options[:extensions].size,
+          normalize_beneficiaries(options.merge(beneficiaries: params[:beneficiaries]))
+        ]
       end
       
       ops << [:comment_options, comment_options]
@@ -567,7 +571,7 @@ module Steem
       check_required_fields(params, *required_fields)
       
       params[:extensions] ||= []
-      ops = [[:account_create, params]]
+      ops = [[:create_claimed_account, params]]
       
       process(options.merge(ops: ops), &block)
     end
@@ -714,13 +718,21 @@ module Steem
       end
       
       if !!(sbd_exchange_rate = params[:props][:sbd_exchange_rate] rescue nil)
-        params[:props][:sbd_exchange_rate] = normalize_amount(options.merge amount: sbd_exchange_rate, serialize: true)
+        params[:props][:sbd_exchange_rate][:base] = normalize_amount(options.merge amount: sbd_exchange_rate[:base], serialize: true)
+        params[:props][:sbd_exchange_rate][:quote] = normalize_amount(options.merge amount: sbd_exchange_rate[:quote], serialize: true)
+        params[:props][:sbd_exchange_rate] = params[:props][:sbd_exchange_rate].to_json
+      end
+      
+      %i(key new_signing_key).each do |key|
+        if !!params[key] && params[key].size == 53
+          params[key] = params[key][3..-1]
+        end
       end
       
       %i(account_creation_fee sbd_exchange_rate url new_signing_key).each do |key|
         next unless !!params[:props][key]
         
-        val = params[:props][key]
+        val = params[:props][key].to_s
           
         params[:props][key] = hexlify val unless val =~ /^[0-9A-F]+$/i
       end
@@ -1282,6 +1294,11 @@ module Steem
       end
     end
     
+    def self.normalize_beneficiaries(options)
+      # Type::Beneficiaries.new(options[:beneficiaries])
+      {beneficiaries: options[:beneficiaries]}
+    end
+    
     # @private
     def self.database_api(options)
       options[:database_api] ||= if !!options[:app_base]

data/lib/steem/marshal.rb

@@ -0,0 +1,231 @@
+require 'bindata'
+require 'base58'
+
+module Steem
+  class Marshal
+    include Utils
+    include ChainConfig
+    
+    PUBLIC_KEY_DISABLED = '1111111111111111111111111111111114T1Anm'
+    
+    attr_reader :bytes, :cursor
+
+    def initialize(options = {})
+      @bytes = if !!(hex = options[:hex])
+        unhexlify hex
+      else
+        options[:bytes]
+      end
+      
+      @chain = options[:chain] || :steem
+      @prefix ||= case @chain
+      when :steem then NETWORKS_STEEM_ADDRESS_PREFIX
+      when :test then NETWORKS_TEST_ADDRESS_PREFIX
+      else; raise UnsupportedChainError, "Unsupported chain: #{@chain}"
+      end
+      @cursor = 0
+    end
+    
+    def hex
+      hexlify bytes
+    end
+    
+    def rewind!
+      @cursor = 0
+    end
+    
+    def step(n = 0)
+      @cursor += n
+    end
+    
+    def scan(len)
+      bytes.slice(@cursor..(@cursor - 1) + len).tap { |_| @cursor += len }
+    end
+    
+    def operation_type
+      Operation::IDS[unsigned_char]
+    end
+    
+    def unsigned_char; BinData::Uint8le.read(scan(1)); end # 8-bit unsigned 
+    def uint16; BinData::Uint16le.read(scan(2)); end # 16-bit unsigned, VAX (little-endian) byte order
+    def uint32; BinData::Uint32le.read(scan(4)); end # 32-bit unsigned, VAX (little-endian) byte order
+    def uint64; BinData::Uint64le.read(scan(8)); end # 64-bit unsigned, little-endian
+
+    def signed_char; BinData::Int8le.read(scan(1)); end # 8-bit signed 
+    def int16; BinData::Int16le.read(scan(2)); end # 16-bit signed, little-endian
+    def int32; BinData::Int32le.read(scan(4)); end # 32-bit signed, little-endian
+    def int64; BinData::Int64le.read(scan(8)); end # 64-bit signed, little-endian
+
+    def boolean; scan(1) == "\x01"; end
+    
+    def varint
+      shift = 0
+      result = 0
+      bytes = []
+      
+      while (n = unsigned_char) >> 7 == 1
+        bytes << n
+      end
+      
+      bytes << n
+      
+      bytes.each do |b|
+        result += ((b & 0x7f) << shift)
+        break unless (b & 0x80)
+        shift += 7
+      end
+      
+      result
+    end
+    
+    def string(len = nil); scan(len || varint); end
+    
+    def raw_bytes(len = nil); scan(len || varint).force_encoding('BINARY'); end
+  
+    def point_in_time
+      if (time = uint32) == 2**32-1
+        Time.at -1
+      else
+        Time.at time
+      end.utc
+    end
+    
+    def public_key(prefix = @prefix)
+      raw_public_key = raw_bytes(33)
+      checksum = OpenSSL::Digest::RIPEMD160.digest(raw_public_key)
+      key = Base58.binary_to_base58(raw_public_key + checksum.slice(0, 4), :bitcoin)
+      
+      prefix + key unless key == PUBLIC_KEY_DISABLED
+    end
+    
+    def amount
+      amount = uint64.to_f
+      precision = signed_char
+      asset = scan(7).strip
+      
+      amount = "%.#{precision}f #{asset}" % (amount / 10 ** precision)
+
+      Steem::Type::Amount.new(amount)
+    end
+    
+    def price
+      {base: amount, quote: amount}
+    end
+    
+    def authority(options = {optional: false})
+      return if !!options[:optional] && unsigned_char == 0
+      
+      {
+        weight_threshold: uint32,
+        account_auths: varint.times.map { [string, uint16] },
+        key_auths: varint.times.map { [public_key, uint16] }
+      }
+    end
+    
+    def optional_authority
+      authority(optional: true)
+    end
+    
+    def comment_options_extensions
+      if scan(1) == "\x01"
+        beneficiaries
+      else
+        []
+      end
+    end
+    
+    def beneficiaries
+      if scan(1) == "\x00"
+        varint.times.map {{account: string, weight: uint16}}
+      end
+    end
+    
+    def chain_properties
+      {
+        account_creation_fee: amount,
+        maximum_block_size: uint32,
+        sbd_interest_rate: uint16
+      }
+    end
+    
+    def required_auths
+      varint.times.map { string }
+    end
+    
+    def witness_properties
+      properties = {}
+      
+      varint.times do
+        key = string.to_sym
+        properties[key] = case key
+        when :account_creation_fee then Steem::Type::Amount.new(string)
+        when :account_subsidy_budget then scan(3)
+        when :account_subsidy_decay, :maximum_block_size then uint32
+        when :url then string
+        when :sbd_exchange_rate
+          JSON[string].tap do |rate|
+            rate["base"] = Steem::Type::Amount.new(rate["base"])
+            rate["quote"] = Steem::Type::Amount.new(rate["quote"])
+          end
+        when :sbd_interest_rate then uint16
+        when :key, :new_signing_key then @prefix + scan(50)
+        else; raise "Unknown witness property: #{key}"
+        end
+      end
+      
+      properties
+    end
+    
+    def empty_array
+      unsigned_char == 0 and [] or raise "Found non-empty array."
+    end
+    
+    def transaction(options = {})
+      trx = options[:trx] || Transaction.new
+      
+      trx.ref_block_num = uint16
+      trx.ref_block_prefix = uint32
+      trx.expiration = point_in_time
+      
+      trx.operations = operations
+      
+      trx
+    rescue => e
+      raise DeserializationError.new("Transaction failed\nOriginal serialized bytes:\n[#{hex[0..(@cursor * 2) - 1]}]#{hex[((@cursor) * 2)..-1]}", e)
+    end
+
+    def operations
+      operations_len = signed_char
+      operations = []
+      
+      while operations.size < operations_len do
+        begin
+          type = operation_type
+          break if type.nil?
+          
+          op_class_name = type.to_s.sub!(/_operation$/, '')
+          op_class_name = "Steem::Operation::" + op_class_name.split('_').map(&:capitalize).join
+          op_class = Object::const_get(op_class_name)
+          op = op_class.new
+          
+          op_class::serializable_types.each do |k, v|
+            begin
+              # binding.pry if v == :comment_options_extensions
+              op.send("#{k}=", send(v))
+            rescue => e
+              raise DeserializationError.new("#{type}.#{k} (#{v}) failed", e)
+            end
+          end
+          
+          operations << {type: type, value: op}
+        rescue => e
+          raise DeserializationError.new("#{type} failed", e)
+        end
+      end
+      
+      operations
+    rescue => e
+      raise DeserializationError.new("Operations failed", e)
+    end
+  end
+end