erc20 0.0.19 → 0.0.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a15afef1a8d918f6594d8ec52f92899c50559f38b8c5ca5fe1ce70cf5123c7e5
-  data.tar.gz: 46ce6edcf81eb9a07b16e3b02cd2ca46f9238a07ef3d54566df67ea4260accc6
+  metadata.gz: 3c6a14d29c4065075aa4c50b8101930a95b3ed09eff93ef8e37f145da576a27e
+  data.tar.gz: cd4ab161e890ba8cd4fdf4d60782c3d1550cadae6b6c74f4d2cec2967e3cda04
 SHA512:
-  metadata.gz: 9c2aaca43b303101022c8189159b08bc9193ed210675e8ed343e32849883a37ac78c6b7ad7fe0efd63eb2a91f3deda2c73280091e37d25e8f8ca8eada40f74e4
-  data.tar.gz: 04d81a60b8ab53fd4de2559f52e76e3dbf63e8266ffc739a7b1ac046250a6420554e5beb40219efa9e4617e750827d860f64cf3a3071de76f28310143d0ff885
+  metadata.gz: a73ba1ba539a7d25fe7cf2ecb022ddf5d7fbdcd61cf1653d987b9cf29b5337229a2756853bc538f2ae7385bf141945cea50a5198214e8da8d29088a34dea63c9
+  data.tar.gz: 318f3270b986d11fb901af11181e457f89a53bc7ae89898a4c3231659edc1537933637285d51c9bac046f5be15b723d9709989def4532d0013ae872e50dadabd

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.19'
+  VERSION = '0.0.20'
 end

data/lib/erc20/fake_wallet.rb

@@ -67,26 +67,24 @@ class ERC20::FakeWallet
     b
   end
 
-  # How much ETH gas is required in order to send this 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
-  # @return [Integer] How many ETH required
-  def gas_required(from, to = from)
-    g = 66_000
-    @history << { method: :gas_required, from:, to:, result: g }
-    g
+  # @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 ETH transaction.
-  #
-  # @param [String] from The departing address, in hex
-  # @param [String] to Arriving address, in hex (may be skipped)
-  # @return [Integer] How many ETH required
-  def eth_gas_required(from, to = from)
-    g = 55_000
-    @history << { method: :eth_gas_required, from:, to:, result: g }
-    g
+  # 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.
@@ -107,9 +105,9 @@ class ERC20::FakeWallet
   # @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, gas_limit: nil, gas_price: nil)
+  def eth_pay(priv, address, amount, gas_price: nil)
     hex = '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
-    @history << { method: :eth_pay, priv:, address:, amount:, gas_limit:, gas_price:, result: hex }
+    @history << { method: :eth_pay, priv:, address:, amount:, gas_price:, result: hex }
     hex
   end
 

data/lib/erc20/wallet.rb

@@ -159,34 +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)
+  # @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)
-    gas_estimate(from, to, to_pay_data(from, 100_000))
+    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)
-    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)
-    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.
@@ -194,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)
@@ -205,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
           }
         )
@@ -245,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)
@@ -256,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
@@ -275,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
           }
@@ -438,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/, '')
@@ -455,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,14 +38,18 @@ 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('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
+  def test_checks_gas_estimate
+    b = ERC20::FakeWallet.new.gas_estimate(
+      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff',
+      '0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1',
+      44_000
+    )
     refute_nil(b)
   end
 
-  def test_checks_eth_gas_required
-    b = ERC20::FakeWallet.new.eth_gas_required('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
-    refute_nil(b)
+  def test_checks_gas_price
+    gwei = ERC20::FakeWallet.new.gas_price
+    refute_nil(gwei)
   end
 
   def test_checks_fake_balance

data/test/erc20/test_wallet.rb

@@ -67,19 +67,13 @@ 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)
+  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_checks_same_address_gas_required_on_mainnet
-    b = mainnet.gas_required(STABLE, STABLE)
-    refute_nil(b)
-    assert_predicate(b, :positive?)
-  end
-
   def test_fails_with_invalid_infura_key
     skip('Apparently, even with invalid key, Infura returns balance')
     w = ERC20::Wallet.new(
@@ -107,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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.19
+  version: 0.0.20
 platform: ruby
 authors:
 - Yegor Bugayenko