Run RChain network on a single machine with docker-compose

This repository is a continuation of https://github.com/zsluedem/rchain-docker-cluster. It's purpose is to deploy RChain shard (plus useful services around it) on local machine using docked-compose. It might be useful for those who wish to test changes to RNode, to get familiar with how network operates and how to configure and start private network. The behaviour is equal to normal network with each node having dedicated machine.

Make sure you give enough resources to docker (check configuration), 6+ CPUs and 8+ GB RAM is preferable.

By default shard of 3 nodes is created, connected with the virtual network rchain-net. Each node exposes API ports via docker port mapping. Please see corresponding .yml file ports section to know exact port numbers.

Initially network state is clean. Once shard is started, nodes will perform genesis ceremony and create genesis block. This takes some time, but after that network can be stopped and started much faster. To clean the state of the network and start with the new genesis block, clear or remove data folder.

Initial network data

• List of public keys of validators bonded in genesis block (bonds file): ./genesis/bonds.txt

• REV balances in the genesis block (wallets file): ./genesis/wallets.txt. Format is ETH addr, number of revletts, 0. Default account:

  • Private key 49b3dd73a5dd5e35620531c58e8bd41b1a3d4e1b1fc924418a6e3cbd6b6d5dc6
  • Public key 04bc79a11dbd780bb1b908728ceac406762b641aafc321552ab17995e2c2a76d19fdae81566632b5916791bb4c7fc7f56d1080cc4cfe33c2233b1b7612136ae637
  • ETH fd62806439c4ae196d5e91b9291e23ee6d35e663
  • REV 11112XUPSZDELqBsGRc7t4vZAXHztAcUfLwHHB1uJXjS7uEKKqhfwaHztAcUfLwHHB1uJXjS7uEKKqhfwa

• Configuration files for network nodes: ./conf

• Validator identities (Secp256k1 keypairs). Keypairs are generated using rnode keygen command, private key files are encrypted with password 123. 
  ./conf/bootstrap/rnode.key - encrypted private key in PEM format. 
  ./conf/bootstrap/rnode.pub.pem and ./conf/bootstrap/rnode.pub.hex - public key in PEM and hex format correspondingly.

NOTE: remove the ./data directory to perform new genesis after changing configuration.

External Resource

1. RChain
2. PyRChain

Dependencies

1. docker >=17.09.0
2. docker-compose >=1.17.0

Start Network

By default rchain:rnode/latest image is used, which is the latest release published. Image can be configured in corresponding .yml files. To make sure image is up to date with the recent changes published, run docker pull rchain/rnode:latest before proceeding.

Start a network of 3 nodes: containers rnode.bootstrap, rnode.validator1 and rnode.validator2

$ docker-compose -f ./shard.yml up

To start only a standalone node (container rnode.bootstrap)

$ docker-compose -f ./standalone.yml up

[OPTIONAL] Enable automatic block creation

Make sure shard is up and running and all nodes printed Making a transition to Running state., which means Casper instance is ready to accept connections.

$ docker-compose -f ./proposer.yml up

[OPTIONAL] Start an observer node

Observer nodes are same as validators but started without private key provided, so they cannot sign and propose blocks. Such instances allow execution of so-called exploratory deploys to query the state of the DAG.

$ docker-compose -f ./read-only.yml up