erc20 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf1f0dbee9d090079bd263a79eeafc0093866fc5503d7a1130b26e7b77ca8630
-  data.tar.gz: 105f04b7df7e9b8f45a3c34acb739fb6b74238e9f7180b624ceb724f8a4c1570
+  metadata.gz: 6b5bccf0ea259136bad39ab36f01240da8a029958b627ed337cd20477a7a13c9
+  data.tar.gz: 4c5d605e086d38755d25d8153c0bf6b220460f5b984607fd304706fe0b3d942f
 SHA512:
-  metadata.gz: e86283d48937fca5b956c0963b19c6b25b25226d6a60bd737e37d6201cc5dc82879d33ab79ff3ef919728762da601aa9d1bc56aaa85b94532f7edcafd29f04eb
-  data.tar.gz: f11fd8b7d8b017c4fbdc70b4442aa054344fee9451fd029e7826da8fe12961ac60447522945e83b941ab7ccf28a67299a9077c47b114f8736336d42c6b16088f
+  metadata.gz: 0adbab22a3b752f63e1e001eac554ba8bcc8a40a2fea7234b9d674608eb281c912fb2e21931497006509b8cf2ae80e82d9de8dd49b7727f48759796da375d43b
+  data.tar.gz: ae3387a6c71c5ba367c8bd5814d2eebced21d6de6087dc214b083659811e2ed60efb5d0d981b7ba57b10030435566645ddd8328ac99ef4f9574b534192385383

data/.rubocop.yml

@@ -43,8 +43,10 @@ Layout/MultilineMethodCallIndentation:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
+Metrics/ParameterLists:
+  Enabled: false
 Metrics/BlockLength:
-  Max: 50
+  Max: 100
 Metrics/CyclomaticComplexity:
   Max: 25
 Metrics/PerceivedComplexity:

data/Gemfile.lock

@@ -6,7 +6,6 @@ PATH
       eth (~> 0.4)
       jsonrpc-client (> 0)
       loog (> 0)
-      tago (> 0)
       websocket-client-simple (> 0)
 
 GEM

data/README.md

@@ -11,17 +11,19 @@
 [![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)
 
-This small Ruby library makes manipulations with [Etherium] [ERC20] tokens
+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
 [Infura], [GetBlock], or [Alchemy]:
 
 ```ruby
 # Create a wallet:
+require 'erc20'
 w = ERC20::Wallet.new(
   contract: ERC20::Wallet.USDT, # hex of it
-  rpc: 'https://mainnet.infura.io/v3/<your-key>',
-  wss: 'wss://mainnet.infura.io/v3/<your-key>',
+  host: 'mainnet.infura.io',
+  path: '/v3/<your-key>',
   log: $stdout
 )
 
@@ -34,9 +36,9 @@ txn = w.pay(private_key, to_address, amount)
 # Stay waiting, and trigger the block when transactions arrive:
 addresses = ['0x...', '0x...']
 w.accept(addresses) do |event|
-  puts event['data'].to_i(16)) # how much
-  puts "0x#{event['topics'][1][26..]}" # who sent the payment
-  puts "0x#{event['topics'][2][26..]}" # who was the receiver
+  puts event[:amount] # how much
+  puts event[:from] # who sent the payment
+  puts event[:to] # who was the receiver
 end
 ```
 

data/erc20.gemspec

@@ -43,7 +43,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'eth', '~>0.4'
   s.add_dependency 'jsonrpc-client', '>0'
   s.add_dependency 'loog', '>0'
-  s.add_dependency 'tago', '>0'
   s.add_dependency 'websocket-client-simple', '>0'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/erc20/wallet.rb

@@ -41,11 +41,28 @@ class ERC20::Wallet
   # @param [String] contract Hex of the contract in Etherium
   # @param [String] rpc The URL of Etherium JSON-RPC provider
   # @param [Integer] chain The ID of the chain (1 for mainnet)
+  # @param [String] host The host to connect to
+  # @param [Integer] port TCP port to use
+  # @param [String] path The path in the connection URL
+  # @param [Boolean] ssl Should we use SSL (for https and wss)
   # @param [Object] log The destination for logs
-  def initialize(contract: USDT, rpc: nil, wss: nil, chain: 1, log: $stdout)
+  def initialize(contract: USDT, rpc: nil, wss: nil, chain: 1, log: $stdout,
+                 host: nil, port: 443, path: '/', ssl: true)
     @contract = contract
-    @rpc = rpc
-    @wss = wss
+    raise 'Use either host or rpc' if rpc && host
+    raise 'Use either host or wss' if wss && host
+    if rpc
+      @rpc = rpc
+    else
+      raise 'Either rpc or host+port+path are required' unless host && port && path
+      @rpc = "http#{ssl ? 's' : ''}://#{host}:#{port}#{path}"
+    end
+    if wss
+      @wss = wss
+    else
+      raise 'Either wss or host+port+path are required' unless host && port && path
+      @wss = "http#{ssl ? 's' : ''}://#{host}:#{port}#{path}"
+    end
     @log = log
     @chain = chain
   end
@@ -59,7 +76,9 @@ class ERC20::Wallet
     padded = "000000000000000000000000#{hex[2..].downcase}"
     data = "0x#{func}#{padded}"
     r = jsonrpc.eth_call({ to: @contract, data: data }, 'latest')
-    r[2..].to_i(16)
+    b = r[2..].to_i(16)
+    @log.debug("Balance of #{hex} is #{b}")
+    b
   end
 
   # Send a single payment from a private address to a public one.
@@ -92,7 +111,10 @@ class ERC20::Wallet
       }
     )
     tx.sign(key)
