erc20 0.0.21 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b64594a5ded4f8f34912d468efbf8fd2a47b716098853df38857a3a0b973cd1e
-  data.tar.gz: bb0285b23d6624f633b92c45ab29bb0975e377a4ea971d0a9772c660c622b4ea
+  metadata.gz: c869348131d5d5bcb38966bc1eaac3d3e9655b11d6846f7ca9bc54893fb68458
+  data.tar.gz: 625b971154f40e09a8fd66091d154df5657efc4dee202bf3a5db3cc62c7e2a54
 SHA512:
-  metadata.gz: de7f6cb6ff26a078860cc9530146f49b7d5df6f462a51120fd48bd3ab9dde07bfe781c03952eb5625350c2e69dad10f2222b9edb05a0902ed4fb4fc564a055ea
-  data.tar.gz: 9ecd61346360053c15d3cdfdd838c3cfdb1d5eff1d789260a04e42662fa16d9183646d14a7fba19d1862d4f6a294ab7cfa19763c48ca4cf5586a4edf1c4e8ecd
+  metadata.gz: 30abb7a895214f536f1c91ad6758b023ded4d28be61265c1db9576a60e71e3b3737b7c86157ba314d649b4096dd86b93936920d8c8a0d76ded554c86da69d931
+  data.tar.gz: 39083d6adc8e2eed75a7d548c2ae4a8311fc226199f2f6c679f23012945a31b2458a766278cb028fd7754d5c95975b2bbde7afbeb1342591cc1f3bf5d8b4f69e

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

@@ -7,3 +7,4 @@ rdoc/
 doc/
 .yardoc/
 node_modules/
+vendor/

data/Gemfile

@@ -7,6 +7,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'backtrace', '>0', require: false
+gem 'cucumber', '9.1.2', require: false
 gem 'donce', '>0', require: false
 gem 'faraday', '>0', require: false
 gem 'loog', '>0', require: false

data/Gemfile.lock

@@ -7,6 +7,7 @@ PATH
       json (>= 2.10.1)
       jsonrpc-client (>= 0.1.4)
       loog (> 0)
+      slop (> 4)
 
 GEM
   remote: https://rubygems.org/
@@ -50,6 +51,31 @@ GEM
     concurrent-ruby (1.3.5)
     connection_pool (2.5.0)
     crass (1.0.6)
+    cucumber (9.1.2)
+      builder (~> 3.2, >= 3.2.4)
+      cucumber-ci-environment (~> 9.2, >= 9.2.0)
+      cucumber-core (~> 12.0)
+      cucumber-cucumber-expressions (~> 17.0)
+      cucumber-gherkin (> 24, < 27)
+      cucumber-html-formatter (> 20.3, < 22)
+      cucumber-messages (> 19, < 25)
+      diff-lcs (~> 1.5)
+      mini_mime (~> 1.1, >= 1.1.5)
+      multi_test (~> 1.1, >= 1.1.0)
+      sys-uname (~> 1.2, >= 1.2.3)
+    cucumber-ci-environment (9.2.0)
+    cucumber-core (12.0.0)
+      cucumber-gherkin (>= 25, < 27)
+      cucumber-messages (>= 20, < 23)
+      cucumber-tag-expressions (~> 5.0, >= 5.0.4)
+    cucumber-cucumber-expressions (17.1.0)
+      bigdecimal
+    cucumber-gherkin (26.2.0)
+      cucumber-messages (>= 19.1.4, < 22.1)
+    cucumber-html-formatter (21.9.0)
+      cucumber-messages (> 19, < 28)
+    cucumber-messages (22.0.0)
+    cucumber-tag-expressions (5.0.6)
     date (3.4.1)
     diff-lcs (1.6.0)
     docile (1.4.1)
@@ -109,6 +135,7 @@ GEM
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     loog (0.6.0)
+    mini_mime (1.1.5)
     mini_portile2 (2.8.8)
     minitest (5.25.4)
     minitest-reporters (1.7.1)
@@ -119,6 +146,7 @@ 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)
@@ -244,7 +272,10 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.3)
+    slop (4.10.1)
+    stringio (3.1.5)
+    sys-uname (1.3.1)
+      ffi (~> 1.1)
     tago (0.0.2)
     thor (1.3.2)
     threads (0.4.1)
@@ -277,6 +308,7 @@ PLATFORMS
 
 DEPENDENCIES
   backtrace (> 0)
+  cucumber (= 9.1.2)
   donce (> 0)
   erc20!
   faraday (> 0)

data/README.md

@@ -93,6 +93,25 @@ 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].
 
+## 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
+```
+
+It should be obvious how to use it. If not, please, submit an issue.
+
 ## How to use in tests
 
 You can use `ERC20::FakeWallet` class that behaves exactly like
@@ -122,6 +141,7 @@ bundle exec rake
 
 If it's clean and you don't see any error messages, submit your pull request.
 
+[gem]: https://github.com/rubygems/rubygems
 [Etherium]: 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/

data/REUSE.toml

@@ -4,15 +4,27 @@
 version = 1
 [[annotations]]
 path = [
+    "**/*.csv",
+    "**/*.jpg",
+    "**/*.json",
+    "**/*.md",
+    "**/*.pdf",
+    "**/*.png",
+    "**/*.svg",
+    "**/*.txt",
+    "**/*.vm",
+    "**/.gitignore",
+    "**/CNAME",
     ".gitattributes",
     ".gitignore",
     ".gitleaksignore",
     ".pdd",
+    ".xcop",
     "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 Etherium 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',
+        'Etherium 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

@@ -23,11 +23,13 @@ Gem::Specification.new do |s|
   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

@@ -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.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.21
+  version: 0.1.0
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-19 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eth
@@ -80,12 +80,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
   RPC and Websockets API.'
 email: yegor256@gmail.com
-executables: []
+executables:
+- erc20
 extensions: []
 extra_rdoc_files:
 - README.md
@@ -117,7 +132,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