Skip to content
This repository has been archived by the owner on Jul 19, 2024. It is now read-only.

Latest commit

 

History

History
28 lines (20 loc) · 1.49 KB

README.md

File metadata and controls

28 lines (20 loc) · 1.49 KB
Raw

indexd

build status Version

An external bitcoind index management service.

Indexes

By default, this module maintains script, spents, transaction block, txout and block indexes. The module uses getblockheader, getblockhash, getblock and getbestblockhash RPC methods for blockchain synchronization; and getrawmempool for mempool synchronization.

-txindex is not required for this module; but is still useful for individual transaction lookup (aka txHex). See bitcoinjs#6 if you think an independent transaction index should be added.

Usage

Assumes yajrpc is used for the bitcoind RPC; and leveldown for the database. See the example for usage.

Example

The example/ is a functioning express REST HTTP API server.

  • Requires a running bitcoind node
    • with -txindex, and
    • ZMQ (-zmqpubhashtx=tcp://127.0.0.1:30001 -zmqpubhashblock=tcp://127.0.0.1:30001)
  • Assumes --testnet ports/configuration, see example/.env for configuration.
  • Change -rpcworkqueue from 16 to 32 for increased throughput [in some scenarios]

License ISC