ethlite 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dea4d9654501b9b1fa7a86477a0b509e7722975fdf29ce3c95e060750d917f7
-  data.tar.gz: 25b082b2803cb0404b39cab23b62740c716680f22d3f61825e364f9dfd387640
+  metadata.gz: ed8e8c05d930dceca2c2bf5f4b2e21ebeaaef68309b0c16474b47df667da2a89
+  data.tar.gz: 203ef7c86aa93e602028b1e0450e70c1c2c3a1388273263ce1e90fc503a18b08
 SHA512:
-  metadata.gz: 6c28f0334a44bdbb3c2b4d2f375b94ff9ee643a49aa66953eac3bcd471a78398f2c89f8f8b150f64a1d64d19c2a47590f793b4c88ab7c41c045330a44a85a06b
-  data.tar.gz: 45ff4d1b251eb7273f8fa1034b92bb2a95164796268e2d0a69d26f3567e7b806163ab7d851ef8d314d75bb61845d0117ae56fd7af089098ff43e3940dc1c7b2d
+  metadata.gz: 1527a1fccb6908164d7744e0b06772c48a18f2f67bc60068f72c7577f512d2de295e9dfe8d917c5ca3c724963396cfb02ddff0aac6611be65d79575aaa90c34f
+  data.tar.gz: 92f93f217349b9ef33b1fc1ec7c0da36e50d172e2b44e06b9b8281d008fc770b4da081ad64f46e2be1819bbb7fa423dbe14a6519da4ddae6f782d9ea9f056108

data/Manifest.txt

@@ -2,15 +2,14 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
-lib/digest/keccak256.rb
+lib/digest/keccak.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/constant.rb
 lib/ethlite/contract.rb
-lib/ethlite/rpc.rb
 lib/ethlite/utility.rb
 lib/ethlite/version.rb
+lib/jsonrpc/jsonrpc.rb

data/lib/digest/{keccak256.rb → keccak.rb}

@@ -8,8 +8,15 @@
 ## require 'digest'
 
 
+
+##
+#  note:  use KeccakLite (or KeccakZero? KeccakSHA3?) instead  of Keccak
+#          to allow usage of native w/ c-extension Keccak and "lite" version
+
+
+
 module Digest
-  class Keccak256 < Digest::Class
+  class KeccakLite < 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]
@@ -27,16 +34,18 @@ module Digest
             0x000000000000800a, 0x800000008000000a, 0x8000000080008081,
             0x8000000000008080, 0x0000000080000001, 0x8000000080008008]
 
-    def initialize
-      @size = 256 / 8
+    ## note: changed initialize to use param hash_size = 512
+    ##           do NOT hard-code only 256 bit
+    def initialize( hash_size = 512 )
+      @size = hash_size / 8
       @buffer = ''
     end
 
-    def << s
+    def <<( s )
       @buffer << s
       self
     end
-    alias update <<
+    alias_method :update, :<<
 
     def reset
       @buffer.clear
@@ -44,37 +53,40 @@ module Digest
     end
 
     def finish
-      s = Array.new 25, 0
+      s = Array.new( 25, 0 )
       width = 200 - @size * 2
+
+      ###  note: padding changed in final FIPS PUB 202 standard
+      ##           from "\x01" to "\x06"
       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*'
+      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
+        _keccak( s )
       end
 
       s.pack('Q*')[0, @size]
     end
 
     private
-    def keccak s
-      24.times.each_with_object [] do |round, a|
+    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|
+          t = a[(i + 4) % 5] ^ _rotate(a[(i + 1) % 5], 1)
+          0.step( 24, 5 ) do |j|
             s[j + i] ^= t
           end
         end
@@ -84,12 +96,12 @@ module Digest
         24.times do |i|
           j = PILN[i]
           a[0] = s[j]
-          s[j] = rotate t, ROTC[i]
+          s[j] = _rotate( t, ROTC[i] )
           t = a[0]
         end
 
         # Chi
-        0.step 24, 5 do |j|
+        0.step( 24, 5 ) do |j|
           5.times do |i|
             a[i] = s[j + i]
           end
@@ -104,8 +116,10 @@ module Digest
       end
     end
 
-    def rotate x, y
+    def _rotate( x, y )
       (x << y | x >> 64 - y) & (1 << 64) - 1
     end
-  end
-end
+
+
+  end   # class KeccakLite
+end     # module Digest

data/lib/digest/sha3.rb

@@ -6,8 +6,13 @@
 
 ## require 'digest'
 
+##
+#  note:  use SHA3Lite (or SHA3Zero? ZeroSHA3?) instead  of SHA3
+#          to allow usage of native w/ c-extension SHA3 and "lite" version
+
+
 module Digest
