radiator 0.4.4 → 0.4.8.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5999a627f1c05a48b41ec3b2cef269ce3a9d9e32f71cc9f33ea8afd18a0e6fc9
-  data.tar.gz: e0121879ce1fea0eda06f3550988d6ca9393fdcc66a19f8ac10e26f44974fd48
+  metadata.gz: 0c7aa2b09067f5b8443c46a49587832b075c29b11e4d002c87a7bc504b6f546a
+  data.tar.gz: a46a5d171ca0ed83f865dbdef347a7ec03d4c2e065913edb4b09d85a3bd0ac32
 SHA512:
-  metadata.gz: 5499a1b95cabf4931380818280aee212d89d320b20dc98d79cdd943d4f8d05eb59565f1f85ad73fb5f2e585a053f2f55d41ae0c1ed69a1e6b54f14bddf02e1d3
-  data.tar.gz: 6d8e26c93dcd7176c43f04f37e11821bbebfd13163509fb94a9c6f2f61712b6ea55413c81d57024d7c677e42155325bff42d5720681a42481509ef5b75efcf6a
+  metadata.gz: 468b09c3e7ddfac6b1c8f4ea1e82661cb7aa99edd326a64002ff7d4b92ff8d727a2ef4d80bbcd073b1093f992e09de63c8fbb5b00ede4eb048eeabaea5a4942d
+  data.tar.gz: 1487e9e0521e6e2e914272fd58adc705beb8f067bef070145e681e510dcae6eeebc5300e90351e903e198797d5bcc7380e849af4a929d0e9ac102c125d245e74

data/README.md

