erc20 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aaaf16c1cb37a5f676efbec190e3b707c34fa816e781d3119c43b5b2b44500b
-  data.tar.gz: a77d26b7f77b56f9a46f860b4a5e5104ed7239da40f16d14b056c96b8d05ca88
+  metadata.gz: 53d1ed4b12b1b7e295242f5345c3ebd4f22e8fe83af31bd2bcb4f27ec8a0b4ca
+  data.tar.gz: e377b3185614081e92f72a7fda5c9a8019de72a3497b9d28259e13f17a5f1ab0
 SHA512:
-  metadata.gz: edef3ec85bb02e73d8815907bf6f256b1a261b8051ada8a1280efde631d8faaa70e5533c4577e63843615a163e4115e383ce4d7d891592277fb71377d1eafffd
-  data.tar.gz: 484da28c8385d9a5b4ce18ca0cffd26e221144d641d1e9f777980a6394edcac0843a9f5e58e2243e7f858aea561ff8a39466934eefd01cfebced3071a029f24b
+  metadata.gz: 892709a9568e7837a708feefd8d7880d309fae9f921d1a8266e1b7b995acb1575a6305af92a1dd5dab7b9e7a7f3da9cc5b0b2539a9984eac91d291f59c5d86d1
+  data.tar.gz: d945d2ec483e4cc14ff76683294941cfaf9603963baf8c3acbf64189ee59aead1ec70e6b2d292c889d790c8f8f6fcd59c5327bb2a5223a138821fd5592971178

data/.rubocop.yml

@@ -63,3 +63,4 @@ Security/MarshalLoad:
   Enabled: false
 Layout/MultilineAssignmentLayout:
   Enabled: true
+require: []

data/Gemfile

@@ -35,10 +35,10 @@ gem 'rake', '13.2.1', require: false
 gem 'random-port', '>0', require: false
 gem 'rspec-rails', '7.1.1', require: false
 gem 'rubocop', '1.72.1', require: false
-gem 'rubocop-minitest', '0.37.1', require: false
-gem 'rubocop-performance', '1.24.0', require: false
+gem 'rubocop-minitest', '>0', require: false
+gem 'rubocop-performance', '>0', require: false
 gem 'rubocop-rake', '>0', require: false
-gem 'rubocop-rspec', '3.4.0', require: false
+gem 'rubocop-rspec', '>0', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
 gem 'threads', '0.4.1', require: false

data/Gemfile.lock

@@ -184,7 +184,7 @@ GEM
     regexp_parser (2.10.0)
     reline (0.6.0)
       io-console (~> 0.5)
-    rexml (3.4.0)
+    rexml (3.4.1)
     rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
     rspec-expectations (3.13.3)
@@ -288,10 +288,10 @@ DEPENDENCIES
   random-port (> 0)
   rspec-rails (= 7.1.1)
   rubocop (= 1.72.1)
-  rubocop-minitest (= 0.37.1)
-  rubocop-performance (= 1.24.0)
+  rubocop-minitest (> 0)
+  rubocop-performance (> 0)
   rubocop-rake (> 0)
-  rubocop-rspec (= 3.4.0)
+  rubocop-rspec (> 0)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   threads (= 0.4.1)

data/README.md

@@ -37,13 +37,23 @@ hex = w.pay(private_key, to_address, amount)
 # Stay waiting, and trigger the block when new ERC20 payments show up:
 addresses = ['0x...', '0x...'] # only wait for payments to these addresses
 w.accept(addresses) do |event|
-  puts event[:txt] # hash of transaction
+  puts event[:txn] # hash of transaction
   puts event[:amount] # how much, in tokens (1000000 = $1 USDT)
   puts event[:from] # who sent the payment
   puts event[:to] # who was the receiver
 end
 ```
 
+It's also possible to check ETH balance and send ETH transaction:
+
+```ruby
+# Check how many ETHs are there on the given address:
+eth = w.eth_balance(address)
+
+# Send a few ETHs to someone and get transaction hash:
+hex = w.eth_pay(private_key, to_address, amount)
+```
+
 To generate a new private key, use [eth](https://rubygems.org/gems/eth):
 
 ```ruby
@@ -51,7 +61,7 @@ require 'eth'
 key = Eth::Key.new.private_hex
 ```
 
-To get address from private one:
+To convert a private key to a public address:
 
 ```ruby
 public_hex = Eth::Key.new(priv: key).address

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.15'
+  VERSION = '0.0.17'
 end

data/lib/erc20/fake_wallet.rb

@@ -43,7 +43,7 @@ class ERC20::FakeWallet
     @http_path = '/'
   end
 
