etherscan 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd1daab223f53155af170d28c0762aca7bfa166c863a04f9bc63ce4aaa238f36
-  data.tar.gz: 0be29dadd9daa63af08cf6aa31aad30964062cfd2f70dc93e817588eff72a4a6
+  metadata.gz: 0e12314597d854f9d264641830082a829f3f99f40a49cbfa1283cac848527416
+  data.tar.gz: 825813db2b4c6debd2cf9c96a59ebbe8f5aacf13cdb84f5cbd9ecd85f44fd814
 SHA512:
-  metadata.gz: 9acb8d8e72c16132e98d2c7e4b5444c4cfd5dd3badefd28adab1d1e533010be7607641e3ad10dd99c8770a950b660652eb2e86768db7d26bfda1f6dc9cb5b43a
-  data.tar.gz: f69f8e8ae09066a8cab2b7a5f0d06ba8b090803cec69f1d0d8c280c20f996088547c28ad0b032780dd29e9760f29378900886b3258f5520c5cbf0919e3d4cead
+  metadata.gz: 3ddbff16ed0c4d471b68bdccd621b1bb6c0f7a70209e93aa5d340f131f0f2e194cb58410b8cb2e50106f91f5a8b68ea75e104f1981a4ef49f53ec1d39a627acc
+  data.tar.gz: 368ab98f97fff3c59808fe6433029bc41b2dd59e60fb0776cfc8d8b863c5461bbec194040371ca9b4f584fcdb249b755903bf48163dc1527c5eb74ab6dda5e0d

data/Gemfile

@@ -0,0 +1,5 @@
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in testgem.gemspec
+gemspec

data/README.md

@@ -0,0 +1,15 @@
+# etherscan
+
+Access to the API of etherscan.io and the compatible APIs.
+
+
+## Installation
+
+```bash
+gem 'etherscan', '~> 0.2.0'
+```
+
+```bash
+gem install etherscan
+```
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/etherscan/api.rb