-    jsonrpc.eth_sendRawTransaction("0x#{tx.hex}")
+    hex = "0x#{tx.hex}"
+    jsonrpc.eth_sendRawTransaction(hex)
+    @log.debug("Sent #{amount} from #{from} to #{address}: #{hex}")
+    hex
   end
 
   # Wait for incoming transactions and let the block know when they
@@ -101,7 +123,8 @@ class ERC20::Wallet
   #
   # @param [Array<String>] addresses Addresses to monitor
   # @param [Array] ready When connected, TRUE will be added to this array
-  def accept(addresses, connected: [])
+  # @param [Boolean] raw TRUE if you need to get JSON events as they arrive from Websockets
+  def accept(addresses, connected: [], raw: false)
     WebSocket::Client::Simple.connect(@wss) do |ws|
       log = @log
       contract = @contract
@@ -126,6 +149,7 @@ class ERC20::Wallet
         }
         ws.send(msg.to_json)
         connected.append(1)
+        log.debug("Subscribed to #{addresses.count} addresses")
       end
       ws.on(:message) do |msg|
         data =
@@ -136,7 +160,14 @@ class ERC20::Wallet
           end
         if data['method'] == 'eth_subscription' && data.dig('params', 'result')
           event = data['params']['result']
-          log.debug("New transaction from: #{event['address']}")
+          unless raw
+            event = {
+              amount: event['data'].to_i(16),
+              from: "0x#{event['topics'][1][26..].downcase}",
+              to: "0x#{event['topics'][2][26..].downcase}"
+            }
+          end
+          log.debug("New event arrived from #{event['address']}")
           yield event
         end
       end

data/lib/erc20.rb

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

data/test/erc20/test_wallet.rb

@@ -62,6 +62,7 @@ class TestWallet < Minitest::Test
   def test_fails_with_invalid_infura_key
     w = ERC20::Wallet.new(
       rpc: 'https://mainnet.infura.io/v3/invalid-key-here',
+      wss: 'https://mainnet.infura.io/v3/another-invalid-key-here',
       log: Loog::NULL
     )
     assert_raises(StandardError) { w.balance(STABLE_ADDRESS) }
@@ -113,11 +114,9 @@ class TestWallet < Minitest::Test
       wait_for { !event.nil? }
       daemon.kill
       daemon.join(30)
-      assert_equal(sum, event['data'].to_i(16))
-      from = "0x#{event['topics'][1][26..].downcase}"
-      assert_equal(jeff, from)
-      to = "0x#{event['topics'][2][26..].downcase}"
-      assert_equal(walter, to)
+      assert_equal(sum, event[:amount])
+      assert_equal(jeff, event[:from])
+      assert_equal(walter, event[:to])
     end
   end
 
@@ -128,7 +127,7 @@ class TestWallet < Minitest::Test
     loop do
       sleep(0.1)
       break if yield
-      raise 'timeout' if Time.now - start > 15
+      raise 'timeout' if Time.now - start > 60
     rescue Errno::ECONNREFUSED
       retry
     end
@@ -148,8 +147,8 @@ class TestWallet < Minitest::Test
     [
       "https://mainnet.infura.io/v3/#{env('INFURA_KEY')}",
       "https://go.getblock.io/#{env('GETBLOCK_KEY')}"
-    ].map do |rpc|
-      ERC20::Wallet.new(rpc:, log: Loog::NULL)
+    ].map do |url|
+      ERC20::Wallet.new(rpc: url, wss: url, log: Loog::NULL)
     end.sample
   end
 
@@ -157,8 +156,8 @@ class TestWallet < Minitest::Test
     [
       "https://sepolia.infura.io/v3/#{env('INFURA_KEY')}",
       "https://go.getblock.io/#{env('GETBLOCK_SEPOILA_KEY')}"
-    ].map do |rpc|
-      ERC20::Wallet.new(rpc:, log: Loog::NULL)
+    ].map do |url|
+      ERC20::Wallet.new(rpc: url, wss: url, log: Loog::NULL)
     end.sample
   end
 
@@ -186,8 +185,7 @@ class TestWallet < Minitest::Test
         ).split("\n").last
         wallet = ERC20::Wallet.new(
           contract:, chain: 4242,
-          rpc: "http://localhost:#{port}",
-          wss: "ws://localhost:#{port}",
+          host: 'localhost', port:, path: '/', ssl: false,
           log: Loog::NULL
         )
         yield wallet

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erc20
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -66,20 +66,6 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: tago
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: websocket-client-simple
   requirement: !ruby/object:Gem::Requirement