eth 0.5.2 → 0.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16b9900b6e0bd1a0bb51d055b545980685416a1e079590196fa9637e1c3e758e
-  data.tar.gz: db3a4a72a0b14458dee3f4af836ac32bfc6ccf987b22e9f965551ddacecb09de
+  metadata.gz: 62da01e731dd3a73a356760ac971250f193142090876e62567d73cbb5664213d
+  data.tar.gz: 8a951b1b585acd7b58dc327f122dbdd4787145fefbe09d71f1aa4d127787e99e
 SHA512:
-  metadata.gz: 90a00773ef20cdf765c19da284b09f20577fbaf26707d7b425f68109be9d559805603eabfd699c7ff68a56ac8d7619ecdaa841233a0d6af9bbd14521238a18e0
-  data.tar.gz: 80127ab21325d386fbef1e57b13a1a5e769882d174114255b938babfd35c9e84ae3515ae28ace04300dfa38eb2059cb4eb529699378e9c354c5ed73d2ae0c6ce
+  metadata.gz: fd1ca2d9f89a545f20cf23a9cff62a83bfe20514b69cb14aac88f08cd101a8bb9e26ba700539259c16d64ee2a3cbae46adf7bedd18b66835785ad701fd515681
+  data.tar.gz: a1f51f0dac47d8ce7a4ccd3df0d3decfdb0847df36a4b16587b5dd9ae217aee7375e952207d00611bcb487647ff152d958d4709ebf8b429ec0235220f45d35bd

data/.github/dependabot.yml

@@ -0,0 +1,18 @@
+---
+updates:
+  -
+    directory: /
+    labels:
+      - dependencies
+    package-ecosystem: bundler
+    schedule:
+      interval: weekly
+    versioning-strategy: increase
+  -
+    directory: /
+    labels:
+      - operations
+    package-ecosystem: github-actions
+    schedule:
+      interval: monthly
+version: 2

data/.github/workflows/codeql.yml

@@ -24,15 +24,15 @@ jobs:
           - ruby
     steps:
       - name: "Checkout repository"
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: "Initialize CodeQL"
-        uses: github/codeql-action/init@v1
+        uses: github/codeql-action/init@v2
         with:
           languages: "${{ matrix.language }}"
       - name: Autobuild
-        uses: github/codeql-action/autobuild@v1
+        uses: github/codeql-action/autobuild@v2
       - name: "Perform CodeQL Analysis"
-        uses: github/codeql-action/analyze@v1
+        uses: github/codeql-action/analyze@v2
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '2.7'

data/.github/workflows/docs.yml

@@ -10,7 +10,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: '2.7'
@@ -20,7 +20,7 @@ jobs:
         gem install yard
         yard doc
     - name: Deploy GH Pages
-      uses: JamesIves/github-pages-deploy-action@4.1.7
+      uses: JamesIves/github-pages-deploy-action@v4.3.3
       with:
           branch: gh-pages
           folder: doc/

data/.github/workflows/spec.yml

@@ -19,9 +19,9 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby: ['2.7', '3.0']
+        ruby: ['2.7', '3.1']
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}

data/AUTHORS.txt

@@ -2,6 +2,8 @@ The Ruby-Eth Contributors are:
 * Steve Ellis @se3000
 * Afri Schoedon @q9f
 * John Omar @chainoperator
+* Joshua Peek @josh
+* Yuta Kurotaki @kurotaky
 
 See also:
 * https://github.com/q9f/eth.rb/graphs/contributors

data/CHANGELOG.md