@@ -0,0 +1,191 @@
+module Etherscan
+  class Api
+    def initialize(url, api_key = nil)
+      @url = url
+      @api_key = api_key
+    end
+
+    def request(module_name, action, params = {})
+      params = params.reject { |_k, v| v.nil? } # filter out nil values
+      params_query = params.keys.map { |key| "#{key}=#{params[key]}" }.join('&').strip
+      params_query = if params_query.empty?
+                       ''
+                     else
+                       "&#{params_query}"
+                     end
+
+      api_key_query = @api_key.nil? ? '' : "&apikey=#{@api_key}"
+
+      uri = URI "#{@url}?module=#{module_name}&action=#{action}#{params_query}#{api_key_query}"
+      Etherscan.logger.debug "Req: #{uri}"
+      resp = Net::HTTP.get(uri)
+      Etherscan.logger.debug "Rsp: #{resp}"
+      resp = JSON.parse(resp)
+
+      raise resp['result'] if resp['status'] == '0'
+
+      resp['result']
+    end
+
+    def respond_to_missing?(*_args)
+      true
+    end
+
+    def method_missing(method, *args)
+      module_name, action = method.to_s.split('_')
+      request(module_name, action, args[0])
+    end
+
+    #########################################
+    # Accounts
+    #########################################
+    def account_balance(address:, tag: 'latest')
+      request('account', 'balance', address: address, tag: tag)
+    end
+
+    def account_balancemulti(addresses:, tag: 'latest')
+      if addresses.is_a? Array
+        request('account', 'balancemulti', address: addresses.join(','), tag: tag)
+      elsif addresses.is_a? String
+        request('account', 'balancemulti', address: addresses, tag: tag)
+      else
+        raise 'addresses must be an array or a string'
+      end
+    end
+
+    def account_txlist(address:, startblock: 0, endblock: 999_999_999, sort: 'asc', page: 1, offset: 1000)
+      request('account', 'txlist', address: address,
+                                   startblock: startblock,
+                                   endblock: endblock,
+                                   sort: sort,
+                                   page: page,
+                                   offset: offset)
+    end
+
+    def account_txlistinternal(address: nil,
+                               startblock: 0, endblock: 999_999_999, sort: 'asc', page: 1, offset: 1000)
+      params = {
+        address: address,
+        startblock: startblock, endblock: endblock, sort: sort, page: page, offset: offset
+      }
+      request('account', 'txlistinternal', params)
+    end
+
+    def account_txlistinternal_by_txhash(txhash:)
+      # https://docs.etherscan.io/api-endpoints/accounts#get-internal-transactions-by-transaction-hash
+      request('account', 'txlistinternal', txhash: txhash)
+    end
+
+    def account_tokentx(address:, contractaddress:,
+                        startblock: 0, endblock: 999_999_999, sort: 'asc', page: 1, offset: 1000)
+      params = {
+        address: address, contractaddress: contractaddress,
+        startblock: startblock, endblock: endblock, sort: sort, page: page, offset: offset
+      }
+      request('account', 'tokentx', params)
+    end
+
+    def account_tokennfttx(address:, contractaddress:,
+                           startblock: 0, endblock: 999_999_999, sort: 'asc', page: 1, offset: 1000)
+      params = {
+        address: address, contractaddress: contractaddress,
+        startblock: startblock, endblock: endblock, sort: sort, page: page, offset: offset
+      }
+      request('account', 'tokennfttx', params)
+    end
+
+    #########################################
+    # Contracts
+    #########################################
+    def contract_getabi(address:)
+      request('contract', 'getabi', address: address)
+    end
+
+    def contract_getsourcecode(address:)
+      request('contract', 'getsourcecode', address: address)
+    end
+
+    def contract_getcontractcreation(contractaddresses:)
+      if contractaddresses.is_a? Array
+        request('contract', 'getcontractcreation', contractaddresses: contractaddresses.join(','))
+      elsif contractaddresses.is_a? String
+        request('contract', 'getcontractcreation', contractaddresses: contractaddresses)
+      else
+        raise 'contractaddresses must be an array or a string'
+      end
+    end
+
+    #########################################
+    # Transactions
+    #########################################
+    def transaction_getstatus(txhash:)
+      request('transaction', 'getstatus', txhash: txhash)
+    end
+
+    def transaction_gettxreceiptstatus(txhash:)
+      request('transaction', 'gettxreceiptstatus', txhash: txhash)
+    end
+
+    #########################################
+    # Blocks
+    #########################################
+    def block_getblockreward(blockno:)
+      request('block', 'getblockreward', blockno: blockno)
+    end
+
+    def block_getblockcount(blockno:)
+      request('block', 'getblockcount', blockno: blockno)
+    end
+
+    def block_getblocknobytime(timestamp:, closest: 'before')
+      request('block', 'getblocknobytime', timestamp: timestamp, closest: closest)
+    end
+
+    #########################################
+    # Logs
+    #########################################
+    # fromBlock, toBlock, address
+    # topic0, topic1, topic2, topic3 (32 Bytes per topic)
+    # topic0_1_opr (and|or between topic0 & topic1),
+    # topic1_2_opr (and|or between topic1 & topic2),
+    # topic2_3_opr (and|or between topic2 & topic3),
+    # topic0_2_opr (and|or between topic0 & topic2),
+    # topic0_3_opr (and|or between topic0 & topic3),
+    # topic1_3_opr (and|or between topic1 & topic3)
+    def logs_getLogs(from_block: 0, to_block: 'latest', address: nil,
+                     topic0: nil, topic1: nil, topic2: nil, topic3: nil,
+                     topic0_1_opr: nil, topic1_2_opr: nil, topic2_3_opr: nil,
+                     topic0_2_opr: nil, topic0_3_opr: nil, topic1_3_opr: nil)
+      params = {
+        fromBlock: from_block, toBlock: to_block, address: address,
+        topic0: topic0, topic1: topic1, topic2: topic2, topic3: topic3,
+        topic0_1_opr: topic0_1_opr, topic1_2_opr: topic1_2_opr, topic2_3_opr: topic2_3_opr,
+        topic0_2_opr: topic0_2_opr, topic0_3_opr: topic0_3_opr, topic1_3_opr: topic1_3_opr
+      }
+
+      request('logs', 'getLogs', params)
+    end
+
+    #########################################
+    # Tokens
+    #########################################
+    def stats_tokensupply(contractaddress:)
+      request('stats', 'tokensupply', contractaddress: contractaddress)
+    end
+
+    def account_tokenbalance(contractaddress:, address:, tag: 'latest')
+      request('account', 'tokenbalance', contractaddress: contractaddress, address: address, tag: tag)
+    end
+
+    #########################################
+    # Stats
+    #########################################
+    def stats_ethsupply
+      request('stats', 'ethsupply')
+    end
+
+    def stats_ethprice
+      request('stats', 'ethprice')
+    end
+  end
+end

