steem-ruby 0.1.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24650742975337b2832ba5ab426f609a5ff8c9ef
-  data.tar.gz: 827c4848766e9b54dc8f04f5e20c920d3964c4eb
+  metadata.gz: 4c0d2e4cfae2885bc24acaa7d2a5f046e73a1505
+  data.tar.gz: ddfdd7c5505ada6ea5e67584e51f6b5241e74bb6
 SHA512:
-  metadata.gz: 40b66f82639c1db97bf844bc07414f4ef512decec1fa4bf99bbc789ac1916379d96d03eebc417a89a7fcc7dcbbcbd9c29d82c3dd08958e3331712b2af4450f04
-  data.tar.gz: 37183706e9bdb150df65afb03d697c6a8cca050d3e3a3ac605054e46ba10d6a0897dc28e55a8035cc10f0a8df7d144fe548bd887344b132fa47f29518ae945be
+  metadata.gz: ec9da3a5222a1ef5bf503ab496eeb12b88609ff1b76d0fd888ca10a355fa3bf0c1bea497a75327a5922a7b002d7b8f19d38eb9b047b431d5fa532eea740c3fa3
+  data.tar.gz: 3a3aac4b912eeb02c92c97b9e74be3c747595b0acfffd75318258d4b89b99b1569776ff9aa4d7393aa0176b45b2170f5723195aafc87729ae7e22f9cb733d944

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steem-ruby (0.1.1)
+    steem-ruby (0.9.0)
       bitcoin-ruby (~> 0.0, >= 0.0.18)
       ffi (~> 1.9, >= 1.9.23)
       hashie (~> 3.5, >= 3.5.7)

data/README.md

@@ -7,6 +7,8 @@ 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`](https://github.com/inertia186/radiator).
@@ -68,6 +70,52 @@ end
 
 *See: [Broadcast](https://www.rubydoc.info/gems/steem-ruby/Steem/Broadcast)*
 
+### Multisig
+
+You can use multisignature to broadcast an operation.
+
+```ruby
+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.
+
+```ruby
+builder = 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.
+
+```ruby
+trx = open('trx.json').read
+builder = TransactionBuilder.new(wif: wif2, trx: trx)
+api = Steem::NetworkBroadcastApi.new
+trx = builder.transaction
+api.broadcast_transaction_synchronous(trx: trx)
+```
+
 ### Get Accounts
 
 ```ruby

data/Rakefile

@@ -79,6 +79,8 @@ namespace :test do
   
   desc 'Tests the API using multiple threads.'
   task :threads do
+    next if !!ENV['TEST']
+    
     threads = []
     api = Steem::Api.new(url: ENV['TEST_NODE'])
     database_api = Steem::DatabaseApi.new(url: ENV['TEST_NODE'])
@@ -146,7 +148,7 @@ namespace :stream do
     loop do
       api.get_dynamic_global_properties do |properties|
         current_block_num = properties.last_irreversible_block_num
-        # First pass replays latest 100 blocks.
+        # First pass replays latest a random number of blocks to test chunking.
         first_block_num ||= current_block_num - (rand * 200).to_i
         
         if current_block_num >= first_block_num

data/lib/steem/api.rb

@@ -39,8 +39,8 @@ module Steem
     attr_accessor :chain, :methods
     
     # Use this for debugging naive thread handler.
-    # DEFAULT_RPC_CLIENT = RPC::BaseClient
-    DEFAULT_RPC_CLIENT = RPC::ThreadSafeHttpClient
+    # DEFAULT_RPC_CLIENT_CLASS = RPC::BaseClient
+    DEFAULT_RPC_CLIENT_CLASS = RPC::ThreadSafeHttpClient
     
     def self.api_name=(api_name)
       @api_name = api_name.to_s.
@@ -65,11 +65,22 @@ module Steem
       @jsonrpc
     end
     
+    # Override this if you want to use your own client.
+    def self.default_rpc_client_class
+      DEFAULT_RPC_CLIENT_CLASS
+    end
+    
     def initialize(options = {})
       @chain = options[:chain] || :steem
       @error_pipe = options[:error_pipe] || STDERR
       @api_name = self.class.api_name ||= :condenser_api
