0chain / 0chain

        # TestNet Setup with Docker Containers

Table of Contents

• Changelog
• Initial Setup
  • Host Machine Network Setup
  • Directory Setup for Miners & Sharders
  • Setup Network
• Building and Starting the Nodes
• Building the Nodes
• Generating Test Transactions
• Troubleshooting
• Development
• Debugging
• Unit tests
• Creating The Magic Block
• Initial states
• Miscellaneous
  • Cleanup
  • Minio Setup
• Integration tests
• Benchmarks
• Run 0chain on ec2 / vm / bare metal
• Run 0chain on ec2 / vm / bare metal over https
• Swagger documentation

Changelog

CHANGELOG.md

Initial Setup

Host Machine Network setup

MacOS

./macos_network.sh

Windows

Run powershell as administrator

./windows_network.sh

Directory Setup for Miners and Sharders

In the git/0chain run the following command

./docker.local/bin/init.setup.sh

Setup Network

Set up a network called testnet0 for each of these node containers to talk to each other.

Note: The config file should be providing the IP address of the nodes as per the IP addresses in this network.

./docker.local/bin/setup.network.sh

Building the Nodes

1. Open 5 terminal tabs. Use the first one for building the containers by being in git/0chain directory. Use the next 3 for 3 miners and be in the respective miner directories created above in docker.local. Use the 5th terminal and be in the sharder1 directory.

1.1) First build the base containers, zchain_build_base and zchain_run_base

Use -m1 flag to build for Apple m1 chip

./docker.local/bin/build.base.sh

2. Building the miners and sharders. From the git/0chain directory use

2.1) To build the miner containers

./docker.local/bin/build.miners.sh

2.2) To build the sharder containers

./docker.local/bin/build.sharders.sh

for building the 1 sharder.

2.3) Syncing time (the host and the containers are being offset by a few seconds that throws validation errors as we accept transactions that are within 5 seconds of creation). This step is needed periodically when you see the validation error.

./docker.local/bin/sync_clock.sh

Configuring the nodes

1. Use ./docker.local/config/0chain.yaml to configure the blockchain properties. The default options are set up for running the blockchain fast in development.

1.1) If you want the logs to appear on the console - change logging.console from false to true

1.2) If you want the debug statements in the logs to appear - change logging.level from "info" to "debug"

1.3) If you want to change the block size, set the value of server_chain.block.size

1.4) If you want to adjust the network relay time, set the value of network.relay_time

Note: Remove sharder72 and miner75 from docker.local/config/b0snode2_keys.txt and docker.local/config/b0mnode5_keys.txt respectively if you are joining to local network.

Starting the nodes

1. Starting the nodes. On each of the miner terminals use the commands (note the .. at the beginning. This is because, these commands are run from within the docker.local/<miner/sharder|i> directories and the bin is one level above relative to these directories)

Start sharder first because miners need the genesis magic block. On the sharder terminal, use

../bin/start.b0sharder.sh

Wait till the cassandra is started and the sharder is ready to listen to requests.

On the respective miner terminal, use

../bin/start.b0miner.sh

Re-starting the nodes

To reflect a change in config files 0chain.yaml and sc.yaml, just restart the miner or sharder to take the new configuration. If you're doing a code change locally or pulling updates from GitHub, you need to build.

git pull
docker.local/bin/build.base.sh && docker.local/bin/build.sharders.sh && docker.local/bin/build.miners.sh

For existing code and if you have tried running once, make sure there are no previous files and processes.

docker stop $(docker ps -a -q)
docker.local/bin/clean.sh
docker.local/bin/init.setup.sh
docker.local/bin/sync_clock.sh

Then go to individual miner/sharder:

../bin/start.b0sharder.sh (start sharders first!)
../bin/start.b0miner.sh

Running on systems with SELinux enabled

Library by herumi for working with BLS threshold signatures requires this flag turned on:

setsebool -P selinuxuser_execheap 1

If you are curious about the reasons for this, this thread sheds some light on the topic:

herumi/xbyak#9

Setting up Cassandra Schema

The following is no longer required as the schema is automatically loaded.

Start the sharder service that also brings up the cassandra service. To run commands on cassandra, use the following command

../bin/run.sharder.sh cassandra cqlsh

1. To create zerochain keyspace, do the following

../bin/run.sharder.sh cassandra cqlsh -f /0chain/sql/zerochain_keyspace.sql

2. To create the tables, do the following

../bin/run.sharder.sh cassandra cqlsh -k zerochain -f /0chain/sql/txn_summary.sql

3. When you want to truncate existing data (use caution), do the following

../bin/run.sharder.sh cassandra cqlsh -k zerochain -f /0chain/sql/truncate_tables.sql

Generating Test Transactions

