erc20 0.2.8 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34ffb8c4c36d85d7afb74f0a573cc97cb58502ddcb5b39cdd032f771b9547592
-  data.tar.gz: 5bb3efad4575d96a7d5fc0a3abc58b79835ec1954177dd774858793431595ce8
+  metadata.gz: bdb92899afb7e0f3ac74c59c07cdf1f48441d8b8bab6c96fadffe506c49dcedd
+  data.tar.gz: fd0faec13d2aafdd1cbd02afd0066c17b308b96637469f60eca0cbd1d5102629
 SHA512:
-  metadata.gz: 4db054bf7264d2df18927384fdbbf6d72152aab5103456e319143681cc97653b7d2236941dbb26961f7de3b9752d7e057382f3695d63e7b3ba4ae92f78e8f00b
-  data.tar.gz: 5eb68447c8736c39125d19daf27c5856ca7122b3b26784f024efc2fadcf1d5f55b6bb3ff088e335ef29cf55facfa8b734e42d9bb42a28aff78826c6e99dd2d28
+  metadata.gz: 509bdbaa8838f52ad6ea7d8a779001c1bfd87ba9c448ce4b808849967575069b8452e3a1f50b506c38f282b709e31e690a31b4247452b34d8cc097caa72e3b45
+  data.tar.gz: 8fa48303af7a75dd4019062bb9d3904c84f76f16dd994ee95d3d6cb0f952c9e207030be9063781c3224af6d0a3cde0f107667cdd4447c9fdc4108a05725b3bc3

data/Gemfile.lock

@@ -8,7 +8,7 @@ PATH
       json (~> 2.10)
       jsonrpc-client (~> 0.1)
       loog (~> 0.4)
-      slop (~> 4.0)
+      thor (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
@@ -189,12 +189,12 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.2)
     simplecov_json_formatter (0.1.4)
-    slop (4.10.1)
     stringio (3.2.0)
     sys-uname (1.4.1)
       ffi (~> 1.1)
       memoist3 (~> 1.0.0)
-    tago (0.6.0)
+    tago (0.7.0)
+    thor (1.5.0)
     threads (0.5.0)
       backtrace (~> 0)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -122,7 +122,7 @@ gem install erc20
 Then, run it:
 
 ```bash
-erc20 --help
+erc20 help
 ```
 
 Usage should be straightforward. If you have questions, please submit an issue.

data/bin/erc20

@@ -8,126 +8,140 @@ $stdout.sync = true
 
 require 'backtrace'
 require 'loog'
-require 'slop'
+require 'thor'
 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.bool(
-        '--ssl',
-        'Use SSL for HTTP connections',
-        default: true
-      )
-      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
+# Command line interface for ERC20 operations.
+#
+# This CLI provides commands for managing ERC20 tokens and ETH on Ethereum:
+# generating keys, checking balances, and sending payments.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2025 Yegor Bugayenko
+# License:: MIT
+class Bin < Thor
+  def self.exit_on_failure?
+    true
   end