data/lib/etherscan/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Etherscan
+  VERSION = "0.2.3"
+end

data/lib/etherscan.rb

@@ -0,0 +1,85 @@
+require 'json'
+require 'logger'
+require 'net/http'
+require 'etherscan/api'
+
+require 'active_support'
+require 'active_support/core_ext/string'
+
+module Etherscan
+  # https://chainid.network/chains.json
+  # key is the underscore(short name) of the chain in chains.json
+  # https://blockscan.com/
+  CHAINS = {
+    'eth' => 'http://api.etherscan.io/api',
+    'gor' => 'https://api-goerli.etherscan.io/api',
+    'sep' => 'https://api-sepolia.etherscan.io/api',
+    'arb1' => 'https://api.arbiscan.io/api',
+    'arb_goerli' => 'https://api-goerli.arbiscan.io/api',
+    'arb_sep' => 'https://api-sepolia.arbiscan.io/api',
+    'bnb' => 'https://api.bscscan.com/api',
+    'bnbt' => 'https://api-testnet.bscscan.com/api',
+    'matic' => 'https://api.polygonscan.com/api',
+    'maticmum' => 'https://api-testnet.polygonscan.com/api',
+    'zkevm' => 'https://api-zkevm.polygonscan.com/api',
+    'testnet_zk_evm_mango' => 'https://api-testnet-zkevm.polygonscan.com/api',
+    'ftm' => 'https://api.ftmscan.com/api',
+    'tftm' => 'https://api-testnet.ftmscan.com/api',
+    'oeth' => 'https://api-optimistic.etherscan.io/api',
+    'mbeam' => 'https://api-moonbeam.moonscan.io/api',
+    'mriver' => 'https://api-moonriver.moonscan.io/api',
+    'mbase' => 'https://api-moonbase.moonscan.io/api',
+    'cronos' => 'https://api.cronoscan.com/api',
+    'btt' => 'https://api.bttcscan.com/api',
+    'tbtt' => 'https://api-testnet.bttcscan.com/api',
+    'gnosis' => 'https://api.gnosisscan.io/api',
+    'arb_nova' => 'https://api-nova.arbiscan.io/api',
+    # 'celo' => 'https://api.celoscan.io',
+    # 'alfa' => 'https://api-alfajores.celoscan.io',
+    'linea' => 'https://api.lineascan.build/api',
+    'linea_testnet' => 'https://api-testnet.lineascan.build/api',
+    'base' => 'https://api.basescan.org/api',
+    'basegor' => 'https://api-goerli.basescan.org/api',
+    'wemix' => 'https://api.wemixscan.com/api',
+    'scr' => 'https://api.scrollscan.com/api',
+    'scr_sepolia' => 'https://api-sepolia.scrollscan.com/api',
+    'obnb' => 'https://api-opbnb.bscscan.com/api'
+  }
+
+  class << self
+    attr_accessor :logger
+
+    def api(chain_short_name, api_key = nil)
+      url = CHAINS[chain_short_name]
+      url = CHAINS[chain_short_name.underscore] if url.nil?
+      raise "Chain `#{chain_short_name}` is not supported. Only #{CHAINS.keys} are supported." if url.nil?
+
+      Etherscan::Api.new(url, api_key)
+    end
+
+    # for example: Etherscan.eth('your_api_key')
+    # just a wrap of Etherscan.api('eth', 'your_api_key')
+    def method_missing(method, *args)
+      chain_short_name = method.to_s.downcase
+      api_key = args[0]
+
+      api(chain_short_name, api_key)
+    end
+
+    def respond_to_missing?(*_args)
+      true
+    end
+
+    def test_all
+      CHAINS.reverse_each do |chain_short_name, url|
+        api = Etherscan::Api.new(url)
+        address = '0x0000000000000000000000000000000000000000'
+        balance = api.account_balance(address: address)
+        puts "#{chain_short_name} 0x0 balance: #{balance}"
+      end
+    end
+  end
+end
+
+Etherscan.logger = Logger.new($stdout)
+Etherscan.logger.level = Logger::INFO

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: etherscan
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Aki Wu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-03 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,11 +30,18 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/etherscan.rb
+- lib/etherscan/api.rb
+- lib/etherscan/version.rb
 homepage: https://github.com/wuminzhe/etherscan
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/wuminzhe/etherscan
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -43,7 +50,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="