There is no need to generate the test data separately. In development mode, the transaction data is automatically generated at a certain rate based on the block size.

However, you can use the block explorer to submit transactions, view the blocks and confirm the transactions.

Monitoring the progress

1. Use block explorer to see the progress of the block chain.

2. In addition, use the '/_diagnostics' link on any node to view internal details of the blockchain and the node.

Troubleshooting

1. Ensure the port mapping is all correct:

docker ps

This should display a few containers and should include containers with images miner1_miner, miner2_miner and miner3_miner, and they should have the ports mapped like "0.0.0.0:7071->7071/tcp"

2. Confirming the servers are up and running. From a browser, visit

• http://localhost:7071/_diagnostics

• http://localhost:7072/_diagnostics

• http://localhost:7073/_diagnostics

to see the status of the miners.

Similarly, following links can be used to see the status of the sharders

• http://localhost:7171/_diagnostics

• http://localhost:7172/_diagnostics

• http://localhost:7173/_diagnostics

3. Connecting to redis servers running within the containers (you are within the appropriate miner directories)

Default redis (used for clients and state):

../bin/run.miner.sh redis redis-cli

Redis used for transactions:

../bin/run.miner.sh redis_txns redis-cli

4. Connecting to cassandra used in the sharder (you are within the appropriate sharder directories)

../bin/run.sharder.sh cassandra cqlsh

Development

Install msgp

Run the following command to install the msgp tool:

make install-msgp

We are using msgp to encode/decode data that store in MPT, it is unnecessary to touch it unless there are data struct changes or new type of data structs need to store in MPT.

When we need to add a new data struct to MPT, for example:

//go:generate msgp -io=false -tests=false -v
package main

type Foo struct {
	Name string
}

Note:

1. msgp does not support system type alias, so please do not use datastore.Key in MPT data struct, it is an alias of system type string.
2. The //go:generate msgp -io=false ... works on file level, i.e, we only need to define it once a file, so please check if it is already defined before adding.

Then run the following command from the project root to generate methods for serialization.

make msgp

A new file will then be generated as {file}_gen.go in the same dir where the data struct is defined.

Dependencies for local compilation

You need to install rocksdb and herumi/bls, refer to docker.local/build.base/Dockerfile.build_base for necessary steps.

For local compilation it should be enough of go build from a submodule folder, e.g.

cd code/go/0chain.net/miner
go build

You can pass tag development if you want to simulate n2n delays. And you also need tag bn256 to build the same code as in production:

go build -tags "bn256 development"

Debugging

Bringing up the chain faster

./0chain_dev_deployment.sh

Debug builds of 0chain

If you want to run a debug 0chain build you can follow the details contained in the 0chain/local folder.

Only one miner and one sharder can be run on any single machine, so you will need at least three machines to for a working 0chain.

Log files

The logs of the nodes are stored in log directory (/0chain/log on the container and docker.local/miner|sharder[n]/log in the host). The 0chain.log contains all the logs related to the protocol and the n2n.log contains all the node to node communication logs. The typical issues that need to be debugged is errors in the log, why certain things have not happened which requires reviewing the timestamp of a sequence of events in the network. Here is an example set of commands to do some debugging.

Find errors in all the miner nodes (from git/0chain)

grep ERROR docker.local/miner*/log/0chain.log

This gives a set of errors in the log. Say an error indicates a problem for a specific block, say abc, then

grep abc docker.local/miner*/log/0chain.log

gives all the logs related to block 'abc'

To get the start time of all the rounds

grep 'starting round' docker.local/miner*/log/0chain.log

This gives the start timestamps that can be used to correlate the events and their timings.

Unit tests

0chain unit tests verify the behaviour of individual parts of the program. A config for the base docker image can be provided on run to execute general unit tests.

Getting started

Prerequisites

Docker and Git must be installed to run the tests .

Install Git using the following command:

sudo apt install git

Docker installation instructions can be found here.

Cloning the repository and Building Base Image

Clone the 0chain repository:

git clone https://github.com/0chain/0chain.git

Navigate to 0chain folder and run the script to build base docker image for unit testing :

cd 0chain
./docker.local/bin/build.base.sh

The base image includes all the dependencies required to test the 0chain code.

Running Tests

Now run the script containing unit tests .

./docker.local/bin/unit_test.sh

The list of packages is optional, and if provided runs only the tests from those packages. Command for running unit tests with specific packages .

./docker.local/bin/unit_test.sh [<packages>]

Testing Steps

Unit testing happens over a series of steps one after the other.

Step 1: FROM zchain_build_base

This FROMstep does the required preparation and specifies the underlying OS architecture to use the build image. Here we are using the base image created in the build phase.

Step 2: ENV SRC_DIR=/0chain

