etherlite 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfe990bc167b90c43ca3ac261196ad69d527b01e
-  data.tar.gz: b42eb161febc5b28e147bbfb77db9e8a7ff3c755
+  metadata.gz: cb97370a946be81259847d2b1f3c7a6da33593e2
+  data.tar.gz: 373696bf36bcf5b5b7889ffe7eadfd0bf3544881
 SHA512:
-  metadata.gz: 2ecfa99699759f4fbadabf6cdbc8198f8efb75f52da7c5f3332f26eb5ae0378124c435726e2b000e043ecd1e2a541932065f8549be70be3d5ca34526db7cedb5
-  data.tar.gz: 194c0493e1db6a1e32f7eec88f7ae1362b6758facc0ffb9ae216b2751a7d0c6bc75c7a7178a384d76215d61b12fcbc58fd54643febfb9f5bfedef76ad80bb604
+  metadata.gz: f45918243e835c01d28c6beb7f3c42ffb77fa35047aab3051aba1f555eb4a65c6e6d7dc0b218a4efbdcb1efef3b3fd3b0b2a1e79f4bd22f202e43085169fc5f7
+  data.tar.gz: 22a6b1e87b0b9778de84607fd2d7d6cc59e35b14c14928ef984d4bfa32901f82d549f7c90ee018071847c69c1ba887e6ec4216989456b5d98efd8c278679d362

data/README.md

@@ -1,6 +1,8 @@
 # Etherlite
 
-Etherlite is a 
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/etherlite`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -14,101 +16,13 @@ And then execute:
 
     $ bundle
 
-Initialize the configuration file and `contracts` folder:
-
-    $ rails g etherlite:init
+Or install it yourself as:
 
-A `etherlite.yml` file will be added to your app's `config` folder, there you can configure the node locations and some other variables for each enviroment.
+    $ gem install etherlite
 
 ## Usage
 
-This gem is intended to be used with contract artifacts generated by Truffle. To start interacting with your contracts, drop the artifacts for the contracts you will be using in the application `contracts` folder. (You can find the contract artifacts on the `build/contracts` folder of your truffle proyect).
-
-Rails will automatically load the artifacts as ruby classes.
-
-For example, given the following contract:
-
-```solidity
-contract BikeStore {
-  event BikeSold(address buyer, string model);
-  event BikeReturned(address buyer, string reason);
-
-  function buyBike(string _model) payable {
-    // some code
-  }
-
-  function getBikePrice(string _model) returns (uint price) {
-    return _return;
-  }
-}
-```
-
-By copying the contract's artifact file in the `contracts` folder you will be able to call:
-
-```ruby
-my_store = BikeStoreContract.at('0xAAAAAAAAAAAAAAAAA') # notice the "Contract" sufix
-price = my_store.get_bike_price
-```
-
-### Accounts
-
-Etherlite supports both node managed accounts and private key accounts (via the `eth` gem).
-
-By default etherlite will try to use the first account from the configured node.
-
-```ruby
-Etherlite.default_account # this should reference the node's first account (if present)
-```
-
-When executing operations that need to send a transaction you will need to provide the account's passphrase. You can set the `passphrase` option in the configuration file:
-
-```yml
-development:
-  passphrase: <%= ENV['STORE_PASSPHRASE'] %>
-```
-
-or pass it on any transaction-triggering call:
-
-```ruby
-my_store.buy_bike('mongoose', passphrase: 'verysecure')
-```
-
-If you need to use a private key account, then set the `private_key` option in the configuration file with the account's private key. Etherlite will automatically switch to using a private key account instead of the node account:
-
-```yml
-development:
-  private_key: <%= ENV['STORE_PRIVATE_KEY'] %>
-```
-
-```ruby
-Etherlite.default_account.address # this should return the private_key corresponding address
-```
-
-If you wish to programatically load a private key account you can call:
-
-```ruby
-account = Etherlite.account_from_pk(your_private_key)
-```
-
-### Creating contract instances
-
-
-
-### Calling contract methods
-
-#### Setting gas limit and price
-
-### Transferring ether
-
-
-### Waiting for transactions
-
-
-### Searching event logs
-
-### Testing with Etherlite, rspec and testrpc
-
-Etherlite (will) provides a set of rspec helpers to make
+TODO: Write usage instructions here
 
 ## Development
 
@@ -120,6 +34,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/etherlite. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/etherlite.rb

@@ -1,5 +1,6 @@
 require "digest/sha3"
 require "active_support/all"
+require "forwardable"
 require "power-types"
 
 require "etherlite/version"
@@ -25,6 +26,7 @@ require "etherlite/contract/base"
 require "etherlite/contract/event_base"
 require "etherlite/contract/event_input"
 require "etherlite/contract/function"
+require "etherlite/contract/function_input"
 
 require "etherlite/errors"
 require "etherlite/configuration"

data/lib/etherlite/abi.rb

@@ -3,58 +3,17 @@ require 'etherlite/commands/abi/load_contract'
 require 'etherlite/commands/abi/load_function'
 
 module Etherlite
-  ##
-  # A set of ABI related utilities
-  #
   module Abi
     extend self
 
-    ##
-    # Load a contract artifact file.
-    #
-    # This method parses a truffle artifact file and loads a **contract** class.
-    #
-    # The generated contract class exposes a series of methods to interact with an instance
-    # of the contract described by the artifact.
-    #
-    # ```
-    # contract_class = Etherlite::Abi.load_contract_at('/path/to/Contract.json')
-    # instance = contract_class.deploy(gas: 1000000)
-    # ```
-    #
-    # @param _path (String) The artifact file absolute path
-    #
-    # @return [Object] the generated contract class.
-    #
     def load_contract_at(_path)
