Skip to content

Latest commit

 

History

History
98 lines (66 loc) · 1.39 KB

README.md

File metadata and controls

98 lines (66 loc) · 1.39 KB
Raw

UTXO Parser

Requirement

  1. NodeJS
  2. Bitcoin Full Node + Index
  3. Bitcoin RPC
  4. MongoDB

Setup

Enable -txindex. For example, .bitcoin/bitcoin.conf:

rpcauth=<username>:<hashed_password>
server=1
txindex=1

Set the following

# Set the environment to proper values
$ cp dotenv .env

# Install dependencies
$ npm install

Usage

Perform all commands below from the root directory of the program

Indexer

# Start
$ npm run indexer

# From a specific block height
$ echo 2590 > data/block_n && node bin/index.js

# Re-index
$ rm data/block_n
$ npm run indexer

Repeater

Continue updating cache transactions

# Start
$ npm run repeater

Lookup functions

# Balance
$ node bin/index.js balance <address>

# Transactions
$ node bin/index.js transactions <address>

# Unconfirmed Transactions
$ node bin/index.js unconfirmed_transactions <address>

# Unspents
$ node bin/index.js unspents <address>

# Transaction
$ node bin/index.js transaction <txid>

# Unconfirmed Transaction
$ node bin/index.js unconfirmed_transaction <wtxid>

# Relay Transaction
$ node bin/index.js relay <hex>

# Mempool Information
$ node bin/index.js mempool_info true

# Ord Inscriptions
$ node bin/index.js inscriptions <outpoint>

# Is Ord indexing
$ node bin/index.js indexing

Monitor block progress

# Watch the index
$ watch -n 1 cat data/block_n