-  class SHA3 < Digest::Class
+  class SHA3Lite < 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]
@@ -25,16 +30,16 @@ module Digest
             0x000000000000800a, 0x800000008000000a, 0x8000000080008081,
             0x8000000000008080, 0x0000000080000001, 0x8000000080008008]
 
-    def initialize hash_size = 512
-      @size = hash_size / 8
-      @buffer = ''
+    def initialize( hash_size = 512 )
+      @size   = hash_size / 8
+      @buffer = ''     ## todo/check: make sure buffer is with encoding BINARY - why? why not?
     end
 
-    def << s
+    def <<( s )
       @buffer << s
       self
     end
-    alias update <<
+    alias_method :update, :<<
 
     def reset
       @buffer.clear
@@ -42,36 +47,40 @@ module Digest
     end
 
     def finish
-      s = Array.new 25, 0
+      s = Array.new( 25, 0 )
       width = 200 - @size * 2
 
+      ###  note: padding changed in final FIPS PUB 202 standard
+      ##           from "\x01" to "\x06"
+      padding = "\x06"
+
       buffer = @buffer
-      buffer << "\x06" << "\0" * (width - buffer.size % width)
+      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*'
+      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
+        _keccak( s )
       end
 
       s.pack('Q*')[0, @size]
     end
 
-    private
-    def keccak s
-      24.times.each_with_object [] do |round, a|
+ 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|
+          t = a[(i + 4) % 5] ^ _rotate(a[(i + 1) % 5], 1)
+          0.step( 24, 5 ) do |j|
             s[j + i] ^= t
           end
         end
@@ -81,12 +90,12 @@ module Digest
         24.times do |i|
           j = PILN[i]
           a[0] = s[j]
-          s[j] = rotate t, ROTC[i]
+          s[j] = _rotate( t, ROTC[i] )
           t = a[0]
         end
 
         # Chi
-        0.step 24, 5 do |j|
+        0.step( 24, 5 ) do |j|
           5.times do |i|
             a[i] = s[j + i]
           end
@@ -101,8 +110,9 @@ module Digest
       end
     end
 
-    def rotate x, y
+    def _rotate( x, y )
       (x << y | x >> 64 - y) & (1 << 64) - 1
     end
-  end
-end
+
+  end  # class SHA3Lite
+end    # module Digest

data/lib/ethlite/abi/abi_coder.rb

@@ -14,8 +14,11 @@ module Ethlite
 
     include Constant
 
+
     class EncodingError < StandardError; end
     class DecodingError < StandardError; end
+    class ValueError < StandardError; end
+
     class ValueOutOfBounds < ValueError; end
 
     ##

data/lib/ethlite/abi/type.rb

@@ -2,17 +2,16 @@ module Ethlite
   module Abi
   class Type
 
-    class ParseError < StandardError;
-    end
+    class ParseError < StandardError; end
+
 
-    class <<self
       ##
       # Crazy regexp to seperate out base type component (eg. uint), size (eg.
       # 256, 128x128, nil), array component (eg. [], [45], nil)
       #
-      def parse(type)
+      def self.parse( type )
 
-        return parse('uint256') if type=='trcToken'
+        return parse('uint256')   if type=='trcToken'
 
         if type =~ /^\((.*)\)((\[[0-9]*\])*)/
           return Tuple.parse $1, $2.scan(/\[[0-9]*\]/)
@@ -56,10 +55,10 @@ module Ethlite
         new(base, sub, dims.map {|x| x[1...-1].to_i})
       end
 
-      def size_type
+      def self.size_type
         @size_type ||= new('uint', 256, [])
       end
-    end
+
 
     attr :base, :sub, :dims
 
@@ -69,7 +68,7 @@ module Ethlite
     # @param dims [Array[Integer]] dimensions of array type, e.g. [1,2,0]
     #   for uint256[1][2][], [] for non-array type
     #
-    def initialize(base, sub, dims)
+    def initialize( base, sub, dims )
       @base = base
       @sub = sub
       @dims = dims
@@ -123,7 +122,7 @@ module Ethlite
 
   class Tuple < Type
 
-    def self.parse types, dims
+    def self.parse( types, dims )
 
       depth = 0
       collected = []
@@ -156,7 +155,8 @@ module Ethlite
     end
 
     attr_reader :types, :parsed_types
-    def initialize types, dims
+
+    def initialize( types, dims )
       super('tuple', '', dims)
       @types = types
       @parsed_types = types.map{|t| Type.parse t}
@@ -188,14 +188,11 @@ module Ethlite
           subtype.dynamic? ? nil : dims.last * subtype.size
         end
       end
-
-
     end
 
     def subtype
       @subtype ||= Tuple.new(types, dims[0...-1])
     end
-
   end
 
 

data/lib/ethlite/abi/utils.rb

@@ -12,16 +12,16 @@ module Abi
     def keccak256(x)
       # Digest::SHA3.new(256).digest(x)
       ## Digest::Keccak.digest(x, 256)
-      Digest::Keccak256.digest( x )
+      Digest::KeccakLite.new(256).digest( x )
     end
 
-=begin
-  ## check where required / in use - what for?
+    ## todo/check where required / in use - what for?
     def keccak512(x)
       # Digest::SHA3.new(512).digest(x)
-      Digest::Keccak.digest(x, 512)
+      # Digest::Keccak.digest(x, 512)
+      Digest::KeccakLite.new(512).digest( x )
     end
-=end
+
 
     def keccak256_rlp(x)
       keccak256 RLP.encode(x)
@@ -218,8 +218,6 @@ module Abi
     def signature_hash signature, length=64
       encode_hex(keccak256(signature))[0...length]
     end
-
-
   end
 
 end  # module Abi

data/lib/ethlite/{abi/constant.rb → constant.rb}

@@ -1,6 +1,5 @@
 
 module Ethlite
-  module Abi
   module Constant
 
     BYTE_EMPTY = "".freeze
@@ -20,13 +19,33 @@ module Ethlite
 
     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
+=begin
+   # The RLP short length limit.
+    SHORT_LENGTH_LIMIT = 56.freeze
+
+    # The RLP long length limit.
+    LONG_LENGTH_LIMIT = (256 ** 8).freeze
+
+    # The RLP primitive type offset.
+    PRIMITIVE_PREFIX_OFFSET = 0x80.freeze
+
+    # The RLP array type offset.
+    LIST_PREFIX_OFFSET = 0xc0.freeze
+
+    # The binary encoding is ASCII (8-bit).
+    BINARY_ENCODING = "ASCII-8BIT".freeze
+
+    # Infinity as constant for convenience.
+    INFINITY = (1.0 / 0.0).freeze
+
+=end
+  end  # module Constant
 end  # module Ethlite

data/lib/ethlite/contract.rb

@@ -2,6 +2,35 @@
       class ContractMethod
         include Utility
 
+
+       def self.parse_abi( abi )
+         ## convenience helper -  auto-convert to json if string passed in
+         abi = JSON.parse( abi ) if abi.is_a?( String )
+
+         name           = abi['name']
+         constant       = !!abi['constant'] || abi['stateMutability']=='view'
+         input_types    = abi['inputs']  ? abi['inputs'].map{|a| _parse_component_type( a ) } : []
+         output_types   = abi['outputs'] ? abi['outputs'].map{|a| _parse_component_type( a ) } : []
+         type           = abi['type'] || 'function'
+
+         new( name, inputs: input_types,
+                    outputs: output_types,
+                    constant: constant,
+                    type: type )
+       end
+
+       def self._parse_component_type( argument )
+        if argument['type'] =~ /^tuple((\[[0-9]*\])*)/
+          argument['components'] ? "(#{argument['components'].collect{ |c| _parse_component_type( c ) }.join(',')})#{$1}"
+                                 : "()#{$1}"
+        else
+          argument['type']
+        end
+      end
+
+
+
+
         attr_reader :abi,
                     :signature,
                     :name,
@@ -10,29 +39,19 @@
                     :output_types,
                     :constant
 
-        def initialize( abi )
-          ## convenience helper -  auto-convert to json if string passed in
-          abi = JSON.parse( abi ) if abi.is_a?( String )
+        def initialize( name, inputs:,
+                              outputs:  [],
+                              constant: true,
+                              type:     'function' )
+          @name         = name
+          @constant     = constant
+          @input_types  = inputs
+          @output_types = outputs
 
-          @abi            = abi
-          @name           = abi['name']
-          @constant       = !!abi['constant'] || abi['stateMutability']=='view'
-          @input_types    = abi['inputs']  ? abi['inputs'].map{|a| parse_component_type a } : []
-          @output_types   = abi['outputs'] ? abi['outputs'].map{|a| parse_component_type a } : nil
           @signature      = Abi::Utils.function_signature( @name, @input_types )
-          @signature_hash = Abi::Utils.signature_hash( @signature, abi['type']=='event' ? 64 : 8)
+          @signature_hash = Abi::Utils.signature_hash( @signature, type=='event' ? 64 : 8)
         end
 
-        def parse_component_type( argument )
-          if argument['type'] =~ /^tuple((\[[0-9]*\])*)/
-            argument['components'] ? "(#{argument['components'].collect{|c| parse_component_type( c ) }.join(',')})#{$1}"
-                                   : "()#{$1}"
-          else
-            argument['type']
-          end
-        end
-
-
         def do_call( rpc, contract_address, args )
           data = '0x' + @signature_hash + Abi::Utils.encode_hex(
                                            Abi::AbiCoder.encode_abi(@input_types, args) )

data/lib/ethlite/version.rb

