lukechilds
/
btc-rpc-explorer
mirror of https://github.com/lukechilds/btc-rpc-explorer.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
646 Commits
4 Branches
15 Tags
9.0 MiB
 
 
 
Tree: e57f14a043
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e57f14a043'
${ noResults }
Dan Janosik e57f14a043
- clarify use/naming for global rpc client 		5 years ago
.github/ISSUE_TEMPLATE request config file content 5 years ago
app - clarify use/naming for global rpc client 5 years ago
bin print version/commit info at startup 5 years ago
docs use nvm for node version mgmt 6 years ago
public updated lnd-admin logo 6 years ago
routes - clarify use/naming for global rpc client 5 years ago
views - clarify use/naming for global rpc client 5 years ago
.env-sample denote default values 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
Dockerfile Use Docker multistage build to reduce image size 5 years ago
LICENSE copyright 2017->2018 7 years ago
README.md btc only 5 years ago
app.js - clarify use/naming for global rpc client 5 years ago
npm-shrinkwrap.json 1.1.1 5 years ago
package.json 1.1.1 5 years ago

README.md

BTC RPC Explorer

npm version NPM downloads

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://btc-explorer.com

Features

  • Browse blocks
  • View block details
  • View transaction details, with navigation "backward" via spent transaction outputs
  • 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

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 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

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

Support

  • 3NPGpNyLLmVKCEcuipBs7G4KpQJoJXjDGe