Getting started
To run this node, you must have the follow software installed on your local machine:
- Docker (including docker-compose)
- Python 3
- Virtualenv (
sudo apt install python3-venv
) - Openssl
- Git
# Clone repository
git clone https://github.com/ActorForth/bch-devsuite.git
cd ./bch-devsuite
# Setup virtualenv
python3 -m venv venv
source ./venv/bin/activate
# Install script dependencies
pip install -r requirements.txt
bch-devsuite initialize the infrastructure from configuration file, see configuration for more details.
You can run this command and follow the command-line wizard
./bch-devsuite build-config /tmp/bch-devsuite.toml

build-config screencast
or create a config file by hand, note that you can remove the part if you don't want that component. See Configuration Examples for more examples.
# Example TOML config file
network = "mainnet" # mainnet | testnet | regtest
rest_service = "bchrest" # bchrest or bchapi
exposed_ports = true
docker_network = "bch-devsuite-network" # docker-network name
[local_node] # Local node configuration
node = "bu" # bu (bitcoin unlimited) or bchn (bitcoin cash node)
wait_time = 6 # a delay before running initializes command. Need to be high if you run on a slow system.
[slp] # SLPDB
username = "actorforth" # MongoDB username
password = "123ldsfoijqwerj" # MongoDB password