@@ -1,20 +1,60 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.5.4]
+### Added
+- Eth/client: method for eip-1271 ([#80](https://github.com/q9f/eth.rb/pull/80))
+
+### Changed
+- Docs: update changelog ([#77](https://github.com/q9f/eth.rb/pull/77))
+- Gem: bump version to 0.5.4 ([#78](https://github.com/q9f/eth.rb/pull/78))
+- Ci: bump ruby version to 3.1 on ci ([#79](https://github.com/q9f/eth.rb/pull/79))
+- Fix typos ([#81](https://github.com/q9f/eth.rb/pull/81))
+- Eth/contract: allow creating from file, abi, bin ([#83](https://github.com/q9f/eth.rb/pull/83))
+- Eth/client: fix account requirement for client.call() ([#85](https://github.com/q9f/eth.rb/pull/85))
+- Add dependency support for openssl 2.2 and greater, including 3.x ([#88](https://github.com/q9f/eth.rb/pull/88))
+
+## [0.5.3]
+### Added
+- Smart contract support ([#68](https://github.com/q9f/eth.rb/pull/68))
+
+### Changed
+- Eth/abi: decode event log ([#69](https://github.com/q9f/eth.rb/pull/69))
+- Gem: bump version ([#70](https://github.com/q9f/eth.rb/pull/70))
+- Eth/abi/event: batch log decoder ([#71](https://github.com/q9f/eth.rb/pull/71))
+
+## [0.5.2]
+### Added
+- Eth/solidity: add solidity compiler bindings ([#66](https://github.com/q9f/eth.rb/pull/66))
+
+### Changed
+- Eth: remove duplicated code ([#62](https://github.com/q9f/eth.rb/pull/62))
+- Ci: allow coverage to drop to 99% without failing ([#63](https://github.com/q9f/eth.rb/pull/63))
+- Docs: update readme ([#64](https://github.com/q9f/eth.rb/pull/64))
+- Docs: add wiki to readme ([#65](https://github.com/q9f/eth.rb/pull/65))
+
 ## [0.5.1]
+### Added
+- Add eth::rlp module ([#52](https://github.com/q9f/eth.rb/pull/52))
+- Eth/client: implement http/ipc ([#37](https://github.com/q9f/eth.rb/pull/37))
+
 ### Changed
 - Docs: update changelog ([#61](https://github.com/q9f/eth.rb/pull/61))
 - Eth/chain: add sepolia chain id; docs ([#60](https://github.com/q9f/eth.rb/pull/60))
 - Eth/rlp: cleanup ([#59](https://github.com/q9f/eth.rb/pull/59))
-- Add eth::rlp module ([#52](https://github.com/q9f/eth.rb/pull/52))
 - Eth/tx: properly serialize signatures ([#58](https://github.com/q9f/eth.rb/pull/58))
 - Eth/client: fix legacy transfer ([#57](https://github.com/q9f/eth.rb/pull/57))
 - Gem: relax openssl requirement ([#56](https://github.com/q9f/eth.rb/pull/56))
-- Eth/client: implement http/ipc ([#37](https://github.com/q9f/eth.rb/pull/37))
 - Docs: update changelog ([#53](https://github.com/q9f/eth.rb/pull/53))
 - Spec: add upstream test fixtures for keystore ([#50](https://github.com/q9f/eth.rb/pull/50))
 
 ## [0.5.0]
+### Added
+- Eth/tx: create legacy, type-1, and type-2 transactions [#33](https://github.com/q9f/eth.rb/pull/33)
+- Signature: implement eip 712 typed structured data signing [#27](https://github.com/q9f/eth.rb/pull/27)
+- Lib: import ABI to eth/abi [#29](https://github.com/q9f/eth.rb/pull/29)
+- Eth/chains: implement eip 155 for replay protection [#20](https://github.com/q9f/eth.rb/pull/20)
+
 ### Changed
 - Docs: update readme with features [#49](https://github.com/q9f/eth.rb/pull/49)
 - Eth/tx: add method to estimate intrinsic gas costs [#48](https://github.com/q9f/eth.rb/pull/48)
@@ -26,16 +66,12 @@ All notable changes to this project will be documented in this file.
 - Lib: improve error handling [#39](https://github.com/q9f/eth.rb/pull/39)
 - Docs: update readme for tx and keys [#40](https://github.com/q9f/eth.rb/pull/40)
 - Implement encrypt/decrypt [#22](https://github.com/q9f/eth.rb/pull/22)
-- Eth/tx: create legacy, type-1, and type-2 transactions [#33](https://github.com/q9f/eth.rb/pull/33)
 - Gem: clean up some docs and scripts [#32](https://github.com/q9f/eth.rb/pull/32)
-- Signature: implement eip 712 typed structured data signing [#27](https://github.com/q9f/eth.rb/pull/27)
-- Lib: import ABI to eth/abi [#29](https://github.com/q9f/eth.rb/pull/29)
 - Rename util and chain to singular [#26](https://github.com/q9f/eth.rb/pull/26)
 - Docs: add some examples to readme [#25](https://github.com/q9f/eth.rb/pull/25)
 - Key/signature: personal sign and verify [#24](https://github.com/q9f/eth.rb/pull/24)
 - Ci: only run coverage on CI [#23](https://github.com/q9f/eth.rb/pull/23)
 - Lib/signature: implement personal_recover (eip 191 [#21](https://github.com/q9f/eth.rb/pull/21)
-- Eth/chains: implement eip 155 for replay protection [#20](https://github.com/q9f/eth.rb/pull/20)
 - Eth/util: public_key_to_address should return an eth::address [#19](https://github.com/q9f/eth.rb/pull/19)
 - Ci: add docs workflow [#18](https://github.com/q9f/eth.rb/pull/18)
 - Address class implementation and tests [#13](https://github.com/q9f/eth.rb/pull/13)

data/README.md

@@ -21,6 +21,7 @@ What you get:
 - [x] EIP-155 Replay protection with Chain IDs (with presets)
 - [x] EIP-191 Ethereum Signed Messages (with prefix and type)
 - [x] EIP-712 Ethereum Signed Type Data
+- [x] EIP-1271 Smart-Contract Authentification
 - [x] EIP-1559 Ethereum Type-2 Transactions (with priority fee and max gas fee)
 - [x] EIP-2028 Call-data intrinsic gas cost estimates (plus access lists)
 - [x] EIP-2718 Ethereum Transaction Envelopes (and types)
@@ -29,11 +30,7 @@ What you get:
 - [x] RLP-Encoder and Decoder (including sedes)
 - [x] RPC-Client (IPC/HTTP) for Execution-Layer APIs
 - [x] Solidity bindings (compile contracts from Ruby)
-
-Soon (TM):
-- [ ] Smart Contract Support
-- [ ] EIP-1271 Smart-Contract Authentification
-- [ ] HD-Wallets (BIP-32) and Mnemonics (BIP-39)
+- [x] Full smart-contract support (deploy, transact, and call)
 
 Contents:
 - [1. Installation](#1-installation)
@@ -45,7 +42,8 @@ Contents:
   - [2.5. Ethereum ABI Encoder and Decoder](#25-ethereum-abi-encoder-and-decoder)
   - [2.6. Ethereum RLP Encoder and Decoder](#26-ethereum-rlp-encoder-and-decoder)
   - [2.7. Ethereum RPC-Client](#27-ethereum-rpc-client)
-  - [2.8 Solidity Compiler Bindings](#28-solidity-compiler-bindings)
+  - [2.8. Solidity Compiler Bindings](#28-solidity-compiler-bindings)
+  - [2.9. Interact with Smart Contract](#29-interact-with-smart-contract)
 - [3. Documentation](#3-documentation)
 - [4. Testing](#4-testing)
 - [5. Contributing](#5-contributing)
@@ -231,7 +229,7 @@ cli.get_nonce cli.eth_coinbase["result"]
 
 Check out `Eth::Api` for a list of supported RPC-APIs or consult the [Documentation](https://q9f.github.io/eth.rb/) for more details.
 
-### 2.8 Solidity Compiler Bindings
+### 2.8. Solidity Compiler Bindings
 Link a system-level Solidity compiler (`solc`) to your Ruby library and compile contracts.
 
 ```ruby
@@ -253,6 +251,49 @@ contract = solc.compile "spec/fixtures/contracts/greeter.sol"
 
 The `contract["Greeter"]["bin"]` could be directly used to deploy the contract as `Eth::Tx` payload. Check out the [Documentation](https://q9f.github.io/eth.rb/) for more details.
 
+### 2.9. Interact with Smart Contract
+
+Create, compile, and deploy smart contracts.
+
+```ruby
+contract = Eth::Contract.from_file(file: 'spec/fixtures/contracts/dummy.sol')
+# => #<Eth::Contract::Dummy:0x00007fbeee936598>
+cli = Eth::Client.create "/tmp/geth.ipc"
+# => #<Eth::Client::Ipc:0x00007fbeee946128 @gas_limit=21000, @id=0, @max_fee_per_gas=0.2e11, @max_priority_fee_per_gas=0, @path="/tmp/geth.ipc">
+address = cli.deploy_and_wait(contract)
+# => "0x2f2faa160420cee087ded96bad52475147136bd8"
+```
+
+Transact with or call the deployed contract.
+
+```ruby
+cli.transact_and_wait(contract, "set", 1234)
+# => "0x49ca4c0a5729da19a1d2574de9a444a9cd3219bdad81745b54f9cf3bb83b6a06"
+cli.call(contract, "get")
+# => 1234
+```
+
+Or call an existing contract, e.g., the ENS registry:
+
+```ruby
+ens_registry_abi = '[{"inputs":[{"internalType":"contract ENS","name":"_old","type":"address"}],"payable":false,"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"owner","type":"address"},{"indexed":true,"internalType":"address","name":"operator","type":"address"},{"indexed":false,"internalType":"bool","name":"approved","type":"bool"}],"name":"ApprovalForAll","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":true,"internalType":"bytes32","name":"label","type":"bytes32"},{"indexed":false,"internalType":"address","name":"owner","type":"address"}],"name":"NewOwner","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":false,"internalType":"address","name":"resolver","type":"address"}],"name":"NewResolver","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":false,"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"NewTTL","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"node","type":"bytes32"},{"indexed":false,"internalType":"address","name":"owner","type":"address"}],"name":"Transfer","type":"event"},{"constant":true,"inputs":[{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"operator","type":"address"}],"name":"isApprovedForAll","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[],"name":"old","outputs":[{"internalType":"contract ENS","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"owner","outputs":[{"internalType":"address","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"recordExists","outputs":[{"internalType":"bool","name":"","type":"bool"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"resolver","outputs":[{"internalType":"address","name":"","type":"address"}],"payable":false,"stateMutability":"view","type":"function"},{"constant":false,"inputs":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"bool","name":"approved","type":"bool"}],"name":"setApprovalForAll","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"}],"name":"setOwner","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"resolver","type":"address"},{"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"setRecord","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"address","name":"resolver","type":"address"}],"name":"setResolver","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"bytes32","name":"label","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"}],"name":"setSubnodeOwner","outputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"bytes32","name":"label","type":"bytes32"},{"internalType":"address","name":"owner","type":"address"},{"internalType":"address","name":"resolver","type":"address"},{"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"setSubnodeRecord","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":false,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"},{"internalType":"uint64","name":"ttl","type":"uint64"}],"name":"setTTL","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"constant":true,"inputs":[{"internalType":"bytes32","name":"node","type":"bytes32"}],"name":"ttl","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"payable":false,"stateMutability":"view","type":"function"}]'
+ens_registry_address = "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e"
+ens_registry_name = "ENSRegistryWithFallback"
+ens_registry = Eth::Contract.from_abi(name: ens_registry_name, address: ens_registry_address, abi: ens_registry_abi)
+# => #<Eth::Contract::ENSRegistryWithFallback:0x000055bece570980>
+ens_registry.address
+# => "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e"
+cli.call(ens_registry, "old")
+# => "0x112234455c3a32fd11230c42e7bccd4a84e02010"
+```
+
+The gem also comes with an EIP-1271 smart-contract authentification interface.
+
+```ruby
+cli.is_valid_signature contract, hash, signature
+# => true
+```
+
 ## 3. Documentation
 The documentation can be found at: https://q9f.github.io/eth.rb
 

data/eth.gemspec

@@ -44,7 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rbsecp256k1", "~> 5.1"
 
   # openssl for encrypted key derivation
-  spec.add_dependency "openssl", "~> 2.2"
+  spec.add_dependency "openssl", ">= 2.2", "< 4.0"
 
   # scrypt for encrypted key derivation
   spec.add_dependency "scrypt", "~> 3.0"

data/lib/eth/abi/event.rb

@@ -0,0 +1,137 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides a Ruby implementation of the Ethereum Application Binary Interface (ABI).
+  module Abi
+
+    # Provides a module to decode transaction log events.
+    module Event
+      extend self
+
+      # Compute topic for ABI event interface.
+      #
+      # @param interface [Hash] ABI event interface.
+      # @return [String] a hex-string topic.
+      def compute_topic(interface)
+        sig = Abi.signature(interface)
+        Util.prefix_hex(Util.bin_to_hex(Util.keccak256(sig)))
+      end
+
+      # A decoded event log.
+      class LogDescription
+        # The event ABI interface used to decode the log.
+        attr_accessor :event_interface
+
+        # The the input argument of the event.
+        attr_accessor :args
+
+        # The named input argument of the event.
+        attr_accessor :kwargs
+
+        # The topic hash.
+        attr_accessor :topic
+
+        # Decodes event log argument values.
+        #
+        # @param event_interface [Hash] event ABI type.
+        # @param log [Hash] transaction receipt log
+        def initialize(event_interface, log)
+          @event_interface = event_interface
+
+          inputs = event_interface.fetch("inputs")
+          data = log.fetch("data")
+          topics = log.fetch("topics", [])
+          anonymous = event_interface.fetch("anonymous", false)
+
+          @topic = topics[0] if !anonymous
+          @args, @kwargs = Event.decode_log(inputs, data, topics, anonymous)
+        end
+
+        # The event name. (e.g. Transfer)
+        def name
+          @name ||= event_interface.fetch("name")
+        end
+
+        # The event signature. (e.g. Transfer(address,address,uint256))
+        def signature
+          @signature ||= Abi.signature(event_interface)
+        end
+      end
+
+      # Decodes a stream of receipt logs with a set of ABI interfaces.
+      #
+      # @param interfaces [Array] event ABI types.
+      # @param logs [Array] transaction receipt logs
+      # @return [Hash] an enumerator of LogDescription objects.
+      def decode_logs(interfaces, logs)
+        Enumerator.new do |y|
+          topic_to_interfaces = Hash[interfaces.map { |i| [compute_topic(i), i] }]
+
+          logs.each do |log|
+            topic = log.fetch("topics", [])[0]
+            if topic && interface = topic_to_interfaces[topic]
+              y << [log, LogDescription.new(interface, log)]
+            else
+              y << [log, nil]
+            end
+          end
+        end
+      end
+
+      # Decodes event log argument values.
+      #
+      # @param inputs [Array] event ABI types.
+      # @param data [String] ABI event data to be decoded.
+      # @param topics [Array] ABI event topics to be decoded.
+      # @param anonymous [Boolean] If event signature is excluded from topics.
+      # @return [[Array, Hash]] decoded positional arguments and decoded keyword arguments.
+      # @raise [DecodingError] if decoding fails for type.
+      def decode_log(inputs, data, topics, anonymous = false)
+        topic_inputs, data_inputs = inputs.partition { |i| i["indexed"] }
+
+        topic_types = topic_inputs.map { |i| i["type"] }
+        data_types = data_inputs.map { |i| i["type"] }
+
+        # If event is anonymous, all topics are arguments. Otherwise, the first
+        # topic will be the event signature.
+        if anonymous == false
+          topics = topics[1..-1]
+        end
+
+        decoded_topics = topics.map.with_index { |t, i| Abi.decode([topic_types[i]], t)[0] }
+        decoded_data = Abi.decode(data_types, data)
+
+        args = []
+        kwargs = {}
+
+        inputs.each_with_index do |input, index|
+          if input["indexed"]
+            value = decoded_topics[topic_inputs.index(input)]
+          else
+            value = decoded_data[data_inputs.index(input)]
+          end
+          args[index] = value
+          kwargs[input["name"].to_sym] = value
+        end
+
+        return args, kwargs
+      end
+    end
+  end
+end

data/lib/eth/abi/type.rb

@@ -17,7 +17,7 @@
 # Provides the {Eth} module.
 module Eth
 
-  # Provides a Ruby implementation of the Ethereum Applicatoin Binary Interface (ABI).
+  # Provides a Ruby implementation of the Ethereum Application Binary Interface (ABI).
   module Abi
 
     # Provides a class to handle and parse common ABI types.

data/lib/eth/abi.rb

@@ -16,12 +16,13 @@
 
 require "konstructor"
 
+require "eth/abi/event"
 require "eth/abi/type"
 
 # Provides the {Eth} module.
 module Eth
 
-  # Provides a Ruby implementation of the Ethereum Applicatoin Binary Interface (ABI).
+  # Provides a Ruby implementation of the Ethereum Application Binary Interface (ABI).
   # ref: https://docs.soliditylang.org/en/develop/abi-spec.html
   module Abi
     extend self
@@ -43,7 +44,7 @@ module Eth
     # @return [String] the encoded ABI data.
     def encode(types, args)
 
-      # prase all types
+      # parse all types
       parsed_types = types.map { |t| Type.parse(t) }
 
       # prepare the "head"
@@ -290,6 +291,17 @@ module Eth
       end
     end
 
+    # Build event signature string from ABI interface.
+    #
+    # @param interface [Hash] ABI event interface.
+    # @return [String] interface signature string.
+    def signature(interface)
+      name = interface.fetch("name")
+      inputs = interface.fetch("inputs", [])
+      types = inputs.map { |i| i.fetch("type") }
+      "#{name}(#{types.join(",")})"
+    end
+
     private
 
     # Properly encodes unsigned integers.
@@ -334,6 +346,8 @@ module Eth
     # Properly encodes byte-strings.
     def encode_bytes(arg, type)
       raise EncodingError, "Expecting String: #{arg}" unless arg.instance_of? String
+      arg = handle_hex_string arg, type
+
       if type.sub_type.empty?
         size = Util.zpad_int arg.size
         padding = Constant::BYTE_ZERO * (Util.ceil32(arg.size) - arg.size)
@@ -392,5 +406,23 @@ module Eth
         raise EncodingError, "Could not parse address: #{arg}"
       end
     end
+
+    # The ABI encoder needs to be able to determine between a hex `"123"`
+    # and a binary `"123"` string.
+    def handle_hex_string(arg, type)
+      if Util.is_prefixed? arg or
+         (arg.size === type.sub_type.to_i * 2 and Util.is_hex? arg)
+
+        # There is no way telling whether a string is hex or binary with certainty
+        # in Ruby. Therefore, we assume a `0x` prefix to indicate a hex string.
+        # Additionally, if the string size is exactly the double of the expected
+        # binary size, we can assume a hex value.
+        return Util.hex_to_bin arg
+      else
+
+        # Everything else will be assumed binary or raw string.
+        return arg.b
+      end
+    end
   end
 end

data/lib/eth/chain.rb

@@ -41,6 +41,9 @@ module Eth
     # Chain ID for Gnosis mainnet.
     XDAI = 100.freeze
 
+    # Chain ID for the Polygon Matic mainnet.
+    MATIC = 137.freeze
+
     # Chain ID for Arbitrum mainnet.
     ARBITRUM = 42161.freeze
 
@@ -77,6 +80,9 @@ module Eth
     # Chain ID for Optimistic Goerli testnet.
     GOERLI_OPTIMISM = 420.freeze
 
+    # Chain ID for the Polygon Mumbai testnet.
+    MUMBAI = 80001.freeze
+
     # Chain ID for Arbitrum Rinkeby testnet.
     RINKEBY_ARBITRUM = 421611.freeze
 
@@ -136,7 +142,7 @@ module Eth
       return v
     end
 
-    # Converst a `v` value into a chain ID. This does not work for legacy signatures
+    # Converts a `v` value into a chain ID. This does not work for legacy signatures
     # with `v < 36` that do not conform with EIP-155.
     #
     # @param v [Integer] the signature's `v` value.

data/lib/eth/client.rb

@@ -149,6 +149,204 @@ module Eth
       end
     end
 
+    # Deploys a contract and waits for it to be mined. Uses
+    # `eth_coinbase` or external signer if no sender key is provided.
+    #
+    # @overload deploy(contract)
+    #   @param contract [Eth::Contract] contracts to deploy.
+    # @overload deploy(contract, *args, **kwargs)
+    #   @param contract [Eth::Contract] contracts to deploy.
+    #   *args Optional variable constructor parameter list
+    #   **sender_key [Eth::Key] the sender private key.
+    #   **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    # @return [String] the contract address.
+    def deploy_and_wait(contract, *args, **kwargs)
+      hash = wait_for_tx(deploy(contract, *args, **kwargs))
+      addr = eth_get_transaction_receipt(hash)["result"]["contractAddress"]
+      contract.address = Address.new(addr).to_s
+    end
+
+    # Deploys a contract. Uses `eth_coinbase` or external signer
+    # if no sender key is provided.
+    #
+    # @overload deploy(contract)
+    #   @param contract [Eth::Contract] contracts to deploy.
+    # @overload deploy(contract, *args, **kwargs)
+    #   @param contract [Eth::Contract] contracts to deploy.
+    #   *args Optional variable constructor parameter list
+    #   **sender_key [Eth::Key] the sender private key.
+    #   **legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    # @return [String] the transaction hash.
+    # @raise [ArgumentError] in case the contract does not have any source.
+    def deploy(contract, *args, **kwargs)
+      raise ArgumentError, "Cannot deploy contract without source or binary!" if contract.bin.nil?
+      raise ArgumentError, "Missing contract constructor params!" if contract.constructor_inputs.length != args.length
+      gas_limit = Tx.estimate_intrinsic_gas(contract.bin) + Tx::CREATE_GAS
+      data = contract.bin
+      unless args.empty?
+        data += encode_constructor_params(contract, args)
+      end
+      params = {
+        value: 0,
+        gas_limit: gas_limit,
+        chain_id: chain_id,
+        data: data,
+      }
+      if kwargs[:legacy]
+        params.merge!({
+          gas_price: max_fee_per_gas,
+        })
+      else
+        params.merge!({
+          priority_fee: max_priority_fee_per_gas,
+          max_gas_fee: max_fee_per_gas,
+        })
+      end
+      unless kwargs[:sender_key].nil?
+        # Uses the provided key as sender and signer
+        params.merge!({
+          from: kwargs[:sender_key].address,
+          nonce: get_nonce(kwargs[:sender_key].address),
+        })
+        tx = Eth::Tx.new(params)
+        tx.sign kwargs[:sender_key]
+        return eth_send_raw_transaction(tx.hex)["result"]
+      else
+        # Uses the default account as sender and external signer
+        params.merge!({
+          from: default_account,
+          nonce: get_nonce(default_account),
+        })
+        return eth_send_transaction(params)["result"]
+      end
+    end
+
+    # Calls a contract function without executing it
+    # (non-transactional contract read).
+    #
+    # @overload call(contract, function_name)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    # @overload call(contract, function_name, value)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    #   @param value [Integer|String] function arguments.
+    # @overload call(contract, function_name, value, sender_key, legacy)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    #   @param value [Integer|String] function arguments.
+    #   @param sender_key [Eth::Key] the sender private key.
+    #   @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    # @return [Object] returns the result of the call.
+    def call(contract, function_name, *args, **kwargs)
+      func = contract.functions.select { |func| func.name == function_name }[0]
+      raise ArgumentError, "function_name does not exist!" if func.nil?
+      output = call_raw(contract, func, *args, **kwargs)
+      if output&.length == 1
+        return output[0]
+      else
+        return output
+      end
+    end
+
+    # Executes a contract function with a transaction (transactional
+    # contract read/write).
+    #
+    # @overload transact(contract, function_name)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    # @overload transact(contract, function_name, value)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    #   @param value [Integer|String] function arguments.
+    # @overload transact(contract, function_name, value, sender_key, legacy, address)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    #   @param value [Integer|String] function arguments.
+    #   @param sender_key [Eth::Key] the sender private key.
+    #   @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    #   @param address [String] contract address.
+    # @return [Object] returns the result of the call.
+    def transact(contract, function_name, *args, **kwargs)
+      gas_limit = Tx.estimate_intrinsic_gas(contract.bin) + Tx::CREATE_GAS
+      fun = contract.functions.select { |func| func.name == function_name }[0]
+      params = {
+        value: 0,
+        gas_limit: gas_limit,
+        chain_id: chain_id,
+        to: kwargs[:address] || contract.address,
+        data: call_payload(fun, args),
+      }
+      if kwargs[:legacy]
+        params.merge!({
+          gas_price: max_fee_per_gas,
+        })
+      else
+        params.merge!({
+          priority_fee: max_priority_fee_per_gas,
+          max_gas_fee: max_fee_per_gas,
+        })
+      end
+      unless kwargs[:sender_key].nil?
+        # use the provided key as sender and signer
+        params.merge!({
+          from: kwargs[:sender_key].address,
+          nonce: get_nonce(kwargs[:sender_key].address),
+        })
+        tx = Eth::Tx.new(params)
+        tx.sign kwargs[:sender_key]
+        return eth_send_raw_transaction(tx.hex)["result"]
+      else
+        # use the default account as sender and external signer
+        params.merge!({
+          from: default_account,
+          nonce: get_nonce(default_account),
+        })
+        return eth_send_transaction(params)["result"]
+      end
+    end
+
+    # Executes a contract function with a transaction and waits for it
+    # to be mined (transactional contract read/write).
+    #
+    # @overload transact_and_wait(contract, function_name)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    # @overload transact_and_wait(contract, function_name, value)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    #   @param value [Integer|String] function arguments.
+    # @overload transact_and_wait(contract, function_name, value, sender_key, legacy, address)
+    #   @param contract [Eth::Contract] subject contract to call.
+    #   @param function_name [String] method name to be called.
+    #   @param value [Integer|String] function arguments.
+    #   @param sender_key [Eth::Key] the sender private key.
+    #   @param legacy [Boolean] enables legacy transactions (pre-EIP-1559).
+    #   @param address [String] contract address.
+    # @return [Object] returns the result of the call.
+    def transact_and_wait(contract, function_name, *args, **kwargs)
+      wait_for_tx(transact(contract, function_name, *args, **kwargs))
+    end
+
+    # Provides an interface to call `isValidSignature` as per EIP-1271 on a given
+    # smart contract to verify the given hash and signature matching the magic
+    # value.
+    #
+    # @param contract [Eth::Contract] a deployed contract implementing EIP-1271.
+    # @param hash [String] the message hash to be checked against the signature.
+    # @param signature [String] the signature to be recovered by the contract.
+    # @param magic [String] the expected magic value (defaults to `1626ba7e`).
+    # @return [Boolean] true if magic matches and signature is valid.
+    # @raise [ArgumentError] in case the contract cannot be called yet.
+    def is_valid_signature(contract, hash, signature, magic = "1626ba7e")
+      raise ArgumentError, "Contract not deployed yet." if contract.address.nil?
+      hash = Util.hex_to_bin hash if Util.is_hex? hash
+      signature = Util.hex_to_bin signature if Util.is_hex? signature
+      magic = Util.hex_to_bin magic if Util.is_hex? magic
+      result = call(contract, "isValidSignature", hash, signature)
+      return result === magic
+    end
+
     # Gives control over resetting the RPC request ID back to zero.
     # Usually not needed.
     #
@@ -169,7 +367,7 @@ module Eth
     # Waits for an transaction to be mined by the connected chain.
     #
     # @param hash [String] the transaction hash.
-    # @return [String] the transactin hash once the transaction is mined.
+    # @return [String] the transaction hash once the transaction is mined.
     # @raise [Timeout::Error] if it's not mined within 5 minutes.
     def wait_for_tx(hash)
       start_time = Time.now
@@ -193,6 +391,55 @@ module Eth
 
     private
 
+    # Non-transactional function call called from call().
+    def call_raw(contract, func, *args, **kwargs)
+      gas_limit = Tx.estimate_intrinsic_gas(contract.bin) + Tx::CREATE_GAS
+      params = {
+        gas_limit: gas_limit,
+        chain_id: chain_id,
+        data: call_payload(func, args),
+      }
+      if kwargs[:address] || contract.address
+        params.merge!({ to: kwargs[:address] || contract.address })
+      end
+      if kwargs[:legacy]
+        params.merge!({
+          gas_price: max_fee_per_gas,
+        })
+      else
+        params.merge!({
+          priority_fee: max_priority_fee_per_gas,
+          max_gas_fee: max_fee_per_gas,
+        })
+      end
+      unless kwargs[:sender_key].nil?
+        # Uses the provided key as sender and signer
+        params.merge!({
+          from: kwargs[:sender_key].address,
+          nonce: get_nonce(kwargs[:sender_key].address),
+        })
+        tx = Eth::Tx.new(params)
+        tx.sign kwargs[:sender_key]
+      end
+      raw_result = eth_call(params)["result"]
+      types = func.outputs.map { |i| i.type }
+      return nil if raw_result == "0x"
+      Eth::Abi.decode(types, raw_result)
+    end
+
+    # Encodes function call payloads.
+    def call_payload(fun, args)
+      types = fun.inputs.map { |i| i.type }
+      encoded_str = Util.bin_to_hex(Eth::Abi.encode(types, args))
+      "0x" + fun.signature + (encoded_str.empty? ? "0" * 64 : encoded_str)
+    end
+
+    # Encodes constructor params
+    def encode_constructor_params(contract, args)
+      types = contract.constructor_inputs.map { |input| input.type }
+      Util.bin_to_hex(Eth::Abi.encode(types, args))
+    end
+
     # Prepares parameters and sends the command to the client.
     def send_command(command, args)
       args << "latest" if ["eth_getBalance", "eth_call"].include? command
@@ -230,3 +477,7 @@ module Eth
     end
   end
 end
+
+# Load the client/* libraries
+require "eth/client/http"
+require "eth/client/ipc"

data/lib/eth/contract/event.rb

@@ -0,0 +1,42 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provide classes for contract event.
+  class Contract::Event
+    attr_accessor :name, :signature, :input_types, :inputs, :event_string, :address
+
+    # Constructor of the {Eth::Contract::Event} class.
+    #
+    # @param data [Hash] contract event data.
+    def initialize(data)
+      @name = data["name"]
+      @input_types = data["inputs"].collect { |x| x["type"] }
+      @inputs = data["inputs"].collect { |x| x["name"] }
+      @event_string = "#{@name}(#{@input_types.join(",")})"
+      @signature = Digest::Keccak.hexdigest(@event_string, 256)
+    end
+
+    # Set the address of the smart contract
+    #
+    # @param address [String] contract address.
+    def set_address(address)
+      @address = address.nil? ? nil : Eth::Address.new(address).address
+    end
+  end
+end

data/lib/eth/contract/function.rb

@@ -0,0 +1,57 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides the methods for smart contract function.
+  class Contract::Function
+    attr_accessor :name, :inputs, :outputs, :signature, :constant, :function_string
+
+    # Constructor of the {Eth::Function} class.
+    #
+    # @param data [Hash] function input and output data.
+    def initialize(data)
+      @name = data["name"]
+      @constant = data["constant"]
+      @inputs = data["inputs"].map do |input|
+        Eth::Contract::FunctionInput.new(input)
+      end
+      @outputs = data["outputs"].collect do |output|
+        Eth::Contract::FunctionOutput.new(output)
+      end
+      @function_string = self.class.calc_signature(@name, @inputs)
+      @signature = self.class.encoded_function_signature(@function_string)
+    end
+
+    # Creates function strings.
+    #
+    # @param name [String] function name.
+    # @param inputs [Array<Eth::Contract::FunctionInput>] function input class list.
+    # @return [String] function string.
+    def self.calc_signature(name, inputs)
+      "#{name}(#{inputs.collect { |x| x.type }.join(",")})"
+    end
+
+    # Encodes a function signature.
+    #
+    # @param signature [String] function signature.
+    # @return [String] encoded function signature string.
+    def self.encoded_function_signature(signature)
+      Util.bin_to_hex Util.keccak256(signature)[0..3]
+    end
+  end
+end

data/lib/eth/contract/function_input.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provide classes for contract function input.
+  class Contract::FunctionInput
+    attr_accessor :type, :name
+
+    # Constructor of the {Eth::Contract::FunctionInput} class.
+    #
+    # @param data [Hash] contract abi data.
+    def initialize(data)
+      @type = Eth::Abi::Type.parse(data["type"])
+      @name = data["name"]
+    end
+
+    # Returns complete types with subtypes, e.g., `uint256`.
+    def type
+      @type.base_type + @type.sub_type
+    end
+  end
+end

data/lib/eth/contract/function_output.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provide classes for contract function output.
+  class Contract::FunctionOutput
+    attr_accessor :type, :name
+
+    # Constructor of the {Eth::Contract::FunctionOutput} class.
+    #
+    # @param data [Hash] contract abi data.
+    def initialize(data)
+      @type = Eth::Abi::Type.parse(data["type"])
+      @name = data["name"]
+    end
+
+    # Returns complete types with subtypes, e.g., `uint256`.
+    def type
+      @type.base_type + @type.sub_type
+    end
+  end
+end

data/lib/eth/contract/initializer.rb

@@ -0,0 +1,47 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provide classes for contract initializer.
+  class Contract::Initializer
+    attr_accessor :contracts, :file
+
+    # Constructor of the {Eth::Contract::Initializer} class.
+    #
+    # @param file [String] file path to solidity code.
+    def initialize(file)
+      sol_output = Eth::Solidity.new.compile(file)
+      contracts = sol_output.keys
+
+      @contracts = []
+      contracts.each do |contract|
+        abi = sol_output[contract]["abi"]
+        name = contract
+        code = sol_output[contract]["bin"]
+        @contracts << Contract.new(name, code, abi)
+      end
+    end
+
+    # Builds and returns all contracts.
+    def build_all
+      @contracts.each do |contract|
+        contract.build
+      end
+    end
+  end
+end

data/lib/eth/contract.rb

@@ -0,0 +1,143 @@
+# Copyright (c) 2016-2022 The Ruby-Eth Contributors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# -*- encoding : ascii-8bit -*-
+
+# Provides the {Eth} module.
+module Eth
+
+  # Provides classes to access smart contracts
+  class Contract
+    attr_reader :address
+    attr_accessor :key
+    attr_accessor :gas_limit, :gas_price, :max_fee_per_gas, :max_priority_fee_per_gas, :nonce
+    attr_accessor :bin, :name, :abi, :class_object
+    attr_accessor :events, :functions, :constructor_inputs
+
+    # Constructor of the {Eth::Contract} class.
+    #
+    # @param name [String] contract name.
+    # @param bin [String] contract bin string.
+    # @param abi [String] contract abi string.
+    def initialize(name, bin, abi)
+      @name = name
+      @bin = bin
+      @abi = abi
+      @constructor_inputs, @functions, @events = parse_abi(abi)
+    end
+
+    # Creates a contract wrapper from a Solidity file.
+    #
+    # @param file [String] solidity file path.
+    # @param contract_index [Number] specify contract.
+    # @return [Eth::Contract::Object] Returns the class of the smart contract.
+    # @raise [ArgumentError] if the file path is empty or no contracts were compiled.
+    def self.from_file(file:, contract_index: 0)
+      raise ArgumentError, "Cannot find the contract at #{file.to_s}!" if !File.exist?(file.to_s)
+      contracts = Eth::Contract::Initializer.new(file).build_all
+      raise ArgumentError, "No contracts compiled." if contracts.empty?
+      contracts[contract_index].class_object.new
+    end
+
+    # Creates a contract wrapper from ABI and address.
+    #
+    # @param abi [String] contract abi string.
+    # @param address [String] contract address.
+    # @param name [String] name of contract.
+    # @return [Eth::Contract::Object] Returns the class of the smart contract.
+    # @raise [JSON::ParserError] if the json format is wrong.
+    # @raise [ArgumentError] if ABI, address, or name is missing.
+    def self.from_abi(abi:, address:, name:)
+      abi = abi.is_a?(Array) ? abi : JSON.parse(abi)
+      contract = Eth::Contract.new(name, nil, abi)
+      contract.build
+      contract = contract.class_object.new
+      contract.address = address
+      contract
+    end
+
+    # Creates a contract wrapper from binary and ABI.
+    #
+    # @param bin [String] contract bin string.
+    # @param abi [String] contract abi string.
+    # @param name [String] name of contract.
+    # @return [Eth::Contract::Object] Returns the class of the smart contract.
+    # @raise [JSON::ParserError] if the json format is wrong.
+    # @raise [ArgumentError] if ABI, binary, or name is missing.
+    def self.from_bin(bin:, abi:, name:)
+      abi = abi.is_a?(Array) ? abi : JSON.parse(abi)
+      contract = Eth::Contract.new(name, bin, abi)
+      contract.build
+      contract.class_object.new
+    end
+
+    # Sets the address of the smart contract.
+    #
+    # @param addr [String|Eth::Address] contract address string.
+    def address=(addr)
+      if addr.is_a? Eth::Address
+        @address = addr.to_s
+      else
+        @address = Eth::Address.new(addr).to_s
+      end
+      @events.each do |event|
+        event.set_address(@address)
+      end
+    end
+
+    # Create meta classes for smart contracts.
+    def build
+      class_name = @name
+      parent = self
+      class_methods = Class.new do
+        extend Forwardable
+        def_delegators :parent, :key, :key=
+        def_delegators :parent, :name, :abi, :bin
+        def_delegators :parent, :gas_limit, :gas_price, :gas_limit=, :gas_price=, :nonce, :nonce=
+        def_delegators :parent, :max_fee_per_gas, :max_fee_per_gas=, :max_priority_fee_per_gas, :max_priority_fee_per_gas=
+        def_delegators :parent, :events
+        def_delegators :parent, :address, :address=
+        def_delegator :parent, :functions
+        def_delegator :parent, :constructor_inputs
+        define_method :parent do
+          parent
+        end
+      end
+      Eth::Contract.send(:remove_const, class_name) if Eth::Contract.const_defined?(class_name, false)
+      Eth::Contract.const_set(class_name, class_methods)
+      @class_object = class_methods
+    end
+
+    private
+
+    def parse_abi(abi)
+      constructor = abi.detect { |x| x["type"] == "constructor" }
+      if !constructor.nil?
+        constructor_inputs = constructor["inputs"].map { |input| Eth::Contract::FunctionInput.new(input) }
+      else
+        constructor_inputs = []
+      end
+      functions = abi.select { |x| x["type"] == "function" }.map { |fun| Eth::Contract::Function.new(fun) }
+      events = abi.select { |x| x["type"] == "event" }.map { |evt| Eth::Contract::Event.new(evt) }
+      [constructor_inputs, functions, events]
+    end
+  end
+end
+
+# Load the contract/* libraries
+require "eth/contract/event"
+require "eth/contract/function"
+require "eth/contract/function_input"
+require "eth/contract/function_output"
+require "eth/contract/initializer"

data/lib/eth/rlp/sedes/binary.rb

@@ -29,7 +29,7 @@ module Eth
         # A singleton class for binary values of fixed length.
         class << self
 
-          # Create a serializable bianry of fixed size.
+          # Create a serializable binary of fixed size.
           #
           # @param l [Integer] the fixed size of the binary.
           # @param allow_empty [Boolean] indicator wether empty binaries should be allowed.
@@ -47,7 +47,7 @@ module Eth
           end
         end
 
-        # Create a serializable bianry of variable size.
+        # Create a serializable binary of variable size.
         #
         # @param min_length [Integer] the minimum size of the binary.
         # @param max_length [Integer] the maximum size of the binary.

data/lib/eth/tx.rb

@@ -69,13 +69,16 @@ module Eth
     # The zero byte is 0x00.
     ZERO_BYTE = "\x00".freeze
 
+    # Smart contract transaction gas cost
+    CREATE_GAS = 32_000.freeze
+
     # Creates a new transaction of any type for given parameters and chain ID.
     # Required parameters are (optional in brackets):
     # - EIP-1559: chain_id, nonce, priority_fee, max_gas_fee, gas_limit(, from, to,
     #   value, data, access_list)
     # - EIP-2930: chain_id, nonce, gas_price, gas_limit, access_list(, from, to,
     #   value, data)
-    # - Legacy: nonce, gas_price, gas_lmit(, from, to, value, data)
+    # - Legacy: nonce, gas_price, gas_limit(, from, to, value, data)
     #
     # @param params [Hash] all necessary transaction fields.
     # @param chain_id [Integer] the EIP-155 Chain ID (legacy transactions only).

data/lib/eth/version.rb

@@ -16,5 +16,5 @@
 module Eth
 
   # Defines the version of the {Eth} module.
-  VERSION = "0.5.2".freeze
+  VERSION = "0.5.5".freeze
 end

data/lib/eth.rb

@@ -22,9 +22,8 @@ require "eth/api"
 require "eth/address"
 require "eth/chain"
 require "eth/constant"
+require "eth/contract"
 require "eth/client"
-require "eth/client/http"
-require "eth/client/ipc"
 require "eth/eip712"
 require "eth/key"
 require "eth/rlp"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eth
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.5
 platform: ruby
 authors:
 - Steve Ellis
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keccak
@@ -57,16 +57,22 @@ dependencies:
   name: openssl
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: scrypt
   requirement: !ruby/object:Gem::Requirement
@@ -89,6 +95,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".github/workflows/codeql.yml"
 - ".github/workflows/docs.yml"
 - ".github/workflows/spec.yml"
@@ -108,6 +115,7 @@ files:
 - eth.gemspec
 - lib/eth.rb
 - lib/eth/abi.rb
+- lib/eth/abi/event.rb
 - lib/eth/abi/type.rb
 - lib/eth/address.rb
 - lib/eth/api.rb
@@ -116,6 +124,12 @@ files:
 - lib/eth/client/http.rb
 - lib/eth/client/ipc.rb
 - lib/eth/constant.rb
+- lib/eth/contract.rb
+- lib/eth/contract/event.rb
+- lib/eth/contract/function.rb
+- lib/eth/contract/function_input.rb
+- lib/eth/contract/function_output.rb
+- lib/eth/contract/initializer.rb
 - lib/eth/eip712.rb
 - lib/eth/key.rb
 - lib/eth/key/decrypter.rb