erc20 0.0.18 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37aa39344c429cfd2153f004bd2a92730cd3a22c4f11c04e31573d36a98b2045
-  data.tar.gz: c64d6baecf8256cce26bad81f16608b01098b1c581a1370dedb05b9761a8a6e2
+  metadata.gz: 3c6a14d29c4065075aa4c50b8101930a95b3ed09eff93ef8e37f145da576a27e
+  data.tar.gz: cd4ab161e890ba8cd4fdf4d60782c3d1550cadae6b6c74f4d2cec2967e3cda04
 SHA512:
-  metadata.gz: 030bd6e0734bef65820b1c0a63237eed014bc1e1291e7a98f2e8ffe17bffab6aaa3d6cc9685f0901002512376c6ac2bece5d9c564249259700df82ba2bb609c0
-  data.tar.gz: 5836008fa63ea04bc68f7e8cc670f18b17ec887be606fedf1315e1d6e94d6be2b21859693c173d7ecd56e173fcd13f4598e08099fca941fb1bedd6367dc16e80
+  metadata.gz: a73ba1ba539a7d25fe7cf2ecb022ddf5d7fbdcd61cf1653d987b9cf29b5337229a2756853bc538f2ae7385bf141945cea50a5198214e8da8d29088a34dea63c9
+  data.tar.gz: 318f3270b986d11fb901af11181e457f89a53bc7ae89898a4c3231659edc1537933637285d51c9bac046f5be15b723d9709989def4532d0013ae872e50dadabd

data/.rubocop.yml

@@ -28,6 +28,7 @@ AllCops:
   SuggestExtensions: false
   NewCops: enable
 plugins:
+  - rubocop-rspec
   - rubocop-performance
   - rubocop-rake
   - rubocop-minitest
@@ -63,4 +64,3 @@ Security/MarshalLoad:
   Enabled: false
 Layout/MultilineAssignmentLayout:
   Enabled: true
-require: []

data/Gemfile.lock

@@ -223,11 +223,12 @@ GEM
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1, < 2.0)
       rubocop-ast (>= 1.38.0, < 2.0)
