radiator 0.4.4 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5999a627f1c05a48b41ec3b2cef269ce3a9d9e32f71cc9f33ea8afd18a0e6fc9
-  data.tar.gz: e0121879ce1fea0eda06f3550988d6ca9393fdcc66a19f8ac10e26f44974fd48
+  metadata.gz: f53430692cf228456ddec8f91bcb964b65b78aeebfcd7fa1eaab6c26e871ad7f
+  data.tar.gz: 44e93244d8505fc8b82fee7157fc752a0f60fadf885bfcb204e64bb83bf74653
 SHA512:
-  metadata.gz: 5499a1b95cabf4931380818280aee212d89d320b20dc98d79cdd943d4f8d05eb59565f1f85ad73fb5f2e585a053f2f55d41ae0c1ed69a1e6b54f14bddf02e1d3
-  data.tar.gz: 6d8e26c93dcd7176c43f04f37e11821bbebfd13163509fb94a9c6f2f61712b6ea55413c81d57024d7c677e42155325bff42d5720681a42481509ef5b75efcf6a
+  metadata.gz: 93187ca8f3308436391d89193e0ae555b1e3f155e98a0981073a1d74c8801d16133f0baf7a63706ed70d1edbdbe67657348fd26a1e16c0dd6de651982bb60cd8
+  data.tar.gz: 07df4deef02419958b07c399a399f66d1a28c7c5d7516f9c62bc117363c2c0ccd72702f6587f870c83640a70f05cbc9aa7f667ca763db022c77449f5f2c0a837

data/README.md

@@ -10,6 +10,13 @@
 
 Radiator is an API Client for interaction with the 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/radiator/doc/Radiator/SSC/Blockchain.html)