-  raise 'Try --help' if opts.arguments.empty?
-  log = opts[:verbose] ? Loog::VERBOSE : Loog::REGULAR
-  wallet =
-    if opts[:dry]
-      ERC20::FakeWallet.new
-    else
-      ERC20::Wallet.new(
-        contract: opts[:contract],
-        host: opts[:host], port: opts[:port].to_i,
-        http_path: opts[:http_path], ws_path: opts[:ws_path],
-        ssl: opts[:ssl],
-        log:
-      )
-    end
-  case opts.arguments[0]
-  when 'key'
-    puts Eth::Key.new.private_hex.downcase
-  when 'address'
-    puts Eth::Key.new(priv: opts.arguments[1]).address.to_s.downcase
-  when 'price'
-    puts wallet.gas_price
-  when 'balance'
-    address = opts.arguments[1]
-    raise 'Address is required' if address.nil?
+
+  class_option :contract, type: :string, default: ERC20::Wallet::USDT,
+    desc: 'Public address of ERC20 contract'
+  class_option :chain, type: :numeric, default: 1,
+    desc: 'Ethereum chain ID'
+  class_option :ssl, type: :boolean, default: true,
+    desc: 'Use SSL for HTTP connections'
+  class_option :host, type: :string, default: 'eth.llamarpc.com',
+    desc: 'Host name of the provider'
+  class_option :port, type: :numeric, default: 443,
+    desc: 'TCP port of the provider'
+  class_option :http_path, type: :string, default: '/',
+    desc: 'URL path for the HTTP RPC entry point of the provider'
+  class_option :ws_path, type: :string, default: '/',
+    desc: 'URL path for the Websockets entry point of the provider'
+  class_option :proxy, type: :string,
+    desc: 'HTTP/S proxy for all requests, e.g. "localhost:3128"'
+  class_option :attempts, type: :numeric, default: 1,
+    desc: 'How many times should we try before failing'
+  class_option :dry, type: :boolean, default: false,
+    desc: "Don't send a real payment, run in a read-only mode"
+  class_option :verbose, type: :boolean, default: false,
+    desc: 'Print all possible debug messages'
+
+  desc 'version', 'Print version of the tool'
+  def version
+    log.info(ERC20::VERSION)
+  end
+
+  desc 'key', 'Generate a new Ethereum private key (64 hex symbols)'
+  def key
+    log.info(Eth::Key.new.private_hex.downcase)
+  end
+
+  desc 'address KEY', 'Turn private key into a public address (44 hex symbols)'
+  def address(pvt)
+    log.info(Eth::Key.new(priv: pvt).address.to_s.downcase)
+  end
+
+  desc 'price', 'Get current price of one gas unit, in gwei'
+  def price
+    log.info(wallet.gas_price)
+  end
+
+  desc 'balance ADDRESS', 'Get ERC20 balance'
+  def balance(address)
     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.info(tokens)
+  end
+
+  desc 'eth_balance ADDRESS', 'Get ETH balance'
+  def eth_balance(address)
     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?
+    log.info(wei)
+  end
+
+  desc 'pay KEY ADDRESS AMOUNT', 'Send ERC20 payment'
+  def pay(pkey, address, amount)
     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 from #{priv.address}")
     log.debug("Sending ERC20 tokens to #{address}")
-    amount = opts.arguments[3]
-    raise 'Amount argument is required (for example, "19.9usdt" or "$19.9")' if amount.nil?
+    amount = tokens(amount)
+    log.debug("Sending #{amount} ERC20 tokens")
+    if wallet.eth_balance(priv.address.to_s).zero?
+      log.debug("ETH balance of #{priv.address} is zero, the txn most definitely will be rejected by the server!")
+    end
+    log.info(wallet.pay(priv.private_hex, address, amount))
+  end
+
+  desc 'eth_pay KEY ADDRESS AMOUNT', 'Send ETH payment'
+  def eth_pay(pkey, address, amount)
+    priv = Eth::Key.new(priv: pkey)
+    log.debug("Sending ETH from #{priv.address}")
+    log.debug("Sending ETH to #{address}")
+    raise "Amount #{amount.inspect} is not valid" unless /^[0-9]+(\.[0-9]+)?(eth|wei|gwei)?$/.match?(amount)
+    amount = wei(amount)
+    log.debug("Sending #{amount} wei...")
+    log.info(wallet.eth_pay(priv.private_hex, address, amount))
+  end
+
+  def self.banner(task, namespace = false, subcommand = false)
+    "#{basename} #{task.usage}"
+  end
+
+  def self.help(shell, subcommand = false)
+    shell.say "Usage (#{ERC20::VERSION}): erc20 [options] command [args]"
+    shell.say 'Commands are:'
+    super
+    shell.say "\nRead this: https://github.com/yegor256/erc20"
+  end
+
+  private
+
+  def log
+    @log ||= options[:verbose] ? Loog::VERBOSE : Loog::REGULAR
+  end
+
+  def wallet
+    @wallet ||=
+      if options[:dry]
+        ERC20::FakeWallet.new
+      else
+        ERC20::Wallet.new(
+          contract: options[:contract],
+          host: options[:host], port: options[:port].to_i,
+          http_path: options[:http_path], ws_path: options[:ws_path],
+          ssl: options[:ssl],
+          log: log
+        )
+      end
+  end
+
+  def tokens(amount)
     if /^[0-9]+$/.match?(amount)
       amount = amount.to_i
       log.debug("The token amount equals to #{amount} ERC20 tokens (as provided)")
@@ -140,43 +154,29 @@ Options are:"
     else
       raise "Can't understand amount: #{amount.inspect}"
     end