-    rubocop-rake (0.7.0)
+    rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.4.0)
-      rubocop (~> 1.61)
+    rubocop-rspec (3.5.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
     rubyzip (2.4.1)
     scrypt (3.0.8)

data/README.md

@@ -83,6 +83,19 @@ 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 tests
+
+You can use `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:
+
+```ruby
+require 'erc20'
+w = ERC20::FakeWallet.new
+w.pay(priv, address, 42_000)
+assert w.history.include?({ method: :pay, params: [priv, address, 42_000] })
+```
+
 ## How to contribute
 
 Read

data/lib/erc20/erc20.rb

@@ -42,5 +42,5 @@
 # License:: MIT
 module ERC20
   # Current version of the gem (changed by the +.rultor.yml+ on every release)
-  VERSION = '0.0.18'
+  VERSION = '0.0.20'
 end

data/lib/erc20/fake_wallet.rb

@@ -32,6 +32,9 @@ class ERC20::FakeWallet
   # Fakes:
   attr_reader :host, :port, :ssl, :chain, :contract, :ws_path, :http_path
 
+  # Full history of all method calls:
+  attr_reader :history
+
   # Ctor.
   def initialize
     @host = 'example.com'
@@ -41,40 +44,47 @@ class ERC20::FakeWallet
     @contract = ERC20::Wallet::USDT
     @ws_path = '/'
     @http_path = '/'
+    @history = []
   end
 
   # Get ERC20 balance of a public address.
   #
-  # @param [String] _hex Public key, in hex, starting from '0x'
+  # @param [String] address Public key, in hex, starting from '0x'
   # @return [Integer] Balance, in tokens
-  def balance(_hex)
-    42_000_000
+  def balance(address)
+    b = 42_000_000
+    @history << { method: :balance, address:, result: b }
+    b
   end
 
   # Get ETH balance of a public address.
   #
-  # @param [String] _hex Public key, in hex, starting from '0x'
+  # @param [String] address Public key, in hex, starting from '0x'
   # @return [Integer] Balance, in tokens
-  def eth_balance(_hex)
-    42_000_000
+  def eth_balance(address)
+    b = 77_000_000_000_000_000
+    @history << { method: :eth_balance, address:, result: b }
+    b
   end
 
-  # How much ETH gas is required in order to send this ETH transaction.
+  # How much gas units is required in order to send ERC20 transaction.
   #
-  # @param [String] _from The departing address, in hex
-  # @param [String] _to Arriving address, in hex
-  # @return [Integer] How many ETH required
-  def eth_gas_required(_from, _to)
-    55_000
+  # @param [String] from The departing address, in hex
+  # @param [String] to Arriving address, in hex
+  # @param [Integer] amount How many ERC20 tokens to send
+  # @return [Integer] How many gas units required
+  def gas_estimate(from, to, amount)
+    gas = 66_000
+    @history << { method: :gas_estimate, from:, to:, amount:, result: gas }
+    gas
   end
 
-  # How much ETH gas is required in order to send this ERC20 transaction.
-  #
-  # @param [String] _from The departing address, in hex
-  # @param [String] _to Arriving address, in hex
-  # @return [Integer] How many ETH required
-  def gas_required(_from, _to)
-    66_000
+  # What is the price of gas unit in gwei?
+  # @return [Integer] Price of gas unit, in gwei (0.000000001 ETH)
+  def gas_price
+    gwei = 55_555
+    @history << { method: :gas_price, result: gwei }
+    gwei
   end
 
   # Send a single ERC20 payment from a private address to a public one.
@@ -83,18 +93,22 @@ class ERC20::FakeWallet
   # @param [String] _address Public key, in hex
   # @param [Integer] _amount The amount of ERC20 tokens to send
   # @return [String] Transaction hash
-  def pay(_priv, _address, _amount, *)
-    '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+  def pay(priv, address, amount, gas_limit: nil, gas_price: nil)
+    hex = '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+    @history << { method: :pay, priv:, address:, amount:, gas_limit:, gas_price:, result: hex }
+    hex
   end
 
   # Send a single ETH 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 ETHs to send
+  # @param [String] priv Private key, in hex
+  # @param [String] address Public key, in hex
+  # @param [Integer] amount The amount of ETHs to send
   # @return [String] Transaction hash
-  def eth_pay(_priv, _address, _amount, *)
-    '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+  def eth_pay(priv, address, amount, gas_price: nil)
+    hex = '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+    @history << { method: :eth_pay, priv:, address:, amount:, gas_price:, result: hex }
+    hex
   end
 
   # Wait and accept.
@@ -104,6 +118,7 @@ class ERC20::FakeWallet
   # @param [Boolean] raw TRUE if you need to get JSON events as they arrive from Websockets
   # @param [Integer] delay How many seconds to wait between +eth_subscribe+ calls
   def accept(addresses, active = [], raw: false, delay: 1)
+    @history << { method: :accept, addresses:, active:, raw:, delay: }
     addresses.to_a.each { |a| active.append(a) }
     loop do
       sleep(delay)

data/lib/erc20/wallet.rb

@@ -159,22 +159,33 @@ class ERC20::Wallet
     b
   end
 
-  # How much ETH gas is required in order to send ERC20 transaction.
+  # How much gas units is required in order to send ERC20 transaction.
   #
   # @param [String] from The departing address, in hex
-  # @param [String] to Arriving address, in hex (it's OK to skip it)
-  # @return [Integer] How many ETH required
-  def gas_required(from, to = from)
-    gas_estimate(from, to, to_pay_data(from, 100_000))
+  # @param [String] to Arriving address, in hex
+  # @param [Integer] amount How many ERC20 tokens to send
+  # @return [Integer] How many 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)
+    raise 'Invalid format of the address' unless /^0x[0-9a-fA-F]{40}$/.match?(from)
+    raise 'Address can\'t be nil' unless to
+    raise 'Address must be a String' unless to.is_a?(String)
+    raise 'Invalid format of the address' unless /^0x[0-9a-fA-F]{40}$/.match?(to)
+    raise 'Amount can\'t be nil' unless amount
+    raise "Amount (#{amount}) must be an Integer" unless amount.is_a?(Integer)
+    raise "Amount (#{amount}) must be a positive Integer" unless amount.positive?
+    gas = jsonrpc.eth_estimateGas({ from:, to: @contract, data: to_pay_data(to, amount) }, 'latest').to_i(16)
+    @log.debug("It would take #{gas} gas units to send #{amount} tokens from #{from} to #{to}")
+    gas
   end
 
-  # How much ETH gas is required in order to send this ETH transaction.
-  #
-  # @param [String] from The departing address, in hex
-  # @param [String] to Arriving address, in hex (it's OK to skip it)
-  # @return [Integer] How many ETH required
-  def eth_gas_required(from, to = from)
-    gas_estimate(from, to)
+  # What is the price of gas unit in gwei?
+  # @return [Integer] Price of gas unit, in gwei (0.000000001 ETH)
+  def gas_price
+    gwei = jsonrpc.eth_getBlockByNumber('latest', false)['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.
@@ -182,10 +193,10 @@ 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] gas_limit How much gas you're ready to spend
-  # @param [Integer] gas_price How much gas you pay per computation unit
+  # @param [Integer] limit How much gas you're ready to spend
+  # @param [Integer] price How much gas you pay per computation unit
   # @return [String] Transaction hash
-  def pay(priv, address, amount, gas_limit: nil, gas_price: gas_best_price)
+  def pay(priv, address, amount, limit: nil, price: gas_price)
     raise 'Private key can\'t be nil' unless priv
     raise 'Private key must be a String' unless priv.is_a?(String)
     raise 'Invalid format of private key' unless /^[0-9a-fA-F]{64}$/.match?(priv)
@@ -193,30 +204,29 @@ class ERC20::Wallet
     raise 'Address must be a String' unless address.is_a?(String)
     raise 'Invalid format of the address' unless /^0x[0-9a-fA-F]{40}$/.match?(address)
     raise 'Amount can\'t be nil' unless amount
-    raise 'Amount must be an Integer' unless amount.is_a?(Integer)
-    raise 'Amount must be a positive Integer' unless amount.positive?
-    if gas_limit
-      raise 'Gas limit must be an Integer' unless gas_limit.is_a?(Integer)
-      raise 'Gas limit must be a positive Integer' unless gas_limit.positive?
+    raise "Amount (#{amount}) must be an Integer" unless amount.is_a?(Integer)
+    raise "Amount (#{amount}) must be a positive Integer" unless amount.positive?
+    if limit
+      raise 'Gas limit must be an Integer' unless limit.is_a?(Integer)
+      raise 'Gas limit must be a positive Integer' unless limit.positive?
     end
-    if gas_price
-      raise 'Gas price must be an Integer' unless gas_price.is_a?(Integer)
-      raise 'Gas price must be a positive Integer' unless gas_price.positive?
+    if price
+      raise 'Gas price must be an Integer' unless price.is_a?(Integer)
+      raise 'Gas price must be a positive Integer' unless price.positive?
     end
     key = Eth::Key.new(priv: priv)
     from = key.address.to_s
-    data = to_pay_data(address, amount)
     tnx =
       @mutex.synchronize do
         nonce = jsonrpc.eth_getTransactionCount(from, 'pending').to_i(16)
         tx = Eth::Tx.new(
           {
             nonce:,
-            gas_price: gas_price,
-            gas_limit: gas_limit || gas_estimate(from, @contract, data),
+            gas_price: price,
+            gas_limit: limit || gas_estimate(from, address, amount),
             to: @contract,
             value: 0,
-            data:,
+            data: to_pay_data(address, amount),
             chain_id: @chain
           }
         )
@@ -233,10 +243,10 @@ 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] gas_limit How much gas you're ready to spend
-  # @param [Integer] gas_price How much gas you pay per computation unit
+  # @param [Integer] limit How much gas you're ready to spend
+  # @param [Integer] price How much gas you pay per computation unit
   # @return [String] Transaction hash
-  def eth_pay(priv, address, amount, gas_limit: nil, gas_price: gas_best_price)
+  def eth_pay(priv, address, amount, price: gas_price)
     raise 'Private key can\'t be nil' unless priv
     raise 'Private key must be a String' unless priv.is_a?(String)
     raise 'Invalid format of private key' unless /^[0-9a-fA-F]{64}$/.match?(priv)
@@ -244,15 +254,11 @@ class ERC20::Wallet
     raise 'Address must be a String' unless address.is_a?(String)
     raise 'Invalid format of the address' unless /^0x[0-9a-fA-F]{40}$/.match?(address)
     raise 'Amount can\'t be nil' unless amount
-    raise 'Amount must be an Integer' unless amount.is_a?(Integer)
-    raise 'Amount must be a positive Integer' unless amount.positive?
-    if gas_limit
-      raise 'Gas limit must be an Integer' unless gas_limit.is_a?(Integer)
-      raise 'Gas limit must be a positive Integer' unless gas_limit.positive?
-    end
-    if gas_price
-      raise 'Gas price must be an Integer' unless gas_price.is_a?(Integer)
-      raise 'Gas price must be a positive Integer' unless gas_price.positive?
+    raise "Amount (#{amount}) must be an Integer" unless amount.is_a?(Integer)
+    raise "Amount (#{amount}) must be a positive Integer" unless amount.positive?
+    if price
+      raise 'Gas price must be an Integer' unless price.is_a?(Integer)
+      raise 'Gas price must be a positive Integer' unless price.positive?
     end
     key = Eth::Key.new(priv: priv)
     from = key.address.to_s
@@ -263,8 +269,8 @@ class ERC20::Wallet
           {
             chain_id: @chain,
             nonce:,
-            gas_price: gas_price,
-            gas_limit: gas_limit || gas_estimate(from, address),
+            gas_price: price,
+            gas_limit: 22_000,
             to: address,
             value: amount
           }
@@ -426,15 +432,6 @@ class ERC20::Wallet
     JSONRPC::Client.new(url, connection:)
   end
 
-  # How much gas should be spent in order to send a transaction from one
-  # public address to another public address, possible carrying some data
-  # inside the transaction.
-  def gas_estimate(from, to, data = '')
-    gas = jsonrpc.eth_estimateGas({ from:, to:, data: }, 'latest').to_i(16)
-    @log.debug("Estimated gas is #{gas} ETH#{data.empty? ? '' : ', for ERC20 transfer'}")
-    gas
-  end
-
   def to_pay_data(address, amount)
     func = 'a9059cbb' # transfer(address,uint256)
     to_clean = address.downcase.sub(/^0x/, '')
@@ -443,8 +440,4 @@ class ERC20::Wallet
     amt_padded = ('0' * (64 - amt_hex.size)) + amt_hex
     "0x#{func}#{to_padded}#{amt_padded}"
   end
-
-  def gas_best_price
-    jsonrpc.eth_getBlockByNumber('latest', false)['baseFeePerGas'].to_i(16)
-  end
 end

data/test/erc20/test_fake_wallet.rb

@@ -38,30 +38,34 @@ require_relative '../test__helper'
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
 class TestFakeWallet < Minitest::Test
-  def test_checks_gas_required
-    b = ERC20::FakeWallet.new.gas_required(
+  def test_checks_gas_estimate
+    b = ERC20::FakeWallet.new.gas_estimate(
       '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff',
-      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
+      '0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1',
+      44_000
     )
     refute_nil(b)
   end
 
-  def test_checks_eth_gas_required
-    b = ERC20::FakeWallet.new.eth_gas_required(
-      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff',
-      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
-    )
-    refute_nil(b)
+  def test_checks_gas_price
+    gwei = ERC20::FakeWallet.new.gas_price
+    refute_nil(gwei)
   end
 
   def test_checks_fake_balance
-    b = ERC20::FakeWallet.new.balance('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
+    w = ERC20::FakeWallet.new
+    a = '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
+    b = w.balance(a)
     refute_nil(b)
+    assert_includes(w.history, { method: :balance, result: b, address: a })
   end
 
   def test_checks_fake_eth_balance
-    b = ERC20::FakeWallet.new.eth_balance('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
+    a = '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
+    w = ERC20::FakeWallet.new
+    b = w.eth_balance(a)
     refute_nil(b)
+    assert_includes(w.history, { method: :eth_balance, result: b, address: a })
   end
 
   def test_returns_host
@@ -70,10 +74,13 @@ class TestFakeWallet < Minitest::Test
 
   def test_pays_fake_money
     priv = '81a9b2114d53731ecc84b261ef6c0387dde34d5907fe7b441240cc21d61bf80a'
-    to = '0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1'
-    txn = ERC20::FakeWallet.new.pay(Eth::Key.new(priv:), to, 555)
+    address = '0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1'
+    w = ERC20::FakeWallet.new
+    amount = 555_000
+    txn = w.pay(priv, address, amount)
     assert_equal(66, txn.length)
     assert_match(/^0x[a-f0-9]{64}$/, txn)
+    assert_includes(w.history, { method: :pay, result: txn, priv:, address:, amount:, gas_limit: nil, gas_price: nil })
   end
 
   def test_pays_fake_eths

data/test/erc20/test_wallet.rb

@@ -67,16 +67,11 @@ class TestWallet < Minitest::Test
     assert_equal(0, b)
   end
 
-  def test_checks_gas_required_on_mainnet
-    b = mainnet.gas_required(STABLE, Eth::Key.new(priv: JEFF).address.to_s)
-    refute_nil(b)
-    assert_predicate(b, :positive?)
-  end
-
-  def test_checks_same_address_gas_required_on_mainnet
-    b = mainnet.gas_required(STABLE, STABLE)
+  def test_checks_gas_estimate_on_mainnet
+    b = mainnet.gas_estimate(STABLE, Eth::Key.new(priv: JEFF).address.to_s, 44_000)
     refute_nil(b)
     assert_predicate(b, :positive?)
+    assert_operator(b, :>, 1000)
   end
 
   def test_fails_with_invalid_infura_key
@@ -106,28 +101,15 @@ class TestWallet < Minitest::Test
     assert_predicate(b, :zero?)
   end
 
-  def test_checks_gas_required_on_hardhat
-    on_hardhat do |wallet|
-      b1 = wallet.gas_required(
-        Eth::Key.new(priv: JEFF).address.to_s,
-        Eth::Key.new(priv: WALTER).address.to_s
-      )
-      assert_equal(21_597, b1)
-      b2 = wallet.gas_required(
-        Eth::Key.new(priv: JEFF).address.to_s,
-        Eth::Key.new(priv: JEFF).address.to_s
-      )
-      assert_equal(b1, b2)
-    end
-  end
-
-  def test_checks_eth_gas_required_on_hardhat
+  def test_checks_gas_estimate_on_hardhat
+    sum = 100_000
     on_hardhat do |wallet|
-      b = wallet.eth_gas_required(
+      b1 = wallet.gas_estimate(
         Eth::Key.new(priv: JEFF).address.to_s,
-        Eth::Key.new(priv: WALTER).address.to_s
+        Eth::Key.new(priv: WALTER).address.to_s,
+        sum
       )
-      assert_equal(21_001, b)
+      assert_operator(b1, :>, 21_000)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.20
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-16 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eth