+    * [Stream](https://www.rubydoc.info/gems/radiator/radiator/doc/Radiator/SSC/Stream.html)
+  * [Contracts](https://www.rubydoc.info/gems/radiator/radiator/doc/Radiator/SSC/Contracts.html)
+
 #### Changes in v0.4.0
 
 * Gem updates
@@ -181,6 +188,63 @@ end
  "steemzine"]
 ```
 
+#### Side Chain Support
+
+Steem Smart Contract side-chains are supported by Radiator.  The default side-chain is 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 Steem 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:

data/lib/radiator.rb

@@ -40,6 +40,10 @@ module Radiator
   require 'radiator/mixins/acts_as_voter'
   require 'radiator/mixins/acts_as_wallet'
   require 'radiator/chain'
+  require 'radiator/ssc/base_steem_smart_contract_rpc'
+  require 'radiator/ssc/blockchain'
+  require 'radiator/ssc/stream'
+  require 'radiator/ssc/contracts'
   require 'steem' unless defined? Steem
   extend self
 end

data/lib/radiator/ssc/base_steem_smart_contract_rpc.rb

@@ -0,0 +1,105 @@
+module Radiator
+  module SSC
+    class BaseSteemSmartContractRPC
+      # @private
+      POST_HEADERS = {
+        'Content-Type' => 'application/json',
+        'User-Agent' => Radiator::AGENT_ID
+      }
+      
+      def initialize(options = {})
+        @root_url = options[:root_url] || 'https://api.steem-engine.com/rpc'
+        
+        @self_hashie_logger = false
+        @hashie_logger = if options[:hashie_logger].nil?
+          @self_hashie_logger = true
+          Logger.new(nil)
+        else
+          options[:hashie_logger]
+        end
+        
+        unless @hashie_logger.respond_to? :warn
+          @hashie_logger = Logger.new(@hashie_logger)
+        end
+        
+        @reuse_ssl_sessions = if options.keys.include? :reuse_ssl_sessions
+          options[:reuse_ssl_sessions]
+        else
+          true
+        end
+        
+        if defined? Net::HTTP::Persistent::DEFAULT_POOL_SIZE
+          @pool_size = options[:pool_size] || Net::HTTP::Persistent::DEFAULT_POOL_SIZE
+        end
+        
+        Hashie.logger = @hashie_logger
+        @uri = nil
+        @http_id = nil
+        @http = nil
+        @max_requests = options[:max_requests] || 30
+      end
+      
+      # Stops the persistant http connections.
+      #
+      def shutdown
+        @uri = nil
+        @http_id = nil
+        @http = nil
+      end
+    protected
+      def rpc_id
+        @rpc_id ||= 0
+        @rpc_id = @rpc_id + 1
+      end
+      
+      def uri
+        @uri ||= URI.parse(@url)
+      end
+      
+      def http_id
+        @http_id ||= "radiator-#{Radiator::VERSION}-ssc-blockchain-#{SecureRandom.uuid}"
+      end
+      
+      def http
+        @http ||= if defined? Net::HTTP::Persistent::DEFAULT_POOL_SIZE
+          Net::HTTP::Persistent.new(name: http_id, pool_size: @pool_size).tap do |http|
+            http.keep_alive = 30
+            http.idle_timeout = 10
+            http.max_requests = @max_requests
+            http.retry_change_requests = true
+            http.reuse_ssl_sessions = @reuse_ssl_sessions
+          end
+        else
+          # net-http-persistent < 3.0
+          Net::HTTP::Persistent.new(http_id) do |http|
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = uri.scheme == 'https'
+          end
+        end
+      end
+      
+      def post_request
+        Net::HTTP::Post.new uri.request_uri, POST_HEADERS
+      end
+      
+      def request(options)
+        request = post_request
+        request.body = JSON[options.merge(jsonrpc: '2.0', id: rpc_id)]
+        
+        response = case http
+        when Net::HTTP::Persistent then http.request(uri, request)
+        when Net::HTTP then http.request(request)
+        else; raise ApiError, "Unsuppored scheme: #{http.inspect}"
+        end
+        
+        response = Hashie::Mash.new(JSON[response.body])
+        
+        if !!(error = response.error)
+          raise ApiError, "Error #{error.code}: #{error.message}"
+        end
+        
+        response.result
+      end
+    end
+  end
+end

data/lib/radiator/ssc/blockchain.rb

@@ -0,0 +1,47 @@
+module Radiator
+  module SSC
+    # The "blockchain" endpoint
+    # 
+    # See: https://github.com/harpagon210/steemsmartcontracts/wiki/JSON-RPC-server#1-the-blockchain-endpoint-httplocalhost5000blockchain
+    class Blockchain < BaseSteemSmartContractRPC
+      # @param options [::Hash] The attributes
+      # @option options [String] :url Specify the full node end-point.  Default: https://api.steem-engine.com/rpc/blockchain
+      def initialize(options = {})
+        super
+        @url = options[:url] || "#{@root_url}/blockchain"
+      end
+      
+      # Example using the defaults, backed by Steem Engine:
+      #
+      #     rpc = Radiator::SSC::Blockchain.new
+      #     rpc.latest_block_info
+      #
+      # @return the latest block of the sidechain
+      def latest_block_info
+        request(method: 'getLatestBlockInfo')
+      end
+      
+      # Example using the defaults, backed by Steem Engine:
+      #
+      #     rpc = Radiator::SSC::Blockchain.new
+      #     rpc.block_info(1)
+      #
+      # @param [Integer] block_num
+      # @return the block with the specified block number of the sidechain
+      def block_info(block_num)
+        request(method: 'getBlockInfo', params: {blockNumber: block_num})
+      end
+      
+      # Example using the defaults, backed by Steem Engine:
+      #
+      #     rpc = Radiator::SSC::Blockchain.new
+      #     rpc.transaction_info('9d288aab2eb66064dc0d4492cb281512386e2293')
+      #
+      # @param [String] trx_id
+      # @return the specified transaction info of the sidechain
+      def transaction_info(trx_id)
+        request(method: 'getTransactionInfo', params: {txid: trx_id})
+      end
+    end
+  end
+end

data/lib/radiator/ssc/contracts.rb

@@ -0,0 +1,71 @@
+module Radiator
+  module SSC
+    # The "contracts" endpoint
+    # 
+    # See: https://github.com/harpagon210/steemsmartcontracts/wiki/JSON-RPC-server#3-the-contracts-endpoint-httplocalhost5000contracts
+    class Contracts < BaseSteemSmartContractRPC
+      # @param options [::Hash] The attributes
+      # @option options [String] :url Specify the full node end-point.  Default: https://api.steem-engine.com/rpc/contracts
+      def initialize(options = {})
+        super
+        @url = options[:url] || "#{@root_url}/contracts"
+      end
+      
+      # Example using the defaults, backed by Steem Engine:
+      #
+      #     rpc = Radiator::SSC::Contracts.new
+      #     rpc.contract('tokens')
+      #
+      # @param [String] name
+      # @return the contract specified from the database
+      def contract(name)
+        request(method: 'getContract', params: {name: name})
+      end
+      
+      # Example using the defaults, backed by Steem Engine:
+      #
+      #     rpc = Radiator::SSC::Contracts.new
+      #     rpc.find_one(
+      #       contract: "tokens",
+      #       table: "balances",
+      #       query: {
+      #         symbol: "STINGY",
+      #         account: "inertia"
+      #       }
+      #     )
+      #
+      # @param options [::Hash] The attributes
+      # @option options [String] :contract
+      # @option options [String] :table
+      # @option options [String] :query
+      # @return the object that matches the query from the table of the specified contract
+      def find_one(options = {})
+        request(method: 'findOne', params: options)
+      end
+      
+      # Example using the defaults, backed by Steem Engine:
+      #
+      #     rpc = Radiator::SSC::Contracts.new
+      #     rpc.find(
+      #       contract: "tokens",
+      #       table: "balances",
+      #       query: {
+      #         symbol: "STINGY"
+      #       }
+      #     )
+      #
+      # @param options [::Hash] The attributes
+      # @option options [String] :contract
+      # @option options [String] :table
+      # @option options [String] :query
+      # @option options [Integer] :limit default: 1000
+      # @option options [Integer] :offset default: 0
+      # @option options [Boolean] :descending
+      # @option options [::Hash] indexes default: empty, an index is an object { index: string, descending: boolean }
+      # @return array of objects that match the query from the table of the specified contract
+      def find(options = {})
+        request(method: 'find', params: options)
+      end
+    end
+  end
+end

data/lib/radiator/ssc/stream.rb

@@ -0,0 +1,62 @@
+module Radiator
+  module SSC
+    # Streams the "blockchain" endpoint.
+    # 
+    # See: https://github.com/harpagon210/steemsmartcontracts/wiki/JSON-RPC-server#3-the-contracts-endpoint-httplocalhost5000contracts
+    class Stream < Blockchain
+      # Block production on the sidechain is no faster than 3 seconds, but can
+      # be indefinately longer than 3 seconds if there are no pending
+      # transactions.
+      # @private
+      MIN_BLOCK_PRODUCTION = 3.0
+      
+      # @param options [::Hash] The attributes
+      # @option options [String] :url Specify the full node end-point.  Default: https://api.steem-engine.com/rpc/blockchain
+      def initialize(options = {})
+        super
+      end
+      
+      # Stream each block on the side-chain.
+      # 
+      #     stream = Radiator::SSC::Stream.new
+      #     stream.blocks do |block|
+      #       puts "Block: #{block}"
+      #     end
+      # 
+      # @param options [::Hash] The attributes
+      # @option options [Integer] :at_block_num start stream at this block number
+      def blocks(options = {}, &block)
+        at_block_num = options[:at_block_num] || latest_block_info.blockNumber
+        
+        loop do
+          block = block_info(at_block_num)
+          
+          if block.nil?
+            sleep MIN_BLOCK_PRODUCTION and next
+          end
+          
+          at_block_num += 1
+          
+          yield block, block.blockNumber
+        end
+      end
+      
+      # Stream each transaction on the side-chain.
+      # 
+      #     stream = Radiator::SSC::Stream.new
+      #     stream.transactions do |trx|
+      #       puts "Transaction: #{trx}"
+      #     end
+      # 
+      # @param options [::Hash] The attributes
+      # @option options [Integer] :at_block_num start stream at this block number
+      def transactions(options = {}, &block)
+        blocks(options) do |block, block_num|
+          block.transactions.each do |transaction|
+            yield transaction, transaction.transactionId, block_num
+          end
+        end
+      end
+    end
+  end
+end

data/lib/radiator/version.rb

@@ -1,4 +1,4 @@
 module Radiator
-  VERSION = '0.4.4'
+  VERSION = '0.4.5'
   AGENT_ID = "radiator/#{VERSION}"
 end

data/radiator.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'yard', '~> 0.9.9'
   spec.add_development_dependency 'pry', '~> 0.11', '>= 0.11.3'
   spec.add_development_dependency 'rb-readline', '~> 0.5', '>= 0.5.5'
+  spec.add_development_dependency 'irb', '~> 1.0', '>= 1.0.0'
   
   # net-http-persistent has an open-ended dependency because radiator directly
   # supports net-http-persistent-3.0.0 as well as net-http-persistent-2.5.2.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: radiator
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
 platform: ruby
 authors:
 - Anthony Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2019-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,6 +212,26 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.5
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: net-http-persistent
   requirement: !ruby/object:Gem::Requirement
@@ -388,6 +408,10 @@ files:
 - lib/radiator/operation.rb
 - lib/radiator/operation_ids.rb
 - lib/radiator/operation_types.rb
+- lib/radiator/ssc/base_steem_smart_contract_rpc.rb
+- lib/radiator/ssc/blockchain.rb
+- lib/radiator/ssc/contracts.rb
+- lib/radiator/ssc/stream.rb
 - lib/radiator/stream.rb
 - lib/radiator/tag_api.rb
 - lib/radiator/transaction.rb