-      artifact = JSON.parse File.read(_path)
-      LoadContract.for artifact: artifact
+      load_contract JSON.parse File.read(_path)
     end
 
-    ##
-    # This method is similar to `load_contract_at` but takes a hash instead of the raw file.
-    #
-    # @param _artifact (Hash) The artifact hash
-    #
-    # @return [Object] the generated contract class.
-    #
-    def load_contract(_artifact)
-      LoadContract.for artifact: _artifact
+    def load_contract(_json)
+      LoadContract.for artifact: _json
     end
 
-    ##
-    # This method is used internally to load a function definition given a function signature.
-    #
-    # The function definition can be later used to call a contract's function without need of
-    # the artifact file.
-    #
-    # @param _signature (String) A string that matches:
-    #
-    #   (payable|onchain|<type>) <name>(<type>, <type>, ...), where <name> is the function's name
-    #   and <type> is any valid solidity type.
-    #
-    # @return [Object] the generated function definition.
-    #
     def load_function(_signature)
       LoadFunction.for signature: _signature
     end

data/lib/etherlite/commands/abi/load_contract.rb

@@ -3,7 +3,7 @@ module Etherlite::Abi
     def perform
       klass = Class.new(Etherlite::Contract::Base)
 
-      define_class_methods klass
+      define_class_getter klass, 'unlinked_binary', unlinked_binary
 
       abi_definitions.each do |definition|
         case definition['type']
@@ -11,6 +11,8 @@ module Etherlite::Abi
           define_function klass, definition
         when 'event'
           define_event klass, definition
+        when 'constructor'
+          define_class_getter klass, 'constructor', build_function_from_definition(definition)
         end
       end
 
@@ -21,6 +23,10 @@ module Etherlite::Abi
 
     private
 
+    def unlinked_binary
+      @artifact['unlinked_binary'] || ''
+    end
+
     def abi_definitions
       @artifact['abi'] || []
     end
@@ -52,28 +58,30 @@ module Etherlite::Abi
         end
       end
 
-      event_class.instance_variable_set(:@original_name, _definition['name'])
-      event_class.instance_variable_set(:@inputs, event_inputs)
+      define_class_getter event_class, 'original_name', _definition['name']
+      define_class_getter event_class, 'inputs', event_inputs
 
       _class.events << event_class
       _class.const_set(_definition['name'], event_class)
     end
 
-    def define_class_methods(_class)
-      unlinked_binary = @artifact['unlinked_binary'] || ''
-
+    def define_class_getter(_class, _name, _value)
       _class.class_eval do
