ethereum 0.2.0 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 322a4404d64ad2d1d14328ec0440b6612aaf5867
-  data.tar.gz: 820552a955aeb11ccb156333758c94eb73eddaae
+  metadata.gz: a374154be8bb1dac7fe3073b4ca7e92ace6b8991
+  data.tar.gz: 7b21a87aa5d0a754f6abe50ee3eabbdf82dd7c50
 SHA512:
-  metadata.gz: b070b6eb2995dc8595a001e584e69fed37b855cbb03a88989fb5bd22fd4d85a57dea48e1d598c2cc990bab21b2162f94f06111acf9b767fa6d583d6d838e3f81
-  data.tar.gz: 84958a99e16f93a6de3f870398dc085c504582cd590c60570c1701e2802c52e845b22edcd220938c694e31c62321df08a4527c9ff5370a34634e6764d157707b
+  metadata.gz: 51e40edef7d4ede819c2ab3e7b3dbce2bc69488ba5b807db0dbcc1b57055611893b5e6c2fb6b782341d67ea22a2216c9287896fa826317faf7c646d8709709ae
+  data.tar.gz: 8982b0e349cacf5dc63ff700f73afbc2797da4bf070294c039da744851536ce9c034920b3bd5cff2147ff22f18678f23fbce6a7a022dda50ed06e05673f9311a

data/README.md

@@ -4,12 +4,21 @@ A simple library for Ethereum.
 
 ## Features
 
+* Pure Ruby implementation
 * IPC Client with batch calls support
+* HTTP Client with batch calls support
 * Compile and deploy Solidity contracts
 * Expose deployed contracts as Ruby classes
 * Test solidity contracts with a Ruby testing framework of your choice
 * Call and wait for the result of Solidity function calls.
 
+## Ruby Compatibility
+
+* Ruby 2.x
+* Ruby 1.9.x
+* JRuby
+* Rubinius
+
 ## Requirements
 
 We currently support UNIX/Linux environments and Windows IPC support on the roadmap.
@@ -53,22 +62,65 @@ simple_name_registry_instance.deploy_and_wait
 
 ### Transacting and Calling Solidity Functions
 
-Solidity functions are exposed as transact_<underscore_function_name>(params) (or transact_and_wait_<underscore_function_name>(params))  and call_<underscore_function_name>(params) e.g.:
+Solidity functions are exposed using the following conventions: 
+
+```
+transact_[function_name](params) 
+transact_and_wait_[function_name](params)  
+call_[function_name](params)
+```
+
+**Example Contract in Solidity**
+```
+contract SimpleNameRegistry {
+
+  mapping (address => bool) public myMapping;
+
+  function register(address _a, bytes32 _b) {
+  }
+
+  function getSomeValue(address _x) public constant returns(bool b, address b) {
+  }
+
+}
+```
 
 ```ruby
 simple_name_registry_instance.transact_and_wait_register("0x5b6cb65d40b0e27fab87a2180abcab22174a2d45", "minter.contract.dgx")
 simple_name_registry_instance.transact_register("0x385acafdb80b71ae001f1dbd0d65e62ec2fff055", "anthony@eufemio.dgx")
+simple_name_registry_instance.call_get_some_value("0x385acafdb80b71ae001f1dbd0d65e62ec2fff055")
+simple_name_registry_instance.call_my_mapping("0x385acafdb80b71ae001f1dbd0d65e62ec2fff055")
+```
+
+### Run contracts using a different address
+
+```ruby
+simple_name_registry_instance.as("0x0c0d99d3608a2d1d38bb1b28025e970d3910b1e1")
+```
+
+### Point contract instance to a previously deployed contract
+
+```ruby
+simple_name_registry_instance.at("0x734533083b5fc0cd14b7cb8c8eb6ed0c9bd184d3")
 ```
 
 ## Roadmap
 
-* Add JSON RPC Client support
 * Add Windows IPC Client (named pipes)
+* Add support for creating and sending of raw transactions
+* Offline account creation
 * Solidity constant function output should be properly formatted according to the ouput data type
