This is a go program that connects to aergo server over RPC and synchronizes blockchain metadata with a database. It supports Elasticsearch.
This creates the indices,
chain_infoblocktxcontracteventnametokentoken_transferaccount_tokensaccount_balancenftwhitelist
Check indexer/documents/documents.go for the exact mappings for all supported databases.
When using Elasticsearch, multiple indexing instances can be run concurrently using these two mechanisms (can be used together):
- The indexer creates a time-based lock in ES, excluding other instances writing to the same data set (enabled by default, depending on --prefix).
- When a data conflict occurs upon indexing, the indexer can set itself into an idle mode, assuming that another instance is running (enabled by 5 seconds).
chain_info
Field Type Comment
id string chain magic id
public bool is public chain
mainnet bool is mainnet
consensus string consensus info
version uint64 version info
block
Field Type Comment
id string block hash
ts timestamp block creation timestamp (unixnano)
no uint64 block number
previous_block string previous block hash
txs uint number of transactions
size uint64 block size in bytes
coinbase string coinbase account
block_producer string block producer peer id
reward_account string reward account
reward_amount string reward amount
tx (transactions)
Field Type Comment
id string tx hash
blockno uint64 block number
block_id string block hash
ts timestamp block creation timestamp (unixnano)
tx_idx uint64 tx index within block
payload string tx payload
from string from address (base58check encoded)
to string to address (base58check encoded)
amount string Precise BigInt string representation of amount
amount_float float32 Imprecise float representation of amount, useful for sorting
type uint64 tx type
category string user-friendly category
method string called function name of a contract
status string tx status from receipt (CREATED/SUCCESS/ERROR)
result string tx result from receipt
nonce uint64 receipt nonce
contract string contract address
fee_delegation bool fee delegation transaction
gas_price string tx gas price
gas_limit uint64 tx gas limit
gas_used uint64 receipt gas used
contract
Field Type Comment
id string contract address
tx_id string tx hash
creator string creators address
blockno uint64 block number
ts timestamp last updated timestamp (unixnano)
payload string compiled bytecode
verified_status string verified status
verified_token string verified token address
code string verified contract code
event
Field Type Comment
id string block_number + tx_idx + event_idx
contract string contract address
blockno uint64 block number
tx_id string tx hash
tx_idx uint64 tx idx in block
event_idx uint64 event idx in tx
event_name string name of event
event_args string args of event
name
Field Type Comment
id string name + tx hash
name string name
address string address (base58check encoded)
blockno uint64 block in which name was updated
tx string tx in which name was updated
token
Field Type Comment
id string address of token contract
tx_id string tx hash
blockno uint64 block number
creator string token creation account
type string token type (ARC1/ARC2)
name string token name
name_lower string token name lowercase, useful to case-insensitive search
symbol string token symbol
symbol_lower string token symbol lowercase, useful to case-insensitive search
decimals uint8 decimals of token
supply string Precise BigInt string representation of total supply
supply_float float32 Imprecise float representation of amount, useful for sorting
verified_status string verified status
token_address string address of token
owner string address of token owner
comment string verified token comment
email string email of token owner
regdate string registration date (YYMMDD)
homepage_url string verified token homepage url
image_url string verified token image url
total_transfer uint64 total transfer count about token
token_transfer
Field Type Comment
id string tx hash + index on tx
tx_id string tx hash
ts timestamp block creation timestamp
blockno uint64 block number
address string contract address (base58check encoded)
from string from address (base58check encoded)
to string to address (base58check encoded)
sender string tx sender address (base58check encoded)
amount string Precise BigInt string representation of amount
amount_float float32 Imprecise float representation of amount, useful for sorting
token_id string NFD id (for ARC2)
account_balance
Field Type Comment
id string account address
ts timestamp last updated timestamp (unixnano)
blockno uint64 last updated block number
balance string Precise BigInt string representation of aergo total balance
balance_float float32 Imprecise float representation of aergo total balance, useful for sorting
staking string Precise BigInt string representation of aergo staking
staking_float float32 Imprecise float representation of aergo staking, useful for sorting
account_tokens
Field Type Comment
id string account address + token address
account string account address
address string token address
type string token type (ARC1/ARC2)
ts timestamp last updated timestamp (unixnano)
balance string Precise BigInt string representation of total supply
balance_float float32 Imprecise float representation of amount, useful for sorting
nft
Field Type Comment
id string nft id
address string contract address
token_id string nft id
account string account address
blockno uint64 block number
ts timestamp last updated timestamp (unixnano)
token_uri string token uri
image_url string image url
whitelist
id string token address
contract string contract address
type string whitelist type (token,contract)
Usage:
indexer [flags]
Flags:
Flags:
-A, --aergo string host and port of aergo server. Alternative to setting host and port separately
-W, --balance_whitelist strings whitelist for update account balance
--cccv string indexing cccv nft by network type.(mainnet,testnet)
--check check indices of range of heights (default true)
-C, --cluster elasticsearch cluster type
-c, --contract string address for query contract code
--contract_whitelist stringArray whitelist for update verified contract
-E, --dburl string Database URL (default "localhost:9200")
--from uint start syncing from this block number
-h, --help help for indexer
-H, --host string host address of aergo server (default "localhost")
-M, --mode string indexer running mode(all,check,onsync) Alternative to setting check, onsync separately
--onsync onsync data in indices (default true)
-p, --port int32 port number of aergo server (default 7845)
-P, --prefix string index name prefix (default "testnet")
--to uint stop syncing at this block number
-t, --token string address for query verified token
--token_whitelist stringArray whitelist for update verified token
Example
./bin/indexer -H localhost -p 7845 --dburl http://localhost:9200
You can use the --prefix parameter and multiple instances of this program to sync several blockchains with one database.
Instead of setting host and port of the aergo server separately, you can also pass them at once with -A localhost:7845.
To check (or reindex)
./bin/indexer --check
When reindexing, this creates new indices to sync the blockchain from scratch.
go get github.com/aergoio/aergo-indexer
cd $GOPATH/src/github.com/aergoio/aergo-indexer
make
docker compose -p aergo_indexer up