etherscan-lite 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b41ed7587e1e595ba013221b1e55534f1aa7cecd068b381ee9319b933b0e2efe
-  data.tar.gz: 9d3ca86dea606bb1b00690e227f382d64e0d59d7eead1be4904701b54b253aa3
+  metadata.gz: edbdb29fdae2d064fbf9d6513b2747ecba5058ef8449d3e430c67be2a2aaa4da
+  data.tar.gz: febad888db3cf78c34e78f46ff09bea7555f2ad0ba030b6146172f5fab03e23d
 SHA512:
-  metadata.gz: 3031b621d4d99ec39b6c73e45b5e714fe255b3dc54c621caec209d7f1ef47d7e8e2ecb60a774a90833c2480fa3d7adf69b80fa039091669f8677495e0b20848f
-  data.tar.gz: '0657688b69115499b4c099efd6e8634b0a103a7b5cd6fdfc78b31b9175e66d05704f634b633f2620db1cf5ac3b51eb12311ea072d9d65799bb927e8e6c2f2dc5'
+  metadata.gz: 8a545c314b42eb7ed7531e79aac0b3a3d495cb3557fcd4f204421154f7b4a1742064552628045af78ff68573e69a44b4ba1e790461507ce26eed2b25990795f4
+  data.tar.gz: 5e66dd8e43960e491b0b2746a38dfeee2a37d6d1b5dfe5c62e1e1d9dd717f752c3973bbf1da4121ae4c7c58f8c87185f565e4ff45b259c0324c18f71383c4ec8

data/Manifest.txt

@@ -5,4 +5,7 @@ Rakefile
 lib/etherscan-lite.rb
 lib/etherscan-lite/account.rb
 lib/etherscan-lite/base.rb
+lib/etherscan-lite/contract.rb
+lib/etherscan-lite/misc.rb
+lib/etherscan-lite/proxy.rb
 lib/etherscan-lite/version.rb

data/lib/etherscan-lite/base.rb

@@ -2,36 +2,19 @@ module Etherscan
   BASE = 'https://api.etherscan.io/api'
 
 
-
-
   def self.call( src )   ## get response as (parsed) json (hash table)
-    uri = URI.parse( src )
-
-    http = Net::HTTP.new( uri.host, uri.port )
-
-    puts "[debug] GET #{uri.request_uri} uri=#{uri}"
 
     headers = {
       # 'User-Agent' => "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36",
       'User-Agent' => "ruby v#{RUBY_VERSION}",
      }
 
+    response = Webclient.get( src, headers: headers )
 
-    request = Net::HTTP::Get.new( uri.request_uri, headers )
-    if uri.instance_of? URI::HTTPS
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-    end
-
-    response   = http.request( request )
-
-    if response.code == '200'
-      puts "#{response.code} #{response.message} -  content_type: #{response.content_type}, content_length: #{response.content_length}"
+    if response.status.ok?
+      puts "#{response.status.code} #{response.status.message} -  content_type: #{response.content_type}, content_length: #{response.content_length}"
 
-      text = response.body.to_s
-      text = text.force_encoding( Encoding::UTF_8 )
-
-      data = JSON.parse( text )
+      data = response.json
 
       ## note:  "unwrap" result - and auto-check status/message e.g.
       ##   {"status"=>"1",
@@ -46,19 +29,65 @@ module Etherscan
       ##   "result":"Max rate limit reached, please use API Key for higher rate limit"
       ## }
 
