erc20 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbce7bc57948f9c8acfeec7c0af2cf67e70e2447e064040485e6868d466828dc
-  data.tar.gz: cc521c55db79dca85e58235c886172a7ca81cf0f59ee61f5c134cc888eb3db4c
+  metadata.gz: 429ad43c63c2126e8f57d5adcbe391c573f34f0a4d1174d19427f7f0b121aab2
+  data.tar.gz: e354d3bc37396d2c1b35da5ca1800ce01ce90905b9ad9bd64e0617c71e1350b1
 SHA512:
-  metadata.gz: c712231ba46caabca78b45e9be366c120e2f5275bc734c874f69c7306d1f961c7b7c3a5b8ae58341cb4d48776a91c5a8bc8ec2360dfcbc294d46ae329d9bf8a4
-  data.tar.gz: 7a074720cfec0773a6e4e0cc70fe07fde201ae9897cb395a2b91a84429683354b822bef0be10650290b554ffe59b150034a1ea320eed34a396d574267954c130
+  metadata.gz: fc5eb0f95f5269cd94b848a05839ac4939b60efef2b0036a2ab693d6f16cc6a1c0d025d5ba580c2f5ce47232c494a64de224b66a47a155464b1401ac022d82f3
+  data.tar.gz: 83b0d56783372f8a90eb0e9d89f6eed15101eb7eb0787882833baa73b1d97163b08b175f80c350d1f236e74e363ee9c1ffd4412437baa9630bfa4ee87196d8e2

data/Gemfile

@@ -7,6 +7,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'backtrace', '>0', require: false
+gem 'concurrent-ruby', '~>1.2', require: false
 gem 'cucumber', '~>9.2', require: false
 gem 'donce', '>0', require: false
 gem 'faraday', '>0', require: false

data/Gemfile.lock

@@ -46,14 +46,15 @@ GEM
     cucumber-tag-expressions (6.1.2)
     diff-lcs (1.6.1)
     docile (1.4.1)
-    donce (0.1.0)
-      backtrace (> 0)
-      os (> 0)
-      qbash (> 0)
+    donce (0.2.0)
+      backtrace (~> 0.3)
+      os (~> 1.1)
+      qbash (~> 0.3)
     elapsed (0.0.1)
       loog (> 0)
       tago (> 0)
-    eth (0.5.13)
+    eth (0.5.14)
+      bigdecimal (~> 3.1)
       forwardable (~> 1.3)
       keccak (~> 1.3)
       konstructor (~> 1.0)
@@ -63,7 +64,7 @@ GEM
     ethon (0.16.0)
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
-    faraday (2.12.2)
+    faraday (2.13.0)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -72,10 +73,10 @@ GEM
     faye-websocket (0.11.3)
       eventmachine (>= 0.12.0)
       websocket-driver (>= 0.5.1)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x64-mingw-ucrt)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x64-mingw-ucrt)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
     ffi-compiler (1.3.2)
       ffi (>= 1.15.5)
       rake
@@ -106,11 +107,11 @@ GEM
       uri
     openssl (3.3.0)
     os (1.1.4)
-    parallel (1.26.3)
-    parser (3.3.7.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
-    pkg-config (1.6.0)
+    pkg-config (1.6.1)
     prism (1.4.0)
     qbash (0.4.0)
       backtrace (> 0)
@@ -139,7 +140,7 @@ GEM
       rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.0)
+    rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-minitest (0.38.0)
@@ -153,7 +154,7 @@ GEM
     rubocop-rake (0.7.1)
       lint_roller (~> 1.1)
       rubocop (>= 1.72.1)
-    rubocop-rspec (3.5.0)
+    rubocop-rspec (3.6.0)
       lint_roller (~> 1.1)
       rubocop (~> 1.72, >= 1.72.1)
     ruby-progressbar (1.13.0)
@@ -200,6 +201,7 @@ PLATFORMS
 
 DEPENDENCIES
   backtrace (> 0)
+  concurrent-ruby (~> 1.2)
   cucumber (~> 9.2)
   donce (> 0)
   erc20!

data/README.md

@@ -1,13 +1,13 @@
 # Ethereum ERC20 Manipulations in Ruby
 
