erc20 0.0.21 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b64594a5ded4f8f34912d468efbf8fd2a47b716098853df38857a3a0b973cd1e
-  data.tar.gz: bb0285b23d6624f633b92c45ab29bb0975e377a4ea971d0a9772c660c622b4ea
+  metadata.gz: fbce7bc57948f9c8acfeec7c0af2cf67e70e2447e064040485e6868d466828dc
+  data.tar.gz: cc521c55db79dca85e58235c886172a7ca81cf0f59ee61f5c134cc888eb3db4c
 SHA512:
-  metadata.gz: de7f6cb6ff26a078860cc9530146f49b7d5df6f462a51120fd48bd3ab9dde07bfe781c03952eb5625350c2e69dad10f2222b9edb05a0902ed4fb4fc564a055ea
-  data.tar.gz: 9ecd61346360053c15d3cdfdd838c3cfdb1d5eff1d789260a04e42662fa16d9183646d14a7fba19d1862d4f6a294ab7cfa19763c48ca4cf5586a4edf1c4e8ecd
+  metadata.gz: c712231ba46caabca78b45e9be366c120e2f5275bc734c874f69c7306d1f961c7b7c3a5b8ae58341cb4d48776a91c5a8bc8ec2360dfcbc294d46ae329d9bf8a4
+  data.tar.gz: 7a074720cfec0773a6e4e0cc70fe07fde201ae9897cb395a2b91a84429683354b822bef0be10650290b554ffe59b150034a1ea320eed34a396d574267954c130

data/.github/workflows/shellcheck.yml

@@ -1,5 +1,3 @@
-# (The MIT License)
-#
 # SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 ---

data/.gitignore

@@ -1,9 +1,10 @@
-coverage/
-.idea/
 *.gem
-.bundle/
 .DS_Store
-rdoc/
-doc/
+.bundle/
+.idea/
 .yardoc/
+coverage/
+doc/
 node_modules/
+rdoc/
+vendor/

data/.rultor.yml

@@ -3,7 +3,7 @@
 ---
 # yamllint disable rule:line-length
 docker:
-  image: yegor256/rultor-ruby
+  image: yegor256/ruby
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |

data/Gemfile

@@ -7,23 +7,23 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'backtrace', '>0', require: false
+gem 'cucumber', '~>9.2', require: false
 gem 'donce', '>0', require: false
 gem 'faraday', '>0', require: false
 gem 'loog', '>0', require: false
-gem 'minitest', '5.25.4', require: false
-gem 'minitest-reporters', '1.7.1', require: false
-gem 'minitest-retry', '0.2.5', require: false
+gem 'minitest', '~>5.25', require: false
+gem 'minitest-reporters', '~>1.7', require: false
+gem 'minitest-retry', '~>0.2', require: false
 gem 'qbash', '>0', require: false
-gem 'rake', '13.2.1', require: false
+gem 'rake', '~>13.2', require: false
 gem 'random-port', '>0', require: false
-gem 'rspec-rails', '7.1.1', require: false
-gem 'rubocop', '1.72.2', require: false
+gem 'rubocop', '~>1.75', require: false
 gem 'rubocop-minitest', '>0', require: false
 gem 'rubocop-performance', '>0', require: false
 gem 'rubocop-rake', '>0', require: false
 gem 'rubocop-rspec', '>0', require: false
-gem 'simplecov', '0.22.0', require: false
-gem 'simplecov-cobertura', '2.1.0', require: false
-gem 'threads', '0.4.1', require: false
+gem 'simplecov', '~>0.22', require: false
+gem 'simplecov-cobertura', '~>2.1', require: false
+gem 'threads', '~>0.4', require: false
 gem 'typhoeus', '>0', require: false
-gem 'yard', '0.9.37', require: false
+gem 'yard', '~>0.9', require: false

data/Gemfile.lock

@@ -7,61 +7,52 @@ PATH
       json (>= 2.10.1)
       jsonrpc-client (>= 0.1.4)
       loog (> 0)
