eth 0.5.9 → 0.5.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b38c43c0d7f3c1403c02e847d02623120bab91260ac0dc841f43719302413e1b
-  data.tar.gz: 41f4086d2911a30869c7cf5c4e63bfff54d618cb16756f5cbebc4f4accb4b26c
+  metadata.gz: 4ddb9f142d1985c57f8abecee08a3275ed0e2dfd6a008cf608bf8c3ac239335d
+  data.tar.gz: d33f16301d9421c4ae584cc293fe26c18e88e2783d8184a91999833753f6f904
 SHA512:
-  metadata.gz: 45549c5b9c4deace4df8bbcd34c2e4a02476a4175aa8ea865249bb01983c484d85d67954f3b7e68193b16425e8c83efcd4415cd7c2034730fcd8d0d1a324cf34
-  data.tar.gz: e1dc19f40eaa284ae09faa6fc70d510ae782b1014f95c0b490dfa8ad86dbf6c9f505b47b6c530217258c33279c204ac6be445fd11fe341bcb302492c95d7b69d
+  metadata.gz: c32065a3eb99ca9dc142c5acd7de9a2a957e850743afa45f8c2ddb9b95597c55d75063e28dd4cce757b4ac228402fa988a7cd76fdbc6b33e2fa7770038068db7
+  data.tar.gz: 8c44621156a464b8676ca9dd6e1bd92295e84a0c41329687b8a84f5335abc10683a3ae39ecfa548f5f5203f218adb6850aa76f227057e69da47405a55d0d81f3

data/.github/workflows/docs.yml

@@ -20,7 +20,7 @@ jobs:
         gem install yard
         yard doc
     - name: Deploy GH Pages
-      uses: JamesIves/github-pages-deploy-action@v4.4.1
+      uses: JamesIves/github-pages-deploy-action@v4.4.3
       with:
           branch: gh-pages
           folder: doc/

data/.github/workflows/spec.yml

@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-22.04, macos-12]
-        ruby: ['3.0', '3.1']
+        ruby: ['3.0', '3.1', '3.2']
     steps:
     - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
@@ -37,10 +37,15 @@ jobs:
         sudo apt-get update
         sudo apt-get install ethereum solc libyaml-dev
       if: startsWith(matrix.os, 'Ubuntu')
+    - name: Patch Geth # https://github.com/ethereum/go-ethereum/pull/27360
+      run: |
+        git clone https://github.com/q9f/go-ethereum.git -b q9f/params/shanghai
+        pushd go-ethereum/
+        make geth
+        popd
     - name: Run Geth
       run: |
-        geth --dev --http --ipcpath /tmp/geth.ipc &
-        disown &
+        ./go-ethereum/build/bin/geth --dev --http --ipcpath /tmp/geth.ipc &
     - name: Gem Dependencies
       run: |
         git submodule update --init
@@ -50,3 +55,4 @@ jobs:
         bundle exec rspec
       env:
         COVERAGE: true
+        INFURA_TOKEN: ${{ secrets.INFURA_TOKEN }}

data/CHANGELOG.md

