erc20 0.0.17 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53d1ed4b12b1b7e295242f5345c3ebd4f22e8fe83af31bd2bcb4f27ec8a0b4ca
-  data.tar.gz: e377b3185614081e92f72a7fda5c9a8019de72a3497b9d28259e13f17a5f1ab0
+  metadata.gz: a15afef1a8d918f6594d8ec52f92899c50559f38b8c5ca5fe1ce70cf5123c7e5
+  data.tar.gz: 46ce6edcf81eb9a07b16e3b02cd2ca46f9238a07ef3d54566df67ea4260accc6
 SHA512:
-  metadata.gz: 892709a9568e7837a708feefd8d7880d309fae9f921d1a8266e1b7b995acb1575a6305af92a1dd5dab7b9e7a7f3da9cc5b0b2539a9984eac91d291f59c5d86d1
-  data.tar.gz: d945d2ec483e4cc14ff76683294941cfaf9603963baf8c3acbf64189ee59aead1ec70e6b2d292c889d790c8f8f6fcd59c5327bb2a5223a138821fd5592971178
+  metadata.gz: 9c2aaca43b303101022c8189159b08bc9193ed210675e8ed343e32849883a37ac78c6b7ad7fe0efd63eb2a91f3deda2c73280091e37d25e8f8ca8eada40f74e4
+  data.tar.gz: 04d81a60b8ab53fd4de2559f52e76e3dbf63e8266ffc739a7b1ac046250a6420554e5beb40219efa9e4617e750827d860f64cf3a3071de76f28310143d0ff885

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.17'
+  VERSION = '0.0.19'
 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,49 @@ 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 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
+  # @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
+  def gas_required(from, to = from)
+    g = 66_000
+    @history << { method: :gas_required, from:, to:, result: g }
+    g
   end
 
-  # How much ETH gas is required in order to send this ERC20 transaction.
+  # 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
+  # @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 gas_required(_from, _to)
-    66_000
+  def eth_gas_required(from, to = from)
+    g = 55_000
+    @history << { method: :eth_gas_required, from:, to:, result: g }
+    g
   end
 
   # Send a single ERC20 payment from a private address to a public one.
@@ -83,18 +95,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_limit: nil, gas_price: nil)
+    hex = '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+    @history << { method: :eth_pay, priv:, address:, amount:, gas_limit:, gas_price:, result: hex }
+    hex
   end
 
   # Wait and accept.
@@ -104,6 +120,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,34 @@ class ERC20::Wallet
     b
   end
 
-  # How much ETH gas is required in order to send this ETH transaction.
+  # 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
+  # @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)
-    gas_estimate(from, to)
+  def 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, to_pay_data(from, 100_000))
   end
 
-  # How much ETH gas is required in order to send this ERC20 transaction.
+  # 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
+  # @param [String] to Arriving address, in hex (it's OK to skip it)
   # @return [Integer] How many ETH required
-  def gas_required(from, to)
-    gas_estimate(from, to, to_pay_data(from, 100_000))
+  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)
   end
 
   # Send a single ERC20 payment from a private address to a public one.
@@ -430,7 +442,9 @@ class ERC20::Wallet
   # 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)
+    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)

data/test/erc20/test_fake_wallet.rb

@@ -39,29 +39,29 @@ require_relative '../test__helper'
 # License:: MIT
 class TestFakeWallet < Minitest::Test
   def test_checks_gas_required
-    b = ERC20::FakeWallet.new.gas_required(
-      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff',
-      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
-    )
+    b = ERC20::FakeWallet.new.gas_required('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
     refute_nil(b)
   end
 
   def test_checks_eth_gas_required
-    b = ERC20::FakeWallet.new.eth_gas_required(
-      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff',
-      '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff'
-    )
+    b = ERC20::FakeWallet.new.eth_gas_required('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
     refute_nil(b)
   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 +70,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

@@ -71,6 +71,13 @@ class TestWallet < Minitest::Test
     b = mainnet.gas_required(STABLE, Eth::Key.new(priv: JEFF).address.to_s)
     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
@@ -102,11 +109,16 @@ class TestWallet < Minitest::Test
 
   def test_checks_gas_required_on_hardhat
     on_hardhat do |wallet|
-      b = wallet.gas_required(
+      b1 = wallet.gas_required(
         Eth::Key.new(priv: JEFF).address.to_s,
         Eth::Key.new(priv: WALTER).address.to_s
       )
-      assert_equal(21_597, b)
+      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
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.19
 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