+      slop (> 4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (8.0.1)
-      actionview (= 8.0.1)
-      activesupport (= 8.0.1)
-      nokogiri (>= 1.8.5)
-      rack (>= 2.2.4)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-      useragent (~> 0.16)
-    actionview (8.0.1)
-      activesupport (= 8.0.1)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activesupport (8.0.1)
-      base64
-      benchmark (>= 0.3)
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
     ansi (1.5.0)
-    ast (2.4.2)
+    ast (2.4.3)
     backtrace (0.4.0)
     base64 (0.2.0)
-    benchmark (0.4.0)
     bigdecimal (3.1.9)
     builder (3.3.0)
     concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
-    crass (1.0.6)
-    date (3.4.1)
-    diff-lcs (1.6.0)
+    cucumber (9.2.1)
+      builder (~> 3.2)
+      cucumber-ci-environment (> 9, < 11)
+      cucumber-core (> 13, < 14)
+      cucumber-cucumber-expressions (~> 17.0)
+      cucumber-gherkin (> 24, < 28)
+      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-messages (> 19, < 25)
+      diff-lcs (~> 1.5)
+      mini_mime (~> 1.1)
+      multi_test (~> 1.1)
+      sys-uname (~> 1.2)
+    cucumber-ci-environment (10.0.1)
+    cucumber-core (13.0.3)
+      cucumber-gherkin (>= 27, < 28)
+      cucumber-messages (>= 20, < 23)
+      cucumber-tag-expressions (> 5, < 7)
+    cucumber-cucumber-expressions (17.1.0)
+      bigdecimal
+    cucumber-gherkin (27.0.0)
+      cucumber-messages (>= 19.1.4, < 23)
+    cucumber-html-formatter (21.9.0)
+      cucumber-messages (> 19, < 28)
+    cucumber-messages (22.0.0)
+    cucumber-tag-expressions (6.1.2)
+    diff-lcs (1.6.1)
     docile (1.4.1)
     donce (0.1.0)
       backtrace (> 0)
       os (> 0)
       qbash (> 0)
-    drb (2.2.1)
     elapsed (0.0.1)
       loog (> 0)
       tago (> 0)
-    erubi (1.13.1)
     eth (0.5.13)
       forwardable (~> 1.3)
       keccak (~> 1.3)
@@ -89,14 +80,7 @@ GEM
       ffi (>= 1.15.5)
       rake
     forwardable (1.3.3)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
-    io-console (0.8.0)
-    irb (1.15.1)
-      pp (>= 0.6.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    json (2.10.1)
+    json (2.10.2)
     jsonrpc-client (0.1.4)
       faraday
       multi_json (>= 1.1.0)
@@ -104,13 +88,11 @@ GEM
     konstructor (1.0.2)
     language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    logger (1.6.6)
-    loofah (2.24.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
+    logger (1.7.0)
     loog (0.6.0)
+    mini_mime (1.1.5)
     mini_portile2 (2.8.8)
-    minitest (5.25.4)
+    minitest (5.25.5)
     minitest-reporters (1.7.1)
       ansi
       builder
@@ -119,58 +101,23 @@ GEM
     minitest-retry (0.2.5)
       minitest (>= 5.0)
     multi_json (1.15.0)
+    multi_test (1.1.0)
     net-http (0.6.0)
       uri
-    nokogiri (1.18.3-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.18.3-x64-mingw-ucrt)
-      racc (~> 1.4)
-    nokogiri (1.18.3-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.18.3-x86_64-linux-gnu)
-      racc (~> 1.4)
     openssl (3.3.0)
     os (1.1.4)
     parallel (1.26.3)
-    parser (3.3.7.1)
+    parser (3.3.7.4)
       ast (~> 2.4.1)
       racc
-    pkg-config (1.5.9)
-    pp (0.6.2)
-      prettyprint
-    prettyprint (0.2.0)
-    psych (5.2.3)
-      date
-      stringio
+    pkg-config (1.6.0)
+    prism (1.4.0)
     qbash (0.4.0)
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
       tago (> 0)
     racc (1.8.1)
-    rack (3.1.10)
-    rack-session (2.1.0)
-      base64 (>= 0.1.0)
-      rack (>= 3.0.0)
-    rack-test (2.2.0)
-      rack (>= 1.3)
-    rackup (2.2.1)
-      rack (>= 3)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
-      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.0.1)
-      actionpack (= 8.0.1)
-      activesupport (= 8.0.1)
-      irb (~> 1.13)
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      zeitwerk (~> 2.6)
     rainbow (3.1.1)
     rake (13.2.1)
     random-port (0.7.5)
@@ -179,30 +126,9 @@ GEM
       mini_portile2 (~> 2.8)
       pkg-config (~> 1.5)
       rubyzip (~> 2.3)
-    rdoc (6.12.0)
-      psych (>= 4.0.0)
     regexp_parser (2.10.0)
-    reline (0.6.0)
-      io-console (~> 0.5)
     rexml (3.4.1)
-    rspec-core (3.13.3)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-rails (7.1.1)
-      actionpack (>= 7.0)
-      activesupport (>= 7.0)
-      railties (>= 7.0)
-      rspec-core (~> 3.13)
-      rspec-expectations (~> 3.13)
-      rspec-mocks (~> 3.13)
-      rspec-support (~> 3.13)
-    rspec-support (3.13.2)
-    rubocop (1.72.2)
+    rubocop (1.75.2)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -210,18 +136,19 @@ GEM
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.0)
-      parser (>= 3.3.1.0)
-    rubocop-minitest (0.37.1)
+    rubocop-ast (1.44.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-minitest (0.38.0)
       lint_roller (~> 1.1)
-      rubocop (>= 1.72.1, < 2.0)
+      rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
-    rubocop-performance (1.24.0)
+    rubocop-performance (1.25.0)
       lint_roller (~> 1.1)
-      rubocop (>= 1.72.1, < 2.0)
+      rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
@@ -234,7 +161,6 @@ GEM
     scrypt (3.0.8)
       ffi-compiler (>= 1.0, < 2.0)
       rake (>= 9, < 14)
-    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -244,27 +170,24 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.3)
-    tago (0.0.2)
-    thor (1.3.2)
+    slop (4.10.1)
+    sys-uname (1.3.1)
+      ffi (~> 1.1)
+    tago (0.1.0)
     threads (0.4.1)
       backtrace (~> 0)
       concurrent-ruby (~> 1.0)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
     unicode-emoji (4.0.4)
-    uri (1.0.2)
-    useragent (0.16.11)
+    uri (1.0.3)
     websocket-driver (0.7.7)
       base64
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
     yard (0.9.37)
-    zeitwerk (2.7.2)
 
 PLATFORMS
   arm64-darwin-22
@@ -277,27 +200,27 @@ PLATFORMS
 
 DEPENDENCIES
   backtrace (> 0)
+  cucumber (~> 9.2)
   donce (> 0)
   erc20!
   faraday (> 0)
   loog (> 0)
-  minitest (= 5.25.4)
-  minitest-reporters (= 1.7.1)
-  minitest-retry (= 0.2.5)
+  minitest (~> 5.25)
+  minitest-reporters (~> 1.7)
+  minitest-retry (~> 0.2)
   qbash (> 0)
-  rake (= 13.2.1)
+  rake (~> 13.2)
   random-port (> 0)
-  rspec-rails (= 7.1.1)
-  rubocop (= 1.72.2)
+  rubocop (~> 1.75)
   rubocop-minitest (> 0)
   rubocop-performance (> 0)
   rubocop-rake (> 0)
   rubocop-rspec (> 0)
-  simplecov (= 0.22.0)
-  simplecov-cobertura (= 2.1.0)
-  threads (= 0.4.1)
+  simplecov (~> 0.22)
+  simplecov-cobertura (~> 2.1)
+  threads (~> 0.4)
   typhoeus (> 0)
-  yard (= 0.9.37)
+  yard (~> 0.9)
 
 BUNDLED WITH
    2.5.16

data/README.md

@@ -1,4 +1,4 @@
-# Etherium ERC20 Manipulations in Ruby
+# Ethereum ERC20 Manipulations in Ruby
 
 [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/erc20)](http://www.rultor.com/p/yegor256/erc20)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
@@ -12,9 +12,9 @@
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/erc20/blob/master/LICENSE.txt)
 
 This small Ruby [gem](https://rubygems.org/gems/erc20)
-makes manipulations with [Etherium] [ERC20] tokens
-as simple as they can be, if you have a provider of
-[JSON-RPC] and [WebSockets] Etherium APIs, for example
+makes manipulations with [Ethereum] [ERC20] tokens
+as simple as possible, when you have a provider of
+[JSON-RPC] and [WebSockets] Ethereum APIs, such as
 [Infura], [GetBlock], or [Alchemy]:
 
 ```ruby
@@ -44,10 +44,10 @@ w.accept(addresses) do |event|
 end
 ```
 
-It's also possible to check ETH balance and send ETH transaction:
+You can also check ETH balance and send ETH transactions:
 
 ```ruby
-# Check how many ETHs are there on the given address:
+# Check how many ETHs are on the given address:
 eth = w.eth_balance(address)
 
 # Send a few ETHs to someone and get transaction hash:
@@ -91,13 +91,32 @@ w = ERC20::Wallet.new(
 You can use [squid-proxy] [Docker] image to set up your own [HTTP proxy] server.
 
 Of course, this library works with [Polygon], [Optimism],
-and other forks of [Etherium].
+and other EVM compatible blockchains.
+
+## How to use in command line
+
+This gem also provides a command line tool for sending ETH and ERC20 payments
+and checking balances.
+
+First, you install it, via [gem]:
+
+```bash
+gem install erc20
+```
+
+Then, run it:
+
+```bash
+erc20 --help
+```
+
+Usage should be straightforward. If you have questions, please submit an issue.
 
 ## How to use in tests
 
-You can use `ERC20::FakeWallet` class that behaves exactly like
+You can use the `ERC20::FakeWallet` class that behaves exactly like
 `ERC20::Wallet`, but doesn't make any network connections to the provider.
-Also, it remembers all requests that were sent to it:
+Additionally, it records all requests sent to it:
 
 ```ruby
 require 'erc20'
@@ -110,7 +129,7 @@ assert w.history.include?({ method: :pay, priv:, address:, amount: 42_000 })
 
 Read
 [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
-Make sure you build is green before you contribute
+Make sure your build is green before you contribute
 your pull request. You will need to have
 [Ruby](https://www.ruby-lang.org/en/) 3.2+ and
 [Bundler](https://bundler.io/) installed. Then:
@@ -122,7 +141,8 @@ bundle exec rake
 
 If it's clean and you don't see any error messages, submit your pull request.
 
-[Etherium]: https://en.wikipedia.org/wiki/Ethereum
+[gem]: https://github.com/rubygems/rubygems
+[Ethereum]: https://en.wikipedia.org/wiki/Ethereum
 [ERC20]: https://ethereum.org/en/developers/docs/standards/tokens/erc-20/
 [JSON-RPC]: https://ethereum.org/en/developers/docs/apis/json-rpc/
 [Websockets]: https://ethereum.org/en/developers/tutorials/using-websockets/

data/REUSE.toml

@@ -4,15 +4,37 @@
 version = 1
 [[annotations]]
 path = [
+    "**.json",
+    "**.md",
+    "**.png",
+    "**.txt",
+    "**/*.csv",
+    "**/*.jpg",
+    "**/*.json",
+    "**/*.md",
+    "**/*.pdf",
+    "**/*.png",
+    "**/*.svg",
+    "**/*.txt",
+    "**/*.vm",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.gitleaksignore",
+    "**/.pdd",
+    "**/CNAME",
+    "**/Cargo.toml",
+    "**/Gemfile.lock",
+    ".DS_Store",
     ".gitattributes",
     ".gitignore",
     ".gitleaksignore",
     ".pdd",
+    "Cargo.toml",
     "Gemfile.lock",
     "README.md",
     "hardhat/.gitignore",
     "hardhat/package.json",
-    "renovate.json"
+    "renovate.json",
 ]
 precedence = "override"
 SPDX-FileCopyrightText = "Copyright (c) 2025 Yegor Bugayenko"

data/Rakefile

@@ -17,7 +17,7 @@ def version
   Gem::Specification.load(Dir['*.gemspec'].first).version
 end
 
-task default: %i[clean test rubocop yard]
+task default: %i[clean test features rubocop yard]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
@@ -42,6 +42,14 @@ RuboCop::RakeTask.new(:rubocop) do |task|
   task.requires << 'rubocop-rspec'
 end
 
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do
+  Rake::Cleaner.cleanup_files(['coverage'])
+end
+Cucumber::Rake::Task.new(:'features:html') do |t|
+  t.profile = 'html_report'
+end
+
 desc 'Run benchmark script'
 task :benchmark do
   ruby 'benchmarks/simple.rb'

data/bin/erc20

@@ -0,0 +1,152 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+$stdout.sync = true
+
+require 'backtrace'
+require 'loog'
+require 'slop'
+require_relative '../lib/erc20'
+require_relative '../lib/erc20/erc20'
+require_relative '../lib/erc20/wallet'
+
+begin
+  begin
+    opts = Slop.parse(ARGV, strict: true, help: true) do |o|
+      o.banner = "Usage (#{ERC20::VERSION}): erc20 [options] command [args]
+Commands are:
+    key:         Generate a new Ethereum private key (64 symbols)
+    address:     Turn private key into a public address (44 symbols)
+    price:       Get current price of one gas unit, in gwei
+    pay:         Send ERC20 payment
+    eth_pay:     Send ETH payment
+    balance:     Get ERC20 balance
+    eth_balance: Get ETH balance
+Options are:"
+      o.string(
+        '--contract',
+        'Public address of ERC20 contract',
+        default: ERC20::Wallet::USDT
+      )
+      o.integer(
+        '--chain',
+        'Ethereum chain ID',
+        default: 1
+      )
+      o.string(
+        '--host',
+        'Host name of the provider',
+        default: 'eth.llamarpc.com'
+      )
+      o.string(
+        '--port',
+        'TCP port of the provider',
+        default: 443
+      )
+      o.string(
+        '--http_path',
+        'URL path for the HTTP RPC entry point of the provider',
+        default: '/'
+      )
+      o.string(
+        '--ws_path',
+        'URL path for the Websockets entry point of the provider',
+        default: '/'
+      )
+      o.string(
+        '--proxy',
+        'HTTP/S proxy for all requests, e.g. "localhost:3128"'
+      )
+      o.integer(
+        '--attempts',
+        'How many times should we try before failing',
+        default: 1
+      )
+      o.bool(
+        '--dry',
+        'Don\'t send a real payment, run in a read-only mode'
+      )
+      o.bool('--help', 'Read this: https://github.com/yegor256/erc20') do
+        puts o
+        exit
+      end
+      o.bool('--verbose', 'Print all possible debug messages')
+    end
+  rescue Slop::Error => e
+    raise e.message
+  end
+  raise 'Try --help' if opts.arguments.empty?
+  log = opts[:verbose] ? Loog::VERBOSE : Loog::REGULAR
+  wallet = ERC20::Wallet.new(
+    contract: opts[:contract],
+    host: opts[:host], port: opts[:port],
+    http_path: opts[:http_path], ws_path: opts[:ws_path],
+    log:
+  )
+  case opts.arguments[0]
+  when 'key'
+    puts Eth::Key.new.private_hex
+  when 'address'
+    puts Eth::Key.new(priv: opts.arguments[1]).address.to_s
+  when 'price'
+    puts wallet.gas_price
+  when 'balance'
+    address = opts.arguments[1]
+    raise 'Address is required' if address.nil?
+    log.debug("Checking ERC20 balance of #{address}")
+    tokens = wallet.balance(address)
+    log.debug("The balance is #{tokens} ERC20 tokens (#{tokens.to_f / 1_000_000} USDT)")
+    puts tokens
+  when 'eth_balance'
+    address = opts.arguments[1]
+    raise 'Address is required' if address.nil?
+    log.debug("Checking ETH balance of #{address}")
+    wei = wallet.eth_balance(address)
+    log.debug("The balance of #{address} is #{wei} wei (#{format('%0.4f', wei.to_f / 1_000_000_000_000_000_000)} ETH)")
+    puts wei
+  when 'pay'
+    pkey = opts.arguments[1]
+    raise 'Private key is required' if pkey.nil?
+    priv = Eth::Key.new(priv: pkey)
+    log.debug("Sending ERC20 tokens from #{priv.address.to_s}")
+    address = opts.arguments[2]
+    raise 'Address is required' if address.nil?
+    log.debug("Sending ERC20 tokens to #{address}")
+    amount = opts.arguments[3]
+    raise 'Amount argument is required' if amount.nil?
+    raise 'Amount is not valid' unless /^[0-9]+(usdt)?$/.match?(amount)
+    amount = amount.to_i if /^[0-9]+$/.match?(amount)
+    amount = (amount.gsub(/usdt^/, '').to_f * 1_000_000).to_i if /^[0-9]usdt+$/.match?(amount)
+    log.debug("Sending #{amount} ERC20 tokens")
+    puts wallet.pay(priv.private_hex, address, amount)
+  when 'eth_pay'
+    pkey = opts.arguments[1]
+    raise 'Private key is required' if pkey.nil?
+    priv = Eth::Key.new(priv: pkey)
+    log.debug("Sending ETH from #{priv.address.to_s}")
+    address = opts.arguments[2]
+    raise 'Address is required' if address.nil?
+    log.debug("Sending ETH to #{address}")
+    amount = opts.arguments[3]
+    raise 'Amount argument is required' if amount.nil?
+    raise "Amount #{amount.inspect} is not valid" unless /^[0-9]+(\.[0-9]+)?(eth|wei|gwei)?$/.match?(amount)
+    amount = amount.to_i if /^[0-9]+$/.match?(amount)
+    amount = amount.gsub(/wei^/, '').to_i if /[0-9]wei+$/.match?(amount)
+    amount = (amount.gsub(/gwei^/, '').to_f * 1_000_000_000).to_i if /[0-9]gwei+$/.match?(amount)
+    amount = (amount.gsub(/eth^/, '').to_f * 1_000_000_000_000_000_000).to_i if /[0-9]eth+$/.match?(amount)
+    log.debug("Sending #{amount} wei...")
+    puts wallet.eth_pay(priv.private_hex, address, amount)
+  else
+    raise "Command #{opts.arguments[0]} is not supported"
+  end
+rescue StandardError => e
+  if opts[:verbose]
+    puts Backtrace.new(e)
+  else
+    puts "ERROR: #{e.message}"
+  end
+  exit(255)
+end

data/erc20.gemspec

@@ -12,22 +12,24 @@ Gem::Specification.new do |s|
   s.name = 'erc20'
   s.version = ERC20::VERSION
   s.license = 'MIT'
-  s.summary = 'Sending and receiving ERC20 tokens in Etherium network'
+  s.summary = 'Sending and receiving ERC20 tokens in Ethereum network'
   s.description =
     'A simple library for making ERC20 manipulations as easy as they ' \
     'can be for cryptocurrency newbies: checking balance, sending payments, ' \
     'and monitoring addresses for incoming payments. The library expects ' \
-    'Etherium node to provide JSON RPC and Websockets API.'
+    'Ethereum node to provide JSON RPC and Websockets API.'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'http://github.com/yegor256/erc20.rb'
   s.files = `git ls-files`.split($RS)
   s.rdoc_options = ['--charset=UTF-8']
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_dependency 'eth', '>=0.5.13'
   s.add_dependency 'faye-websocket', '>=0.11.3'
   s.add_dependency 'json', '>=2.10.1'
   s.add_dependency 'jsonrpc-client', '>=0.1.4'
   s.add_dependency 'loog', '>0'
+  s.add_dependency 'slop', '>4'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/features/cli.feature

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+Feature: Command Line Processing
+  As a simple ETH/ERC20 user I want to send payments
+
+  Scenario: Help can be printed
+    When I run bin/erc20 with "--help"
+    Then Exit code is zero
+    And Stdout contains "--help"
+
+  Scenario: Gas price price can be retrieved
+    When I run bin/erc20 with "price --attempts=4"
+    Then Exit code is zero
+
+  Scenario: ETH private key can be generated
+    When I run bin/erc20 with "key"
+    Then Exit code is zero
+
+  Scenario: ETH address can be created
+    When I run bin/erc20 with "address 46feba063e9b59a8ae0dba68abd39a3cb8f52089e776576d6eb1bb5bfec123d1"
+    Then Exit code is zero
+
+  Scenario: ERC20 balance can be checked
+    When I run bin/erc20 with "balance 0x7232148927F8a580053792f44D4d59d40Fd00ABD --verbose"
+    Then Exit code is zero
+
+  Scenario: ETH balance can be checked
+    When I run bin/erc20 with "eth_balance 0x7232148927F8a580053792f44D4d59d40Fd00ABD --verbose"
+    Then Exit code is zero

data/features/gem_package.feature

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+Feature: Gem Package
+  As a source code writer I want to be able to
+  package the Gem into .gem file
+
+  Scenario: Gem can be packaged
+    Given It is Unix
+    Given I have a "execs.rb" file with content:
+    """
+    #!/usr/bin/env ruby
+    require 'rubygems'
+    spec = Gem::Specification::load('./spec.rb')
+    if spec.executables.empty?
+      fail 'no executables: ' + File.read('./spec.rb')
+    end
+    """
+    When I run bash with:
+    """
+    cd erc20
+    gem build erc20.gemspec
+    gem specification --ruby erc20-*.gem > ../spec.rb
+    cd ..
+    ruby execs.rb
+    """
+    Then Exit code is zero

data/features/step_definitions/steps.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'tmpdir'
+require 'slop'
+require 'English'
+require_relative '../../lib/erc20'
+
+Before do
+  @cwd = Dir.pwd
+  @dir = Dir.mktmpdir('test')
+  FileUtils.mkdir_p(@dir)
+  Dir.chdir(@dir)
+  @opts =
+    Slop.parse ['-v'] do |o|
+      o.bool '-v', '--verbose'
+    end
+end
+
+After do
+  Dir.chdir(@cwd)
+  FileUtils.rm_rf(@dir)
+end
+
+Given(/^I have a "([^"]*)" file with content:$/) do |file, text|
+  FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(file)
+  File.write(file, text.gsub('\\xFF', 0xFF.chr))
+end
+
+When(%r{^I run bin/erc20 with "([^"]*)"$}) do |arg|
+  home = File.join(File.dirname(__FILE__), '../..')
+  @stdout = `ruby -I#{home}/lib #{home}/bin/erc20 #{arg}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+Then(/^Stdout contains "([^"]*)"$/) do |txt|
+  raise "STDOUT doesn't contain '#{txt}':\n#{@stdout}" unless @stdout.include?(txt)
+end
+
+Then(/^Stdout is empty$/) do
+  raise "STDOUT is not empty:\n#{@stdout}" unless @stdout == ''
+end
+
+Then(/^Exit code is zero$/) do
+  raise "Non-zero exit #{@exitstatus}:\n#{@stdout}" unless @exitstatus.zero?
+end
+
+Then(/^Exit code is not zero$/) do
+  raise 'Zero exit code' if @exitstatus.zero?
+end
+
+When(/^I run bash with "([^"]*)"$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@dir, 'erc20'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+When(/^I run bash with:$/) do |text|
+  FileUtils.copy_entry(@cwd, File.join(@dir, 'erc20'))
+  @stdout = `#{text}`
+  @exitstatus = $CHILD_STATUS.exitstatus
+end
+
+Given(/^It is Unix$/) do
+  pending if Gem.win_platform?
+end
+
+Given(/^It is Windows$/) do
+  pending unless Gem.win_platform?
+end

data/features/support/env.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+require 'simplecov'
+require 'cucumber'
+require_relative '../../lib/erc20'

data/lib/erc20/erc20.rb

@@ -3,9 +3,9 @@
 # SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
 # SPDX-License-Identifier: MIT
 
-# This module makes manipulations with Etherium ERC20 tokens
+# This module makes manipulations with Ethereum ERC20 tokens
 # as simple as they can be, if you have a provider of
-# JSON-RPC and WebSockets Etherium APIs, for example
+# JSON-RPC and WebSockets Ethereum APIs, for example
 # Infura, GetBlock, or Alchemy.
 #
 # Start like this:
@@ -25,5 +25,5 @@
 # License:: MIT
 module ERC20
   # Current version of the gem (changed by the +.rultor.yml+ on every release)
-  VERSION = '0.0.21'
+  VERSION = '0.1.1'
 end

data/lib/erc20/fake_wallet.rb

@@ -91,9 +91,11 @@ class ERC20::FakeWallet
 
   # Send a single ERC20 payment from a private address to a public one.
   #
-  # @param [String] _priv Private key, in hex
-  # @param [String] _address Public key, in hex
-  # @param [Integer] _amount The amount of ERC20 tokens to send
+  # @param [String] priv Private key, in hex
+  # @param [String] address Public key, in hex
+  # @param [Integer] amount The amount of ERC20 tokens to send
+  # @param [Integer] gas_limit Optional gas limit
+  # @param [Integer] gas_price Optional gas price in gwei
   # @return [String] Transaction hash
   def pay(priv, address, amount, gas_limit: nil, gas_price: nil)
     hex = TXN_HASH
@@ -106,6 +108,7 @@ class ERC20::FakeWallet
   # @param [String] priv Private key, in hex
   # @param [String] address Public key, in hex
   # @param [Integer] amount The amount of ETHs to send
+  # @param [Integer] gas_price Optional gas price in gwei
   # @return [String] Transaction hash
   def eth_pay(priv, address, amount, gas_price: nil)
     hex = TXN_HASH

data/lib/erc20/wallet.rb

@@ -12,7 +12,7 @@ require 'loog'
 require 'uri'
 require_relative 'erc20'
 
-# A wallet with ERC20 tokens on Etherium.
+# A wallet with ERC20 tokens on Ethereum.
 #
 # Objects of this class are thread-safe.
 #
@@ -64,7 +64,7 @@ class ERC20::Wallet
   attr_reader :host, :port, :ssl, :chain, :contract, :ws_path, :http_path
 
   # Constructor.
-  # @param [String] contract Hex of the contract in Etherium
+  # @param [String] contract Hex of the contract in Ethereum
   # @param [Integer] chain The ID of the chain (1 for mainnet)
   # @param [String] host The host to connect to
   # @param [Integer] port TCP port to use
@@ -107,9 +107,9 @@ class ERC20::Wallet
 
   # Get ERC20 balance of a public address (it's not the same as ETH balance!).
   #
-  # An address in Etherium may have many balances. One of them is the main
-  # balance in ETH crypto. Another balance is the one kept by ERC20 contract
-  # in its own ledge in root storage. This balance is checked by this method.
+  # An address in Ethereum may have many balances. One of them is the main
+  # balance in ETH crypto. Another balance is the one kept by the ERC20 contract
+  # in its own ledger in root storage. This balance is checked by this method.
   #
   # @param [String] address Public key, in hex, starting from '0x'
   # @return [Integer] Balance, in tokens
@@ -127,7 +127,7 @@ class ERC20::Wallet
 
   # Get ETH balance of a public address.
   #
-  # An address in Etherium may have many balances. One of them is the main
+  # An address in Ethereum may have many balances. One of them is the main
   # balance in ETH crypto. This balance is checked by this method.
   #
   # @param [String] hex Public key, in hex, starting from '0x'
@@ -142,12 +142,12 @@ class ERC20::Wallet
     b
   end
 
-  # How much gas units is required in order to send ERC20 transaction.
+  # How many gas units are required to send an ERC20 transaction.
   #
-  # @param [String] from The departing address, in hex
-  # @param [String] to Arriving address, in hex
+  # @param [String] from The sending address, in hex
+  # @param [String] to The receiving address, in hex
   # @param [Integer] amount How many ERC20 tokens to send
-  # @return [Integer] How many gas units required
+  # @return [Integer] Number of gas units required
   def gas_estimate(from, to, amount)
     raise 'Address can\'t be nil' unless from
     raise 'Address must be a String' unless from.is_a?(String)
@@ -164,15 +164,33 @@ class ERC20::Wallet
   end
 
   # What is the price of gas unit in gwei?
+  #
+  # In Ethereum, gas is a unit that measures the computational work required to
+  # execute operations on the network. Every transaction and smart contract
+  # interaction consumes gas. Gas price is the amount of ETH you're willing to pay
+  # for each unit of gas, denominated in gwei (1 gwei = 0.000000001 ETH). Higher
+  # gas prices incentivize miners to include your transaction sooner, while lower
+  # prices may result in longer confirmation times.
+  #
   # @return [Integer] Price of gas unit, in gwei (0.000000001 ETH)
   def gas_price
-    gwei = jsonrpc.eth_getBlockByNumber('latest', false)['baseFeePerGas'].to_i(16)
+    block = jsonrpc.eth_getBlockByNumber('latest', false)
+    raise "Can't get gas price, try again later" if block.nil?
+    gwei = block['baseFeePerGas'].to_i(16)
     @log.debug("The cost of one gas unit is #{gwei} gwei")
     gwei
   end
 
   # Send a single ERC20 payment from a private address to a public one.
   #
+  # ERC20 payments differ fundamentally from native ETH transfers. While ETH transfers
+  # simply move the cryptocurrency directly between addresses, ERC20 token transfers
+  # are actually interactions with a smart contract. When you transfer ERC20 tokens,
+  # you're not sending anything directly to another user - instead, you're calling
+  # the token contract's transfer function, which updates its internal ledger to
+  # decrease your balance and increase the recipient's balance. This requires more
+  # gas than ETH transfers since it involves executing contract code.
+  #
   # @param [String] priv Private key, in hex
   # @param [String] address Public key, in hex
   # @param [Integer] amount The amount of ERC20 tokens to send
@@ -225,8 +243,7 @@ class ERC20::Wallet
   #
   # @param [String] priv Private key, in hex
   # @param [String] address Public key, in hex
-  # @param [Integer] amount The amount of ERC20 tokens to send
-  # @param [Integer] limit How much gas you're ready to spend
+  # @param [Integer] amount The amount of ETH to send
   # @param [Integer] price How much gas you pay per computation unit
   # @return [String] Transaction hash
   def eth_pay(priv, address, amount, price: gas_price)
@@ -272,7 +289,7 @@ class ERC20::Wallet
   # +Thread.kill+.
   #
   # The array with the list of addresses (+addresses+) may change its
-  # content on-fly. The +accept()+ method will +eht_subscribe+ to the addresses
+  # content on-the-fly. The +accept()+ method will +eth_subscribe+ to the addresses
   # that are added and will +eth_unsubscribe+ from those that are removed.
   # Once we actually start listening, the +active+ array will be updated
   # with the list of addresses.
@@ -291,8 +308,8 @@ class ERC20::Wallet
     raise 'Addresses must respond to .to_a()' unless addresses.respond_to?(:to_a)
     raise 'Active can\'t be nil' unless active
     raise 'Active must respond to .append()' unless active.respond_to?(:append)
-    raise 'Amount must be an Integer' unless delay.is_a?(Integer)
-    raise 'Amount must be a positive Integer' unless delay.positive?
+    raise 'Delay must be an Integer' unless delay.is_a?(Integer)
+    raise 'Delay must be a positive Integer' unless delay.positive?
     raise 'Subscription ID must be an Integer' unless subscription_id.is_a?(Integer)
     raise 'Subscription ID must be a positive Integer' unless subscription_id.positive?
     EventMachine.run do
@@ -332,7 +349,7 @@ class ERC20::Wallet
                 txn: event['transactionHash'].downcase
               }
               log.debug(
-                "Payment of #{event[:amount]} tokens arrived" \
+                "Payment of #{event[:amount]} tokens arrived " \
                 "from #{event[:from]} to #{event[:to]} in #{event[:txn]}"
               )
             end

data/test/erc20/test_fake_wallet.rb

@@ -13,8 +13,8 @@ require 'random-port'
 require 'shellwords'
 require 'threads'
 require 'typhoeus'
-require_relative '../../lib/erc20/fake_wallet'
 require_relative '../test__helper'
+require_relative '../../lib/erc20/fake_wallet'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)

data/test/erc20/test_wallet.rb

@@ -13,15 +13,15 @@ require 'random-port'
 require 'shellwords'
 require 'threads'
 require 'typhoeus'
-require_relative '../../lib/erc20/wallet'
 require_relative '../test__helper'
+require_relative '../../lib/erc20/wallet'
 
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
 class TestWallet < Minitest::Test
-  # At this address, in Etherium mainnet, there are $8 USDT and 0.0042 ETH. I won't
+  # At this address, in Ethereum mainnet, there are $8 USDT and 0.0042 ETH. I won't
   # move them anyway, that's why tests can use this address forever.
   STABLE = '0x7232148927F8a580053792f44D4d59d40Fd00ABD'
 
@@ -76,7 +76,8 @@ class TestWallet < Minitest::Test
   def test_checks_balance_on_polygon
     w = ERC20::Wallet.new(
       contract: '0xc2132D05D31c914a87C6611C10748AEb04B58e8F',
-      host: 'polygon-mainnet.infura.io', http_path: "/v3/#{env('INFURA_KEY')}",
+      host: 'polygon-mainnet.infura.io',
+      http_path: "/v3/#{env('INFURA_KEY')}",
       log: loog
     )
     b = w.balance(STABLE)
@@ -290,20 +291,19 @@ class TestWallet < Minitest::Test
 
   def test_checks_balance_via_proxy_on_mainnet
     via_proxy do |proxy|
-      on_hardhat do
-        w = ERC20::Wallet.new(
-          host: 'mainnet.infura.io', http_path: "/v3/#{env('INFURA_KEY')}",
-          proxy:, log: loog
-        )
-        assert_equal(8_000_000, w.balance(STABLE))
-      end
+      w = ERC20::Wallet.new(
+        host: 'mainnet.infura.io',
+        http_path: "/v3/#{env('INFURA_KEY')}",
+        proxy:, log: loog
+      )
+      assert_equal(8_000_000, w.balance(STABLE))
     end
   end
 
   def test_pays_on_mainnet
     skip('This is live, must be run manually')
     w = mainnet
-    print 'Enter Etherium ERC20 private key (64 chars): '
+    print 'Enter Ethereum ERC20 private key (64 chars): '
     priv = gets.chomp
     to = '0xEB2fE8872A6f1eDb70a2632EA1f869AB131532f6'
     txn = w.pay(priv, to, 1_990_000)
@@ -315,6 +315,7 @@ class TestWallet < Minitest::Test
   def env(var)
     key = ENV.fetch(var, nil)
     skip("The #{var} environment variable is not set") if key.nil?
+    skip("The #{var} environment variable is empty") if key.empty?
     key
   end
 

data/test/test__helper.rb

@@ -20,7 +20,7 @@ Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
 # To make tests retry on failure:
 if ENV['RAKE']
   require 'minitest/retry'
-  Minitest::Retry.use!(methods_to_skip: [])
+  Minitest::Retry.use!
 end
 
 # Primitive array.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.1.1
 platform: ruby
 authors:
 - Yegor Bugayenko
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eth
@@ -80,12 +79,27 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '4'
 description: 'A simple library for making ERC20 manipulations as easy as they can
   be for cryptocurrency newbies: checking balance, sending payments, and monitoring
-  addresses for incoming payments. The library expects Etherium node to provide JSON
+  addresses for incoming payments. The library expects Ethereum node to provide JSON
   RPC and Websockets API.'
 email: yegor256@gmail.com
-executables: []
+executables:
+- erc20
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -117,7 +131,12 @@ files:
 - README.md
 - REUSE.toml
 - Rakefile
+- bin/erc20
 - erc20.gemspec
+- features/cli.feature
+- features/gem_package.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
 - hardhat/.gitignore
 - hardhat/Dockerfile
 - hardhat/contracts/Foo.sol
@@ -137,7 +156,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -153,8 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
-summary: Sending and receiving ERC20 tokens in Etherium network
+summary: Sending and receiving ERC20 tokens in Ethereum network
 test_files: []