-      if data['status'] == '1' && data['message'] == 'OK'
-         ## puts "#{data['status']} #{data['message']}"
-         data['result']
+      ##
+      #  note: add special error handling case for no transaction found!!
+      # ==> [8] query 0x01c59869B44F3Fc5420dbB9166a735CdC020E9Ae...
+      # [debug] GET /api?module=account&action=txlist&address=...
+      # 200 OK -  content_type: application/json, content_length: 172
+      # !! ETHERSCAN API ERROR:
+      # 0 No transactions found - []
+
+      if data['status'] == '0' && data['message'] == 'No transactions found' && data['result'].empty?
+        data['result']
+      elsif data['status'] == '1' && data['message'] == 'OK'
+        ## puts "#{data['status']} #{data['message']}"
+        data['result']
       else
         puts "!! ETHERSCAN API ERROR:"
         puts "#{data['status']} #{data['message']} - #{data['result']}"
         exit 1
       end
     else
-      puts "!! ERROR:"
-      puts "#{response.code} #{response.message}"
+      puts "!! HTTP ERROR:"
+      puts "#{response.status.code} #{response.status.message}"
       exit 1
     end
   end
 
+
+  def self.proxy_call( src )   ## get response as (parsed) json (hash table)
+
+    headers = {
+      # 'User-Agent' => "Mozilla/5.0 (Windows NT 10.0; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/100.0.4896.127 Safari/537.36",
+      'User-Agent' => "ruby v#{RUBY_VERSION}",
+     }
+
+    response = Webclient.get( src, headers: headers )
+
+    if response.status.ok?
+      puts "#{response.status.code} #{response.status.message} -  content_type: #{response.content_type}, content_length: #{response.content_length}"
+
+    ### check for {"jsonrpc"=>"2.0",
+    ##  "id"=>1,
+    ##   "result"=> ... }
+      data = response.json
+      ## pp data
+
+      if data['result']
+        data['result']
+      elsif data['error']
+        puts "!! ETHERSCAN API (PROXY JSON-RPC) ERROR:"
+        puts "#{data['error']}"
+        exit 1
+      else
+        puts "!! ETHERSCAN API (PROXY JSON-RPC) ERROR:"
+        puts "  No response on request"
+        exit 1
+      end
+    else
+      puts "!! HTTP ERROR:"
+      puts "#{response.status.code} #{response.status.message}"
+      exit 1
+    end
+  end
 end   # module Etherscan

data/lib/etherscan-lite/contract.rb

@@ -0,0 +1,21 @@
+module Etherscan
+
+
+  ###
+  ## Get Contract Creator and Creation Tx Hash
+  ##   Returns a contract's deployer address and transaction hash
+  ## it was created, up to 5 at a time.
+  ##   see https://docs.etherscan.io/api-endpoints/contracts#get-contract-creator-and-creation-tx-hash
+  def self.getcontractcreation_url( contractaddresses: )
+    src = "#{BASE}?module=contract&action=getcontractcreation" +
+            "&contractaddresses=#{contractaddresses.join(',')}" +
+            "&apikey=#{config.key}"
+    src
+  end
+
+  def self.getcontractcreation( **kwargs )
+    call( getcontractcreation_url( **kwargs ) )
+  end
+
+
+end  # module Etherscan

data/lib/etherscan-lite/misc.rb

@@ -0,0 +1,48 @@
+
+module Etherscan
+
+
+###############
+#  all-in-one helper for getting contract details
+#    note: requires (collects data via) three api calls
+
+def self.getcontractdetails( contractaddress: )
+
+  delay_in_s = 0.5
+  puts "   sleeping #{delay_in_s} sec(s)..."
+  sleep( delay_in_s )
+  data = getcontractcreation( contractaddresses: [contractaddress] )
+  ## pp data
+
+  # [{"contractAddress"=>"0x16f5a35647d6f03d5d3da7b35409d65ba03af3b2",
+  #   "contractCreator"=>"0xc352b534e8b987e036a93539fd6897f53488e56a",
+  #   "txHash"=>"0xc82aa34310c310463eb9fe7835471f7317ac4b5008034a78c93b2a8a237be228"}]
+
+  ## reuse hash from repsone - why? why not?
+  details = data[0]
+
+  puts "   sleeping #{delay_in_s} sec(s)..."
+  sleep( delay_in_s )
+  data2 = gettransactionbyhash( txhash: details['txHash'] )
+  ## puts
+  ## pp data2
+  #  {"blockHash"=>"0x07f9b4846ee2702da8d18b9eeead15912d977acc8886ab9bf5d760914cb37670",
+  #  "blockNumber"=>"0x3f17d2",
+  # "from"=>"0xa97f8ffc8f8e354475880448334e4e99a0e7212f",
+  #  "gas"=>"0x2c51d3",
+  # "gasPrice"=>"0x53c53dc33",
+  # "hash"=>"0x79d48c41b99f0ac8f735dbf4d048165542576862df2b05a80be9a4dbe233a623",
+  details['blockNumber']  = data2['blockNumber']
+
+  puts "   sleeping #{delay_in_s} sec(s)..."
+  sleep( delay_in_s )
+  data3 = getblockbynumber( blocknumber: data2['blockNumber'] )
+  ## puts
+  ## pp data3
+
+  details['timestamp'] = data3['timestamp']
+  details
+end
+
+
+end  # module Etherscan

