Merge pull request #6 from alexhanh/master

Improve clients

Author: tymat

.ruby-version

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
+
   spec.add_dependency "activesupport"
-  spec.add_dependency "sha3-pure-ruby", "0.1.1"
+  spec.add_dependency "digest-sha3", "~> 1.1"
 end

ethereum.gemspec

@@ -1,7 +1,7 @@
 require "ethereum/version"
 require 'active_support'
 require 'active_support/core_ext'
-require 'sha3-pure-ruby'
+require 'digest/sha3'
 
 module Ethereum
   require 'ethereum/client'

lib/ethereum.rb

@@ -1,15 +1,65 @@
 module Ethereum
   class Client
+    # https://github.com/ethereum/wiki/wiki/JSON-RPC
+    RPC_COMMANDS = %w(web3_clientVersion web3_sha3 net_version net_peerCount net_listening eth_protocolVersion eth_syncing eth_coinbase eth_mining eth_hashrate eth_gasPrice eth_accounts eth_blockNumber eth_getBalance eth_getStorageAt eth_getTransactionCount eth_getBlockTransactionCountByHash eth_getBlockTransactionCountByNumber eth_getUncleCountByBlockHash eth_getUncleCountByBlockNumber eth_getCode eth_sign eth_sendTransaction eth_sendRawTransaction eth_call eth_estimateGas eth_getBlockByHash eth_getBlockByNumber eth_getTransactionByHash eth_getTransactionByBlockHashAndIndex eth_getTransactionByBlockNumberAndIndex eth_getTransactionReceipt eth_getUncleByBlockHashAndIndex eth_getUncleByBlockNumberAndIndex eth_getCompilers eth_compileLLL eth_compileSolidity eth_compileSerpent eth_newFilter eth_newBlockFilter eth_newPendingTransactionFilter eth_uninstallFilter eth_getFilterChanges eth_getFilterLogs eth_getLogs eth_getWork eth_submitWork eth_submitHashrate db_putString db_getString db_putHex db_getHex shh_post shh_version shh_newIdentity shh_hasIdentity shh_newGroup shh_addToGroup shh_newFilter shh_uninstallFilter shh_getFilterChanges shh_getMessages)
+    # https://github.com/ethereum/go-ethereum/wiki/Management-APIs
+    RPC_MANAGEMENT_COMMANDS = %w(admin_addPeer admin_datadir admin_nodeInfo admin_peers admin_setSolc admin_startRPC admin_startWS admin_stopRPC admin_stopWS debug_backtraceAt debug_blockProfile debug_cpuProfile debug_dumpBlock debug_gcStats debug_getBlockRlp debug_goTrace debug_memStats debug_seedHash debug_setHead debug_setBlockProfileRate debug_stacks debug_startCPUProfile debug_startGoTrace debug_stopCPUProfile debug_stopGoTrace debug_traceBlock debug_traceBlockByNumber debug_traceBlockByHash debug_traceBlockFromFile debug_traceTransaction debug_verbosity debug_vmodule debug_writeBlockProfile debug_writeMemProfile miner_hashrate miner_makeDAG miner_setExtra miner_setGasPrice miner_start miner_startAutoDAG miner_stop miner_stopAutoDAG personal_importRawKey personal_listAccounts personal_lockAccount personal_newAccount personal_unlockAccount personal_sendTransaction txpool_content txpool_inspect txpool_status)
 