@@ -6,9 +6,16 @@
 [radiator](https://github.com/inertia186/radiator)
 ========
 
-#### STEEM Ruby API Client
+#### Hive/Steem Ruby API Client
 
-Radiator is an API Client for interaction with the STEEM network using Ruby.
+Radiator is an API Client for interaction with the Hive/Steem network using Ruby.
+
+#### Changes in v0.4.5
+
+* Added support to query and stream a Steem Smart Contract backed side-chains like Steem Engine.
+  * [Blockchain](https://www.rubydoc.info/gems/radiator/0.4.5/Radiator/SSC/Blockchain.html)
+    * [Stream](https://www.rubydoc.info/gems/radiator/0.4.5/Radiator/SSC/Stream.html)
+  * [Contracts](https://www.rubydoc.info/gems/radiator/0.4.5/Radiator/SSC/Contracts.html)
 
 #### Changes in v0.4.0
 
@@ -116,7 +123,7 @@ If you don't have `bundler`, see the next section.
     
 ### Prerequisites
 
-`minimum ruby version: 2.2`
+`minimum ruby version: 2.5`
 
 #### Linux
 
@@ -181,6 +188,63 @@ end
  "steemzine"]
 ```
 
+#### Side Chain Support
+
+Steem Smart Contract side-chains are supported by Radiator.  The default side-chain is Hive/Steem Engine.
+
+This will fetch the latest block from the side-chain ...
+
+```ruby
+rpc = Radiator::SSC::Blockchain.new
+rpc.latest_block_info
+```
+
+This will fetch block 1 ...
+
+```ruby
+rpc.block_info(1)
+```
+
+Or a specific transaction ...
+
+```ruby
+rpc.transaction_info('9d288aab2eb66064dc0d4492cb281512386e2293')
+```
+
+You can also do contract queries.  This will look up the `tokens` contract:
+
+```ruby
+rpc = Radiator::SSC::Contracts.new
+rpc.contract('tokens')
+```
+
+This will look up a specific record in a contract result ...
+
+```ruby
+rpc.find_one(
+  contract: "tokens",
+  table: "balances",
+  query: {
+    symbol: "STINGY",
+    account: "inertia"
+  }
+)
+```
+
+Or get multiple results ...
+
+```ruby
+rpc.find(
+  contract: "tokens",
+  table: "balances",
+  query: {
+    symbol: "STINGY"
+  }
+)
+```
+
+
+
 #### Streaming
 
 Here's an example of how to use a streaming instance to listen for votes:
@@ -372,6 +436,26 @@ Example of the output:
 .
 ```
 
+#### Side-chain Streaming
+
+Streaming side-chain transactions are supported:
+
+```ruby
+# Default side-chain is Hive Engine.
+stream = Radiator::SSC::Stream.new
+stream.transactions do |tx, trx_id|
+  puts "[#{trx_id}] #{tx.to_json}"
+end
+```
+
+Even whole side-chain blocks:
+
+```ruby
+stream.blocks do |bk, num|
+  puts "[#{num}] #{bk.to_json}"
+end
+```
+
 #### Transaction Signing
 
 Radiator supports transaction signing, so you can use it to vote:
@@ -539,20 +623,20 @@ https://github.com/inertia186/radiator/issues/12
   * `rake`
 * To run tests with parallelization and local code coverage:
   * `HELL_ENABLED=true rake`
-* To run a stream test on the live STEEM blockchain with debug logging enabled:
+* To run a stream test on the live Hive/Steem blockchain with debug logging enabled:
   * `LOG=DEBUG rake test_live_stream`
 
 ---
 
 <center>
-  <img src="http://www.steemimg.com/images/2016/08/19/RadiatorCoolingFan-54in-Webfdcb1.png" />
+  <img src="https://steemitimages.com/0x0/http://www.steemimg.com/images/2016/08/19/RadiatorCoolingFan-54in-Webfdcb1.png" />
 </center>
 
 See my previous Ruby How To posts in: [#radiator](https://steemit.com/created/radiator) [#ruby](https://steemit.com/created/ruby)
 
 ## Get in touch!
 
-If you're using Radiator, I'd love to hear from you.  Drop me a line and tell me what you think!  I'm @inertia on STEEM.
+If you're using Radiator, I'd love to hear from you.  Drop me a line and tell me what you think!  I'm @inertia on Hive/Steem.
   
 ## License
 

data/Rakefile

@@ -32,18 +32,35 @@ desc 'Tests the ability to broadcast live data.  This task broadcasts a claim_re
 task :test_live_broadcast, [:account, :wif, :chain] do |t, args|
   account_name = args[:account] || 'social'
   posting_wif = args[:wif] || '5JrvPrQeBBvCRdjv29iDvkwn3EQYZ9jqfAHzrCyUvfbEbRkrYFC'
-  chain = args[:chain] || 'steem'
+  chain = (args[:chain] || 'steem').to_sym
   # url = 'https://testnet.steemitdev.com/' # use testnet
   url = nil # use default
   options = {chain: chain, wif: posting_wif, url: url}
   tx = Radiator::Transaction.new(options)
-  tx.operations << {
-    type: :claim_reward_balance,
-    account: account_name,
-    reward_steem: '0.000 STEEM',
-    reward_sbd: '0.000 SBD',
-    reward_vests: '0.000001 VESTS'
-  }
+  
+  reward_core, reward_debt, reward_vest = case chain
+  when :steem then ['0.000 STEEM', '0.000 SBD', '0.000001 VESTS']
+  when :hive then ['0.000 HIVE', '0.000 HBD', '0.000001 VESTS']
+  end
+  
+  case chain
+  when :steem
+    tx.operations << {
+      type: :claim_reward_balance,
+      account: account_name,
+      reward_steem: reward_core,
+      reward_sbd: reward_debt,
+      reward_vests: reward_vest
+    }
+  when :hive
+    tx.operations << {
+      type: :claim_reward_balance,
+      account: account_name,
+      reward_hive: reward_core,
+      reward_hbd: reward_debt,
+      reward_vests: reward_vest
+    }
+  end
   
   response = tx.process(true)
   ap response
@@ -51,18 +68,27 @@ task :test_live_broadcast, [:account, :wif, :chain] do |t, args|
   if !!response.result
     result = response.result
     
-    puts "https://steemd.com/b/#{result[:block_num]}" if !!result[:block_num]
-    puts "https://steemd.com/tx/#{result[:id]}" if !!result[:id]
+    case chain
+    when :steem
+      puts "https://steemd.com/b/#{result[:block_num]}" if !!result[:block_num]
+      puts "https://steemd.com/tx/#{result[:id]}" if !!result[:id]
+    when :hive
+      puts "https://hiveblocks.com/b/#{result[:block_num]}" if !!result[:block_num]
+      puts "https://hiveblocks.com/tx/#{result[:id]}" if !!result[:id]
+    else
+      puts result
+    end
   end
 end
 
 desc 'Tests the ability to stream live data. defaults: chain = steem; persist = true.'
 task :test_live_stream, [:chain, :persist] do |t, args|
-  chain = args[:chain] || 'steem'
+  chain = (args[:chain] || 'hive').to_sym
   persist = (args[:persist] || 'true') == 'true'
   last_block_number = 0
   # url = 'https://testnet.steemitdev.com/'
-  url = nil # use default
+  url = chain == :steem ? 'https://api.steemit.com' : 'http://anyx.io'
+  # url = nil # use default
   options = {chain: chain, persist: persist, url: url}
   total_ops = 0.0
   total_vops = 0.0
@@ -81,18 +107,22 @@ task :test_live_stream, [:chain, :persist] do |t, args|
       op_size = o.map(&:size).reduce(0, :+)
       total_ops += op_size
       
-      api.get_ops_in_block(n, true) do |vops, error|
+      catch :try_vops do; api.get_ops_in_block(n, true) do |vops, error|
         if !!error
           puts "Error on get_ops_in_block for block #{n}"
           ap error if defined? ap
         end
         
-        puts "Problem: vops is nil!" if vops.nil?
-        
-        # Did we reach this point with an unhandled error that wasn't retried?
-        # If so, vops might be nil and we might need this error to get handled
-        # instead of checking for vops.nil?.
-        
+        if vops.nil?
+          puts "#{n}: #{b.witness}; Problem: vops is nil!  Retrying ..."
+          sleep 3 # Possibly fall behind a bit and catch up later.
+          throw :try_vops
+          
+          # Did we reach this point with an unhandled error that wasn't retried?
+          # If so, vops might be nil and we might need this error to get handled
+          # instead of checking for vops.nil?.
+        end
+      
         vop_size = vops.size
         total_vops += vop_size
         
@@ -105,7 +135,7 @@ task :test_live_stream, [:chain, :persist] do |t, args|
         elapsed += Time.now.utc - start
         count += 1
         puts "#{n}: #{b.witness}; trx: #{t_size}; op: #{op_size}, vop: #{vop_size} (cumulative vop ratio: #{('%.2f' % (vop_ratio * 100))} %; average #{((elapsed / count) * 1000).to_i}ms)"
-      end
+      end; end
     else
       # This should not happen.  If it does, there's likely a bug in Radiator.
       

data/lib/radiator.rb

@@ -1,4 +1,6 @@
 require 'radiator/version'
+require 'steem'
+require 'hive'
 require 'json'
 require 'awesome_print' if ENV['USE_AWESOME_PRINT'] == 'true'
 
@@ -29,6 +31,7 @@ module Radiator
   require 'radiator/account_history_api'
   require 'radiator/condenser_api'
   require 'radiator/block_api'
+  require 'radiator/bridge'
   require 'radiator/stream'
   require 'radiator/operation_ids'
   require 'radiator/operation_types'
@@ -40,6 +43,9 @@ module Radiator
   require 'radiator/mixins/acts_as_voter'
   require 'radiator/mixins/acts_as_wallet'
   require 'radiator/chain'
-  require 'steem' unless defined? Steem
+  require 'radiator/ssc/base_steem_smart_contract_rpc'
+  require 'radiator/ssc/blockchain'
+  require 'radiator/ssc/stream'
+  require 'radiator/ssc/contracts'
   extend self
 end

data/lib/radiator/api.rb

@@ -138,15 +138,29 @@ module Radiator
     
     DEFAULT_STEEM_FAILOVER_URLS = [
       DEFAULT_STEEM_URL,
-      'https://appbasetest.timcliff.com',
-      'https://api.steem.house',
       'https://steemd.minnowsupportproject.org',
-      'https://steemd.privex.io',
-      'https://rpc.steemviz.com',
+      'https://api.justyy.com',
+      'https://steem.bts.tw'
+    ]
+    
+    DEFAULT_STEEM_RESTFUL_URL = nil
+    
+    DEFAULT_HIVE_URL = 'https://api.openhive.network'
+    
+    DEFAULT_HIVE_FAILOVER_URLS = [
+      DEFAULT_HIVE_URL,
       'https://anyx.io',
-      'httpd://rpc.usesteem.com'
+      'https://api.hivekings.com',
+      'https://api.hive.blog',
+      'https://techcoderx.com',
+      'https://rpc.esteem.app',
+      'https://hived.privex.io',
+      'https://api.pharesim.me',
+      'https://rpc.ausbit.dev'
     ]
     
+    DEFAULT_HIVE_RESTFUL_URL = 'https://anyx.io/v1'
+    
     # @private
     POST_HEADERS = {
       'Content-Type' => 'application/json',
@@ -159,15 +173,65 @@ module Radiator
     def self.default_url(chain)
       case chain.to_sym
       when :steem then DEFAULT_STEEM_URL
+      when :hive then DEFAULT_HIVE_URL
       else; raise ApiError, "Unsupported chain: #{chain}"
       end
     end
     
+    def self.default_restful_url(chain)
+      case chain.to_sym
+      when :steem then DEFAULT_STEEM_RESTFUL_URL
+      when :hive then DEFAULT_HIVE_RESTFUL_URL
+      end
+    end
+    
     def self.default_failover_urls(chain)
       case chain.to_sym
-      when :steem then DEFAULT_STEEM_FAILOVER_URLS
+      when :steem, :hive
+        begin
+          _api = Radiator::Api.new(url: DEFAULT_STEEM_FAILOVER_URLS.sample, failover_urls: DEFAULT_STEEM_FAILOVER_URLS)
+          
+          default_failover_urls = _api.get_accounts(['fullnodeupdate']) do |accounts|
+            fullnodeupdate = accounts.first
+            metadata = (JSON[fullnodeupdate.json_metadata] rescue nil) || {}
+            report = metadata.fetch('report', [])
+            
+            if report.any?
+              report.map do |r|
+                if chain.to_sym == :steem && !r.fetch('hive', false)
+                  r.fetch('node')
+                elsif chain.to_sym == :hive && r.fetch('hive', false)
+                  r.fetch('node')
+                end
+              end.compact
+            end
+          end
+        rescue => e
+          puts e
+        end
       else; raise ApiError, "Unsupported chain: #{chain}"
       end
+      
+      if !!default_failover_urls
+        default_failover_urls
+      else
+        case chain.to_sym
+        when :steem then DEFAULT_STEEM_FAILOVER_URLS
+        when :hive then DEFAULT_HIVE_FAILOVER_URLS
+        else; []
+        end
+      end
+    end
+    
+    def self.network_api(chain, api_name, options = {})
+      api = case chain.to_sym
+      when :steem then Steem::Api.clone(freeze: true) rescue Api.clone
+      when :hive then Hive::Api.clone(freeze: true) rescue Api.clone
+      else; raise ApiError, "Unsupported chain: #{chain}"
+      end
+      
+      api.api_name = api_name
+      api.new(options) rescue nil
     end
     
     # Cretes a new instance of Radiator::Api.
@@ -190,6 +254,7 @@ module Radiator
       @password = options[:password]
       @chain = options[:chain] || :steem
       @url = options[:url] || Api::default_url(@chain)
+      @restful_url = options[:restful_url] || Api::default_restful_url(@chain)
       @preferred_url = @url.dup
       @failover_urls = options[:failover_urls]
       @debug = !!options[:debug]
@@ -263,6 +328,7 @@ module Radiator
       @block_api = nil
       @backoff_at = nil
       @jussi_supported = []
+      @network_api = Api::network_api(@chain, api_name, url: @url)
     end
     
     # Get a specific block or range of blocks.
@@ -357,6 +423,8 @@ module Radiator
     
     # @private
     def respond_to_missing?(m, include_private = false)
+      return true if @network_api.respond_to? m.to_sym
+      
       method_names.nil? ? false : method_names.include?(m.to_sym)
     end
     
@@ -412,6 +480,18 @@ module Radiator
             end
           end
           
+          @network_api ||= Api::network_api(@chain, api_name, url: @uri)
+          
+          if !!@network_api && @network_api.respond_to?(m)
+            if !!block
+              @network_api.send(m, *args) do |*r|
+                return yield(*r)
+              end
+            else
+              return @network_api.send(m, *args)
+            end
+          end
+          
           if response.nil?
             response = request(options)
             
@@ -497,6 +577,9 @@ module Radiator
         #   warning e
         end
         
+        # failover latch
+        @network_api = nil if !!@network_api
+        
         if !!response
           @persist_error_count = 0
           
@@ -618,7 +701,7 @@ module Radiator
         http.keep_alive = 30
         http.idle_timeout = idempotent ? 10 : nil
         http.max_requests = @max_requests
-        http.retry_change_requests = idempotent
+        http.retry_change_requests = idempotent if defined? http.retry_change_requests
         http.reuse_ssl_sessions = @reuse_ssl_sessions
         
         http
@@ -789,15 +872,23 @@ module Radiator
         
         if @recover_transactions_on_error
           begin
-            # Node operators often disable this operation.
-            api.get_transaction(parser.trx_id) do |tx|
-              if !!tx
-                response[:result][:block_num] = tx.block_num
-                response[:result][:trx_num] = tx.transaction_num
-                response[:recovered_by] = http_id
-                response.delete('error') # no need for this, now
+            if !!@restful_url
+              JSON[open("#{@restful_url}/account_history_api/get_transaction?id=#{parser.trx_id}").read].tap do |tx|
+                response[:result][:block_num] = tx['block_num']
+                response[:result][:trx_num] = tx['transaction_num']
+              end
+            else
+              # Node operators often disable this operation.
+              api.get_transaction(parser.trx_id) do |tx|
+                if !!tx
+                  response[:result][:block_num] = tx.block_num
+                  response[:result][:trx_num] = tx.transaction_num
+                end
               end
             end
+            
+            response[:recovered_by] = http_id
+            response.delete('error') # no need for this, now
           rescue
             debug "Couldn't find block for trx_id: #{parser.trx_id}, giving up."
           end