-  # Get balance of a public address.
+  # Get ERC20 balance of a public address.
   #
   # @param [String] _hex Public key, in hex, starting from '0x'
   # @return [Integer] Balance, in tokens
@@ -51,7 +51,33 @@ class ERC20::FakeWallet
     42_000_000
   end
 
-  # Send a single payment from a private address to a public one.
+  # Get ETH balance of a public address.
+  #
+  # @param [String] _hex Public key, in hex, starting from '0x'
+  # @return [Integer] Balance, in tokens
+  def eth_balance(_hex)
+    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
   # @param [String] _address Public key, in hex
@@ -61,6 +87,16 @@ class ERC20::FakeWallet
     '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
   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
+  # @return [String] Transaction hash
+  def eth_pay(_priv, _address, _amount, *)
+    '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+  end
+
   # Wait and accept.
   #
   # @param [Array<String>] addresses Addresses to monitor

data/lib/erc20/wallet.rb

@@ -122,23 +122,62 @@ class ERC20::Wallet
     @mutex = Mutex.new
   end
 
-  # Get balance of a public address.
+  # Get ERC20 balance of a public address (it's not the same as ETH balance!).
   #
-  # @param [String] hex Public key, in hex, starting from '0x'
+  # An address in Etherium may have many balances. One of them is the main
+  # balance in ETH crypto. Another balance is the one kept by ERC20 contract
+  # in its own ledge in root storage. This balance is checked by this method.
+  #
+  # @param [String] address Public key, in hex, starting from '0x'
   # @return [Integer] Balance, in tokens
-  def balance(hex)
-    raise 'Address can\'t be nil' unless hex
-    raise 'Address must be a String' unless hex.is_a?(String)
-    raise 'Invalid format of the address' unless /^0x[0-9a-fA-F]{40}$/.match?(hex)
+  def balance(address)
+    raise 'Address can\'t be nil' unless address
+    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)
     func = '70a08231' # balanceOf
-    data = "0x#{func}000000000000000000000000#{hex[2..].downcase}"
+    data = "0x#{func}000000000000000000000000#{address[2..].downcase}"
     r = jsonrpc.eth_call({ to: @contract, data: data }, 'latest')
     b = r[2..].to_i(16)
-    @log.debug("Balance of #{hex} is #{b}")
+    @log.debug("Balance of #{address} is #{b} ERC20 tokens")
     b
   end
 
-  # Send a single payment from a private address to a public one.
+  # Get ETH balance of a public address.
+  #
+  # An address in Etherium may have many balances. One of them is the main
+  # balance in ETH crypto. This balance is checked by this method.
+  #
+  # @param [String] hex Public key, in hex, starting from '0x'
+  # @return [Integer] Balance, in ETH
+  def eth_balance(address)
+    raise 'Address can\'t be nil' unless address
+    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)
+    r = jsonrpc.eth_getBalance(address, 'latest')
+    b = r[2..].to_i(16)
+    @log.debug("Balance of #{address} is #{b} ETHs")
+    b
+  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)
+    gas_estimate(from, to)
+  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)
+    gas_estimate(from, to, to_pay_data(from, 100_000))
+  end
+
+  # Send a single ERC20 payment from a private address to a public one.
   #
   # @param [String] priv Private key, in hex
   # @param [String] address Public key, in hex
@@ -146,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)
@@ -164,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_limit: gas_limit || gas_estimate(from, data),
+            gas_price: gas_price,
+            gas_limit: gas_limit || gas_estimate(from, @contract, data),
             to: @contract,
             value: 0,
-            data: data,
+            data:,
             chain_id: @chain
           }
         )
@@ -190,7 +224,56 @@ class ERC20::Wallet
         hex = "0x#{tx.hex}"
         jsonrpc.eth_sendRawTransaction(hex)
       end
-    @log.debug("Sent #{amount} from #{from} to #{address}: #{tnx}")
+    @log.debug("Sent #{amount} ERC20 tokens from #{from} to #{address}: #{tnx}")
+    tnx.downcase
+  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 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
+  # @return [String] Transaction hash
+  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)
+    raise 'Address can\'t be nil' unless address
+    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?
+    end
+    key = Eth::Key.new(priv: priv)
+    from = key.address.to_s
+    tnx =
+      @mutex.synchronize do
+        nonce = jsonrpc.eth_getTransactionCount(from, 'pending').to_i(16)
+        tx = Eth::Tx.new(
+          {
+            chain_id: @chain,
+            nonce:,
+            gas_price: gas_price,
+            gas_limit: gas_limit || gas_estimate(from, address),
+            to: address,
+            value: amount
+          }
+        )
+        tx.sign(key)
+        hex = "0x#{tx.hex}"
+        jsonrpc.eth_sendRawTransaction(hex)
+      end
+    @log.debug("Sent #{amount} ETHs from #{from} to #{address}: #{tnx}")
     tnx.downcase
   end
 
