ethlite 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 782c6115c725eaefb922c2486832197ddeb44473d21d74e9b8f27de9986aef63
-  data.tar.gz: 30db801b21cc0fb703ba78908470b5e6ea9b2741768b03caf7a01bd7a772734a
+  metadata.gz: 5dea4d9654501b9b1fa7a86477a0b509e7722975fdf29ce3c95e060750d917f7
+  data.tar.gz: 25b082b2803cb0404b39cab23b62740c716680f22d3f61825e364f9dfd387640
 SHA512:
-  metadata.gz: 3babcd1abc28ba676df94e7afe53cf3ea7880a4b69e112c85ab12b6f6d226b63424e5cebe7678e91b0c34f2ed4da6bbcf3e88eb401d9e3ac7375ef38592f4bbf
-  data.tar.gz: 34c38f561121d5ad42070b2fbadc6899cc94b1e8ecf4a6f695f71a1a5166f98211fbe572a7a0b2d9d111407ef1b4fcf7058d2f58aca81d5e1e4662b834cd7f77
+  metadata.gz: 6c28f0334a44bdbb3c2b4d2f375b94ff9ee643a49aa66953eac3bcd471a78398f2c89f8f8b150f64a1d64d19c2a47590f793b4c88ab7c41c045330a44a85a06b
+  data.tar.gz: 45ff4d1b251eb7273f8fa1034b92bb2a95164796268e2d0a69d26f3567e7b806163ab7d851ef8d314d75bb61845d0117ae56fd7af089098ff43e3940dc1c7b2d

data/Manifest.txt

@@ -2,5 +2,15 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
+lib/digest/keccak256.rb
+lib/digest/sha3.rb
 lib/ethlite.rb
+lib/ethlite/abi/abi_coder.rb
+lib/ethlite/abi/constant.rb
+lib/ethlite/abi/exceptions.rb
+lib/ethlite/abi/type.rb
+lib/ethlite/abi/utils.rb
+lib/ethlite/contract.rb
+lib/ethlite/rpc.rb
+lib/ethlite/utility.rb
 lib/ethlite/version.rb

data/Rakefile

@@ -20,6 +20,8 @@ Hoe.spec 'ethlite' do
 
   self.extra_deps = [
     ['cocos'],
+    ## ['keccak'],  -- try using bundled ruby version for now
+    ['rlp'],
   ]
 
   self.licenses = ['Public Domain']

data/lib/digest/keccak256.rb

