account-indexer

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #go #golang #android #linux #macos #nodejs #cli #kubernetes #pytorch #open-source

account-indexer

(★ 20)

A go-ethereum companion to index all transactions in Ethereum blockchain

account-indexer Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# account-indexer
A [go-ethereum](https://github.com/ethereum/go-ethereum) companion to index all transactions in Ethereum blockchain. Deploy this inside a geth node and you can get transactions of any accounts after one day.

## REST api
To get transactions of an account, use this Rest
- `http(s)://${server}${port}/api/v1/accounts/:accountNumber?from=${from}&to=${to}&fl=${additional_field_list}`
  - By default, the api should return account address, timestamp, hash and value of transaction
  - fl: additional fields separated by `,` - "data" for transaction data, "gas" for gas, "gasPrice" for gas price
  - from and to: timestamp, should be in unix format or ISO8601 format

## Configuration
+ Admin Rest API is protected by ${INDEXER_USER_NAME} and ${INDEXER_PASSWORD} environment variable
+ Use INDEXER_LOG_LEVEL to define the log level ("info" - default, "warn", "debug" ...)
+ --ipc: either unix socket or wss connection
+ -p: port number for http
+ -h: for the overall configuration

## Development

### High Level Design
![High Level Design](https://github.com/WeTrustPlatform/account-indexer/blob/master/docs/high_level_design.png)

### Technology stack
We use the same technology stack like go-ethereum: golang - LevelDB. For REST, we use gin. We also leverage ethclient package of go-ethereum to connect with an ethereum node through ipc.

### Address database
Given an address, we can get all records with ${address} prefix in key.
${address}${block_time}${sequence}=${tx_hash}${other_address}${blockNumber}${value}
+ Search by address and time range is very performant
+ To handle reorg scenario, get address and block time from block database.

### Batch Status database
This is to track the sync status of batch process. Initially, a batch has "from" as genesis block and "to" as latest block.
A batch can be from the last newHead block in DB to the latest block in block chain
${from}${to}${created_at}=${updated_at}${current_block_number}

### Block database
This is used by the "newHead" subscribe to handle Reorg scenario.
${block_number}=${created_at}${block_time}${address_1}${seq_1}...${address_n}${seq_n}

### Handle Reorg
If an old block comes again, get time and address sequences from block database, delete respective records from address database

### Handle node out of sync
Use a go routine to regularly check for last record of block database amongst current time, created at and block time

### Handle block db
Block db is born for Reorg scenario and we need last block most of the time.
Use a go routine to regularly delete old blocks.

### Handle Restart
+ If there is no batch status database, run from genesis to latest as a batch, track status at each block processed
+ Else if there are any uncompleted batches, run all of them, each in a separate go routine. And run a separate batch from the last newHead block to the latest block in blockchain
+ Start newHead subscription to geth

account-indexer

account-indexer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

account-indexer

account-indexer Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README