etheruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 12c070c1b68b2effbf8d546fe905fd3d184bc26f
+  data.tar.gz: de4aa5107ea7cd347aabed1848eec9fb9f612f0d
+SHA512:
+  metadata.gz: 0c914deee7b439f63d11111e3fe16be892e18da1d115722faab9505ee965d1905ce0d361f6599e8920521237bea1578525e0772278b0cfdb19ef424511c12457
+  data.tar.gz: 2424d20153c2fa7c0a818c347e9535b197843c8d01d9a36d9f32cb2d285cb3685ed82b653dec7f244e2479806d2a006be2ee3c17ea5cdb93d99cb5f5aa603cc8

data/lib/etheruby.rb

@@ -0,0 +1,67 @@
+require 'logger'
+
+require_relative 'etheruby/client'
+require_relative 'etheruby/contract_method_dsl'
+require_relative 'etheruby/arguments_generator'
+
+module Etheruby
+  class NoContractMethodError < StandardError; end
+
+  def contract
+    Class.new do
+        def self.inherited(subclass)
+          @@c_methods = {}
+          @@logger = ::Logger.new(STDOUT)
+          @@logger.level = if ENV.has_key? 'ETHERUBY_DEBUG'
+            ::Logger::DEBUG
+          else
+            ::Logger::WARN
+          end
+          @@logger.progname = "Etheruby Contract '#{subclass.name}'"
+        end
+
+        def self.at_address(address)
+          @@address = address
+        end
+
+        def self.method(name, &blk)
+          cmd = ContractMethodDSL.new(name)
+          cmd.instance_exec &blk if blk
+          @@c_methods[name] = cmd.validate!
+          @@logger.debug("Registred method #{name}")
+        end
+
+        def self.method_missing(sym, *args)
+          raise NoContractMethodError.new (
+            "The method #{sym} does not exist in the #{self.class.to_s} contract."
+          ) unless @@c_methods.include? sym
+          execute_contract_method(@@c_methods[sym], args)
+        end
+
+        def self.execute_contract_method(method_info, args)
+          arguments = ArgumentsGenerator.new(method_info[:params], args).to_s
+          data = "#{method_info[:signature]}#{arguments}"
+          composed_body = { to: self.address, data: data }
+          [ :gas, :gasPrice, :value, :from ].each { |kw|
+            composed_body[kw] = method_info[kw] if method_info.has_key? kw
+          }
+          @@logger.debug("Calling #{method_info[:name]} with parameters #{composed_body.inspect}")
+          response = Client.eth.call composed_body, "latest"
+          if response.has_key? 'error'
+            @@logger.error("Failed contract execution #{response['error']['message']}")
+          else
+            @@logger.debug("Response from API for #{method_info[:name]} : #{response.inspect}")
+          end
+          response['result']
+        end
+
+        def self.address
+          "0x#{@@address.to_s(16)}"
+        end
+    end
+  end
+
+  module_function :contract
+
+  Contract = Etheruby::contract
+end

data/lib/etheruby/arguments_generator.rb

