Git Product home page Git Product logo

bch-rpc-explorer's Introduction

BCH RPC Explorer

npm version NPM downloads

Simple, database-free Bitcoin Cash 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.

Live demo available at: https://explorer.bitcoinabc.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 and blockchair.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 BCH, but can be adapted easily to other coins.

Prerequisites

  1. Recent version of Docker
  2. 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).
  3. Synchronize your node with the Bitcoin network.

Instructions

On the project base directory:

docker build -t bch-rpc-explorer .
docker run -p 3002:3002 bch-rpc-explorer --bitcoind-user [rpcusername] --bitcoind-pass [rpcpassword]

If have a mainnet node running with the default datadir and port, this should work. Open http://127.0.0.1:3002/ to view the explorer.

Configuration (Advanced)

Configuration options may be passed as environment variables or by creating an env file at ~/.config/bch-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:

docker run bch-rpc-explorer --port 8080 --bitcoind-port 18443 --bitcoind-user [rpcusername] --bitcoind-pass [rpcpassword]

See docker run bch-rpc-explorer --help for the full list of CLI options.

Support

  • bitcoincash:qqeht8vnwag20yv8dvtcrd4ujx09fwxwsqqqw93w88

bch-rpc-explorer's People

Contributors

janoside avatar sickpig avatar majcosta avatar shesek avatar jasonbcox avatar sangaman avatar gandrewstone avatar echterago avatar neptunix avatar fabcien avatar henrikuittinen avatar imgbotapp avatar proteanx avatar oktapodia avatar yamada-guro-baru avatar qshuai avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.