Dan Janosik 2ac2a54a53 frontend improvements related to error handling		5 years ago
.github/ISSUE_TEMPLATE	request config file content	5 years ago
app	Separate max supply value per network...	5 years ago
bin	Optional querying of utxo set:	5 years ago
docs	More misc improvements, prepping for 2.0:	5 years ago
public	frontend improvements related to error handling	5 years ago
raw	Versioning for misc/support assets	5 years ago
routes	Making testnet demo site more prominent	5 years ago
views	frontend improvements related to error handling	5 years ago
.env-sample	Working toward medium-size update v1.2.0:	5 years ago
.gitattributes	for LF line endings for CSS/JS files, WIP #103	6 years ago
.gitignore	Check public/css/radial-progress.css into git (refs #93)	6 years ago
CHANGELOG.md	correct my optimistic release date	5 years ago
Dockerfile	Use Docker multistage build to reduce image size	5 years ago
LICENSE	copyright	5 years ago
README.md	More misc improvements, prepping for 2.0:	5 years ago
app.js	frontend improvements related to error handling	5 years ago
npm-shrinkwrap.json	2.0.0	5 years ago
package.json	2.0.0	5 years ago
roadmap.md	Misc UX improvements and cleanup/consistency fixes:	5 years ago

README.md

BTC RPC Explorer

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

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).
Synchronize your node with the Bitcoin network.
"Recent" version of Node.js (8+ recommended).

Instructions

npm install -g btc-rpc-explorer
btc-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/btc-rpc-explorer.env or at .env in the working directory. See .env-sample for a list of the options and details for formatting .env.

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

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

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

Run via Docker

docker build -t btc-rpc-explorer .
docker run -p 3002:3002 -it btc-rpc-explorer

Support

https://donate.btc21.org