@@ -0,0 +1,111 @@
+###
+#  use a "vendor" bundled   keccak 256 in all ruby (no c-extensions required)
+#
+#   see  https://github.com/evtaylor/keccak256
+
+
+
+## require 'digest'
+
+
+module Digest
+  class Keccak256 < Digest::Class
+    PILN = [10,  7, 11, 17, 18,  3,  5, 16,
+             8, 21, 24,  4, 15, 23, 19, 13,
+            12,  2, 20, 14, 22,  9,  6,  1]
+
+    ROTC = [ 1,  3,  6, 10, 15, 21, 28, 36,
+            45, 55,  2, 14, 27, 41, 56,  8,
+            25, 43, 62, 18, 39, 61, 20, 44]
+
+    RNDC = [0x0000000000000001, 0x0000000000008082, 0x800000000000808a,
+            0x8000000080008000, 0x000000000000808b, 0x0000000080000001,
+            0x8000000080008081, 0x8000000000008009, 0x000000000000008a,
+            0x0000000000000088, 0x0000000080008009, 0x000000008000000a,
+            0x000000008000808b, 0x800000000000008b, 0x8000000000008089,
+            0x8000000000008003, 0x8000000000008002, 0x8000000000000080,
+            0x000000000000800a, 0x800000008000000a, 0x8000000080008081,
+            0x8000000000008080, 0x0000000080000001, 0x8000000080008008]
+
+    def initialize
+      @size = 256 / 8
+      @buffer = ''
+    end
+
+    def << s
+      @buffer << s
+      self
+    end
+    alias update <<
+
+    def reset
+      @buffer.clear
+      self
+    end
+
+    def finish
+      s = Array.new 25, 0
+      width = 200 - @size * 2
+      padding = "\x01"
+
+      buffer = @buffer
+      buffer << padding << "\0" * (width - buffer.size % width)
+      buffer[-1] = (buffer[-1].ord | 0x80).chr
+
+      0.step buffer.size - 1, width do |j|
+        quads = buffer[j, width].unpack 'Q*'
+        (width / 8).times do |i|
+          s[i] ^= quads[i]
+        end
+
+        keccak s
+      end
+
+      s.pack('Q*')[0, @size]
+    end
+
+    private
+    def keccak s
+      24.times.each_with_object [] do |round, a|
+        # Theta
+        5.times do |i|
+          a[i] = s[i] ^ s[i + 5] ^ s[i + 10] ^ s[i + 15] ^ s[i + 20]
+        end
+
+        5.times do |i|
+          t = a[(i + 4) % 5] ^ rotate(a[(i + 1) % 5], 1)
+          0.step 24, 5 do |j|
+            s[j + i] ^= t
+          end
+        end
+
+        # Rho Pi
+        t = s[1]
+        24.times do |i|
+          j = PILN[i]
+          a[0] = s[j]
+          s[j] = rotate t, ROTC[i]
+          t = a[0]
+        end
+
+        # Chi
+        0.step 24, 5 do |j|
+          5.times do |i|
+            a[i] = s[j + i]
+          end
+
+          5.times do |i|
+            s[j + i] ^= ~a[(i + 1) % 5] & a[(i + 2) % 5]
+          end
+        end
+
+        # Iota
+        s[0] ^= RNDC[round]
+      end
+    end
+
+    def rotate x, y
+      (x << y | x >> 64 - y) & (1 << 64) - 1
+    end
+  end
+end

data/lib/digest/sha3.rb

@@ -0,0 +1,108 @@
+###
+#  use a "vendor" bundled   sha3 in all ruby (no c-extensions required)
+#
+#   see  https://github.com/havenwood/sha3-pure-ruby/blob/master/lib/sha3-pure-ruby.rb
+
+
+## require 'digest'
+
+module Digest
+  class SHA3 < Digest::Class
+    PILN = [10,  7, 11, 17, 18,  3,  5, 16,
+             8, 21, 24,  4, 15, 23, 19, 13,
+            12,  2, 20, 14, 22,  9,  6,  1]
+
+    ROTC = [ 1,  3,  6, 10, 15, 21, 28, 36,
+            45, 55,  2, 14, 27, 41, 56,  8,
+            25, 43, 62, 18, 39, 61, 20, 44]
+
+    RNDC = [0x0000000000000001, 0x0000000000008082, 0x800000000000808a,
+            0x8000000080008000, 0x000000000000808b, 0x0000000080000001,
+            0x8000000080008081, 0x8000000000008009, 0x000000000000008a,
+            0x0000000000000088, 0x0000000080008009, 0x000000008000000a,
+            0x000000008000808b, 0x800000000000008b, 0x8000000000008089,
+            0x8000000000008003, 0x8000000000008002, 0x8000000000000080,
+            0x000000000000800a, 0x800000008000000a, 0x8000000080008081,
+            0x8000000000008080, 0x0000000080000001, 0x8000000080008008]
+
+    def initialize hash_size = 512
+      @size = hash_size / 8
+      @buffer = ''
+    end
+
+    def << s
+      @buffer << s
+      self
+    end
+    alias update <<
+
+    def reset
+      @buffer.clear
+      self
+    end
+
+    def finish
+      s = Array.new 25, 0
+      width = 200 - @size * 2
+
+      buffer = @buffer
+      buffer << "\x06" << "\0" * (width - buffer.size % width)
+      buffer[-1] = (buffer[-1].ord | 0x80).chr
+
+      0.step buffer.size - 1, width do |j|
+        quads = buffer[j, width].unpack 'Q*'
+        (width / 8).times do |i|
+          s[i] ^= quads[i]
+        end
+
+        keccak s
+      end
+
+      s.pack('Q*')[0, @size]
+    end
+
+    private
+    def keccak s
+      24.times.each_with_object [] do |round, a|
+        # Theta
+        5.times do |i|
+          a[i] = s[i] ^ s[i + 5] ^ s[i + 10] ^ s[i + 15] ^ s[i + 20]
+        end
+
+        5.times do |i|
+          t = a[(i + 4) % 5] ^ rotate(a[(i + 1) % 5], 1)
+          0.step 24, 5 do |j|
+            s[j + i] ^= t
+          end
+        end
+
+        # Rho Pi
+        t = s[1]
+        24.times do |i|
+          j = PILN[i]
+          a[0] = s[j]
+          s[j] = rotate t, ROTC[i]
+          t = a[0]
+        end
+
+        # Chi
+        0.step 24, 5 do |j|
+          5.times do |i|
+            a[i] = s[j + i]
+          end
+
+          5.times do |i|
+            s[j + i] ^= ~a[(i + 1) % 5] & a[(i + 2) % 5]
+          end
+        end
+
+        # Iota
+        s[0] ^= RNDC[round]
+      end
+    end
+
+    def rotate x, y
+      (x << y | x >> 64 - y) & (1 << 64) - 1
+    end
+  end
+end

