Skip to content

mjmacleod/nlg-rpc-explorer

master
Switch branches/tags
Code
This branch is 12 commits ahead, 757 commits behind janoside:master.
Contribute

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
app
 
 
bin
 
 
 
 
 
 
raw
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

BTC RPC Explorer

[![npm version][npm-ver-img]][npm-ver-url] [![NPM downloads][npm-dl-img]][npm-dl-url]

Simple, database-free Bitcoin blockchain explorer, via RPC. Built with Node.js, express, bootstrap-v4.

This tool is intended to be a simple, self-hosted explorer for the Bitcoin blockchain, driven by RPC calls to your own bitcoind node. This tool is easy to run but currently lacks features compared to database-backed explorers.

Whatever reasons one might have for running a full node (trustlessness, technical curiosity, supporting the network, etc) it's helpful to appreciate the "fullness" of your node. With this explorer, you can not only explore the blockchain (in the traditional sense of the term "explorer"), but also explore the functional capabilities of your own node.

Live demo available at: https://explorer.btc21.org

Features

  • Network Summary "dashboard"
  • View details of blocks, transactions, and addresses
  • Analysis tools for viewing stats on blocks, transactions, and miner activity
  • View JSON content used to generate most pages
  • Search by transaction ID, block hash/height, and address
  • Optional transaction history for addresses by querying from ElectrumX, blockchain.com, blockchair.com, or blockcypher.com
  • Mempool summary, with fee, size, and age breakdowns
  • RPC command browser and terminal

Changelog / Release notes

See CHANGELOG.md.

Getting started

The below instructions are geared toward BTC, but can be adapted easily to other coins.

Prerequisites

  1. Install and run a full, archiving node - instructions. Ensure that your bitcoin node has full transaction indexing enabled (txindex=1) and the RPC server enabled (server=1).
  2. Synchronize your node with the Bitcoin network.
  3. "Recent" version of Node.js (8+ recommended).

Instructions

npm install -g nlg-rpc-explorer
nlg-rpc-explorer

If you're running on mainnet with the default datadir and port, this Should Just Work. Open http://127.0.0.1:3002/ to view the explorer.

You may set configuration options in a .env file or using CLI args. See configuration for details.

Configuration

Configuration options may be passed as environment variables or by creating an env file at ~/.config/nlg-rpc-explorer.env or at .env in the working directory. See .env-sample for a list of the options and details for formatting .env.

BTCEXP_PORT=8080 BTCEXP_BITCOIND_PORT=9232 BTCEXP_BITCOIND_USER=gulden BTCEXP_BITCOIND_PASS=password npm start

You may also pass options as CLI arguments, for example:

nlg-rpc-explorer --port 8080 --bitcoind-port 18443 --bitcoind-cookie ~/.bitcoin/regtest/.cookie

See nlg-rpc-explorer --help for the full list of CLI options.

Run via Docker

  1. docker build -t nlg-rpc-explorer .
  2. docker run -p 3002:3002 -it nlg-rpc-explorer

Support

About

Database-free, self-hosted Bitcoin explorer, via RPC. Built with Node.js, express, bootstrap-v4.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 59.3%
  • Pug 39.4%
  • CSS 1.3%