kaspanet/kaspa-rest-server repository overview

⁠Docker images of Kaspa Rest Server

Built from https://github.com/kaspa-ng/kaspa-rest-server⁠⁠
Release versions on GitHub, will have corresponding image versions pushed here.
You can use latest or lock to a specific release version e.g. v1.5.0.

⁠Getting started

The kaspa-rest-server is designed to be used together with the simply-kaspa-indexer, postgres and rusty-kaspad.
A complete configuration example is available here: https://hub.docker.com/r/supertypo/simply-kaspa-indexer⁠

⁠Supported environment variables

• KASPAD_WRPC_URL - ws(s)://host:port (wrpc) to a kaspa node, use 'resolver' to use the Kaspa PNN. (default: none)
• KASPAD_HOST1 - host:port (grpc) to a kaspa node, multiple nodes is supported. (default: none)
• SQL_URI - uri to a postgres db (default: postgresql+asyncpg://127.0.0.1:5432)
• SQL_URI_BLOCKS - uri to a postgres db to query for blocks, block_parent and blocks_transactions (default: SQL_URI)
• HEALTH_TOLERANCE_DOWN - How many seconds behind kaspad the db can be before /info/health reports DOWN (default: 300)
• NETWORK_TYPE - mainnet/testnet/simnet/devnet (default: mainnet)
• BPS - Blocks per second, affects block difficulty/hashrate calculation (default: 10)
• DISABLE_PRICE - If true /info/price and /info/market-data is disabled (default: false)
• USE_SCRIPT_FOR_ADDRESS - If true scripts_transactions will be used for address to tx, see indexer doc (default: false)
• PREV_OUT_RESOLVED - If true tx inputs are assumed populated with sender address, see indexer doc (default: false)
• TX_COUNT_LIMIT - adjust the maximum tx count returned by /addresses/{kaspaAddress}/transactions-count (default: 100k)
• TX_SEARCH_ID_LIMIT - adjust the maximum number of transactionIds for transactions/search (default: 1000)
• TX_SEARCH_BS_LIMIT - adjust the maximum blue score range for transactions/search (default: 100)
• VSPC_REQUEST - If true enables /info/get-vscp-from-block (default: false)
• HASHRATE_HISTORY - If true populates hashrate_history table and enables /info/hashrate/history (default: false)
• DEBUG - Enables additional logging (default: false)