blockscan

README

Blockscan

---

Chains supported

chain id	network	blockscan
1	ethereum	etherscan
10	optimism	optimism
56	binance	bscscan
128	heco	hecoscan
137	polygon	polygonscan
250	fantom	ftmscan
42161	arbitrum	arbiscan
43114	avalanche	snowtrace

---

New a Scanner

How to get an api key?

// You can use "" as your api key, but not recommanded.
// You may suffer from some unpredictabale errors when requesting data form blockscans.
ethScanner, _ := blockscan.New(chainId.EthereumChainName, "YOUR API KEY")
avaxScanner, _ := blockscan.New(chainId.AvalancheChainName, "YOUR API KEY")
polyScanner, _ := blockscan.New(chainId.PolygonChainName, "YOUR API KEY")
...

---

To see more on etherscan api.

Accounts

1. GetBalance

Return the chain token(eth for ethereum) balance of an address.

2. GetBalances

Return the chain token(eth for ethereum) balances of a list of addresses.

3. GetErc20Transactions

Return the erc20 transactions(up to 10000) of an address between sepecific blocks.

4. GetErc20TransactionsAll

Return all the erc20 transactions(no amount limit) of an address from block 0 till now.

5. GetInternalTransactions

Return the internal transactions(up to 10000) of an address between sepecific blocks.

6. GetInternalTransactionsAll

Return all the internal transactions(no amount limit) of an address from block 0 till now.

7. GetNormalTransactions

Return the normal transactions(up to 10000) of an address between sepecific blocks.

8. GetNormalTransactionsAll

Return all the normal transactions(no amount limit) of an address from block 0 till now.

---

Contracts

1. GetContractAbi

Return the contract abi.

2. GetSourceCode

Return the contract's source code.

3. GetContractName

Return the contract's name.

4. IsVerifiedContract

Return whether the address is a contract.

If the contract is not verified, will still return false.

---

Blocks

1. GetBlockNumberByTimestamp

Return the block number at specific timestamp.

---

Logs

1. GetEvents

Return the events(up to 1000) of a topic0 between sepecific blocks.

2. GetEventsAll

Return all the events(no amount limit) of a topic0 from block 0 till now.

---

Gas

1. GetGasPrice

Return the gas price in wei.

Documentation

Overview

Request info from blockscan.

Example:

// To get the balance of address "0xb31f66aa3c1e785363f0875a1b74e27b85fd66c7"
scanner, err:=blockscan.New("avalanche","")
if err != nil { return err }
res, err := scanner.GetBalance("0xb31f66aa3c1e785363f0875a1b74e27b85fd66c7")
if err != nil { return err }
fmt.Println(res)

Index

• type AbiInput
• type AbiOutput
• type ContractAbi
• type Scanner
  • func New(network string, apiKey string) (*Scanner, error)
  • func (s *Scanner) GetBalance(address any) (*big.Int, error)
  • func (s *Scanner) GetBalances(addresses []string) (map[string]*big.Int, error)
  • func (s *Scanner) GetBlockNumberByTimestamp(timestamp string) (int64, error)
  • func (s *Scanner) GetContractAbi(address any) (ContractAbi, error)
  • func (s *Scanner) GetContractName(address any) (string, error)
  • func (s *Scanner) GetErc20Transactions(address any, startBlock int, endBlock any) ([]erc20Txs, error)
  • func (s *Scanner) GetErc20TransactionsAll(address any) ([]erc20Txs, error)
  • func (s *Scanner) GetEvents(topic0 string, address any, startBlock int, endBlock any) ([]events, error)
  • func (s *Scanner) GetEventsAll(topic0 string, address string) ([]events, error)
  • func (s *Scanner) GetGasPrice() (*big.Int, error)
  • func (s *Scanner) GetInternalTransactions(address any, startBlock int, endBlock any) ([]internalTxs, error)
  • func (s *Scanner) GetInternalTransactionsAll(address any) ([]internalTxs, error)
  • func (s *Scanner) GetNormalTransactions(address any, startBlock int, endBlock any) ([]normalTxs, error)
  • func (s *Scanner) GetNormalTransactionsAll(address any) ([]normalTxs, error)
  • func (s *Scanner) GetSourceCode(address any) (sourceCode, error)
  • func (s *Scanner) IsVerifiedContract(address any) (bool, error)

Examples

• New

Types

type AbiInput

type AbiInput struct {
	InternalType string `json:"internalType"`
	Name         string `json:"name"`
	Type         string `json:"type"`
}

type AbiOutput

type AbiOutput struct {
	InternalType string `json:"internalType"`
	Name         string `json:"name"`
	Type         string `json:"type"`
}