-        define_singleton_method('unlinked_binary') { unlinked_binary }
+        define_singleton_method(_name) { _value }
       end
     end
 
     def build_function_from_definition(_definition)
       Etherlite::Contract::Function.new(
         _definition['name'],
-        _definition['inputs'].map { |input| LoadType.for signature: input['type'] },
-        _definition['outputs'].map { |input| LoadType.for signature: input['type'] },
-        _definition['payable'],
-        _definition['constant']
+        _definition['inputs'].map do |input|
+          Etherlite::Contract::FunctionInput.new(
+            input['name'], LoadType.for(signature: input['type'])
+          )
+        end,
+        (_definition['outputs'] || []).map { |input| LoadType.for signature: input['type'] },
+        _definition.fetch('payable', false),
+        _definition.fetch('constant', false)
       )
     end
   end

data/lib/etherlite/commands/abi/load_function.rb

@@ -6,7 +6,9 @@ module Etherlite::Abi
       parts = MATCHER.match @signature
       raise ArgumentError, 'invalid method signature' if parts.nil?
 
-      inputs = parts[3].split(',').map { |a| LoadType.for(signature: a.strip) }
+      inputs = parts[3].split(',').map do |a|
+        Etherlite::Contract::FunctionInput.new nil, LoadType.for(signature: a.strip)
+      end
 
       case parts[1]
       when 'payable'

data/lib/etherlite/configuration.rb

@@ -2,11 +2,12 @@ module Etherlite
   class Configuration
     DEFAULTS = {
       url: 'http://127.0.0.1:8545',
+      enable_nonce_cache: false,
       chain_id: nil, # any chain
       logger: nil # set by method
     }
 
-    attr_accessor :url, :chain_id, :logger
+    attr_accessor :url, :chain_id, :logger, :enable_nonce_cache
 
     def initialize
       assign_attributes DEFAULTS

data/lib/etherlite/contract/base.rb

@@ -1,21 +1,23 @@
 module Etherlite::Contract
-  ##
-  # The base class for etherlite contract classes
-  #
   class Base
     include Etherlite::Api::Address
 
-    # The contract's registered functions
     def self.functions
       @functions ||= []
     end
 
-    # The contract's registered events
     def self.events
       @events ||= []
     end
 
-    # The contract's compiled bytecode in binary format (stored as hex)
+    def self.unlinked_binary
+      '0x0'
+    end
+
+    def self.constructor
+      nil
+    end
+
     def self.binary
       @binary ||= begin
         if /__[^_]+_+/ === unlinked_binary
@@ -26,37 +28,19 @@ module Etherlite::Contract
       end
     end
 
-    ##
-    # Deploys the contract and waits for the creation transaction to be mined.
-    #
-    # This method can be given a source account or client. If an account is given, the it will be
-    # used to send the creation transaction. If instead a client is given, the client
-    # `default_account` will be used to send the transaction. If no account nor client is given,
-    # then the default_account from the default client will be used (if configured).
-    #
-    # @param as (Object) The source account
-    # @param client (Object) The source client (no effect if :as is given)
-    # @param timeout (Integer) The transaction mining timeout in seconds, defaults to 120 seconds.
-    #
-    # This method also takes any parameters the underlying account.send_transaction accepts, like
-    # :gas, :gas_price, etc.
-    #
-    # @return [Object] instance of the contract class pointing the newly deployed contract address.
-    #
-    def self.deploy(_options = {})
-      as = _options[:as] || _options[:client].try(:default_account) || Etherlite.default_account
-
-      tx = as.send_transaction({ data: binary }.merge(_options))
-      if tx.wait_for_block(timeout: _options.fetch(:timeout, 120))
+    def self.deploy(*_args)
+      options = _args.last.is_a?(Hash) ? _args.pop : {}
+      as = options[:as] || options[:client].try(:default_account) || Etherlite.default_account
+
+      tx_data = binary
+      tx_data += constructor.encode(_args) unless constructor.nil?
+
+      tx = as.send_transaction({ data: tx_data }.merge(options))
+      if tx.wait_for_block(timeout: options.fetch(:timeout, 120))
         at tx.contract_address, as: as
       end
     end
 