@@ -1,6 +1,40 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
+## [0.5.10]
+### Added
+* Eth/client: add transfer_erc20 function [#197](https://github.com/q9f/eth.rb/pull/197)
+* Eth/client: add resolve_ens function [#192](https://github.com/q9f/eth.rb/pull/192)
+
+### Changed
+* Eth/ens: restore docs for normalize [#198](https://github.com/q9f/eth.rb/pull/198)
+* Docs: update readme [#195](https://github.com/q9f/eth.rb/pull/195)
+* Eth/contract: ensure address arrays support [#194](https://github.com/q9f/eth.rb/pull/194)
+* Eth/client: do not allow accessing local accounts on remote connections [#193](https://github.com/q9f/eth.rb/pull/193)
+* Eth/client: correctly select functions [#191](https://github.com/q9f/eth.rb/pull/191)
+* Docs: create security policy [#190](https://github.com/q9f/eth.rb/pull/190)
+* Docs: add contribution guidelines [#189](https://github.com/q9f/eth.rb/pull/189)
+* Docs: add coc [#188](https://github.com/q9f/eth.rb/pull/188)
+* Docs: update changelog for 0.5.9 [#187](https://github.com/q9f/eth.rb/pull/187)
+
+## [0.5.9]
+### Added
+* Eth/abi: dynamic struct encoding (#135) [#185](https://github.com/q9f/eth.rb/pull/185)
+* Eth/client: support camel case (convert before sending the tx) [#172](https://github.com/q9f/eth.rb/pull/172)
+* Eth/client: add `tx_succeeded?` [#173](https://github.com/q9f/eth.rb/pull/173)
+
+### Changed
+* Eth/client: raise an error if a contract interaction reverts [#186](https://github.com/q9f/eth.rb/pull/186)
+* Eth/client: dup params to prevent marshalling on client obj [#184](https://github.com/q9f/eth.rb/pull/184)
+* Eth/client: add test for tx_succeeded? [#183](https://github.com/q9f/eth.rb/pull/183)
+* Eth: rename functions prefixed with is_ [#182](https://github.com/q9f/eth.rb/pull/182)
+* Eth/chain: update available chains [#181](https://github.com/q9f/eth.rb/pull/181)
+* Docs: update changelog for 0.5.8 [#180](https://github.com/q9f/eth.rb/pull/180)
+* Eth: happy new 2023 [#179](https://github.com/q9f/eth.rb/pull/179)
+* Docs: fix readme workflow badge [#178](https://github.com/q9f/eth.rb/pull/178)
+* Solidity: sanitize the contract path before compiling [#176](https://github.com/q9f/eth.rb/pull/176)
+* Ci: add libyaml on ubuntu [#175](https://github.com/q9f/eth.rb/pull/175)
+
 ## [0.5.8]
 ### Added
 * Client: ability to manual set nonce of tx for transfer, deploy, transact methods was added. [#169](https://github.com/q9f/eth.rb/pull/169)

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,122 @@
+
+# Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<github@q9f.cc>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

data/CONTRIBUTING.md

@@ -0,0 +1,61 @@
+# Contributing to Ruby Ethereum
+
+Everyone is welcome to contribute to the Ruby Ethereum gem. It is
+more than six years old and had seen many maintainers come and go.
+
+Current maintainers:
+* [@q9f](https://github.com/q9f)
+* [@kurotaky](https://github.com/kurotaky)
+
+### Workflow
+
+To propose a change, fix, or new feature, create an issue or comment
+on an existing issue to see if anyone else has an opinion on it or is
+eventually already working on it
+
+The general workflow looks roughly like this:
+
+1. Discuss it
+2. Fork it
+3. Improve it
+4. Test it
+5. Document it
+6. Submit it
+
+### Linting
+
+We use the Ruby formatter `rufo` to ensure consistent formatting across
+the code base.
+* <https://github.com/ruby-formatter/rufo>
+
+Simply run `rufo .` before comitting your changes.
+
+### Testing
+
+We use behaviour-driven development and this codebase is at least 100%
+unit tested. We use RSpec to run the spec tests.
+* <https://rspec.info>
+
+The full Ethereum test-suite is available in `fixtures/ethereum/tests`.
+Run `git submodule update --init --recursive` to fetch it.
+* <https://github.com/ethereum/tests>
+
+If your tests are failing make sure you pulled the ethereum/tests 
+submodule and run a local geth node in background with
+`geth --dev --http --ipcpath /tmp/geth.ipc` as we are running some tests
+against a local live node.
+
+Other static test data is available in `fixtures/`
+
+### Documentation
+
+We use the Ruby documentation tool Yard.
+* <https://yardoc.org>
+
+The code base is 100% API documented.
+* <https://q9f.github.io/eth.rb>
+
+More involved documentation, tutorials, and usage examples should go
+into the wiki.
+* <https://github.com/q9f/eth.rb/wiki>
+

data/README.md

@@ -23,7 +23,9 @@ A straightforward library to build, sign, and broadcast Ethereum transactions. I
 
 What you get:
 - [x] Secp256k1 Key-Pairs and Encrypted Ethereum Key-Stores (JSON)
+- [x] EIP-20 Token Transfers (ERC20)
 - [x] EIP-55 Checksummed Ethereum Addresses
+- [x] EIP-137 Ethereum Domain Name Service (ENS)
 - [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
@@ -36,7 +38,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)
-- [x] ~~Full~~ Some smart-contract support (deploy, transact, and call)
+- [x] Full smart-contract support (deploy, transact, and call)
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -78,6 +80,8 @@ The test suite expects working local HTTP and IPC endpoints with a prefunded dev
 geth --dev --http --ipcpath /tmp/geth.ipc &
 ```
 
+It also expects an `$INFURA_TOKEN` in environment to test some ENS queries on mainnet.
+
 To run tests, simply use `rspec`. Note, that the Ethereum test fixtures are also required.
 
 ```shell

data/SECURITY.md

@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+Ruby Ethereum 0.5.0 is a complete rewrite of the old `eth` 0.4.x gem.
+It also contains modules from `abi`, `rlp` and the `ethereum` gem.
+
+None of these gems are maintained anymore except for `eth` 0.5.0 and
+later.
+
+| Gem            | Version | Supported          |
+| -------------- | ------- | ------------------ |
+| `eth`          | 0.5.x   | :white_check_mark: |
+| `eth`          | < 0.5   | :x:                |
+| `ethereum`     | _any_   | :x:                |
+| `ethereum-abi` | _any_   | :x:                |
+| `rlp`          | _any_   | :x:                |
+
+## Reporting a Vulnerability
+
+Please report your findings to <security@q9f.cc>. Do not create a
+Github issue!
+
+You can expect an answer within 48 hours.