ethereum.rb 2.1.8 → 2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afa7f2461a4f8f594fc3e8d57cf53d92e8540a55
-  data.tar.gz: 88e3b4d2066800644e8f1b82a6afaf8eb876fa47
+  metadata.gz: fe82a37129944871e8670fbc4dde4818fdbc5c7a
+  data.tar.gz: 144ff632e0837e2eb72d64900aba51791250e26b
 SHA512:
-  metadata.gz: 1caa864078b37ff71e1e48e779a6f595a42a31e8bd839bf8cd886a397ab90efd6dbee68f4f22e858df89aa227497450ef5a3d04c62a2aec48a0a85fc2d3a3294
-  data.tar.gz: 28eaa1419c7cde34d3daadc452178d03baa92fd24b49a85b1768896c2b678438105ce4e0f4289ec828603d7c7f8fa5320d4cb6c29ebb11324ae161ce19b261dd
+  metadata.gz: dc154bb5b6c11573df10f15d8d05e3d08b4094970b9be4f36053e29d2c267357dc51c75c51db45656ab1435a1e3428a26855d1cdfc2537d4d049ca43ac8572ea
+  data.tar.gz: 0b0d6d9b5e79220ca4ecec3f93cb9cca1b91b63eaae5aa51e2aeaba2c2e8be4bd9dc1696b7b4872f05ed228fe097e068f78e9a62c73820aaa7a6fc4b7a5877d4

data/.gitignore

@@ -9,3 +9,5 @@
 /tmp/
 /.*.swp
 /**/.*.swp
+
+.idea

data/.travis.yml

@@ -1,7 +1,9 @@
 dist: trusty
 language: ruby
 rvm:
-  - 2.3.1
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
 env:
   - PARITY="1.6.10"
 cache:

data/PREREQUISITES.md