@@ -0,0 +1,118 @@
+module Etheruby
+
+  class IncorrectTypeError < StandardError; end
+  class ArgumentsCountError < StandardError; end
+
+  # https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI
+  class ArgumentsGenerator
+
+    attr_reader :params, :args
+
+    def initialize(params, args)
+      @params = params
+      @args = args
+    end
+
+    def is_sized_type(param)
+      param.to_s.match /^([a-z]+)(\d+)$/
+    end
+
+    def is_static_array_type(param)
+      param.to_s.match(/^([a-z]+)\[(\d+)\]$/)
+    end
+
+    def is_dynamic_array_type(param)
+      param.to_s.match(/^([a-z]+)\[\]$/)
+    end
+
+    def to_s
+      raise ArgumentsCountError.new unless params.count == args.count
+      arguments = ""
+      # For each parameter of the method called, we
+      # match the corresponding type to encode and we send the
+      # parameter given to this encoder
+      (0..params.count-1).each do |i|
+        param, arg = params[i], args[i]
+        if match = is_sized_type(param)
+          # Parameter is a sized type, e.g. uint256, byte32 ...
+          method_name = "#{match[1]}_encode".to_sym
+          if respond_to?(method_name)
+            arguments += send(method_name, match[2].to_i, arg)
+          else
+            raise IncorrectTypeError.new("Type #{param} cannot be encoded")
+          end
+        elsif match = is_static_array_type(param)
+          # Parameter is a staticly sized array type, e.g. uint256[24]
+          arguments += static_array(match[1], match[2].to_i, arg)
+        elsif match = is_dynamic_array_type(param)
+          # Parameter is a dynamicaly sized array type, e.g. uint256[]
+          arguments += dynamic_array(match[1], arg)
+        else
+          # Parameter is a single-word type : string, bytes, address etc...
+          method_name = "#{param}_encode".to_sym
+          if respond_to?(method_name)
+            arguments += send(method_name, arg)
+          else
+            raise IncorrectTypeError.new("Type #{param} cannot be encoded")
+          end
+        end
+      end
+      arguments
+    end
+
+    ##
+    # int<X> encoding
+    def int_encode(size, arg)
+      if arg >= 0
+          arg.to_s(16).rjust(size / 4, '0')
+      else
+          mask = (1 << size) - 1
+          (arg & mask).to_s(16)
+      end
+    end
+
+    ##
+    # uint<X> encoding
+    def uint_encode(size, arg)
+      arg.to_s(16).rjust(size / 4,'0')
+    end
+
+    def fixed_encode(size, arg)
+      #Todo
+    end
+
+    def ufixed_encode(size, arg)
+      #Todo
+    end
+
+    def byte_encode(size, arg)
+      arg.map{ |b| b.to_s(16) }.join.rjust(size,'0')
+    end
+
+    def static_array(type, size, arg)
+      #Todo
+    end
+
+    def dynamic_array(type, arg)
+      #Todo
+    end
+
+    def address_encode(arg)
+      uint_encode(160, arg)
+    end
+
+    def string_encode(arg)
+      #Todo
+    end
+
+    def bytes_encode(arg)
+      #Todo
+    end
+
+    def bool_encode(arg)
+      #Todo
+    end
+
+  end
+
+end

data/lib/etheruby/client.rb

@@ -0,0 +1,36 @@
+require 'net/http'
+require 'uri'
+require 'multi_json'
+
+module Etheruby
+
+  class Client
+    def self.uri=(_uri)
+      @@uri = URI.parse(_uri)
+    end
+    def self.method_missing(sym)
+      @@uri ||= URI.parse('http://localhost:8545/')
+      ClientHolder.new(@@uri,sym)
+    end
+  end
+
+  class ClientHolder
+    def initialize(uri,sym)
+      @uri = uri
+      @sym = sym
+    end
+    def method_missing(sym, *data)
+      body = { 'id' => 'jsonrpc', 'method' => "#{@sym}_#{sym}", 'params' => data }
+      text_response = http_post_request(::MultiJson.dump(body))
+      ::MultiJson.load(text_response)
+    end
+    def http_post_request(post_body)
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      request = Net::HTTP::Post.new(@uri.request_uri)
+      request.content_type = 'application/json'
+      request.body = post_body
+      http.request(request).body
+    end
+  end
+
+end

data/lib/etheruby/contract_method_dsl.rb

@@ -0,0 +1,42 @@
+require 'digest/sha3'
+
+module Etheruby
+
+  class ContractMethodDSL
+
+    attr_reader :data
+
+    def initialize(name)
+      @data = { name: name }
+    end
+
+    def parameters(*args)
+      data[:params] = args
+    end
+
+    def array(type, size=nil)
+      if size
+        "#{type}[#{size}]"
+      else
+        "#{type}[]"
+      end
+    end
+
+    def returns(*args)
+      data[:returns] = args
+    end
+
+    def method_missing(sym, *args)
+      data[sym] = args[0]
+    end
+
+    def validate!
+      data[:params] = [] unless data.has_key? :params
+      signature = "#{@data[:name]}(#{data[:params].join(',')})"
+      data[:signature] = "0x#{Digest::SHA3.hexdigest(signature,256)[0..7]}"
+      data
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: etheruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jérémy SEBAN
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: digest-sha3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Describe ethereum smart-contract and execute them with ease.
+email: jeremy@seban.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/etheruby.rb
+- lib/etheruby/arguments_generator.rb
+- lib/etheruby/client.rb
+- lib/etheruby/contract_method_dsl.rb
+homepage: https://github.com/MechanicalSloth/etheruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: 'Etheruby : Ethereum smart-contract classy-describer for Ruby.'
+test_files: []