/regtest-stack

Primary LanguageJavaScript

Regtest Stack

This repository contains dockerfiles and a docker-compose configuration to run the following:

  • Bitcoin SV in regtest mode
  • What's On Chain
  • A custom web dashboard for controlling the mining operations of the Bitcoin SV node

Getting Started

  1. Clone this repository
  2. Check and modify docker-compose.yaml to set the desired SV Node version (services/sv/args/VERSION element). Also check the sv/build script if you manually build just that image
  3. docker-compose up -d
  4. docker container exec node1 [RPC command]

To list the available RPC commands, run:

bitcoin-cli help

The following services are available:

SV Node RPC

Host: localhost Port: 8332 User: rpc Pass: rpc

SV Node P2P

Host: localhost Port: 8333

SV Node ZeroMQ

Host: localhost Port: 28332

MinerId

Host: localhost Port: 9012

Miner ID reference contains commands.

To create a MinerId, run:

npm run cli -- generateminerid --name testMiner

mAPI

Host: localhost Port: 9014

The API reference has more information as well as the swagger documentation.

What's On Chain

URL: http://localhost:8080

Mining Dashboard

URL: http://localhost:3010

Updating SV Node Configuration

The file sv/bitcoin.conf is volume-mounted into the SV Node container during docker-compose up. Modify it as required, then restart the node with docker-compose down and docker-compose up.