type ContractAbi

type ContractAbi []struct {
	Inputs          []AbiInput  `json:"inputs"`
	StateMutability string      `json:"stateMutability"`
	Type            string      `json:"type"`
	Anonymous       bool        `json:"anonymous"`
	Name            string      `json:"name"`
	Outputs         []AbiOutput `json:"outputs"`
}

type Scanner

type Scanner struct {
	UrlHead string // Url head based on network.
	ApiKey  string // User's api key, length should be 34.
}

func New

func New(network string, apiKey string) (*Scanner, error)

Create a new scanner.

"network" should be the full name of the chain, such as "ethereum", "avalanche", etc.

"apiKey" is the key for blockscan requests. When the key is "", default key will be used. Otherwise, the key length should be 34.

To get an apikey on ethereum, visit https://docs.etherscan.io/getting-started/viewing-api-usage-statistics

Example

// case 1
fmt.Println("\ncase 1:")
scanner, err := New(chainId.AvalancheChainName, "")
if err != nil {
	fmt.Println(err)
} else {
	fmt.Println(*scanner)
}
// case 2, wrong key
fmt.Println("\ncase 2:")
scanner, err = New(chainId.AvalancheChainName, "asaasfas")
if err != nil {
	fmt.Println(err)
} else {
	fmt.Println(*scanner)
}

Output:


case 1:
You do not have a blockscan api key. Unecpected errors may occur when running.
{https://api.snowtrace.io/api? K6SR1G96B2SQBRWPI4JP8WXM6BCG62EPQ7}

case 2:
api key length should be 34

func (*Scanner) GetBalance

func (s *Scanner) GetBalance(address any) (*big.Int, error)

Return the balance of a single address.

func (*Scanner) GetBalances

func (s *Scanner) GetBalances(addresses []string) (map[string]*big.Int, error)

Return balances of up to 20 addresses. map[address] = balance.

func (*Scanner) GetBlockNumberByTimestamp

func (s *Scanner) GetBlockNumberByTimestamp(timestamp string) (int64, error)

Return the block number.

func (*Scanner) GetContractAbi

func (s *Scanner) GetContractAbi(address any) (ContractAbi, error)

Return the contract's abi.

func (*Scanner) GetContractName

func (s *Scanner) GetContractName(address any) (string, error)

Return the contract's name.

func (*Scanner) GetErc20Transactions

func (s *Scanner) GetErc20Transactions(address any, startBlock int, endBlock any) ([]erc20Txs, error)

Return up to 10000 erc20 txs of an address.

func (*Scanner) GetErc20TransactionsAll

func (s *Scanner) GetErc20TransactionsAll(address any) ([]erc20Txs, error)

Return all the erc20 txs of an address.

func (*Scanner) GetEvents

func (s *Scanner) GetEvents(topic0 string, address any, startBlock int, endBlock any) ([]events, error)

Return up to 1000 events of an address.

Param:

topic0:     The topic0 of the event. In most cases means the hash of the function name.
address:    The address. Can be string or common.Address
startBlock: The block to start from.
endBlock:   The block to end. If greater than latest block number, or use "latest", will use the latest block number.

func (*Scanner) GetEventsAll

func (s *Scanner) GetEventsAll(topic0 string, address string) ([]events, error)

Return all the events of an address.

Param:

topic0:     The topic0 of the event. In most cases means the hash of the function name.
address:    The address. Can be string or common.Address

func (*Scanner) GetGasPrice

func (s *Scanner) GetGasPrice() (*big.Int, error)

Return gas price in WEI.

func (*Scanner) GetInternalTransactions

func (s *Scanner) GetInternalTransactions(address any, startBlock int, endBlock any) ([]internalTxs, error)

Return up to 10000 internal txs of an address.

func (*Scanner) GetInternalTransactionsAll

func (s *Scanner) GetInternalTransactionsAll(address any) ([]internalTxs, error)

Return all the internal txs of an address.

func (*Scanner) GetNormalTransactions

func (s *Scanner) GetNormalTransactions(address any, startBlock int, endBlock any) ([]normalTxs, error)

Return up to 10000 txs of an address.

func (*Scanner) GetNormalTransactionsAll

func (s *Scanner) GetNormalTransactionsAll(address any) ([]normalTxs, error)

Return all the txs of an address.

func (*Scanner) GetSourceCode

func (s *Scanner) GetSourceCode(address any) (sourceCode, error)

Return the source code of a contract.

func (*Scanner) IsVerifiedContract

func (s *Scanner) IsVerifiedContract(address any) (bool, error)

Return whether the address is a verified contract.

Some contracts may not be verified, will be considered not contract.