A high-performance, highly compatible EVM Inscriptions Indexer by Rust.
An accessible and complete version of the documentation is available at insdexer.gitbook.io.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
at your option.
1.75
Disclaimer: this software is currently a tech preview. We will do our best to keep it stable and make no breaking changes but we don't guarantee anything. Things can and will break.
-
CPU: 4-core (or 2-core hyperthreaded).
-
RAM: >=16GB, 64-bit architecture.
-
Storage: > 500Gb. SSD or NVMe. Do not recommend HDD. Bear in mind that SSD performance deteriorates when close to capacity.
Example: for ethereum inscriptions on sepolia network
./insdexer --web3-provider=https://rpc.sepolia.org --start-block=5000000 --start-block-mint=5000000./insdexer -h
Usage: insdexer [OPTIONS] --web3-provider <WEB3_PROVIDER> --start-block <START_BLOCK> --start-block-mint <START_BLOCK_MINT>
Options:
--tick-max-len <TICK_MAX_LEN>
The maximum length of tick [env: TICK_MAX_LEN=] [default: 32]
--worker-count <WORKER_COUNT>
The number of workers for sync blocks data [env: WORKER_COUNT=1] [default: 1]
--confirm-block <CONFIRM_BLOCK>
The number of confirm block, when inscribe a new block data [env: CONFIRM_BLOCK=1] [default: 1]
--chain-id <CHAIN_ID>
The chain id of the network [env: CHAIN_ID=1] [default: 1]
--web3-provider <WEB3_PROVIDER>
The web3 provider url [env: WEB3_PROVIDER=https://rpc.sepolia.org]
--start-block <START_BLOCK>
The start block number for sync and inscribe [env: START_BLOCK=5000000]
--start-block-mint <START_BLOCK_MINT>
The start block number for sync and token mint [env: START_BLOCK_MINT=5000000]
--reindex
Reindex the block data [env: REINDEX=]
--worker-buffer-length <WORKER_BUFFER_LENGTH>
The length of worker sync buffer [env: WORKER_BUFFER_LENGTH=100] [default: 64]
--db-path <DB_PATH>
The path of database [env: DB_PATH=./data] [default: ./data]
--token-protocol <TOKEN_PROTOCOL>
The token protocol [env: TOKEN_PROTOCOL=erc-20] [default: erc-20]
--http-bind <HTTP_BIND>
The rpc http bind address [env: HTTP_BIND=0.0.0.0] [default: 127.0.0.1]
--http-port <HTTP_PORT>
The rpc http port [env: HTTP_PORT=8888] [default: 8711]
--api-only
Run in api only mode [env: API_ONLY=]
--open-files-limit <OPEN_FILES_LIMIT>
The open files limit [env: OPEN_FILES_LIMIT=1024000] [default: 10240]
--market-address-list <MARKET_ADDRESS_LIST>
The market address list [default: []]
-h, --help
Print help
-V, --version
Print versionlog4rs.yaml
refresh_rate: 30 seconds
appenders:
stdout:
kind: console
encoder:
pattern: "{d} {l} {m}{n}"
file:
kind: file
path: "logs/insdexer.log"
encoder:
pattern: "{d} {l} {m}{n}"
root:
level: info
appenders:
- stdout
- fileFor developers, just set token-protocol and modify marketplace module, a new inscriptions indexer born.
Flat KV storage. Insdexer use RocksDB (a key-value database) and storage in a simple way.
Transaction Inscribe. Insdexer utilize transactions to batch process block data, aiming for high performance and consistency.
It has a Log-Structured-Merge-Database (LSM) design with flexible tradeoffs between Write-Amplification-Factor (WAF), Read-Amplification-Factor (RAF) and Space-Amplification-Factor (SAF). It has multi-threaded compactions, making it especially suitable for storing multiple terabytes of data in a single database.
Insdexer separate block syncing and inscribe. It use multi-threading for block data synchronization. For first syncing, you can adjust the number of threads and working buffer according to machine configuration and bandwidth. After reaching the latest block, adjustments to settings can be made.