-    RPC_COMMANDS = %w(personal_newAccount personal_unlockAccount eth_accounts eth_blockNumber eth_getBalance eth_protocolVersion eth_coinbase eth_mining eth_gasPrice eth_getStorage eth_storageAt eth_getStorageAt eth_getTransactionCount eth_getBlockTransactionCountByHash eth_getBlockTransactionCountByNumber eth_getUncleCountByBlockHash eth_getUncleCountByBlockNumber eth_getData eth_getCode eth_sign eth_sendRawTransaction eth_sendTransaction eth_transact eth_estimateGas eth_call eth_flush eth_getBlockByHash eth_getBlockByNumber eth_getTransactionByHash eth_getTransactionByBlockNumberAndIndex eth_getTransactionByBlockHashAndIndex eth_getUncleByBlockHashAndIndex eth_getUncleByBlockNumberAndIndex eth_getCompilers eth_compileSolidity eth_newFilter eth_newBlockFilter eth_newPendingTransactionFilter eth_uninstallFilter eth_getFilterChanges eth_getFilterLogs eth_getLogs eth_hashrate eth_getWork eth_submitWork eth_resend eth_pendingTransactions eth_getTransactionReceipt)
+    attr_accessor :command, :id, :log, :logger
+
+    def initialize(log = false)
+      @id = 0
+      @log = log
+      @batch = nil
+
+      if @log == true
+        @logger = Logger.new("/tmp/ethereum_ruby_http.log")
+      end
+    end
+
+    def batch
+      @batch = []
+
+      yield
+      result = send_batch(@batch)
+
+      @batch = nil
+      reset_id
+
+      return result
+    end
 
     def get_id
-      @id = @id + 1
+      @id += 1
       return @id
     end
 
-    def clear_batch
-      @batch = []
+    def reset_id
+      @id = 0
+    end
+
+    (RPC_COMMANDS + RPC_MANAGEMENT_COMMANDS).each do |rpc_command|
+      method_name = "#{rpc_command.underscore}"
+      define_method method_name do |*args|
+        command = rpc_command
+        if command == "eth_call"
+          args << "latest"
+        end
+        payload = {jsonrpc: "2.0", method: command, params: args, id: get_id}
+        if @log == true
+          @logger.info("Sending #{payload.to_json}")
+        end
+
+        if @batch
+          @batch << payload
+          return true
+        else
+          read = send_single(payload.to_json)
+          output = JSON.parse(read)
+          reset_id
+          return output
+        end
+      end
     end
 
   end

lib/ethereum/client.rb

@@ -1,58 +1,35 @@
 require 'net/http'
 module Ethereum
   class HttpClient < Client
-    attr_accessor :command, :id, :host, :port, :batch, :converted_transactions, :uri, :ssl, :logger, :log
+    attr_accessor :host, :port, :uri, :ssl
 
-    def initialize(host, port, ssl = false, log = true)
+    def initialize(host, port, ssl = false, log = false)
+      super(log)
       @host = host
       @port = port
-      @id = 1
       @ssl = ssl
-      @log = log
-      if @log == true
-        @logger = Logger.new("/tmp/ethereum_ruby_http.log")
-      end
       if ssl
         @uri = URI("https://#{@host}:#{@port}")
       else
         @uri = URI("http://#{@host}:#{@port}")
       end
-      @batch = []
     end
 
-    RPC_COMMANDS.each do |rpc_command|
-      method_name = "#{rpc_command.split("_")[1].underscore}"
-      define_method method_name do |*args|
-        command = rpc_command
-        if command == "eth_call"
-          args << "latest"
-        end
-        payload = {jsonrpc: "2.0", method: command, params: args, id: get_id}
-        http = ::Net::HTTP.new(@host, @port)
-        if @ssl
-          http.use_ssl = true
-        end
-        header = {'Content-Type' => 'application/json'}
-        request = ::Net::HTTP::Post.new(uri, header)
-        if @log == true
-          @logger.info("Sending #{payload.to_json}")
-        end
-        request.body = payload.to_json
-        response =  http.request(request)
-        return JSON.parse(response.body)
-      end
-
-      define_method "#{method_name}_batch" do |*args|
-        command = rpc_command
-        payload = {jsonrpc: "2.0", method: command, params: args, id: get_id}
-        @batch << payload.to_json
+    def send_single(payload)
+      http = ::Net::HTTP.new(@host, @port)
+      if @ssl
+        http.use_ssl = true
       end
+      header = {'Content-Type' => 'application/json'}
+      request = ::Net::HTTP::Post.new(uri, header)
+      request.body = payload
+      response = http.request(request)
+      return response.body
     end
 
-    def send_batch
-
+    def send_batch(batch)
+      raise NotImplementedError
     end