The SRC_DIR variable is a reference to a filepath which contains the code from your pull request. Here /0chain directory is specified as it is the one which was cloned.

Step 3: Setting the GO111Module variable to ON

GO111MODULE is an environment variable that can be set when using go for changing how Go imports packages. It was introduced to help ensure a smooth transition to the module system.

GO111MODULE=on will force using Go modules even if the project is in your GOPATH. Requires go.mod to work.

Note: The default behavior in Go 1.16 is now GO111MODULE=on

Step 4: COPY ./code/go/0chain.net $SRC_DIR/go/0chain.net

This step copies the code from the source path to the destination path.

Step 5: RUN cd $SRC_DIR/go/0chain.net && go mod download

The RUN command is an image build step which allows installing of application and packages requited for testing while thego mod download downloads the specific module versions you've specified in the go.modfile.

Step 6: RUN cd $GOPATH/pkg/mod/github.com/valyala/[email protected]. && chmod -R +w . && make clean libzstd.a

This step runs the gozstd package and provides write permissions to the directory. gozstd which is a go wrapper for zstd (library) provides Go bindings for the libzstd C library. The make clean is run in the last to clean up the code and remove all the compiled object files from the source code

Step 7: WORKDIR $SRC_DIR/go

This step defines the working directory for running unit tests which is (0chain/code/go/0chain.net/).For all the running general unit tests their code coverage will be defined in the terminal like this

ok      0chain.net/chaincore/block      0.128s  coverage: 98.9% of statements

The above output shows 98.9% of code statements was covered with tests.

Creating The Magic Block

First build the magic block image.

./docker.local/bin/build.magic_block.sh

Next, set the configuration file. To do this edit the docker.local/build.magicBlock/docker-compose.yml file. On line 13 is a flag "--config_file" set it to the magic block configuration file you want to use.

To create the magic block.

./docker.local/bin/create.magic_block.sh

The magic block and the dkg summary json files will appear in the docker.local/config under the name given in the configuration file.

The magic_block_file setting in the 0chain.yaml file needs to be updated with the new name of the magic block created.

Update the miner config file, so it is set to the new dkg summaries. To do this edit the docker.local/build.miner/b0docker-compose.yml file. On line 55 is a flag "--dkg_file" set it to the dkg summary files created with the magic block.

Initial states

The balance for the various nodes is set up in a initial_state.yaml file. This file is a list of node ids and token amounts.

The initial state yaml file is entered as a command line argument when running a sharder or miner, falling that the 0chain.yaml network.inital_states entry is used to find the initial state file.

An example, that can be used with the preset ids, can be found at 0chain/docker.local/config/initial_state.yaml`

Miscellaneous

Cleanup

1. If you want to restart the blockchain from the beginning

./docker.local/bin/clean.sh

This cleans up the directories within docker.local/miner* and docker.local/sharder*

Note: this script can take a while if the blockchain generated a lot of blocks as the script deletes the databases and also all the blocks that are stored by the sharders. Since each block is stored as a separate file, deleting thousands of such files will take some time.

2. If you want to get rid of old unused docker resources:

docker system prune

Minio

• You can use the inbuilt minio support to store blocks on cloud

You have to update minio_config file with the cloud creds data, The file can be found at docker.local/config/minio_config.txt. The following order is used for the content :

CONNECTION_URL
ACCESS_KEY_ID
SECRET_ACCESS_KEY
BUCKET_NAME
REGION

• Your minio config file is then used in the docker-compose while starting the sharder node

--minio_file config/minio_config.txt

• You can either update the setting in the same file which is given above or create a new one with you config and use that as

--minio_file config/your_new_minio_config_file.txt

**_Note: Do not forget to put the file in the same config folder OR mount your new folder.

• Apart from private connection config, There are other options as well in the 0chain.yaml file to manage minio settings.

Sample config

minio:
  # Enable or disable minio backup, Do not enable with deep scan ON
  enabled: false
  # In Seconds, The frequency at which the worker should look for files, Ex: 3600 means it will run every 3600 seconds
  worker_frequency: 3600
  # Number of workers to run in parallel, Just to make execution faster we can have mutiple workers running simultaneously
  num_workers: 5
  # Use SSL for connection or not
  use_ssl: false
  # How old the block should be to be considered for moving to cloud
  old_block_round_range: 20000000
  # Delete local copy of block once it's moved to cloud
  delete_local_copy: true

• In minio the folders do not get deleted and will cause a slight increase in volume over time.

Integration tests

Integration testing combines individual 0chain modules and test them as a group. Integration testing evaluates the compliance of a system for specific functional requirements and usually occurs after unit testing .

For integration testing, A conductor which is RPC(Remote Procedure Call) server is implemented to control behaviour of nodes .To know more about the conductor refer to the conductor documentation

Benchmarks

Benchmark 0chain smart-contract endpoints.

Runs testing.Benchmark on each 0chain endpoint. The blockchain database used in these tests is constructed from the parameters in the benchmark.yaml. file. Smartcontracts do not (or should not) access tha chain so a populated MPT database is enough to give a realistic benchmark.

More info in read.me

Architecture

A conductor requires the nodes to be built in a certain order to control them during the tests. A config file is defined in conductor.config.yaml which contains important details such as details of all nodes used and custom commands used in integration testing.

For running multiple test cases,conductor uses a test suite which contains multiple sets of tests .A test suites can be categorized into 3 types of tests

standard tests - Checks whether chain continue to function properly despite bad miner and sharder participants

view-change tests - Checks whether addition and removal of nodes is working

.blobber tests - Checks whether storage functions continue to work properly despite bad or lost blobber, and confirms expected storage function failures

Below is an example of conductor test suite.

# Under `enable` is the list of sets that will be run.
enable:
  - "Miner down/up"
  - "Blobber tests"

# Test sets defines the test cases it covers.
sets:
  - name: "Miner down/up"
    tests:
      - "Miner: 50 (switch to contribute)"
      - "Miner: 100 (switch to share)"
  - name: "Blobber tests"
    tests:
      - "All blobber tests"

# Test cases defines the execution flow for the tests.
tests:
  - name: "Miner: 50 (switch to contribute)"
    flow:
    # Flow is a series of directives.
    # The directive can either be built-in in the conductor
    # or custom command defined in "conductor.config.yaml"
      - set_monitor: "sharder-1" # Most directive refer to node by name, these are defined in `conductor.config.yaml`
      - cleanup_bc: {} # A sample built-in command that triggers stop on all nodes and clean up.
      - start: ['sharder-1']
      - start: ['miner-1', 'miner-2', 'miner-3']
      - wait_phase:
          phase: 'contribute'
      - stop: ['miner-1']
      - start: ['miner-1']
      - wait_view_change:
          timeout: '5m'
          expect_magic_block:
            miners: ['miner-1', 'miner-2', 'miner-3']
            sharders: ['sharder-1']
  - name: "Miner: 100 (switch to share)"
    flow:
    ...
  - name: "All blobber tests"
    flow:
      - command:
          name: 'build_test_blobbers' # Sample custom command that executes `build_test_blobbers`
    ...
...

Getting Started

Prerequisites

Docker and Git must be installed to run the tests .

Install Git using the following command:

sudo apt install git

Docker installation instructions can be found here.

Cloning the repository and Building Base Image

Clone the 0chain repository:

git clone https://github.com/0chain/0chain.git

Build miner docker image for integration test

(cd 0chain && ./docker.local/bin/build.miners-integration-tests.sh)

Build sharder docker image for integration test

(cd 0chain && ./docker.local/bin/build.sharders-integration-tests.sh)

NOTE: The miner and sharder images are designed for integration tests only. If wanted to run chain normally, rebuild the original images.

(cd 0chain && ./docker.local/bin/build.sharders.sh && ./docker.local/bin/build.miners.sh)

Confirm that view change rounds are set to 50 on 0chain/docker.local/config.yaml

    start_rounds: 50
    contribute_rounds: 50
    share_rounds: 50
    publish_rounds: 50
    wait_rounds: 50

Running standard tests

Run miners test

(cd 0chain && ./docker.local/bin/start.conductor.sh miners)

Run sharders test

(cd 0chain && ./docker.local/bin/start.conductor.sh sharders)

Running complex scenario suites

1. These 2 scripts should be run with view_change: false in 0chain/docker.local/config.yaml 1.1. (cd 0chain && ./docker.local/bin/start.conductor.sh no-view-change.byzantine) 1.2. (cd 0chain && ./docker.local/bin/start.conductor.sh no-view-change.fault-tolerance)
2. Set view_change: true in 0chain/docker.local/config.yaml for the following 2 scripts 2.1. (cd 0chain && ./docker.local/bin/start.conductor.sh view-change.byzantine) 2.2. (cd 0chain && ./docker.local/bin/start.conductor.sh view-change.fault-tolerance*)

Running blobber tests

Refer to conductor documentation

Adding new Tests

New tests can be easily added to the conductor check Updating conductor tests in the conductor documentation for more information.

Enabling or Disabling Tests

Check Temporarily disabling tests in the conductor documentation for more information

Supported Conductor Commands

Check the supported directives in the conductor documentation for more information.

Creating Custom Conductor Commands

Check Custom Commands in the conductor documentation for more information

Swagger documentation

To generate swagger documentation you need go-swagger installed, visit https://goswagger.io/install.html for details.

You then need to run the makefile

make swagger

The documentation will be in docs/swagger.md and docs/swagger.yaml.