-[![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/erc20)](http://www.rultor.com/p/yegor256/erc20)
+[![DevOps By Rultor.com](https://www.rultor.com/b/yegor256/erc20)](https://www.rultor.com/p/yegor256/erc20)
 [![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/)
 
 [![rake](https://github.com/yegor256/erc20/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/erc20/actions/workflows/rake.yml)
-[![PDD status](http://www.0pdd.com/svg?name=yegor256/erc20)](http://www.0pdd.com/p?name=yegor256/erc20)
-[![Gem Version](https://badge.fury.io/rb/erc20.svg)](http://badge.fury.io/rb/erc20)
+[![PDD status](https://www.0pdd.com/svg?name=yegor256/erc20)](https://www.0pdd.com/p?name=yegor256/erc20)
+[![Gem Version](https://badge.fury.io/rb/erc20.svg)](https://badge.fury.io/rb/erc20)
 [![Test Coverage](https://img.shields.io/codecov/c/github/yegor256/erc20.svg)](https://codecov.io/github/yegor256/erc20?branch=master)
-[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/github/yegor256/erc20/master/frames)
+[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/yegor256/erc20/master/frames)
 [![Hits-of-Code](https://hitsofcode.com/github/yegor256/erc20)](https://hitsofcode.com/view/github/yegor256/erc20)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/erc20/blob/master/LICENSE.txt)
 
@@ -15,7 +15,22 @@ This small Ruby [gem](https://rubygems.org/gems/erc20)
 makes manipulations with [Ethereum] [ERC20] tokens
 as simple as possible, when you have a provider of
 [JSON-RPC] and [WebSockets] Ethereum APIs, such as
-[Infura], [GetBlock], or [Alchemy]:
+[Infura], [GetBlock], or [Alchemy].
+
+Install it like this:
+
+```bash
+gem install erc20
+```
+
+Or simply add this to your Gemfile:
+
+```ruby
+gem 'erc20'
+```
+
+Then, make an instance of the main class and use to read
+balances, send and receive payments:
 
 ```ruby
 # Create a wallet:

data/lib/erc20/erc20.rb

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

data/lib/erc20/wallet.rb

@@ -121,7 +121,7 @@ class ERC20::Wallet
     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 #{address} is #{b} ERC20 tokens")
+    @log.debug("The balance of #{address} is #{b} ERC20 tokens")
     b
   end
 
@@ -138,7 +138,7 @@ class ERC20::Wallet
     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")
+    @log.debug("The balance of #{address} is #{b} ETHs")
     b
   end
 
@@ -294,9 +294,14 @@ class ERC20::Wallet
   # Once we actually start listening, the +active+ array will be updated
   # with the list of addresses.
   #
-  # The +addresses+ must have +to_a()+ implemented.
-  # The +active+ must have +append()+ implemented.
-  # Only these methods will be called.
+  # The +addresses+ must have +to_a()+ implemented. This method will be
+  # called every +delay+ seconds. It is expected that it returns the list
+  # of Ethereum public addresses that must be monitored.
+  #
+  # The +active+ must have +append()+ and +to_a()+ implemented. This array
+  # maintains the list of addresses that were mentioned in incoming transactions.
+  # This array is used mostly for testing. It is suggested to always provide
+  # an empty array.
   #
   # @param [Array<String>] addresses Addresses to monitor
   # @param [Array] active List of addresses that we are actually listening to
@@ -321,50 +326,58 @@ class ERC20::Wallet
       attempt = []
       log_url = "ws#{@ssl ? 's' : ''}://#{u.hostname}:#{u.port}"
       ws.on(:open) do
-        verbose do
-          log.debug("Connected to #{log_url}")
+        safe do
+          verbose do
+            log.debug("Connected to #{log_url}")
+          end
         end
       end
       ws.on(:message) do |msg|
-        verbose do
-          data = to_json(msg)
-          if data['id']
-            before = active.to_a
-            attempt.each do |a|
-              active.append(a) unless before.include?(a)
-            end
-            log.debug(
-              "Subscribed ##{subscription_id} to #{active.to_a.size} addresses at #{log_url}: " \
-              "#{active.to_a.map { |a| a[0..6] }.join(', ')}"
-            )
-          elsif data['method'] == 'eth_subscription' && data.dig('params', 'result')
-            event = data['params']['result']
-            if raw
-              log.debug("New event arrived from #{event['address']}")
-            else
-              event = {
-                amount: event['data'].to_i(16),
-                from: "0x#{event['topics'][1][26..].downcase}",
-                to: "0x#{event['topics'][2][26..].downcase}",
-                txn: event['transactionHash'].downcase
-              }
+        safe do
+          verbose do
+            data = to_json(msg)
+            if data['id']
+              before = active.to_a
+              attempt.each do |a|
+                active.append(a) unless before.include?(a)
+              end
               log.debug(
-                "Payment of #{event[:amount]} tokens arrived " \
-                "from #{event[:from]} to #{event[:to]} in #{event[:txn]}"
+                "Subscribed ##{subscription_id} to #{active.to_a.size} addresses at #{log_url}: " \
+                "#{active.to_a.map { |a| a[0..6] }.join(', ')}"
               )
+            elsif data['method'] == 'eth_subscription' && data.dig('params', 'result')
+              event = data['params']['result']
+              if raw
+                log.debug("New event arrived from #{event['address']}")
+              else
+                event = {
+                  amount: event['data'].to_i(16),
+                  from: "0x#{event['topics'][1][26..].downcase}",
+                  to: "0x#{event['topics'][2][26..].downcase}",
+                  txn: event['transactionHash'].downcase
+                }
+                log.debug(
+                  "Payment of #{event[:amount]} tokens arrived " \
+                  "from #{event[:from]} to #{event[:to]} in #{event[:txn]}"
+                )
+              end
+              yield event
             end
-            yield event
           end
         end
       end
       ws.on(:close) do
-        verbose do
-          log.debug("Disconnected from #{log_url}")
+        safe do
+          verbose do
+            log.debug("Disconnected from #{log_url}")
+          end
         end
       end
       ws.on(:error) do |e|
-        verbose do
-          log.debug("Error at #{log_url}: #{e.message}")
+        safe do
+          verbose do
+            log.debug("Error at #{log_url}: #{e.message}")
+          end
         end
       end
       EventMachine.add_periodic_timer(delay) do
@@ -411,15 +424,22 @@ class ERC20::Wallet
     raise e
   end
 
+  def safe
+    yield
+  rescue StandardError
+    # ignore it
+  end
+
   def url(http: true)
     URI.parse("#{http ? 'http' : 'ws'}#{@ssl ? 's' : ''}://#{@host}:#{@port}#{http ? @http_path : @ws_path}")
   end
 
   def jsonrpc
     JSONRPC.logger = Loog::NULL
-    connection =
-      if @proxy
-        uri = URI.parse(@proxy)
+    opts = {}
+    if @proxy
+      uri = URI.parse(@proxy)
+      opts[:connection] =
         Faraday.new do |f|
           f.adapter(Faraday.default_adapter)
           f.proxy = {
@@ -428,8 +448,8 @@ class ERC20::Wallet
             password: uri.password
           }
         end
-      end
-    JSONRPC::Client.new(url, connection:)
+    end
+    JSONRPC::Client.new(url.to_s, opts)
   end
 
   def to_pay_data(address, amount)

data/test/erc20/test_fake_wallet.rb

@@ -8,7 +8,6 @@ require 'donce'
 require 'eth'
 require 'faraday'
 require 'loog'
-require 'minitest/autorun'
 require 'random-port'
 require 'shellwords'
 require 'threads'
@@ -20,7 +19,7 @@ require_relative '../../lib/erc20/fake_wallet'
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
-class TestFakeWallet < Minitest::Test
+class TestFakeWallet < ERC20::Test
   def test_checks_gas_estimate
     b = ERC20::FakeWallet.new.gas_estimate(
       '0xEB2fE8872A6f1eDb70a2632Effffffffffffffff',

data/test/erc20/test_wallet.rb

@@ -8,7 +8,6 @@ require 'donce'
 require 'eth'
 require 'faraday'
 require 'loog'
-require 'minitest/autorun'
 require 'random-port'
 require 'shellwords'
 require 'threads'
@@ -20,7 +19,7 @@ require_relative '../../lib/erc20/wallet'
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
-class TestWallet < Minitest::Test
+class TestWallet < ERC20::Test
   # At this address, in Ethereum 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'
@@ -60,6 +59,7 @@ class TestWallet < Minitest::Test
   def test_fails_with_invalid_infura_key
     skip('Apparently, even with invalid key, Infura returns balance')
     w = ERC20::Wallet.new(
+      contract: ERC20::Wallet.USDT,
       host: 'mainnet.infura.io',
       http_path: '/v3/invalid-key-here',
       log: loog
@@ -201,6 +201,57 @@ class TestWallet < Minitest::Test
     end
   end
 
+  def test_accepts_many_payments_on_hardhat
+    walter = Eth::Key.new(priv: WALTER).address.to_s.downcase
+    on_hardhat do |wallet|
+      active = []
+      events = Concurrent::Set.new
+      total = 10
+      daemon =
+        Thread.new do
+          wallet.accept([walter], active) do |e|
+            events.add(e)
+          end
+        rescue StandardError => e
+          loog.error(Backtrace.new(e))
+        end
+      wait_for { !active.empty? }
+      sum = 1_234
+      Threads.new(total).assert do
+        wallet.pay(JEFF, walter, sum)
+      end
+      wait_for { events.size == total }
+      daemon.kill
+      daemon.join(30)
+      assert_equal(total, events.size)
+    end
+  end
+
+  def test_accepts_payments_with_failures_on_hardhat
+    walter = Eth::Key.new(priv: WALTER).address.to_s.downcase
+    on_hardhat do |wallet|
+      active = []
+      events = Concurrent::Set.new
+      total = 10
+      daemon =
+        Thread.new do
+          wallet.accept([walter], active) do |e|
+            events.add(e)
+            raise 'intentional'
+          end
+        end
+      wait_for { !active.empty? }
+      sum = 1_234
+      Threads.new(total).assert do
+        wallet.pay(JEFF, walter, sum)
+      end
+      wait_for { events.size == total }
+      daemon.kill
+      daemon.join(30)
+      assert_equal(total, events.size)
+    end
+  end
+
   def test_accepts_payments_on_changing_addresses_on_hardhat
     walter = Eth::Key.new(priv: WALTER).address.to_s.downcase
     jeff = Eth::Key.new(priv: JEFF).address.to_s.downcase
@@ -280,13 +331,14 @@ class TestWallet < Minitest::Test
   end
 
   def test_checks_balance_via_proxy
+    b = nil
     via_proxy do |proxy|
       on_hardhat do |w|
         wallet = through_proxy(w, proxy)
         b = wallet.balance(Eth::Key.new(priv: JEFF).address.to_s)
-        assert_equal(123_000_100_000, b)
       end
     end
+    assert_equal(123_000_100_000, b)
   end
 
   def test_checks_balance_via_proxy_on_mainnet

data/test/test__helper.rb

@@ -6,14 +6,27 @@
 $stdout.sync = true
 
 require 'simplecov'
-SimpleCov.external_at_exit = true
-SimpleCov.start
-
 require 'simplecov-cobertura'
-SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+unless SimpleCov.running
+  SimpleCov.command_name('test')
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+    [
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::CoberturaFormatter
+    ]
+  )
+  SimpleCov.minimum_coverage 90
+  SimpleCov.minimum_coverage_by_file 90
+  SimpleCov.start do
+    add_filter 'test/'
+    add_filter 'vendor/'
+    add_filter 'target/'
+    track_files 'lib/**/*.rb'
+    track_files '*.rb'
+  end
+end
 
 require 'minitest/autorun'
-
 require 'minitest/reporters'
 Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
 
@@ -42,7 +55,7 @@ end
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
-class Minitest::Test
+class ERC20::Test < Minitest::Test
   def loog
     ENV['RAKE'] ? Loog::ERRORS : Loog::VERBOSE
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Yegor Bugayenko
 bindir: bin
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 2025-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eth
@@ -122,7 +122,6 @@ files:
 - ".pdd"
 - ".rubocop.yml"
 - ".rultor.yml"
-- ".simplecov"
 - ".yamllint.yml"
 - Gemfile
 - Gemfile.lock

data/.simplecov

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-#
-# SPDX-FileCopyrightText: Copyright (c) 2025 Yegor Bugayenko
-# SPDX-License-Identifier: MIT
-
-if Gem.win_platform?
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter
-  ]
-  SimpleCov.start do
-    add_filter '/test/'
-  end
-else
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
-    [SimpleCov::Formatter::HTMLFormatter]
-  )
-  SimpleCov.start do
-    add_filter '/test/'
-    minimum_coverage 20
-  end
-end