@@ -343,8 +426,20 @@ class ERC20::Wallet
     JSONRPC::Client.new(url, connection:)
   end
 
-  def gas_estimate(from, data)
-    jsonrpc.eth_estimateGas({ from:, to: @contract, 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 = '')
+    jsonrpc.eth_estimateGas({ from:, to:, data: }, 'latest').to_i(16)
+  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

@@ -33,20 +33,37 @@ require 'typhoeus'
 require_relative '../../lib/erc20/fake_wallet'
 require_relative '../test__helper'
 
-k = Eth::Key.new
-puts k.private_hex
-puts k.address
-
 # Test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # 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)
   end
 
+  def test_checks_fake_eth_balance
+    b = ERC20::FakeWallet.new.eth_balance('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
+    refute_nil(b)
+  end
+
   def test_returns_host
     assert_equal('example.com', ERC20::FakeWallet.new.host)
   end
@@ -59,6 +76,14 @@ class TestFakeWallet < Minitest::Test
     assert_match(/^0x[a-f0-9]{64}$/, txn)
   end
 
+  def test_pays_fake_eths
+    priv = '81a9b2114d53731ecc84b261ef6c0387dde34d5907fe7b441240cc21d61bf80a'
+    to = '0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1'
+    txn = ERC20::FakeWallet.new.eth_pay(Eth::Key.new(priv:), to, 555)
+    assert_equal(66, txn.length)
+    assert_match(/^0x[a-f0-9]{64}$/, txn)
+  end
+
   def test_accepts_payments_on_hardhat
     active = Primitivo.new([])
     addresses = Primitivo.new(['0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1'])

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,7 +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(4_200_000_000_000_000, b) # this is 0.0042 ETH
   end
 
   def test_checks_balance_of_absent_address
@@ -61,6 +67,12 @@ 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_fails_with_invalid_infura_key
     skip('Apparently, even with invalid key, Infura returns balance')
     w = ERC20::Wallet.new(
@@ -88,6 +100,26 @@ class TestWallet < Minitest::Test
     assert_predicate(b, :zero?)
   end
 
+  def test_checks_gas_required_on_hardhat
+    on_hardhat do |wallet|
+      b = wallet.gas_required(
+        Eth::Key.new(priv: JEFF).address.to_s,
+        Eth::Key.new(priv: WALTER).address.to_s
+      )
+      assert_equal(21_597, b)
+    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)
@@ -95,6 +127,13 @@ class TestWallet < Minitest::Test
     end
   end
 
+  def test_checks_eth_balance_on_hardhat
+    on_hardhat do |wallet|
+      b = wallet.balance(Eth::Key.new(priv: WALTER).address.to_s)
+      assert_equal(456_000_000_000, b)
+    end
+  end
+
   def test_checks_balance_on_hardhat_in_threads
     on_hardhat do |wallet|
       Threads.new.assert do
@@ -118,6 +157,20 @@ class TestWallet < Minitest::Test
     end
   end
 
+  def test_eth_pays_on_hardhat
+    on_hardhat do |wallet|
+      to = Eth::Key.new(priv: WALTER).address.to_s
+      before = wallet.eth_balance(to)
+      sum = 42_000
+      from = Eth::Key.new(priv: JEFF).address.to_s
+      assert_operator(wallet.eth_balance(from), :>, sum * 2)
+      txn = wallet.eth_pay(JEFF, to, sum)
+      assert_equal(66, txn.length)
+      assert_match(/^0x[a-f0-9]{64}$/, txn)
+      assert_equal(before + sum, wallet.eth_balance(to))
+    end
+  end
+
   def test_pays_on_hardhat_in_threads
     on_hardhat do |wallet|
       to = Eth::Key.new(priv: WALTER).address.to_s
@@ -131,6 +184,19 @@ class TestWallet < Minitest::Test
     end
   end
 
+  def test_pays_eth_on_hardhat_in_threads
+    on_hardhat do |wallet|
+      to = Eth::Key.new(priv: WALTER).address.to_s
+      before = wallet.eth_balance(to)
+      sum = 42_000
+      mul = 10
+      Threads.new(mul).assert do
+        wallet.eth_pay(JEFF, to, sum)
+      end
+      assert_equal(before + (sum * mul), wallet.eth_balance(to))
+    end
+  end
+
   def test_accepts_payments_on_hardhat
     walter = Eth::Key.new(priv: WALTER).address.to_s.downcase
     jeff = Eth::Key.new(priv: JEFF).address.to_s.downcase

metadata

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