-
   end
 
 end

lib/ethereum/http_client.rb

@@ -1,60 +1,35 @@
 require 'socket'
 module Ethereum
   class IpcClient < Client
-    attr_accessor :command, :id, :ipcpath, :batch, :converted_transactions, :log, :logger
+    attr_accessor :ipcpath
 
-    def initialize(ipcpath = "#{ENV['HOME']}/.ethereum/geth.ipc", log = true)
+    def initialize(ipcpath = "#{ENV['HOME']}/.ethereum/geth.ipc", log = false)
+      super(log)
       @ipcpath = ipcpath
-      @id = 1
-      @batch = []
-      @log = log
-      if @log == true
-        @logger = Logger.new("/tmp/ethereum_ruby_ipc.log")
-      end
     end
 
-    RPC_COMMANDS.each do |rpc_command|
-      method_name = "#{rpc_command.split("_")[1].underscore}"
-      define_method method_name do |*args|
-        command = rpc_command
-        if command == "eth_call"
-          args << "latest"
-        end
-        payload = {jsonrpc: "2.0", method: command, params: args, id: get_id}
-        socket = UNIXSocket.new(@ipcpath)
-        socket.write(payload.to_json)
-        if @log == true
-          @logger.info("Sending #{payload.to_json}")
-        end
-        socket.close_write
-        read = socket.read
-        socket.close_read
-        output = JSON.parse(read)
-        return output
-      end
-
-      define_method "#{method_name}_batch" do |*args|
-        command = rpc_command
-        payload = {jsonrpc: "2.0", method: command, params: args, id: get_id}
-        @batch << payload.to_json
-      end
-    end
-
-    def send_batch
+    def send_single(payload)
       socket = UNIXSocket.new(@ipcpath)
-      socket.write(@batch.join(" "))
-      socket.close_write
-      read = socket.read
-      collection = read.chop.split("}{").collect do |output|
-        if output[0] == "{"
-          JSON.parse("#{output}}")["result"]
-        else
-          JSON.parse("{#{output}}")["result"]
-        end
-      end
-      return collection
+      socket.puts(payload)
+      read = socket.gets
+      socket.close
+      return read
     end
 
-  end
-end
+    # TODO: Not sure if multithread safe
+    # Note: Guarantees the results are in the same order as defined in batch call.
+    # client.batch do
+    #   client.eth_block_number
+    #   client.eth_mining
+    # end
+    # => [{"jsonrpc"=>"2.0", "id"=>1, "result"=>"0x26"}, {"jsonrpc"=>"2.0", "id"=>2, "result"=>false}] 
+    def send_batch(batch)
+      result = send_single(batch.to_json)
+      result = JSON.parse(result)
 
+      # Make sure the order is the same as it was when batching calls
+      # See 6 Batch here http://www.jsonrpc.org/specification
+      return result.sort_by! { |c| c['id'] }
+    end
+  end
+end

lib/ethereum/ipc_client.rb

@@ -1,3 +1,3 @@
 module Ethereum
-  VERSION = "0.5.2"
+  VERSION = "1.5.2"
 end

lib/ethereum/version.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Ethereum do
+  describe 'HttpClient' do
+    it 'should work' do
+      client = Ethereum::HttpClient.new('localhost', '8545')
+      expect(client.eth_accounts['error']).to eq(nil)
+    end
+  end
+
+  describe 'IpcClient' do
+    before(:each) do
+      @client = Ethereum::IpcClient.new("#{ENV['HOME']}/EtherDev/data/geth.ipc")
+    end
+
+    it 'should work' do
+      expect(@client.eth_accounts['error']).to eq(nil)
+    end
+
+    it 'should support batching' do
+      response = @client.batch do
+        @client.net_listening
+        @client.eth_block_number
+      end
+
+      expect(response).to be_a Array
+      expect(response.length).to eq 2
+      expect(response.first['result']).to be_in [true, false]
+      expect(response.last['result']).to match /(0x)?[0-9a-f]+/i
+    end
+  end
+end