-    log.debug("Sending #{amount} ERC20 tokens")
-    if wallet.eth_balance(priv.address.to_s).zero?
-      log.debug("ETH balance of #{priv.address} is zero, the txn most definitely will be rejected by the server!")
-    end
-    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
+  end
+
+  def wei(amount)
     if /^[0-9]+$/.match?(amount)
-      amount = amount.to_i
-    elsif /[0-9]wei+$/.match?(amount)
-      amount = amount.gsub(/wei^/, '').to_i
-    elsif /[0-9]gwei+$/.match?(amount)
-      amount = (amount.gsub(/gwei^/, '').to_f * 1_000_000_000).to_i
-    elsif /[0-9]eth+$/.match?(amount)
-      amount = (amount.gsub(/eth^/, '').to_f * 1_000_000_000_000_000_000).to_i
+      amount.to_i
+    elsif /[0-9]wei$/.match?(amount)
+      amount.gsub(/wei$/, '').to_i
+    elsif /[0-9]gwei$/.match?(amount)
+      (amount.gsub(/gwei$/, '').to_f * 1_000_000_000).to_i
+    elsif /[0-9]eth$/.match?(amount)
+      (amount.gsub(/eth$/, '').to_f * 1_000_000_000_000_000_000).to_i
     else
       raise "Can't understand amount: #{amount.inspect}"
     end
-    log.debug("Sending #{amount} wei...")
-    puts wallet.eth_pay(priv.private_hex, address, amount)
-  else
-    raise "Command #{opts.arguments[0]} is not supported"
   end
+end
+
+begin
+  Bin.start(ARGV)
 rescue StandardError => e
-  if opts[:verbose]
-    puts Backtrace.new(e)
-  else
-    puts "ERROR: #{e.message}"
-  end
+  log = ARGV.include?('--verbose') ? Loog::VERBOSE : Loog::REGULAR
+  log.debug(Backtrace.new(e))
+  log.error(e.message)
   exit(255)
 end

data/erc20.gemspec

@@ -31,6 +31,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'json', '~>2.10'
   s.add_dependency 'jsonrpc-client', '~>0.1'
   s.add_dependency 'loog', '~>0.4'
-  s.add_dependency 'slop', '~>4.0'
+  s.add_dependency 'thor', '~>1.3'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/features/cli.feature

@@ -2,16 +2,12 @@
 # SPDX-License-Identifier: MIT
 
 Feature: Command Line Processing
-  As a simple ETH/ERC20 user I want to send payments
+  As a simple ETH/ERC20 user I want to use it
 
   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"
+    When I run bin/erc20 with "help"
     Then Exit code is zero
+    And Stdout contains "help"
 
   Scenario: ETH private key can be generated
     When I run bin/erc20 with "key"
@@ -20,11 +16,3 @@ Feature: Command Line Processing
   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/live.feature

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
+# SPDX-License-Identifier: MIT
+
+Feature: Command Line Processing
+  As a simple ETH/ERC20 user I want to use it live
+
+  Scenario: Gas price price can be retrieved
+    When I run bin/erc20 with "price --attempts=4"
+    Then Exit code is zero
+
+  Scenario: ERC20 balance can be checked
+    When I run bin/erc20 with "balance 0x7232148927F8a580053792f44D4d59d40Fd00ABD --verbose --attempts=4"
+    Then Exit code is zero
+
+  Scenario: ETH balance can be checked
+    When I run bin/erc20 with "eth_balance 0x7232148927F8a580053792f44D4d59d40Fd00ABD --verbose --attempts=4"
+    Then Exit code is zero

data/features/step_definitions/steps.rb

@@ -4,7 +4,6 @@
 # SPDX-License-Identifier: MIT
 
 require 'tmpdir'
-require 'slop'
 require 'English'
 require_relative '../../lib/erc20'
 
@@ -13,10 +12,6 @@ Before do
   @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

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.2.8'
+  VERSION = '0.2.9' unless defined?(VERSION)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.2.9
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -94,19 +94,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: slop
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.3'
 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 Ethereum node to provide JSON
@@ -131,6 +131,7 @@ files:
 - features/cli.feature
 - features/dry.feature
 - features/gem_package.feature
+- features/live.feature
 - features/step_definitions/steps.rb
 - features/support/env.rb
 - hardhat/.gitignore