data/lib/ethlite/abi/abi_coder.rb

@@ -0,0 +1,423 @@
+
+
+module Ethlite
+  module Abi
+
+  ##
+  # Contract ABI encoding and decoding.
+  #
+  # @see https://github.com/ethereum/wiki/wiki/Ethereum-Contract-ABI
+  #
+  module AbiCoder
+
+    extend self
+
+    include Constant
+
+    class EncodingError < StandardError; end
+    class DecodingError < StandardError; end
+    class ValueOutOfBounds < ValueError; end
+
+    ##
+    # Encodes multiple arguments using the head/tail mechanism.
+    #
+    def encode_abi(types, args)
+      parsed_types = types.map {|t| Type.parse(t) }
+
+      head_size = (0...args.size)
+        .map {|i| parsed_types[i].size || 32 }
+        .reduce(0, &:+)
+
+      head, tail = '', ''
+      args.each_with_index do |arg, i|
+        if parsed_types[i].dynamic?
+          head += encode_type(Type.size_type, head_size + tail.size)
+          tail += encode_type(parsed_types[i], arg)
+        else
+          head += encode_type(parsed_types[i], arg)
+        end
+      end
+
+      "#{head}#{tail}"
+    end
+    alias :encode :encode_abi
+
+    ##
+    # Encodes a single value (static or dynamic).
+    #
+    # @param type [Ethereum::ABI::Type] value type
+    # @param arg [Object] value
+    #
+    # @return [String] encoded bytes
+    #
+    def encode_type(type, arg)
+      if %w(string bytes).include?(type.base) && type.sub.empty?
+        encode_primitive_type type, arg
+      elsif type.dynamic?
+        raise ArgumentError, "arg must be an array" unless arg.instance_of?(Array)
+
+        head, tail = '', ''
+        if type.dims.last == 0
+          head += encode_type(Type.size_type, arg.size)
+        else
+          raise ArgumentError, "Wrong array size: found #{arg.size}, expecting #{type.dims.last}" unless arg.size == type.dims.last
+        end
+
+        sub_type = type.subtype
+        sub_size = type.subtype.size
+        arg.size.times do |i|
+          if sub_size.nil?
+            head += encode_type(Type.size_type, 32*arg.size + tail.size)
+            tail += encode_type(sub_type, arg[i])
+          else
+            head += encode_type(sub_type, arg[i])
+          end
+        end
+
+        "#{head}#{tail}"
+      else # static type
+        if type.dims.empty?
+          encode_primitive_type type, arg
+        else
+          arg.map {|x| encode_type(type.subtype, x) }.join
+        end
+      end
+    end
+
+    def encode_primitive_type(type, arg)
+      case type.base
+      when 'uint'
+        begin
+          real_size = type.sub.to_i
+          i = get_uint arg
+
+          raise ValueOutOfBounds, arg unless i >= 0 && i < 2**real_size
+          Utils.zpad_int i
+        rescue EncodingError
+          raise ValueOutOfBounds, arg
+        end
+      when 'bool'
+        raise ArgumentError, "arg is not bool: #{arg}" unless arg.instance_of?(TrueClass) || arg.instance_of?(FalseClass)
+        Utils.zpad_int(arg ? 1 : 0)
+      when 'int'
+        begin
+          real_size = type.sub.to_i
+          i = get_int arg
+
+          raise ValueOutOfBounds, arg unless i >= -2**(real_size-1) && i < 2**(real_size-1)
+          Utils.zpad_int(i % 2**type.sub.to_i)
+        rescue EncodingError
+          raise ValueOutOfBounds, arg
+        end
+      when 'ufixed'
+        high, low = type.sub.split('x').map(&:to_i)
+
+        raise ValueOutOfBounds, arg unless arg >= 0 && arg < 2**high
+        Utils.zpad_int((arg * 2**low).to_i)
+      when 'fixed'
+        high, low = type.sub.split('x').map(&:to_i)
+
+        raise ValueOutOfBounds, arg unless arg >= -2**(high - 1) && arg < 2**(high - 1)
+
+        i = (arg * 2**low).to_i
+        Utils.zpad_int(i % 2**(high+low))
+      when 'string'
+        if arg.encoding.name == 'UTF-8'
+          arg = arg.b
+        else
+          begin
+            arg.unpack('U*')
+          rescue ArgumentError
+            raise ValueError, "string must be UTF-8 encoded"
+          end
+        end
+
+        if type.sub.empty? # variable length type
+          raise ValueOutOfBounds, "Integer invalid or out of range: #{arg.size}" if arg.size >= TT256
+          size = Utils.zpad_int arg.size
+          value = Utils.rpad arg, BYTE_ZERO, Utils.ceil32(arg.size)
+          "#{size}#{value}"
+        else # fixed length type
+          sub = type.sub.to_i
+          raise ValueOutOfBounds, "invalid string length #{sub}" if arg.size > sub
+          raise ValueOutOfBounds, "invalid string length #{sub}" if sub < 0 || sub > 32
+          Utils.rpad(arg, BYTE_ZERO, 32)
+        end
+      when 'bytes'
+        raise EncodingError, "Expecting string: #{arg}" unless arg.instance_of?(String)
+        arg = arg.b
+
+        if type.sub.empty? # variable length type
+          raise ValueOutOfBounds, "Integer invalid or out of range: #{arg.size}" if arg.size >= TT256
+          size = Utils.zpad_int arg.size
+          value = Utils.rpad arg, BYTE_ZERO, Utils.ceil32(arg.size)
+          "#{size}#{value}"
+        else # fixed length type
+          sub = type.sub.to_i
+          raise ValueOutOfBounds, "invalid bytes length #{sub}" if arg.size > sub
+          raise ValueOutOfBounds, "invalid bytes length #{sub}" if sub < 0 || sub > 32
+          Utils.rpad(arg, BYTE_ZERO, 32)
+        end
+      when 'hash'
+        size = type.sub.to_i
+        raise EncodingError, "too long: #{arg}" unless size > 0 && size <= 32
+
+        if arg.is_a?(Integer)
+          Utils.zpad_int(arg)
+        elsif arg.size == size
+          Utils.zpad arg, 32
+        elsif arg.size == size * 2
+          Utils.zpad_hex arg
+        else
+          raise EncodingError, "Could not parse hash: #{arg}"
+        end
+      when 'address'
+        if arg.is_a?(Integer)
+          Utils.zpad_int arg
+        elsif arg.size == 20
+          Utils.zpad arg, 32
+        elsif arg.size == 40
+          Utils.zpad_hex arg
+        elsif arg.size == 42 && arg[0,2] == '0x'
+          Utils.zpad_hex arg[2..-1]
+        else
+          raise EncodingError, "Could not parse address: #{arg}"
+        end
+      else
+        raise EncodingError, "Unhandled type: #{type.base} #{type.sub}"
+      end
+    end
+
+
+    def min_data_size types
+      types.size*32
+    end
+
+    ##
+    # Decodes multiple arguments using the head/tail mechanism.
+    #
+    def decode_abi types, data, raise_errors = false
+      parsed_types = types.map {|t| Type.parse(t) }
+
+      outputs = [nil] * types.size
+      start_positions = [nil] * types.size + [data.size]
+
+      # TODO: refactor, a reverse iteration will be better
+      pos = 0
+      parsed_types.each_with_index do |t, i|
+        # If a type is static, grab the data directly, otherwise record its
+        # start position
+        if t.dynamic?
+
+          if raise_errors && pos>data.size-1
+            raise DecodingError, "Position out of bounds #{pos}>#{data.size-1}"
+          end
+
+          start_positions[i] = Utils.big_endian_to_int(data[pos, 32])
+
+          if raise_errors && start_positions[i]>data.size-1
+            raise DecodingError, "Start position out of bounds #{start_positions[i]}>#{data.size-1}"
+          end
+
+          j = i - 1
+          while j >= 0 && start_positions[j].nil?
+            start_positions[j] = start_positions[i]
+            j -= 1
+          end
+
+          pos += 32
+        else
+          outputs[i] = zero_padding data, pos, t.size, start_positions
+          pos += t.size
+        end
+      end
+
+      # We add a start position equal to the length of the entire data for
+      # convenience.
+      j = types.size - 1
+      while j >= 0 && start_positions[j].nil?
+        start_positions[j] = start_positions[types.size]
+        j -= 1
+      end
+
+      if raise_errors && pos > data.size
+        raise DecodingError, "Not enough data for head"
+      end
+
+
+      parsed_types.each_with_index do |t, i|
+        if t.dynamic?
+          offset, next_offset = start_positions[i, 2]
+          if offset<=data.size && next_offset<=data.size
+            outputs[i] = data[offset...next_offset]
+          end
+        end
+      end
+
+      if raise_errors && outputs.include?(nil)
+        raise DecodingError, "Not all data can be parsed"
+      end
+
+      parsed_types.zip(outputs).map {|(type, out)| decode_type(type, out) }
+    end
+    alias :decode :decode_abi
+
+    def zero_padding data, pos, count, start_positions
+      if pos >= data.size
+        start_positions[start_positions.size-1] += count
+        "\x00"*count
+      elsif pos + count > data.size
+        start_positions[start_positions.size-1] += ( count - (data.size-pos))
+        data[pos,data.size-pos] + "\x00"*( count - (data.size-pos))
+      else
+        data[pos, count]
+      end
+    end
+
+    def decode_typed_data type_name, data
+      decode_primitive_type Type.parse(type_name), data
+    end
+
+    def decode_type(type, arg)
+      return nil if arg.nil? || arg.empty?
+      if type.kind_of?(Tuple) && type.dims.empty?
+        arg ? decode_abi(type.types, arg) : []
+      elsif %w(string bytes).include?(type.base) && type.sub.empty?
+        l = Utils.big_endian_to_int arg[0,32]
+        data = arg[32..-1]
+        data[0, l]
+      elsif !type.dims.empty? && (l = type.dims.last)>0 # static-sized arrays
+        subtype = type.subtype
+        if subtype.dynamic?
+          start_positions = (0...l).map {|i| Utils.big_endian_to_int(arg[32*i, 32]) }
+          start_positions.push arg.size
+
+          outputs = (0...l).map {|i| arg[start_positions[i]...start_positions[i+1]] }
+
+          outputs.map {|out| decode_type(subtype, out) }
+        else
+          (0...l).map {|i| decode_type(subtype, arg[subtype.size*i, subtype.size]) }
+        end
+
+      elsif type.dynamic?
+        l = Utils.big_endian_to_int arg[0,32]
+        raise DecodingError, "Too long length: #{l}" if l>100000
+        subtype = type.subtype
+
+        if subtype.dynamic?
+          raise DecodingError, "Not enough data for head" unless arg.size >= 32 + 32*l
+
+          start_positions = (1..l).map {|i| 32+Utils.big_endian_to_int(arg[32*i, 32]) }
+          start_positions.push arg.size
+
+          outputs = (0...l).map {|i| arg[start_positions[i]...start_positions[i+1]] }
+
+          outputs.map {|out| decode_type(subtype, out) }
+        else
+          (0...l).map {|i| decode_type(subtype, arg[32 + subtype.size*i, subtype.size]) }
+        end
+
+      else
+        decode_primitive_type type, arg
+      end
+    end
+
+    def decode_primitive_type(type, data)
+      case type.base
+      when 'address'
+        Utils.encode_hex data[12..-1]
+      when 'string', 'bytes'
+        if type.sub.empty? # dynamic
+          if data.length==32
+            data[0..32]
+          else
+            size = Utils.big_endian_to_int data[0,32]
+            data[32..-1][0,size]
+          end
+        else # fixed
+          data[0, type.sub.to_i]
+        end
+      when 'hash'
+        data[(32 - type.sub.to_i), type.sub.to_i]
+      when 'uint'
+        Utils.big_endian_to_int data
+      when 'int'
+        u = Utils.big_endian_to_int data
+        u >= 2**(type.sub.to_i-1) ? (u - 2**type.sub.to_i) : u
+      when 'ufixed'
+        high, low = type.sub.split('x').map(&:to_i)
+        Utils.big_endian_to_int(data) * 1.0 / 2**low
+      when 'fixed'
+        high, low = type.sub.split('x').map(&:to_i)
+        u = Utils.big_endian_to_int data
+        i = u >= 2**(high+low-1) ? (u - 2**(high+low)) : u
+        i * 1.0 / 2**low
+      when 'bool'
+        data[-1] == BYTE_ONE
+      else
+        raise DecodingError, "Unknown primitive type: #{type.base}"
+      end
+    end
+
+    private
+
+    def get_uint(n)
+      case n
+      when Integer
+        raise EncodingError, "Number out of range: #{n}" if n > UINT_MAX || n < UINT_MIN
+        n
+      when String
+        i = if n.size == 40
+              Utils.decode_hex(n)
+            elsif n.size <= 32
+              n
+            else
+              raise EncodingError, "String too long: #{n}"
+            end
+        i = Utils.big_endian_to_int i
+
+        raise EncodingError, "Number out of range: #{i}" if i > UINT_MAX || i < UINT_MIN
+        i
+      when true
+        1
+      when false, nil
+        0
+      else
+        raise EncodingError, "Cannot decode uint: #{n}"
+      end
+    end
+
+    def get_int(n)
+      case n
+      when Integer
+        raise EncodingError, "Number out of range: #{n}" if n > INT_MAX || n < INT_MIN
+        n
+      when String
+        i = if n.size == 40
+              Utils.decode_hex(n)
+            elsif n.size <= 32
+              n
+            else
+              raise EncodingError, "String too long: #{n}"
+            end
+        i = Utils.big_endian_to_int i
+
+        i = i > INT_MAX ? (i-TT256) : i
+        raise EncodingError, "Number out of range: #{i}" if i > INT_MAX || i < INT_MIN
+        i
+      when true
+        1
+      when false, nil
+        0
+      else
+        raise EncodingError, "Cannot decode int: #{n}"
+      end
+    end
+
+  end
+
+end  # module Abi
+end  # module Ethlite
+
+
+

data/lib/ethlite/abi/constant.rb

@@ -0,0 +1,32 @@
+
+module Ethlite
+  module Abi
+  module Constant
+
+    BYTE_EMPTY = "".freeze
+    BYTE_ZERO  = "\x00".freeze
+    BYTE_ONE   = "\x01".freeze
+
+    TT32   = 2**32
+    TT40   = 2**40
+    TT160  = 2**160
+    TT256  = 2**256
+    TT64M1 = 2**64 - 1
+
+    UINT_MAX = 2**256 - 1
+    UINT_MIN = 0
+    INT_MAX  = 2**255 - 1
+    INT_MIN  = -2**255
+
+    HASH_ZERO = ("\x00"*32).freeze
+
+    PUBKEY_ZERO = ("\x00"*32).freeze
+    PRIVKEY_ZERO = ("\x00"*32).freeze
+    PRIVKEY_ZERO_HEX = ('0'*64).freeze
+
+    CONTRACT_CODE_SIZE_LIMIT = 0x6000
+
+  end
+
+end  # module Abi
+end  # module Ethlite