erc20 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a6045ef455a8f096b144b8a680abd27df0b56c3d66b55893ad7f0f3dc4e4203
-  data.tar.gz: e5276a87ad3ac48ec1df0928e28bc18295e3033a280fe1172d1d9199b582c54f
+  metadata.gz: 34581e0a63fe07f3910a76e45848204045119efd01aaa0d2478d8c2ab7b2cac2
+  data.tar.gz: 21086a1c737f697d7ac6bc8c3b4f21845c104f007daca5c9091dfdf46bdb53e4
 SHA512:
-  metadata.gz: e964c619368827683031db7eae717c662cc292eb60b0cded4868968e19bdebb1ab091c3ad1edc65e78aa4d0ba2b451587b9f77cf38ac381765776a7b078182f6
-  data.tar.gz: 83793a79b62811b4f34589a5d60db5cec07f707e04673ef02adcf29e81eaf7d91f3ad7198d2c4bbfc2645032cf8a6c2ac508ec477a3a60edf5874401864c2e20
+  metadata.gz: dda126cea1191e735bed9d3ab733c37a42ab0bef1d4566a84fedd0cb4462d9269f974a35256c9367f054e7b2147f657e8d92e267e669e56d24d2691d332a182e
+  data.tar.gz: 5b2787b755d7a7d6c1527dd7c0d5b5bf4e824eeeea5b0c9190ad7d2d3899c768ba85b1c1cd93d51c67539e369a0e978bfef296d550996eb2b83e9685b0cdf386

data/.rultor.yml

@@ -31,8 +31,8 @@ release:
     [[ "${tag}" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]] || exit -1
     DONCE_SUDO=true bundle exec rake
     rm -rf *.gem
-    sed -i "s/0\.0\.0/${tag}/g" lib/erc20.rb
-    git add lib/erc20.rb
+    sed -i "s/0\.0\.0/${tag}/g" lib/erc20/erc20.rb
+    git add lib/erc20/erc20.rb
     git commit -m "version set to ${tag}"
     gem build erc20.gemspec
     chmod 0600 ../rubygems.yml

data/Gemfile.lock

@@ -51,7 +51,7 @@ GEM
     connection_pool (2.5.0)
     crass (1.0.6)
     date (3.4.1)
-    diff-lcs (1.5.1)
+    diff-lcs (1.6.0)
     docile (1.4.1)
     donce (0.1.0)
       backtrace (> 0)
@@ -103,7 +103,7 @@ GEM
     keccak (1.3.2)
     konstructor (1.0.2)
     language_server-protocol (3.17.0.4)
-    logger (1.6.5)
+    logger (1.6.6)
     loofah (2.24.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -147,7 +147,7 @@ GEM
       loog (> 0)
       tago (> 0)
     racc (1.8.1)
-    rack (3.1.9)
+    rack (3.1.10)
     rack-session (2.1.0)
       base64 (>= 0.1.0)
       rack (>= 3.0.0)

data/README.md

@@ -14,7 +14,7 @@
 This small Ruby [gem](https://rubygems.org/gems/erc20)
 makes manipulations with [Etherium] [ERC20] tokens
 as simple as they can be, if you have a provider of
-[JSON-RPC] and [WebSocket] Etherium APIs, for example
+[JSON-RPC] and [WebSockets] Etherium APIs, for example
 [Infura], [GetBlock], or [Alchemy]:
 
 ```ruby
@@ -92,7 +92,7 @@ If it's clean and you don't see any error messages, submit your pull request.
 [Etherium]: https://en.wikipedia.org/wiki/Ethereum
 [ERC20]: https://ethereum.org/en/developers/docs/standards/tokens/erc-20/
 [JSON-RPC]: https://ethereum.org/en/developers/docs/apis/json-rpc/
-[Websocket]: https://ethereum.org/en/developers/tutorials/using-websockets/
+[Websockets]: https://ethereum.org/en/developers/tutorials/using-websockets/
 [Infura]: https://infura.io/
 [Alchemy]: https://alchemy.com/
 [GetBlock]: https://getblock.io/

data/erc20.gemspec

@@ -21,7 +21,7 @@
 # SOFTWARE.
 
 require 'English'
-require_relative 'lib/erc20'
+require_relative 'lib/erc20/erc20'
 
 Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=

data/lib/erc20/erc20.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2025 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+# This module makes manipulations with Etherium ERC20 tokens
+# as simple as they can be, if you have a provider of
+# JSON-RPC and WebSockets Etherium APIs, for example
+# Infura, GetBlock, or Alchemy.
+#
+# Start like this:
+#
+#  require 'erc20'
+#  w = ERC20::Wallet.new(
+#    host: 'mainnet.infura.io',
+#    http_path: '/v3/<your-infura-key>',
+#    ws_path: '/ws/v3/<your-infura-key>'
+#  )
+#  puts w.balance(address)
+#
+# This should print the balance of the ERC20 address.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2025 Yegor Bugayenko
+# License:: MIT
+module ERC20
+  # Current version of the gem (changed by the +.rultor.yml+ on every release)
+  VERSION = '0.0.10'
+end

data/lib/erc20/fake_wallet.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2025 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require_relative 'erc20'
+require_relative 'wallet'
+
+# A fake wallet that behaves like a +ERC20::Wallet+.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2025 Yegor Bugayenko
+# License:: MIT
+class ERC20::FakeWallet
+  # Fakes:
+  attr_reader :host, :port, :ssl, :chain, :contract, :ws_path, :http_path
+
+  # Ctor.
+  def initialize
+    @host = 'example.com'
+    @port = 443
+    @ssl = true
+    @chain = 1
+    @contract = ERC20::Wallet::USDT
+    @ws_path = '/'
+    @http_path = '/'
+  end
+
+  # Get balance of a public address.
+  #
+  # @param [String] _hex Public key, in hex, starting from '0x'
+  # @return [Integer] Balance, in tokens
+  def balance(_hex)
+    42_000_000
+  end
+
+  # Send a single 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
+  # @return [String] Transaction hash
+  def pay(_priv, _address, _amount, *)
+    '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+  end
+
+  # Wait and accept.
+  #
+  # @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)
+    addresses.to_a.each { |a| active.append(a) }
+    loop do
+      event =
+        if raw
+          {}
+        else
+          {
+            amount: 424_242,
+            from: '0xd5ff1bfcde7a03da61ad229d962c74f1ea2f16a5',
+            to: addresses.sample,
+            txn: '0x172de9cda30537eae68ab4a96163ebbb8f8a85293b8737dd2e5deb4714b14623'
+          }
+        end
+      yield event
+      sleep(delay)
+    end
+  end
+end

data/lib/erc20/wallet.rb

@@ -27,12 +27,49 @@ require 'json'
 require 'jsonrpc/client'
 require 'loog'
 require 'uri'
-require_relative '../erc20'
+require_relative 'erc20'
 
 # A wallet with ERC20 tokens on Etherium.
 #
 # Objects of this class are thread-safe.
 #
+# In order to check the balance of ERC20 address:
+#
+#  require 'erc20'
+#  w = ERC20::Wallet.new(
+#    contract: ERC20::Wallet.USDT, # hex of it
+#    host: 'mainnet.infura.io',
+#    http_path: '/v3/<your-infura-key>',
+#    ws_path: '/ws/v3/<your-infura-key>',
+#    log: $stdout
+#  )
+#  usdt = w.balance(address)
+#
+# In order to send a payment:
+#
+#  hex = w.pay(private_key, to_address, amount)
+#
+# In order to catch incoming payments to a set of addresses:
+#
+#  addresses = ['0x...', '0x...']
+#  w.accept(addresses) do |event|
+#    puts event[:txt] # 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
+#
+# To connect to the server via HTTP proxy with basic authentication:
+#
+#  w = ERC20::Wallet.new(
+#    host: 'go.getblock.io',
+#    http_path: '/<your-rpc-getblock-key>',
+#    ws_path: '/<your-ws-getblock-key>',
+#    proxy: 'http://jeffrey:swordfish@example.com:3128' # here!
+#  )
+#
+# More information in our README.
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2025 Yegor Bugayenko
 # License:: MIT
@@ -71,7 +108,7 @@ class ERC20::Wallet
   # Get balance of a public address.
   #
   # @param [String] hex Public key, in hex, starting from '0x'
-  # @return [Integer] Balance, in
+  # @return [Integer] Balance, in tokens
   def balance(hex)
     func = '70a08231' # balanceOf
     padded = "000000000000000000000000#{hex[2..].downcase}"

data/lib/erc20.rb

@@ -20,12 +20,5 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-# ERC20 module.
-#
-# Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2025 Yegor Bugayenko
-# License:: MIT
-module ERC20
-  # Current version of the gem (changed by .rultor.yml on every release)
-  VERSION = '0.0.8'
-end
+require_relative 'erc20/erc20'
+require_relative 'erc20/wallet'

data/test/erc20/test_fake_wallet.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2025 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'backtrace'
+require 'donce'
+require 'eth'
+require 'faraday'
+require 'loog'
+require 'minitest/autorun'
+require 'random-port'
+require 'shellwords'
+require 'threads'
+require 'typhoeus'
+require_relative '../../lib/erc20/fake_wallet'
+require_relative '../test__helper'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2025 Yegor Bugayenko
+# License:: MIT
+class TestFakeWallet < Minitest::Test
+  def test_checks_fake_balance
+    b = ERC20::FakeWallet.new.balance('0xEB2fE8872A6f1eDb70a2632Effffffffffffffff')
+    refute_nil(b)
+  end
+
+  def test_returns_host
+    assert_equal('example.com', ERC20::FakeWallet.new.host)
+  end
+
+  def test_pays_fake_money
+    priv = '81a9b2114d53731ecc84b261ef6c0387dde34d5907fe7b441240cc21d61bf80a'
+    to = '0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1'
+    txn = ERC20::FakeWallet.new.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 = []
+    event = nil
+    daemon =
+      Thread.new do
+        ERC20::FakeWallet.new.accept(['0xfadef8ba4a5d709a2bf55b7a8798c9b438c640c1'], active) do |e|
+          event = e
+        end
+      rescue StandardError => e
+        loog.error(Backtrace.new(e))
+      end
+    wait_for { !active.empty? }
+    daemon.kill
+    daemon.join(30)
+    refute_nil(event)
+  end
+end

data/test/erc20/test_wallet.rb

@@ -30,7 +30,6 @@ require 'random-port'
 require 'shellwords'
 require 'threads'
 require 'typhoeus'
-require_relative '../../lib/erc20'
 require_relative '../../lib/erc20/wallet'
 require_relative '../test__helper'
 
@@ -261,25 +260,6 @@ class TestWallet < Minitest::Test
 
   private
 
-  def loog
-    ENV['RAKE'] ? Loog::ERRORS : Loog::VERBOSE
-  end
-
-  def wait_for
-    start = Time.now
-    loop do
-      sleep(0.1)
-      break if yield
-      raise 'timeout' if Time.now - start > 60
-    rescue Errno::ECONNREFUSED
-      retry
-    end
-  end
-
-  def wait_for_port(port)
-    wait_for { Typhoeus::Request.get("http://localhost:#{port}").code == 200 }
-  end
-
   def env(var)
     key = ENV.fetch(var, nil)
     skip("The #{var} environment variable is not set") if key.nil?

data/test/test__helper.rb

@@ -39,3 +39,28 @@ if ENV['RAKE']
   require 'minitest/retry'
   Minitest::Retry.use!(methods_to_skip: [])
 end
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2025 Yegor Bugayenko
+# License:: MIT
+class Minitest::Test
+  def loog
+    ENV['RAKE'] ? Loog::ERRORS : Loog::VERBOSE
+  end
+
+  def wait_for
+    start = Time.now
+    loop do
+      sleep(0.1)
+      break if yield
+      raise 'timeout' if Time.now - start > 60
+    rescue Errno::ECONNREFUSED
+      retry
+    end
+  end
+
+  def wait_for_port(port)
+    wait_for { Typhoeus::Request.get("http://localhost:#{port}").code == 200 }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-13 00:00:00.000000000 Z
+date: 2025-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eth
@@ -122,8 +122,11 @@ files:
 - hardhat/ignition/modules/Foo.ts
 - hardhat/package.json
 - lib/erc20.rb
+- lib/erc20/erc20.rb
+- lib/erc20/fake_wallet.rb
 - lib/erc20/wallet.rb
 - renovate.json
+- test/erc20/test_fake_wallet.rb
 - test/erc20/test_wallet.rb
 - test/test__helper.rb
 homepage: http://github.com/yegor256/erc20.rb