@@ -3,7 +3,7 @@
 module Ethlite
   MAJOR = 0
   MINOR = 2
-  PATCH = 1
+  PATCH = 3
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/ethlite.rb

@@ -13,29 +13,54 @@ require 'digest'
 require 'rlp'               ## gem rlp    - see https://rubygems.org/gems/rlp
 
 ##  bundled require 'digest/keccak'     ## gem keccak - see https://rubygems.org/gems/keccak
-require 'digest/keccak256'
+require_relative 'digest/keccak'
+require_relative 'digest/sha3'
 
+require_relative 'jsonrpc/jsonrpc'
 
 
 
 ## our own code
 require_relative 'ethlite/version'    # note: let version always go first
 
+require_relative 'ethlite/constant'
+
 
 require_relative 'ethlite/abi/type'
-require_relative 'ethlite/abi/constant'
-require_relative 'ethlite/abi/exceptions'
 require_relative 'ethlite/abi/utils'
 require_relative 'ethlite/abi/abi_coder'
 
 
-require_relative 'ethlite/rpc'
-
 require_relative 'ethlite/utility'
 require_relative 'ethlite/contract'
 
 
 
+
+module Ethlite
+class Configuration
+  def rpc()       @rpc || JsonRpc.new( ENV['INFURA_URI'] ); end
+  def rpc=(value)
+    @rpc =   if value.is_a?( String )
+                 JsonRpc.new( value )   ## auto-wrap in (built-in/simple) jsonrpc client/serverproxy
+             else
+                value
+             end
+  end
+end # class Configuration
+
+
+## lets you use
+##   Ethlite.configure do |config|
+##      config.rpc = Ethlite::Rpc.new( ENV['INFURA_URI'] )
+##   end
+def self.configure() yield( config ); end
+def self.config()    @config ||= Configuration.new;  end
+end  # module Ethlite
+
+
+
+
 ## add convenience alternate spelling
 EthLite      = Ethlite
 

data/lib/{ethlite/rpc.rb → jsonrpc/jsonrpc.rb}

@@ -1,12 +1,20 @@
-  module Ethlite
 
-    class Rpc
+###
+#  simple JsonRpc client
+#
+#  see   https://www.jsonrpc.org/specification
+#        https://en.wikipedia.org/wiki/JSON-RPC
+
+
+
+class JsonRpc
       def initialize( uri )
         @client_id = Random.rand( 10000000 )
 
         @uri = URI.parse( uri )
       end
 
+
       def request( method, params=[] )
         opts = {}
         if @uri.instance_of?( URI::HTTPS )
@@ -29,9 +37,12 @@
           request.body = json
           response = http.request( request )
 
-          raise "Error code #{response.code} on request #{@uri.to_s} #{request.body}" unless response.kind_of?( Net::HTTPOK )
+          unless response.kind_of?( Net::HTTPOK )
+            raise "Error code #{response.code} on request #{@uri.to_s} #{request.body}"
+          end
+
 
-          body = JSON.parse(response.body, max_nesting: 1500)
+          body = JSON.parse( response.body, max_nesting: 1500 )
 
           if body['result']
             body['result']
@@ -42,7 +53,5 @@
           end
         end
       end
-    end  # class Rpc
-
-end # module Ethlite
+end  # class JsonRpc
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ethlite
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2022-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos
@@ -86,18 +86,17 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
-- lib/digest/keccak256.rb
+- lib/digest/keccak.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/constant.rb
 - lib/ethlite/contract.rb
-- lib/ethlite/rpc.rb
 - lib/ethlite/utility.rb
 - lib/ethlite/version.rb
+- lib/jsonrpc/jsonrpc.rb
 homepage: https://github.com/pixelartexchange/artbase
 licenses:
 - Public Domain

data/lib/ethlite/abi/exceptions.rb

@@ -1,29 +0,0 @@
-
-module Ethlite
-  module Abi
-
-  class DeprecatedError < StandardError; end
-  class ChecksumError < StandardError; end
-  class FormatError < StandardError; end
-  class ValidationError < StandardError; end
-  class ValueError < StandardError; end
-  class AssertError < StandardError; end
-
-  class UnknownParentError < StandardError; end
-  class InvalidBlock < ValidationError; end
-  class InvalidUncles < ValidationError; end
-
-  class InvalidTransaction < ValidationError; end
-  class UnsignedTransactionError < InvalidTransaction; end
-  class InvalidNonce < InvalidTransaction; end
-  class InsufficientStartGas < InvalidTransaction; end
-  class InsufficientBalance < InvalidTransaction; end
-  class BlockGasLimitReached < InvalidTransaction; end
-
-  class InvalidSPVProof < ValidationError; end
-
-  class ContractCreationFailed < StandardError; end
-  class TransactionFailed < StandardError; end
-
-end  # module Abi
-end  # module Ethlite