data/lib/etherscan-lite/proxy.rb

@@ -0,0 +1,46 @@
+
+module Etherscan
+
+
+
+  ###
+  ##  eth_getTransactionByHash
+  ##    Returns the information about a transaction requested
+  ## by transaction hash.
+  ##   see https://docs.etherscan.io/api-endpoints/geth-parity-proxy#eth_gettransactionbyhash
+
+  def self.gettransactionbyhash_url( txhash: )
+    src = "#{BASE}?module=proxy&action=eth_getTransactionByHash" +
+          "&txhash=#{txhash}" +
+          "&apikey=#{config.key}"
+    src
+  end
+
+  def self.gettransactionbyhash( **kwargs )
+    ## note: requires proxy_call!!! - different return / response format in json!!
+    proxy_call( gettransactionbyhash_url( **kwargs ) )
+  end
+
+  #####
+  ##  eth_getBlockByNumber
+  ##    Returns information about a block by block number.
+  ##      see https://docs.etherscan.io/api-endpoints/geth-parity-proxy#eth_getblockbynumber
+  ##
+  ##  the boolean value to show full transaction objects.
+  ##     when true, returns full transaction objects and their information,
+  ##     when false only returns a list of transactions.
+  def self.getblockbynumber_url( blocknumber:, transactions: false )
+    src = "#{BASE}?module=proxy&action=eth_getBlockByNumber" +
+           "&tag=#{blocknumber}" +    ## note - must be a hexstring !!! e.g. 0x10d4f
+           "&boolean=#{transactions}" +   ## " note:must be true or false
+           "&apikey=#{config.key}"
+    src
+  end
+
+  def self.getblockbynumber( **kwargs )
+    ## note: requires proxy_call!!! - different return / response format in json!!
+    proxy_call( getblockbynumber_url( **kwargs ) )
+  end
+
+
+end   # module Etherscan

data/lib/etherscan-lite/version.rb

@@ -3,7 +3,7 @@
 module EtherscanLite
   MAJOR = 0
   MINOR = 1
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/etherscan-lite.rb

@@ -46,6 +46,9 @@ module Etherscan
 
 require_relative 'etherscan-lite/base'
 require_relative 'etherscan-lite/account'
+require_relative 'etherscan-lite/contract'
+require_relative 'etherscan-lite/proxy'
+require_relative 'etherscan-lite/misc'
 
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etherscan-lite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-15 00:00:00.000000000 Z
+date: 2022-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos
@@ -75,6 +75,9 @@ files:
 - lib/etherscan-lite.rb
 - lib/etherscan-lite/account.rb
 - lib/etherscan-lite/base.rb
+- lib/etherscan-lite/contract.rb
+- lib/etherscan-lite/misc.rb
+- lib/etherscan-lite/proxy.rb
 - lib/etherscan-lite/version.rb
 homepage: https://github.com/rubycocos/blockchain
 licenses: