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.
309 Commits
4 Branches
15 Tags
9.0 MiB
 
 
 
Tree: e70dedfd97
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e70dedfd97'
${ noResults }
Dan Janosik e70dedfd97
minor cleanup 		7 years ago
app remove old utils.formatBytes and replace with new, flexible utils.formatLargeNumber 7 years ago
bin display exchange-rate values (currently from coinmarketcap, but easy to configure to use other sources) next to primary currency values 7 years ago
docs Update Server-Setup.md 7 years ago
public style tweaks for summary tables on block/tx pages 7 years ago
routes minor cleanup 7 years ago
views fix some page titles and other minor cleanup 7 years ago
.gitignore pre-compile less to css for performance 7 years ago
Dockerfile Fix #37 7 years ago
LICENSE copyright 2017->2018 7 years ago
README.md pre-compile less to css for performance 7 years ago
app.js minor reorganization 7 years ago
package.json pre-compile less to css for performance 7 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.

I built this tool because I wanted to use it myself. 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 demos are available at:

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 supports transactions, blocks, addresses (including bech32)
  • Mempool summary, with fee, size, and age breakdowns
  • RPC command browser and terminal
  • Currently supports BTC, LTC (support for any Bitcoin-RPC-protocol-compliant coin can be added easily)

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 node has full transaction indexing enabled (txindex=1) and the RPC server enabled (server=1).
  2. Synchronize your node with the Bitcoin network.

Instructions

  1. Clone this repo
  2. npm install
  3. npm run build
  4. Edit the "rpc" settings in credentials.js to target your node
  5. Optional: Change the "coin" value in config.js. Currently supported values are "BTC" and "LTC".
  6. Optional: Add an ipstack.com API access key to credentials.js. Doing so will add a map to the /peers page.
  7. npm start to start the local server
  8. Visit http://127.0.0.1:3002/

Run via Docker

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

Screenshots

Homepage (list of recent blocks)

Node Details

Transaction Details

Browse Blocks

Block Details

Mempool Summary

Transaction, Raw JSON

RPC Browser

Connect via RPC

Donate

To support continued development of this tool and/or to support the hosting of the live demo site:

  • Bitcoin: 3NPGpNyLLmVKCEcuipBs7G4KpQJoJXjDGe
  • Litecoin: ME4pXiXuWfEi1ANBDo9irUJVcZBhsTx14i