-      @rpc_client = options[:rpc_client] || DEFAULT_RPC_CLIENT.new(options.merge(api_name: @api_name))
+      
+      @rpc_client = if !!options[:rpc_client]
+        options[:rpc_client]
+      else
+        rpc_client_class = self.class.default_rpc_client_class
+        rpc_client_class.new(options.merge(api_name: @api_name))
+      end
       
       if @api_name == :jsonrpc
         Api::jsonrpc = self

data/lib/steem/rpc/base_client.rb

@@ -3,7 +3,7 @@ module Steem
     class BaseClient
       include ChainConfig
       
-      attr_accessor :chain, :error_pipe
+      attr_accessor :url, :chain, :error_pipe
       
       # @private
       MAX_TIMEOUT_RETRY_COUNT = 100
@@ -27,7 +27,7 @@ module Steem
       end
       
       def uri
-        @uri ||= URI.parse(@url)
+        @uri ||= URI.parse(url)
       end
       
       # Adds a request object to the stack.  Usually, this method is called

data/lib/steem/rpc/http_client.rb

@@ -16,7 +16,8 @@ module Steem
       # http status code of 200 and HTML page.
       # 
       # @private
-      TIMEOUT_ERRORS = [Net::OpenTimeout, Net::ReadTimeout, JSON::ParserError]
+      TIMEOUT_ERRORS = [Net::OpenTimeout, JSON::ParserError, Net::ReadTimeout,
+        Errno::EBADF, Errno::ECONNREFUSED, IOError]
       
       # @private
       POST_HEADERS = {
@@ -28,7 +29,7 @@ module Steem
       
       def http
         @http ||= Net::HTTP.new(uri.host, uri.port).tap do |http|
-          http.use_ssl = true
+          http.use_ssl = true if uri.to_s =~ /^https/i
           http.keep_alive_timeout = 2 # seconds
           
           # WARNING This method opens a serious security hole. Never use this
@@ -66,7 +67,7 @@ module Steem
           end
           
           if request_object.size > JSON_RPC_BATCH_SIZE_MAXIMUM
-            raise JsonRpcBatchMaximumSizeExceededError, 'Maximum json-rpc-batch is 50 elements.'
+            raise JsonRpcBatchMaximumSizeExceededError, "Maximum json-rpc-batch is #{JSON_RPC_BATCH_SIZE_MAXIMUM} elements."
           end
           
           request.body = if request_object.class == Hash

data/lib/steem/transaction_builder.rb

@@ -18,23 +18,52 @@ module Steem
   #     network_broadcast_api = Steem::NetworkBroadcastApi.new
   #     network_broadcast_api.broadcast_transaction_synchronous(trx: trx)
   #
+  #
+  # The `wif` value may also be an array, when signing with multiple signatures
+  # (multisig).
   class TransactionBuilder
     include Retriable
     include ChainConfig
     include Utils
     
-    attr_accessor :database_api, :block_api, :wif, :expiration, :operations
+    attr_accessor :database_api, :block_api, :expiration, :operations
+    attr_writer :wif
+    attr_reader :signed
     
     def initialize(options = {})
       @database_api = options[:database_api] || Steem::DatabaseApi.new(options)
       @block_api = options[:block_api] || Steem::BlockApi.new(options)
-      @wif = options[:wif]
+      @wif = [options[:wif]].flatten
+      @signed = false
+      
+      if !!(trx = options[:trx])
+        trx = case trx
+        when String then JSON[trx]
+        else; trx
+        end
+        
+        trx_options = {
+          ref_block_num: trx['ref_block_num'],
+          ref_block_prefix: trx['ref_block_prefix'],
+          extensions: (trx['extensions']),
+          operations: trx['operations'],
+          signatures: (trx['signatures']),
+        }
+        
+        trx_options[:expiration] = case trx['expiration']
+        when String then Time.parse(trx['expiration'] + 'Z')
+        else; trx['expiration']
+        end
+        
+        options = options.merge(trx_options)
+      end
+      
       @ref_block_num = options[:ref_block_num]
       @ref_block_prefix = options[:ref_block_prefix]
-      @expiration = nil
       @operations = options[:operations] || []
-      @extensions = []
-      @signatures = []
+      @expiration = options[:expiration]
+      @extensions = options[:extensions] || []
+      @signatures = options[:signatures] || []
       @chain = options[:chain] || :steem
       @error_pipe = options[:error_pipe] || STDERR
       @chain_id = case @chain
@@ -46,8 +75,8 @@ module Steem
     
     def inspect
       properties = %w(
-        ref_block_num ref_block_prefix expiration operations
-        extensions signatures
+        ref_block_num ref_block_prefix expiration operations extensions
+        signatures
       ).map do |prop|
         if !!(v = instance_variable_get("@#{prop}"))
           "@#{prop}=#{v}" 
@@ -64,6 +93,7 @@ module Steem
       @operations = []
       @extensions = []
       @signatures = []
+      @signed = false
       
       self
     end
@@ -90,7 +120,7 @@ module Steem
               
               @ref_block_num = (block_number - 1) & 0xFFFF
               @ref_block_prefix = unhexlify(header.previous[8..-1]).unpack('V*')[0]
-              @expiration = (Time.parse(properties.time + 'Z') + EXPIRE_IN_SECS).utc
+              @expiration ||= (Time.parse(properties.time + 'Z') + EXPIRE_IN_SECS).utc
             end
           end
         rescue => e
@@ -196,7 +226,7 @@ module Steem
     #
     # @return {Hash | TransactionBuilder} The fully signed transaction if a `wif` is provided or the instance of the {TransactionBuilder} if a `wif` has not yet been provided.
     def sign
-      return self unless !!@wif
+      return self if @wif.empty?
       return self if expired?
       
       trx = {
@@ -208,38 +238,47 @@ module Steem
         signatures: @signatures
       }
       
-      catch :serialize do; begin
-        @database_api.get_transaction_hex(trx: trx) do |result|
-          hex = @chain_id + result.hex[0..-4] # Why do we have to chop the last two bytes?
-          digest = unhexlify(hex)
-          digest_hex = Digest::SHA256.digest(digest)
-          private_key = Bitcoin::Key.from_base58 @wif
-          public_key_hex = private_key.pub
-          ec = Bitcoin::OpenSSL_EC
-          count = 0
-          sig = nil
-          
-          loop do
-            count += 1
-            @error_pipe.puts "#{count} attempts to find canonical signature" if count % 40 == 0
-            sig = ec.sign_compact(digest_hex, private_key.priv, public_key_hex, false)
+      unless @signed
+        catch :serialize do; begin
+          @database_api.get_transaction_hex(trx: trx) do |result|
+            hex = @chain_id + result.hex[0..-4] # Why do we have to chop the last two bytes?
+            digest = unhexlify(hex)
+            digest_hex = Digest::SHA256.digest(digest)
+            private_keys = @wif.map{ |wif| Bitcoin::Key.from_base58 wif }
+            ec = Bitcoin::OpenSSL_EC
+            count = 0
+            sigs = []
+            
+            private_keys.each do |private_key|
+              sig = nil
+              
+              loop do
+                count += 1
+                @error_pipe.puts "#{count} attempts to find canonical signature" if count % 40 == 0
+                public_key_hex = private_key.pub
+                sig = ec.sign_compact(digest_hex, private_key.priv, public_key_hex, false)
+                
+                next if public_key_hex != ec.recover_compact(digest_hex, sig)
+                break if canonical? sig
+              end
+              
+              @signatures << hexlify(sig)
+            end
             
-            next if public_key_hex != ec.recover_compact(digest_hex, sig)
-            break if canonical? sig
+            @signed = true
+            trx[:signatures] = @signatures
           end
-          
-          trx[:signatures] = @signatures = [hexlify(sig)]
-        end
-      rescue => e
-        if can_retry? e
-          @error_pipe.puts "#{e} ... retrying."
-          throw :serialize
-        else
-          raise e
-        end
-      end; end
-      
-      trx
+        rescue => e
+          if can_retry? e
+            @error_pipe.puts "#{e} ... retrying."
+            throw :serialize
+          else
+            raise e
+          end
+        end; end
+      end
+        
+      Hashie::Mash.new trx
     end
     
     # @return [Array] All public keys that could possibly sign for a given transaction.
@@ -267,7 +306,7 @@ module Steem
       end
     end
   private
-    # See: https://github.com/steemit/steem/issues/1944
+    # See: https://github.com/steemit/steem/pull/2500
     # @private
     def canonical?(sig)
       sig = sig.unpack('C*')

data/lib/steem/version.rb

@@ -1,4 +1,4 @@
 module Steem
-  VERSION = '0.1.1'
+  VERSION = '0.9.0'
   AGENT_ID = "steem-ruby/#{VERSION}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steem-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Anthony Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-22 00:00:00.000000000 Z
+date: 2018-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler