erc20 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47883e48393686ed5d357fb9f5f762e0744a30a8f0999724dd2ddba369ac75ae
-  data.tar.gz: bad63b9aa6269a79cc2276c10c0f6aec02d8bf94bf18057b89fc0e9f896833be
+  metadata.gz: c553c2335f6272040af4bd2d361a30a11f0094e6871190799b90688482ad0eda
+  data.tar.gz: a5adb387763f6303dfccdcddeefa9a190e51c327f42a299fd25588018f9a9f6b
 SHA512:
-  metadata.gz: bf78c2548b09b33c9e67ba7476d9e14576f9be07ca1cbb1620067899451c96c587a87849d7c86c88ec449254362db9d921a4d0fde9534954b8ad9c48405f4b51
-  data.tar.gz: 224500ace20e3abaa25bbdc4a6be32fe7fca7b57b7d7b2bf4a4b01a8dac50a3fb45bf2a70c13f2f737b502a5ea80c4f452eeda5d0737ed6c5087d1458b590f20
+  metadata.gz: 332235aa28a28b38e0d56caf6f223560679b3b2622491cf6351016b6b8e11221f414bd5790d3b393af644b1d6a9c50be807a80126866108afc6c399729c73231
+  data.tar.gz: d74969a43d49696bfa5dfa04e26f6f0206772fffed76d94843e28189f2586d7552853361387ae102010ae976f90edcca497b1eee45addfdb101d3734641e091a

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.9'
+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
@@ -118,7 +155,7 @@ class ERC20::Wallet
         jsonrpc.eth_sendRawTransaction(hex)
       end
     @log.debug("Sent #{amount} from #{from} to #{address}: #{tnx}")
-    tnx
+    tnx.downcase
   end
 
   # Wait for incoming transactions and let the block know when they
@@ -179,7 +216,7 @@ class ERC20::Wallet
                 amount: event['data'].to_i(16),
                 from: "0x#{event['topics'][1][26..].downcase}",
                 to: "0x#{event['topics'][2][26..].downcase}",
-                txn: event['transactionHash']
+                txn: event['transactionHash'].downcase
               }
               log.debug("Payment of #{event[:amount]} tokens arrived from #{event[:from]} to #{event[:to]}")
             end

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.7'
-end
+require_relative 'erc20/erc20'
+require_relative 'erc20/wallet'

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'
 
@@ -63,12 +62,13 @@ class TestWallet < Minitest::Test
   end
 
   def test_fails_with_invalid_infura_key
+    skip('Apparently, even with invalid key, Infura returns balance')
     w = ERC20::Wallet.new(
       host: 'mainnet.infura.io',
       http_path: '/v3/invalid-key-here',
       log: loog
     )
-    assert_raises(StandardError) { w.balance(STABLE) }
+    assert_raises(StandardError) { p w.balance(STABLE) }
   end
 
   def test_checks_balance_on_testnet
@@ -113,6 +113,7 @@ class TestWallet < Minitest::Test
       assert_operator(wallet.balance(from), :>, sum * 2)
       txn = wallet.pay(JEFF, to, sum)
       assert_equal(66, txn.length)
+      assert_match(/^0x[a-f0-9]{64}$/, txn)
       assert_equal(before + sum, wallet.balance(to))
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 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,6 +122,7 @@ files:
 - hardhat/ignition/modules/Foo.ts
 - hardhat/package.json
 - lib/erc20.rb
+- lib/erc20/erc20.rb
 - lib/erc20/wallet.rb
 - renovate.json
 - test/erc20/test_wallet.rb