-* Unit testing and contract testing examples
+* Unit testing and contract testing examples.  Use [web3.js](https://github.com/ethereum/web3.js) tests as a baseline.
+* ContractTransaction class
 * Add more examples
 * API documentation
 
+## Support 
+
+Please join our Gitter chat room or open a new issue in this repository
+
+[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/DigixGlobal/ethereum-ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/ethereum.gemspec

@@ -6,7 +6,7 @@ require 'ethereum/version'
 Gem::Specification.new do |spec|
   spec.name          = "ethereum"
   spec.version       = Ethereum::VERSION
-  spec.authors       = ["Digix"]
+  spec.authors       = ["DigixGlobal Pte Ltd (https://dgx.io)"]
   spec.email         = ["ace@dgx.io"]
 
   spec.summary       = %q{Ethereum libraries for Ruby}
@@ -32,5 +32,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "pry"
   spec.add_dependency "activesupport"
-  spec.add_dependency "digest-sha3"
+  spec.add_dependency "sha3-pure-ruby"
 end

data/lib/ethereum.rb

@@ -1,9 +1,12 @@
 require "ethereum/version"
 require 'active_support'
 require 'active_support/core_ext'
+require 'sha3-pure-ruby'
 
 module Ethereum
+  require 'ethereum/client'
   require 'ethereum/ipc_client'
+  require 'ethereum/http_client'
   require 'ethereum/initializer'
   require 'ethereum/contract'
   require 'ethereum/function'

data/lib/ethereum/client.rb

@@ -0,0 +1,18 @@
+module Ethereum
+  class Client
+
+    RPC_COMMANDS = %w(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)
+
+    def get_id
+      @id = @id + 1
+      return @id
+    end
+
+    def clear_batch
+      @batch = []
+    end
+
+  end
+
+end
+

data/lib/ethereum/contract.rb

@@ -71,41 +71,44 @@ module Ethereum
         end
 
         functions.each do |fun|
-          if fun.constant
-            define_method "call_#{fun.name.underscore}".to_sym do |*args|
-              formatter = Ethereum::Formatter.new
-              arg_types = fun.inputs.collect(&:type)
-              #out_types = fun.outputs.collect(&:type)
-              connection = self.connection
-              return {result: :error, message: "missing parameters for #{fun.function_string}" } if arg_types.length != args.length
-              payload = []
-              payload << fun.signature
-              arg_types.zip(args).each do |arg|
-                payload << formatter.to_payload(arg)
-              end
-              return {result: connection.call({to: self.address, from: self.sender, data: payload.join()})["result"].gsub(/^0x/,'').scan(/.{64}/)}
-            end
-          else
-            define_method "transact_#{fun.name.underscore}".to_sym do |*args|
-              formatter = Ethereum::Formatter.new
-              arg_types = fun.inputs.collect(&:type)
-              connection = self.connection
-              return {result: :error, message: "missing parameters for #{fun.function_string}" } if arg_types.length != args.length
-              payload = []
-              payload << fun.signature
-              arg_types.zip(args).each do |arg|
-                payload << formatter.to_payload(arg)
-              end
-              txid = connection.send_transaction({to: self.address, from: self.sender, data: payload.join(), gas: self.gas, gasPrice: self.gas_price})["result"]
-              return Ethereum::Transaction.new(txid, self.connection)
+
+          define_method "call_#{fun.name.underscore}".to_sym do |*args|
+            formatter = Ethereum::Formatter.new
+            arg_types = fun.inputs.collect(&:type)
+            #out_types = fun.outputs.collect(&:type)
+            connection = self.connection
+            return {result: :error, message: "missing parameters for #{fun.function_string}" } if arg_types.length != args.length
+            payload = []
+            payload << fun.signature
+            arg_types.zip(args).each do |arg|
+              payload << formatter.to_payload(arg)
             end
-            define_method "transact_and_wait_#{fun.name.underscore}".to_sym do |*args|
-              function_name = "transact_#{fun.name.underscore}".to_sym
-              tx = self.send(function_name, *args)
-              tx.wait_for_miner
-              return tx
+            raw_result = connection.call({to: self.address, from: self.sender, data: payload.join()})["result"]
+            formatted_result = raw_result.gsub(/^0x/,'').scan(/.{64}/)
+            return {data: payload.join(), raw: raw_result, formatted: formatted_result}
+          end
+
+          define_method "transact_#{fun.name.underscore}".to_sym do |*args|
+            formatter = Ethereum::Formatter.new
+            arg_types = fun.inputs.collect(&:type)
+            connection = self.connection
+            return {result: :error, message: "missing parameters for #{fun.function_string}" } if arg_types.length != args.length
+            payload = []
+            payload << fun.signature
+            arg_types.zip(args).each do |arg|
+              payload << formatter.to_payload(arg)
             end
+            txid = connection.send_transaction({to: self.address, from: self.sender, data: payload.join(), gas: self.gas, gasPrice: self.gas_price})["result"]
+            return Ethereum::Transaction.new(txid, self.connection, payload.join(), args)
           end
+
+          define_method "transact_and_wait_#{fun.name.underscore}".to_sym do |*args|
+            function_name = "transact_#{fun.name.underscore}".to_sym
+            tx = self.send(function_name, *args)
+            tx.wait_for_miner
+            return tx
+          end
+
         end
       end
       Object.const_set(class_name, class_methods)

data/lib/ethereum/deployment.rb

@@ -31,10 +31,10 @@ module Ethereum
       @valid_deployment = @connection.get_code(@contract_address)["result"] != "0x"
     end
 
-    def wait_for_deployment(timeout = 60.seconds)
+    def wait_for_deployment(timeout = 1500.seconds)
       start_time = Time.now
       while self.deployed? == false
-        raise Timeout::Error if ((Time.now - start_time) > timeout) 
+        raise "Transaction #{@id} timed out." if ((Time.now - start_time) > timeout) 
         sleep 5 
         return true if self.deployed? 
       end

data/lib/ethereum/formatter.rb

@@ -54,11 +54,11 @@ module Ethereum
     end
 
     def uint_to_payload(uint)
-      self.to_twos_complement(uint)
+      self.to_twos_complement(uint).rjust(64, '0')
     end
 
     def int_to_payload(int)
-      self.to_twos_complement(uint)
+      self.to_twos_complement(uint).rjust(64, '0')
     end
 
     def bytes_to_payload(bytes)

data/lib/ethereum/http_client.rb

@@ -0,0 +1,40 @@
+require 'pry'
+module Ethereum
+  class HttpClient < Client
+    attr_accessor :command, :id, :host, :port, :batch, :converted_transactions, :uri
+
+    def initialize(host, port)
+      @host = host
+      @port = port
+      @id = 1
+      @uri = URI("http://#{@host}:#{@port}")
+      @batch = []
+    end
+
+    RPC_COMMANDS.each do |rpc_command|
+      method_name = "#{rpc_command.split("_")[1].underscore}"
+      define_method method_name do |*args|
+        command = rpc_command
+        payload = {jsonrpc: "2.0", method: command, params: args, id: get_id}
+        http = Net::HTTP.new(@host, @port)
+        header = {'Content-Type' => 'application/json'}
+        request = Net::HTTP::Post.new(uri, header)
+        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
+      end
+    end
+
+    def send_batch
+
+    end
+
+  end
+
+end

data/lib/ethereum/ipc_client.rb

@@ -1,6 +1,6 @@
 require 'socket'
 module Ethereum
-  class IpcClient
+  class IpcClient < Client
     attr_accessor :command, :id, :ipcpath, :batch, :converted_transactions
 
     def initialize(ipcpath = "#{ENV['HOME']}/.ethereum/geth.ipc")
@@ -9,13 +9,6 @@ module Ethereum
       @batch = []
     end
 
-    def get_id
-      @id = @id + 1
-      return @id
-    end
-
-    RPC_COMMANDS = %w(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)
-
     RPC_COMMANDS.each do |rpc_command|
       method_name = "#{rpc_command.split("_")[1].underscore}"
       define_method method_name do |*args|
@@ -52,10 +45,6 @@ module Ethereum
       return collection
     end
 
-    def clear_batch
-      @batch = []
-    end
-
   end
 end
 

data/lib/ethereum/transaction.rb

@@ -1,12 +1,14 @@
 module Ethereum
 
   class Transaction
-    attr_accessor :id, :mined, :connection
+    attr_accessor :id, :mined, :connection, :input, :input_parameters
 
-    def initialize(id, connection)
+    def initialize(id, connection, data, input_parameters = [])
       @mined = false
       @connection = connection
       @id = id
+      @input = data
+      @input_parameters = input_parameters
     end
 
     def mined?
@@ -14,7 +16,7 @@ module Ethereum
       @mined = @connection.get_transaction_by_hash(@id)["result"]["blockNumber"].present?
     end
 
-    def wait_for_miner(timeout = 60.seconds)
+    def wait_for_miner(timeout = 1500.seconds)
       start_time = Time.now
       while self.mined? == false
         raise Timeout::Error if ((Time.now - start_time) > timeout)

data/lib/ethereum/version.rb

@@ -1,3 +1,3 @@
 module Ethereum
-  VERSION = "0.2.0"
+  VERSION = "0.3.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethereum
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.8
 platform: ruby
 authors:
-- Digix
+- DigixGlobal Pte Ltd (https://dgx.io)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-08 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: digest-sha3
+  name: sha3-pure-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -116,12 +116,14 @@ files:
 - bin/setup
 - ethereum.gemspec
 - lib/ethereum.rb
+- lib/ethereum/client.rb
 - lib/ethereum/contract.rb
 - lib/ethereum/deployment.rb
 - lib/ethereum/formatter.rb
 - lib/ethereum/function.rb
 - lib/ethereum/function_input.rb
 - lib/ethereum/function_output.rb
+- lib/ethereum/http_client.rb
 - lib/ethereum/initializer.rb
 - lib/ethereum/ipc_client.rb
 - lib/ethereum/transaction.rb