erc20 0.0.12 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c9c69024f80c9041c0f80364a9e8129cf2d7802f9320576fbf007b9b3f32e9f
-  data.tar.gz: 00f5eba51cde139b5a4c697253fc285152c52c06c8927cbdac34deb40863702b
+  metadata.gz: ac1bd8d3ffe6bf19ceb44174514dca9abb57746110c864821de775b2f11f955a
+  data.tar.gz: 7cc7b1d4fe20626629ea99ca5bb6cbb02686c872e36106c4c05fab846ad9b24b
 SHA512:
-  metadata.gz: 10d041c08ff2cbcb1e1fe7521980d26919b6b4926e1506a6341bd36280886cf26ee9d9192c4b2b3c4bf6e6e9237251a9fc3d4bda3430cdaaf54f229146b7febf
-  data.tar.gz: 802187ea0f8acc530b22f9d5518b60e534a8a633eac114c0f5c682a8cc1b079edae4d130fc7ac1b6d52c3f24b443c2f3939b4727d61524ddca6fe2d94b90d726
+  metadata.gz: 7212c53bce48a094d0eaa8359bed81cad82e81f883caa47da2da4851cff7c6d3956036a3919265925f540b125cede427f5a9c506a60e3b002469bed22096695a
+  data.tar.gz: 7a80add54d6ecf810bff74a265cf4dca8ae8b99ae8c8f9e046cfec537bc9256d7a6127159d52d0b04001a7c3b17f9895c4b64814e7d9b058789e2c267b648a21

data/.rubocop.yml

@@ -27,10 +27,10 @@ AllCops:
   TargetRubyVersion: 3.2
   SuggestExtensions: false
   NewCops: enable
-require:
-  - rubocop-minitest
+plugins:
   - rubocop-performance
   - rubocop-rake
+  - rubocop-minitest
 Minitest/EmptyLineBeforeAssertionMethods:
   Enabled: false
 Gemspec/RequiredRubyVersion:

data/Gemfile

@@ -34,9 +34,9 @@ gem 'qbash', '>0', require: false
 gem 'rake', '13.2.1', require: false
 gem 'random-port', '>0', require: false
 gem 'rspec-rails', '7.1.1', require: false
-gem 'rubocop', '1.71.2', require: false
-gem 'rubocop-minitest', '0.36.0', require: false
-gem 'rubocop-performance', '1.23.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-rake', '>0', require: false
 gem 'rubocop-rspec', '3.4.0', require: false
 gem 'simplecov', '0.22.0', require: false

data/Gemfile.lock

@@ -103,6 +103,7 @@ GEM
     keccak (1.3.2)
     konstructor (1.0.2)
     language_server-protocol (3.17.0.4)
+    lint_roller (1.1.0)
     logger (1.6.6)
     loofah (2.24.0)
       crass (~> 1.0.2)
@@ -201,9 +202,10 @@ GEM
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.2)
-    rubocop (1.71.2)
+    rubocop (1.72.1)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
@@ -213,14 +215,17 @@ GEM
       unicode-display_width (>= 2.4.0, < 4.0)
     rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
