erc20 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d2dd0547d65ca59e601a28f93a2b35b45ae8b3dc57fe6a09bd296d13fe807fd
-  data.tar.gz: a69c35dfd60d083f891a840285411373e7996937481f7c52a63f2ce9c09e2462
+  metadata.gz: 37aa39344c429cfd2153f004bd2a92730cd3a22c4f11c04e31573d36a98b2045
+  data.tar.gz: c64d6baecf8256cce26bad81f16608b01098b1c581a1370dedb05b9761a8a6e2
 SHA512:
-  metadata.gz: 1ddfb2214d688465488e224c59460e185b8bb361acadfd3b4d215053392f53dcf23367366b29a577b563be982432233efcc72ba5f4e6f6cae6651189b221c53c
-  data.tar.gz: d8f93754ea6baf64d46591aa3ab52559bb601785df08d3071f51d5e283c7d0ad7c2b226bdaec12abbef913750136f5e895a302a451aa4ddac2225b862497631f
+  metadata.gz: 030bd6e0734bef65820b1c0a63237eed014bc1e1291e7a98f2e8ffe17bffab6aaa3d6cc9685f0901002512376c6ac2bece5d9c564249259700df82ba2bb609c0
+  data.tar.gz: 5836008fa63ea04bc68f7e8cc670f18b17ec887be606fedf1315e1d6e94d6be2b21859693c173d7ecd56e173fcd13f4598e08099fca941fb1bedd6367dc16e80

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.16'
+  VERSION = '0.0.18'
 end

data/lib/erc20/fake_wallet.rb

@@ -59,6 +59,24 @@ class ERC20::FakeWallet
     42_000_000
   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
+  # @return [Integer] How many ETH required
+  def eth_gas_required(_from, _to)
+    55_000
+  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
+  end
+
   # Send a single ERC20 payment from a private address to a public one.
   #
   # @param [String] _priv Private key, in hex

data/lib/erc20/wallet.rb

@@ -159,6 +159,24 @@ class ERC20::Wallet
     b
   end
 
+  # How much ETH gas 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))
+  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)
+  end
+
   # Send a single ERC20 payment from a private address to a public one.
   #
   # @param [String] priv Private key, in hex
@@ -167,7 +185,7 @@ class ERC20::Wallet
   # @param [Integer] gas_limit How much gas you're ready to spend
   # @param [Integer] gas_price How much gas you pay per computation unit
   # @return [String] Transaction hash
-  def pay(priv, address, amount, gas_limit: nil, gas_price: nil)
+  def pay(priv, address, amount, gas_limit: nil, gas_price: gas_best_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)
@@ -185,25 +203,20 @@ class ERC20::Wallet
       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?
     end
-    func = 'a9059cbb' # transfer(address,uint256)
-    to_clean = address.downcase.sub(/^0x/, '')
-    to_padded = ('0' * (64 - to_clean.size)) + to_clean
-    amt_hex = amount.to_s(16)
-    amt_padded = ('0' * (64 - amt_hex.size)) + amt_hex
-    data = "0x#{func}#{to_padded}#{amt_padded}"
     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_best_price,
+            gas_price: gas_price,
             gas_limit: gas_limit || gas_estimate(from, @contract, data),
             to: @contract,
             value: 0,
-            data: data,
+            data:,
             chain_id: @chain
           }
         )
@@ -223,7 +236,7 @@ class ERC20::Wallet
   # @param [Integer] gas_limit How much gas you're ready to spend
   # @param [Integer] gas_price How much gas you pay per computation unit
   # @return [String] Transaction hash
-  def eth_pay(priv, address, amount, gas_limit: nil, gas_price: nil)
+  def eth_pay(priv, address, amount, gas_limit: nil, gas_price: gas_best_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)
@@ -243,7 +256,6 @@ class ERC20::Wallet
     end
     key = Eth::Key.new(priv: priv)
     from = key.address.to_s
-    data = ''
     tnx =
       @mutex.synchronize do
         nonce = jsonrpc.eth_getTransactionCount(from, 'pending').to_i(16)
@@ -251,11 +263,10 @@ class ERC20::Wallet
           {
             chain_id: @chain,
             nonce:,
-            gas_price: gas_price || gas_best_price,
-            gas_limit: gas_limit || gas_estimate(from, address, data),
+            gas_price: gas_price,
+            gas_limit: gas_limit || gas_estimate(from, address),
             to: address,
-            value: amount,
-            data:
+            value: amount
           }
         )
         tx.sign(key)
@@ -415,8 +426,22 @@ class ERC20::Wallet
     JSONRPC::Client.new(url, connection:)
   end
 
-  def gas_estimate(from, to, data)
-    jsonrpc.eth_estimateGas({ from:, to:, data: }, 'latest').to_i(16)
+  # 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/, '')
+    to_padded = ('0' * (64 - to_clean.size)) + to_clean
+    amt_hex = amount.to_s(16)
+    amt_padded = ('0' * (64 - amt_hex.size)) + amt_hex
+    "0x#{func}#{to_padded}#{amt_padded}"
   end
 
   def gas_best_price

data/test/erc20/test_fake_wallet.rb

@@ -38,6 +38,22 @@ 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',
+      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
+    )
+    refute_nil(b)
+  end
+
+  def test_checks_eth_gas_required
+    b = ERC20::FakeWallet.new.eth_gas_required(
+      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff',
+      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
+    )
+    refute_nil(b)
+  end
+
   def test_checks_fake_balance
     b = ERC20::FakeWallet.new.balance('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
     refute_nil(b)

data/test/erc20/test_wallet.rb

@@ -38,7 +38,7 @@ require_relative '../test__helper'
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
 class TestWallet < Minitest::Test
-  # At this address, in Etherium mainnet, there are $8 USDT. I won't
+  # At this address, in Etherium 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'
 
@@ -51,13 +51,13 @@ class TestWallet < Minitest::Test
   def test_checks_balance_on_mainnet
     b = mainnet.balance(STABLE)
     refute_nil(b)
-    assert_equal(8_000_000, b)
+    assert_equal(8_000_000, b) # this is $8 USDT
   end
 
   def test_checks_eth_balance_on_mainnet
     b = mainnet.eth_balance(STABLE)
     refute_nil(b)
-    assert_equal(0, b)
+    assert_equal(4_200_000_000_000_000, b) # this is 0.0042 ETH
   end
 
   def test_checks_balance_of_absent_address
@@ -67,6 +67,18 @@ 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)
+    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(
@@ -94,6 +106,31 @@ 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
+    on_hardhat do |wallet|
+      b = wallet.eth_gas_required(
+        Eth::Key.new(priv: JEFF).address.to_s,
+        Eth::Key.new(priv: WALTER).address.to_s
+      )
+      assert_equal(21_001, b)
+    end
+  end
+
   def test_checks_balance_on_hardhat
     on_hardhat do |wallet|
       b = wallet.balance(Eth::Key.new(priv: JEFF).address.to_s)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Yegor Bugayenko