@@ -16,7 +16,7 @@ Currently the only node supported by ethereum.rb is [parity](https://ethcore.io/
     $ brew tap ethcore/ethcore
     $ brew install parity --beta
 
-To install parity on linux download latest package from [parity github](https://github.com/ethcore/parity/releases) and install on your computer.
+To install parity on linux download latest package from [parity github](https://github.com/paritytech/parity/releases) and install on your computer.
 
 It might work with [geth](https://github.com/ethereum/go-ethereum/wiki/geth) as well, but this configuration is not tested. 
 

data/README.md

@@ -96,6 +96,21 @@ If you want to create new contract, that is not yet deployed from ABI definition
 contract = Ethereum::Contract.create(name: "MyContract", abi: abi, code: "...")
 ```
 
+### Simple Truffle integration
+
+If you use Truffle to build and deploy contracts, you can pick up the Truffle artifacts to initialize
+a contract. For example, if you have a MyContract in the Truffle directory at `/my/truffle/project`:
+
+```
+contract = Ethereum::Contract.create(name: "MyContract", truffle: { paths: [ '/my/truffle/project' ] }, client: client, address: '0x01a4d1A62F01ED966646acBfA8BB0b59960D06dd')
+```
+
+The contract factory will attempt to load the deployed address from the Truffle artifacts if the client's network is present:
+
+```
+contract = Ethereum::Contract.create(name: "MyContract", truffle: { paths: [ '/my/truffle/project' ] }, client: client)
+```
+
 ### Interacting with contract
 
 Functions defined in a contract are exposed using the following conventions:
@@ -109,11 +124,12 @@ contract.call.[function_name](params)
 **Example Contract in Solidity**
 ```
 contract SimpleRegistry {
-
+  event LogRegister(bytes32 key, string value);
   mapping (bytes32 => string) public registry;
 
   function register(bytes32 key, string value) {
     registry[key] = value;
+    LogRegister(key, value);
   }
 
   function get(bytes32 key) public constant returns(string) {
@@ -145,6 +161,37 @@ Will call method of the contract and return result.
 Note that no transaction need to be send to the network as method is read-only.
 On the other hand `register` method will change contract state, so you need to use `transact` or `transact_and_wait` to call it.
 
+### Receiving Contract Events
+
+Using the example smart contract described above, one can listen for `LogRegister` events by using filters.
+
+You can get a list of events from a certain block number to the latest:
+
+```ruby
+require 'ostruct'
+
+event_abi = contract.abi.find {|a| a['name'] == 'LogRegister'}
+event_inputs = event_abi['inputs'].map {|i| OpenStruct.new(i)}
+decoder = Ethereum::Decoder.new
+
+filter_id = contract.new_filter.log_register(
+  {
+    from_block: '0x0',
+    to_block: 'latest',
+    address: '0x....',
+    topics: []
+  }
+)
+
+events = contract.get_filter_logs.log_register(filter_id)
+
+events.each do |event|
+  transaction_id = event[:transactionHash]
+  transaction = ethereum.eth_get_transaction_receipt(transaction_id)
+  args = decoder.decode_arguments(event_inputs, entry['data'])
+  puts "#{transaction.inspect} with args: #{args}"
+end
+```
 
 ### IPC Client Connection
 

data/ethereum.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry", "~> 0.10"
   spec.add_development_dependency "eth", "~> 0.4"
 
-  spec.add_dependency "activesupport", "~> 5.0"
+  spec.add_dependency "activesupport", ">= 4.0"
   spec.add_dependency "digest-sha3", "~> 1.1"
 end

data/lib/ethereum/client.rb

@@ -73,7 +73,7 @@ module Ethereum
     end
 
     def get_nonce(address)
-      eth_get_transaction_count(address, "latest")["result"].to_i(16)
+      eth_get_transaction_count(address, "pending")["result"].to_i(16)
     end
     
 

data/lib/ethereum/contract.rb

@@ -5,7 +5,7 @@ module Ethereum
 
     attr_reader :address
     attr_accessor :key
-    attr_accessor :gas_limit, :gas_price
+    attr_accessor :gas_limit, :gas_price, :nonce
     attr_accessor :code, :name, :abi, :class_object, :sender, :deployment, :client
     attr_accessor :events, :functions, :constructor_inputs
     attr_accessor :call_raw_proxy, :call_proxy, :transact_proxy, :transact_and_wait_proxy
@@ -25,7 +25,34 @@ module Ethereum
       @gas_price = @client.gas_price
     end
 
-    def self.create(file: nil, client: Ethereum::Singleton.instance, code: nil, abi: nil, address: nil, name: nil, contract_index: nil)
+    # Creates a contract wrapper.
+    # This method attempts to instantiate a contract object from a Solidity source file, from a Truffle
+    # artifacts file, or from explicit API and bytecode.
+    # - If *:file* is present, the method compiles it and looks up the contract factory at *:contract_index*
+    #   (0 if not provided). *:abi* and *:code* are ignored.
+    # - If *:truffle* is present, the method looks up the Truffle artifacts data for *:name* and uses
+    #   those data to build a contract instance.
+    # - Otherwise, the method uses *:name*, *:code*, and *:abi* to build the contract instance.
+    #
+    # @param opts [Hash] Options to the method.
+    # @option opts [String] :file Path to the Solidity source that contains the contract code.
+    # @option opts [Ethereum::Singleton] :client The client to use.
+    # @option opts [String] :code The hex representation of the contract's bytecode.
+    # @option opts [Array,String] :abi The contract's ABI; a string is assumed to contain a JSON representation
+    #  of the ABI.
+    # @option opts [String] :address The contract's address; if not present and +:truffle+ is present,
+    #  the method attempts to determine the address from the artifacts' +networks+ key and the client's
+    #  network id.
+    # @option opts [String] :name The contract name.
+    # @option opts [Integer] :contract_index The index of the contract data in the compiled file.
+    # @option opts [Hash] :truffle If this parameter is present, the method uses Truffle information to
+    #  generate the contract wrapper.
+    #  - *:paths* An array of strings containing the list of paths where to look up Truffle artifacts files.
+    #    See also {#find_truffle_artifacts}.
+    #
+    # @return [Ethereum::Contract] Returns a contract wrapper.
+
+    def self.create(file: nil, client: Ethereum::Singleton.instance, code: nil, abi: nil, address: nil, name: nil, contract_index: nil, truffle: nil)
       contract = nil
       if file.present?
         contracts = Ethereum::Initializer.new(file, client).build_all
@@ -36,7 +63,29 @@ module Ethereum
           contract = contracts.first.class_object.new
         end
       else
-        abi = JSON.parse(abi) if abi.is_a? String
+        if truffle.present? && truffle.is_a?(Hash)
+          artifacts = find_truffle_artifacts(name, (truffle[:paths].is_a?(Array)) ? truffle[:paths] : [])
+          if artifacts
+            abi = artifacts['abi']
+            # The truffle artifacts store bytecodes with a 0x tag, which we need to remove
+            # this may need to be 'deployedBytecode'
+            code_key = artifacts['bytecode'].present? ? 'bytecode' : 'unlinked_binary'
+            code = (artifacts[code_key].start_with?('0x')) ? artifacts[code_key][2, artifacts[code_key].length] : artifacts[code_key]
+            unless address
+              address = if client
+                          network_id = client.net_version['result']
+                          (artifacts['networks'][network_id]) ? artifacts['networks'][network_id]['address'] : nil
+                        else
+                          nil
+                        end
+            end
+          else
+            abi = nil
+            code = nil
+          end
+        else
+          abi = JSON.parse(abi) if abi.is_a? String
+        end
         contract = Ethereum::Contract.new(name, code, abi, client)
         contract.build
         contract = contract.class_object.new
@@ -114,7 +163,7 @@ module Ethereum
     end
 
     def call_payload(fun, args)
-      "0x" + fun.signature + @encoder.encode_arguments(fun.inputs, args)
+      "0x" + fun.signature + (@encoder.encode_arguments(fun.inputs, args).presence || "0"*64)
     end
 
     def call_args(fun, args)
@@ -199,7 +248,7 @@ module Ethereum
         extend Forwardable
         def_delegators :parent, :deploy_payload, :deploy_args, :call_payload, :call_args
         def_delegators :parent, :signed_deploy, :key, :key=
-        def_delegators :parent, :gas_limit, :gas_price, :gas_limit=, :gas_price=
+        def_delegators :parent, :gas_limit, :gas_price, :gas_limit=, :gas_price=, :nonce, :nonce=
         def_delegators :parent, :abi, :deployment, :events
         def_delegators :parent, :estimate, :deploy, :deploy_and_wait
         def_delegators :parent, :address, :address=, :sender, :sender=
@@ -219,6 +268,46 @@ module Ethereum
       @class_object = class_methods
     end
 
+    # Get the list of paths where to look up Truffle artifacts files.
+    #
+    # @return [Array<String>] Returns the array containing the list of lookup paths.
+
+    def self.truffle_paths()
+      @truffle_paths = [] unless @truffle_paths
+      @truffle_paths
+    end
+
+    # Set the list of paths where to look up Truffle artifacts files.
+    #
+    # @param paths [Array<String>, nil] The array containing the list of lookup paths; a `nil` value is
+    #  converted to the empty array.
+
+    def self.truffle_paths=(paths)
+      @truffle_paths = (paths.is_a?(Array)) ? paths : []
+    end
+
+    # Looks up and loads a Truffle artifacts file.
+    # This method iterates over the `truffle_path` elements, looking for an artifact file in the
+    # `build/contracts` subdirectory.
+    #
+    # @param name [String] The name of the contract whose artifacts to look up.
+    # @param paths [Array<String>] An additional list of paths to look up; this list, if present, is
+    #  prepended to the `truffle_path`.
+    #
+    # @return [Hash,nil] Returns a hash containing the parsed JSON from the artifacts file; if no file
+    #  was found, returns `nil`.
+
+    def self.find_truffle_artifacts(name, paths = [])
+      subpath = File.join('build', 'contracts', "#{name}.json")
+
+      found = paths.concat(truffle_paths).find { |p| File.file?(File.join(p, subpath)) }
+      if (found) 
+        JSON.parse(IO.read(File.join(found, subpath)))
+      else
+        nil
+      end
+    end
+
     private
       def add_gas_options_args(args)
         args[:gas] = @client.int_to_hex(gas_limit) if gas_limit.present?

data/lib/ethereum/http_client.rb

@@ -2,25 +2,28 @@ require 'net/http'
 require 'json'
 module Ethereum
   class HttpClient < Client
-    attr_accessor :host, :port, :uri, :ssl
+    attr_accessor :host, :port, :uri, :ssl, :proxy
 
-    def initialize(host, log = false)
+    def initialize(host, proxy = nil, log = false)
       super(log)
       uri = URI.parse(host)
       raise ArgumentError unless ['http', 'https'].include? uri.scheme
       @host = uri.host
       @port = uri.port
+      @proxy = proxy
       
       @ssl = uri.scheme == 'https'
-      if ssl
-        @uri = URI("https://#{@host}:#{@port}")
-      else
-        @uri = URI("http://#{@host}:#{@port}")
-      end
+      @uri = URI("#{uri.scheme}://#{@host}:#{@port}#{uri.path}")
     end
 
     def send_single(payload)
-      http = ::Net::HTTP.new(@host, @port)
+      if @proxy.present?
+        _, p_username, p_password, p_host, p_port = @proxy.gsub(/(:|\/|@)/,' ').squeeze(' ').split
+        http = ::Net::HTTP.new(@host, @port, p_host, p_port, p_username, p_password)
+      else
+        http = ::Net::HTTP.new(@host, @port)
+      end
+
       if @ssl
         http.use_ssl = true
       end
@@ -28,13 +31,13 @@ module Ethereum
       request = ::Net::HTTP::Post.new(uri, header)
       request.body = payload
       response = http.request(request)
-      return response.body
+      response.body
     end
 
     def send_batch(batch)
       result = send_single(batch.to_json)
       result = JSON.parse(result)
-      return result.sort_by! { |c| c['id'] }
+      result.sort_by! { |c| c['id'] }
     end
   end
 

data/lib/ethereum/solidity.rb

@@ -14,7 +14,7 @@ module Ethereum
 
     def initialize(bin_path = "solc")
       @bin_path = bin_path
-      @args = "--bin --abi --add-std --optimize"
+      @args = "--bin --abi --optimize"
     end
 
     def compile(filename)

data/lib/ethereum/version.rb

@@ -1,3 +1,3 @@
 module Ethereum
-  VERSION = "2.1.8"
+  VERSION = "2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethereum.rb
 version: !ruby/object:Gem::Version
-  version: 2.1.8
+  version: '2.2'
 platform: ruby
 authors:
 - Marek Kirejczyk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2018-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: digest-sha3
   requirement: !ruby/object:Gem::Requirement