1.0.3 • Published 4 years ago

sum-rpc-explorer v1.0.3

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

SUM RPC Explorer

npm version NPM downloads

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

This tool is intended to be a simple, self-hosted explorer for the Sumcoin blockchain, driven by RPC calls to your own sumcoind 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

Changelog / Release notes

See CHANGELOG.md.

Getting started

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

Prerequisites

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

Setup of https://sum-explorer.com on Ubuntu 16.04

apt update
apt upgrade
apt install git python-software-properties software-properties-common nginx gcc g++ make
curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash
nvm install 10.14.1 ## LTS release of NodeJS as of 2018-11-29, via https://nodejs.org/en/
npm install pm2 --global
add-apt-repository ppa:certbot/certbot
apt update
apt upgrade
apt install python-certbot-nginx

Copy content from ./sum-explorer.com.conf into /etc/nginx/sites-available/sum-explorer.com.conf

certbot --nginx -d sum-explorer.com
cd /etc/ssl/certs
openssl dhparam -out dhparam.pem 4096
cd /home/sumcoin
git clone https://github.com/sumcoinlabs/sum-rpc-explorer.git
cd /home/sumcoin/sum-rpc-explorer
npm install
npm run build
pm2 start bin/www --name "sum-rpc-explorer"

Instructions

npm install -g sum-rpc-explorer
sum-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/sum-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:

sum-rpc-explorer --port 8080 --sumcoind-port 18443 --sumcoind-cookie ~/.sumcoin/regtest/.cookie

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

Run via Docker

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

Support