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.
454 Commits
4 Branches
15 Tags
9.0 MiB
 
 
 
Tree: 48b289a4ec
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '48b289a4ec'
${ noResults }
Dan Janosik 48b289a4ec
Merge branch 'shesek-no-git' 		6 years ago
.github/ISSUE_TEMPLATE Update issue templates 6 years ago
app bugfix: Filter empty Electrum servers 6 years ago
bin New configuration options: BTCEXP_RPC_ALLOWALL and BTCEXP_RPC_BLACKLIST 6 years ago
docs use nvm for node version mgmt 6 years ago
public styling tweaks for dark theme, fixes #70 6 years ago
routes formatting 6 years ago
views Get sourcecodeVersion and sourcecodeDate only when .git is available 6 years ago
.env-sample documentation/logging improvements for rpc cookie usage 6 years ago
.gitignore more config related cleanup: 6 years ago
Dockerfile Fix #37 6 years ago
LICENSE copyright 2017->2018 7 years ago
README.md minor follow-ups to shesek's excellent changes: 6 years ago
app.js Get sourcecodeVersion and sourcecodeDate only when .git is available 6 years ago
package-lock.json minor follow-ups to shesek's excellent changes: 6 years ago
package.json Implement CSRF protection 6 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
  • Optional transaction history for addresses by querying configurable ElectrumX servers
  • 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 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

  1. Clone this repo: git clone https://github.com/janoside/btc-rpc-explorer
  2. npm install
  3. npm run build
  4. Configure via environment variables or .env file. See configuration.
  5. npm start
  6. Open http://127.0.0.1:3002/

Configuration

Configuration options may be passed as environment variables or by creating a .env file in the root directory. See .env-sample for a list of the options and details for formatting .env.

Run via Docker

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

Donate

Any support for continued development of this tool is appreciated!

  • Bitcoin: 3NPGpNyLLmVKCEcuipBs7G4KpQJoJXjDGe

Bitcoin Donation QR Code

  • Litecoin: ME4pXiXuWfEi1ANBDo9irUJVcZBhsTx14i

Litecoin Donation QR Code