-    rubocop-minitest (0.36.0)
-      rubocop (>= 1.61, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-performance (1.23.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rake (0.6.0)
-      rubocop (~> 1.0)
+    rubocop-minitest (0.37.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-performance (1.24.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    rubocop-rake (0.7.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.72.1)
     rubocop-rspec (3.4.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
@@ -238,7 +243,7 @@ GEM
       simplecov (~> 0.19)
     simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    stringio (3.1.2)
+    stringio (3.1.3)
     tago (0.0.2)
     thor (1.3.2)
     threads (0.4.1)
@@ -282,9 +287,9 @@ DEPENDENCIES
   rake (= 13.2.1)
   random-port (> 0)
   rspec-rails (= 7.1.1)
-  rubocop (= 1.71.2)
-  rubocop-minitest (= 0.36.0)
-  rubocop-performance (= 1.23.1)
+  rubocop (= 1.72.1)
+  rubocop-minitest (= 0.37.1)
+  rubocop-performance (= 1.24.0)
   rubocop-rake (> 0)
   rubocop-rspec (= 3.4.0)
   simplecov (= 0.22.0)

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.12'
+  VERSION = '0.0.14'
 end

data/lib/erc20/wallet.rb

@@ -93,13 +93,30 @@ class ERC20::Wallet
   def initialize(contract: USDT, chain: 1, log: $stdout,
                  host: nil, port: 443, http_path: '/', ws_path: '/',
                  ssl: true, proxy: nil)
+    raise 'Contract can\'t be nil' unless contract
+    raise 'Contract must be a String' unless contract.is_a?(String)
+    raise 'Invalid format of the contract' unless /^0x[0-9a-fA-F]{40}$/.match?(contract)
     @contract = contract
+    raise 'Host can\'t be nil' unless host
+    raise 'Host must be a String' unless host.is_a?(String)
     @host = host
+    raise 'Port can\'t be nil' unless port
+    raise 'Port must be an Integer' unless port.is_a?(Integer)
+    raise 'Port must be a positive Integer' unless port.positive?
     @port = port
+    raise 'Ssl can\'t be nil' if ssl.nil?
     @ssl = ssl
+    raise 'Http_path can\'t be nil' unless http_path
+    raise 'Http_path must be a String' unless http_path.is_a?(String)
     @http_path = http_path
+    raise 'Ws_path can\'t be nil' unless ws_path
+    raise 'Ws_path must be a String' unless ws_path.is_a?(String)
     @ws_path = ws_path
+    raise 'Log can\'t be nil' unless log
     @log = log
+    raise 'Chain can\'t be nil' unless chain
+    raise 'Chain must be an Integer' unless chain.is_a?(Integer)
+    raise 'Chain must be a positive Integer' unless chain.positive?
     @chain = chain
     @proxy = proxy
     @mutex = Mutex.new
@@ -110,9 +127,11 @@ class ERC20::Wallet
   # @param [String] hex 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)
     func = '70a08231' # balanceOf
-    padded = "000000000000000000000000#{hex[2..].downcase}"
-    data = "0x#{func}#{padded}"
+    data = "0x#{func}000000000000000000000000#{hex[2..].downcase}"
     r = jsonrpc.eth_call({ to: @contract, data: data }, 'latest')
     b = r[2..].to_i(16)
     @log.debug("Balance of #{hex} is #{b}")
@@ -128,6 +147,23 @@ class ERC20::Wallet
   # @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)
+    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
     func = 'a9059cbb' # transfer(address,uint256)
     to_clean = address.downcase.sub(/^0x/, '')
     to_padded = ('0' * (64 - to_clean.size)) + to_clean
@@ -169,42 +205,47 @@ class ERC20::Wallet
   # Once we actually start listening, the +active+ array will be updated
   # with the list of addresses.
   #
-  # Both +addresses+ and +active+ must have two methods implemented: +to_a()+
-  # and +append()+. Only these methods will be called.
+  # The +addresses+ must have +to_a()+ implemented.
+  # The +active+ must have +append()+ implemented.
+  # Only these methods will be called.
   #
   # @param [Array<String>] addresses Addresses to monitor
   # @param [Array] active List of addresses that we are actually listening to
   # @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)
+  # @param [Integer] subscription_id Unique ID of the subscription
+  def accept(addresses, active = [], raw: false, delay: 1, subscription_id: rand(99_999))
+    raise 'Addresses can\'t be nil' unless addresses
+    raise 'Addresses must respond to .to_a()' unless addresses.respond_to?(:to_a)
+    raise 'Active can\'t be nil' unless active
+    raise 'Active must respond to .append()' unless active.respond_to?(:append)
+    raise 'Amount must be an Integer' unless delay.is_a?(Integer)
+    raise 'Amount must be a positive Integer' unless delay.positive?
+    raise 'Subscription ID must be an Integer' unless subscription_id.is_a?(Integer)
+    raise 'Subscription ID must be a positive Integer' unless subscription_id.positive?
     EventMachine.run do
       u = url(http: false)
       @log.debug("Connecting to #{u.hostname}:#{u.port}...")
       ws = Faye::WebSocket::Client.new(u.to_s, [], proxy: @proxy ? { origin: @proxy } : {})
       log = @log
       contract = @contract
-      id = rand(99_999)
       attempt = []
+      log_url = "ws#{@ssl ? 's' : ''}://#{u.hostname}:#{u.port}"
       ws.on(:open) do
         verbose do
-          log.debug("Connected to ws://#{u.hostname}:#{u.port}")
+          log.debug("Connected to #{log_url}")
         end
       end
       ws.on(:message) do |msg|
         verbose do
-          data =
-            begin
-              JSON.parse(msg.data)
-            rescue StandardError
-              {}
-            end
+          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 ##{id} to #{active.to_a.size} addresses: " \
+              "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')
@@ -218,7 +259,10 @@ class ERC20::Wallet
                 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]}")
+              log.debug(
+                "Payment of #{event[:amount]} tokens arrived" \
+                "from #{event[:from]} to #{event[:to]} in #{event[:txn]}"
+              )
             end
             yield event
           end
@@ -226,12 +270,12 @@ class ERC20::Wallet
       end
       ws.on(:close) do
         verbose do
-          log.debug("Disconnected from ws://#{u.hostname}:#{u.port}")
+          log.debug("Disconnected from #{log_url}")
         end
       end
       ws.on(:error) do |e|
         verbose do
-          log.debug("Error at #{u.hostname}: #{e.message}")
+          log.debug("Error at #{log_url}: #{e.message}")
         end
       end
       EventMachine.add_periodic_timer(delay) do
@@ -240,7 +284,7 @@ class ERC20::Wallet
         ws.send(
           {
             jsonrpc: '2.0',
-            id:,
+            id: subscription_id,
             method: 'eth_subscribe',
             params: [
               'logs',
@@ -256,7 +300,7 @@ class ERC20::Wallet
           }.to_json
         )
         log.debug(
-          "Requested to subscribe ##{id} to #{addresses.to_a.size} addresses: " \
+          "Requested to subscribe ##{subscription_id} to #{addresses.to_a.size} addresses at #{log_url}: " \
           "#{addresses.to_a.map { |a| a[0..6] }.join(', ')}"
         )
       end
@@ -265,6 +309,12 @@ class ERC20::Wallet
 
   private
 
+  def to_json(msg)
+    JSON.parse(msg.data)
+  rescue StandardError
+    {}
+  end
+
   def verbose
     yield
   rescue StandardError => e

data/test/erc20/test_fake_wallet.rb

@@ -33,6 +33,10 @@ 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

data/test/erc20/test_wallet.rb

@@ -38,9 +38,9 @@ require_relative '../test__helper'
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
 class TestWallet < Minitest::Test
-  # At this address, in Etherium mainnet, there are a ~$27 USDT. I won't
+  # At this address, in Etherium mainnet, there are $8 USDT. I won't
   # move them anyway, that's why tests can use this address forever.
-  STABLE = '0xEB2fE8872A6f1eDb70a2632EA1f869AB131532f6'
+  STABLE = '0x7232148927F8a580053792f44D4d59d40Fd00ABD'
 
   # One guy private hex.
   JEFF = '81a9b2114d53731ecc84b261ef6c0387dde34d5907fe7b441240cc21d61bf80a'
@@ -51,7 +51,7 @@ class TestWallet < Minitest::Test
   def test_checks_balance_on_mainnet
     b = mainnet.balance(STABLE)
     refute_nil(b)
-    assert_equal(27_258_889, b)
+    assert_equal(8_000_000, b)
   end
 
   def test_checks_balance_of_absent_address
@@ -253,11 +253,21 @@ class TestWallet < Minitest::Test
           host: 'mainnet.infura.io', http_path: "/v3/#{env('INFURA_KEY')}",
           proxy:, log: loog
         )
-        assert_equal(27_258_889, w.balance(STABLE))
+        assert_equal(8_000_000, w.balance(STABLE))
       end
     end
   end
 
+  def test_pays_on_mainnet
+    skip('This is live, must be run manually')
+    w = mainnet
+    print 'Enter Etherium ERC20 private key (64 chars): '
+    priv = gets.chomp
+    to = '0xEB2fE8872A6f1eDb70a2632EA1f869AB131532f6'
+    txn = w.pay(priv, to, 1_990_000)
+    assert_equal(66, txn.length)
+  end
+
   private
 
   def env(var)

data/test/test__helper.rb

@@ -64,12 +64,13 @@ class Minitest::Test
     ENV['RAKE'] ? Loog::ERRORS : Loog::VERBOSE
   end
 
-  def wait_for
+  def wait_for(seconds = 30)
     start = Time.now
     loop do
       sleep(0.1)
       break if yield
-      raise 'timeout' if Time.now - start > 60
+      passed = Time.now - start
+      raise "Giving up after #{passed} seconds of waiting" if passed > seconds
     rescue Errno::ECONNREFUSED
       retry
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.14
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-14 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eth