-    ##
-    # Creates a new instance of the contract class that points to a given address.
-    #
-    #
-    #
     def self.at(_address, client: nil, as: nil)
       _address = Etherlite::Utils.normalize_address_param _address
 
@@ -76,11 +60,6 @@ module Etherlite::Contract
       @default_account = _default_account
     end
 
-    ##
-    # Searches for event logs emitted by this contract
-    #
-    #
-    #
     def get_logs(events: nil, from_block: :earliest, to_block: :latest)
       params = {
         address: json_encoded_address,

data/lib/etherlite/contract/event_base.rb

@@ -3,17 +3,17 @@ require 'etherlite/commands/contract/event_base/decode_log_inputs'
 module Etherlite::Contract
   class EventBase
     def self.inputs
-      @inputs
+      nil # To be implemented by sub classes
     end
 
     def self.original_name
-      @original_name
+      nil # To be implemented by sub classes
     end
 
     def self.signature
       @signature ||= begin
-        input_sig = @inputs.map { |i| i.type.signature }
-        "#{@original_name}(#{input_sig.join(',')})"
+        input_sig = inputs.map { |i| i.type.signature }
+        "#{original_name}(#{input_sig.join(',')})"
       end
     end
 

data/lib/etherlite/contract/function.rb

@@ -31,10 +31,14 @@ module Etherlite::Contract
         raise ArgumentError, "Expected #{@inputs.count} arguments, got #{_values.length} "
       end
 
-      signature_hash = Etherlite::Utils.sha3 signature
-      encoded_inputs = Etherlite::Support::Array.encode(@inputs, _values)
+      encoded_inputs = Etherlite::Support::Array.encode(@inputs.map(&:type), _values)
 
-      '0x' + signature_hash[0..7] + encoded_inputs
+      if @name
+        signature_hash = Etherlite::Utils.sha3 signature
+        '0x' + signature_hash[0..7] + encoded_inputs
+      else
+        encoded_inputs # if no name is provided, just render arguments
+      end
     end
 
     def decode(_connection, _data)

data/lib/etherlite/contract/function_input.rb

@@ -0,0 +1,18 @@
+module Etherlite::Contract
+  class FunctionInput
+    attr_reader :original_name, :type
+
+    def initialize(_original_name, _type)
+      @original_name = _original_name
+      @type = _type
+    end
+
+    def signature
+      @type.signature
+    end
+
+    def name
+      @name ||= @original_name.underscore
+    end
+  end
+end

data/lib/etherlite/nonce_manager.rb

@@ -23,11 +23,11 @@ module Etherlite
 
         begin
           result = yield next_nonce
-          @@nonce_cache[_normalized_address] = next_nonce
+          @@nonce_cache[_normalized_address] = next_nonce if caching_enabled?
           return result
         rescue
           # if yield fails, cant be sure about transaction status so must rely again on observing.
-          @@nonce_cache.delete _normalized_address
+          @@nonce_cache.delete _normalized_address if caching_enabled?
           raise
         end
       end
@@ -36,9 +36,12 @@ module Etherlite
     private
 
     def last_observed_nonce_for(_normalized_address)
-      # TODO: support using tx_pool API to improve this:
-      # http://qnimate.com/calculating-nonce-for-raw-transactions-in-geth/
+      # https://github.com/ethereum/go-ethereum/issues/2736
       @connection.eth_get_transaction_count('0x' + _normalized_address, 'pending') - 1
     end
+
+    def caching_enabled?
+      Etherlite.config.enable_nonce_cache
+    end
   end
 end

data/lib/etherlite/version.rb

@@ -1,3 +1,3 @@
 module Etherlite
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etherlite
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Ignacio Baixas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-07 00:00:00.000000000 Z
+date: 2018-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: digest-sha3
@@ -205,6 +205,7 @@ files:
 - lib/etherlite/contract/event_base.rb
 - lib/etherlite/contract/event_input.rb
 - lib/etherlite/contract/function.rb
+- lib/etherlite/contract/function_input.rb
 - lib/etherlite/errors.rb
 - lib/etherlite/nonce_manager.rb
 - lib/etherlite/railtie.rb