Run A Local Network

​

Introduction

Here, we’ll installing and running a local instance of Quai Network in a containerized environment. The local network instance contains one full node, one CPU miner for each of the 9 shards, and multiple accounts with pre-loaded Quai and Qi balance. The containerized local network instance is designed to provide an easily configurable, low overhead development environment for builders.

​

Install Dependencies

To run a local instance of Quai Network, you’ll need to install a few dependencies.

git clone https://github.com/dominant-strategies/quai-local-node
cd quai-local-node

​

Run Local Instance

Now that we’ve installed Docker Compose and navigated to the quai-local-node repository, we can run the local network instance.

​

Start

To start the local network instance in a Docker container, run:

• Run in Background
• Run in Foreground

After running this command, you’ll see each of the processes start up. One go-quai container, and 9 instances of quai-cpu-miner (one for each shard) should initialize like so:

[+] Running 10/10
 ⠿ Container quai-local-node-paxos2-quai-cpu-miner-1   Started
 ⠿ Container quai-local-node-cyprus1-quai-cpu-miner-1  Started
 ⠿ Container quai-local-node-cyprus2-quai-cpu-miner-1  Started
 ⠿ Container quai-local-node-hydra2-quai-cpu-miner-1   Started
 ⠿ Container quai-local-node-paxos1-quai-cpu-miner-1   Started
 ⠿ Container quai-local-node-cyprus3-quai-cpu-miner-1  Started
 ⠿ Container quai-local-node-go-quai-1                 Started
 ⠿ Container quai-local-node-paxos3-quai-cpu-miner-1   Started
 ⠿ Container quai-local-node-hydra1-quai-cpu-miner-1   Started
 ⠿ Container quai-local-node-hydra3-quai-cpu-miner-1   Started

​

View Logs

To view the logs for the go-quai container from your terminal, run:

## print global logs
docker logs quai-local-node-go-quai-1

## follow global logs
docker logs -f --tail 0 quai-local-node-go-quai-1

If you’d like to access logs for a specific shard, you’ll need to navigate to the quai-local-node-go-quai-1 container and print logs directly.

## navigate to go-quai container
docker exec -it quai-local-node-go-quai-1 sh

## follow logs for a specific zone
tail -f nodelogs/zone-0-0.log

## follow logs for a specific region
tail -f nodelogs/region-1.log

​

Stop

If your local network instance is running in the background, run the following command to stop:

docker-compose down

If your local network instance is running in the foreground, you can exit the terminal or use CTRL+C to stop the container.

​

Custom Network Configuration

The quai-local-node is configured to run all 9 shards (slices) and a CPU miner for each shard by default. It is recommended to run the default configuration for most use-cases. If you want to run a custom slice configuration, the section below details how to do so.

To alter the default local network configuration, you’ll need to:

• Edit the slices the local node is running in the config.toml file
• Edit the number of CPU miners to match the number of shards in the docker-compose.yml file

vim config/go-quai/config.toml

slices = '[0 0],[0 1],[0 2],[1 0],[1 1],[1 2],[2 0],[2 1],[2 2]'

vim docker-compose.yml

cyprus1-quai-cpu-miner:
  image: quainetwork/quai-cpu-miner:0.1.0-test.4
  volumes:
    - ./config/quai-cpu-miner/cyprus1-config.yaml:/root/config/config.yaml
  deploy:
    resources:
      limits:
        cpus: '1'
    replicas: 1
  command: ['./build/bin/quai-cpu-miner']
  networks:
    - quainet

cyprus1-quai-cpu-miner:
  ...
  replicas: 1

cyprus2-quai-cpu-miner:
  ...
  replicas: 1

cyprus3-quai-cpu-miner:
  ...
  replicas: 1

paxos1-quai-cpu-miner:
  ...
  replicas: 0

etc...

After matching the slices the node is running to the CPU miner configurations, you can start up your custom local network instance.

​

Interacting With The Local Network

To interact with the local network instance, you can use the Quais SDK or JSON RPC API. The network is accesible via specific networking ports on localhost.

​

SDK

You can use the Quais SDK to create a provider connected to your local network instance and get chain data and send transactions.

import { quais } from 'quais'

// create local provider
const provider = new quais.JsonRpcProvider('http://localhost')

// get block number on cyprus 1
const currentBlock = await provider.getBlockNumber('Cyprus1')

​

JSON RPC API

You can make requests to your local network using the JSON RPC API and cURL:

# get paxos 3 gas price
curl --request POST \
  --url http://localhost:9222 \
  --header 'Content-Type: application/json' \
  --data '{
  "jsonrpc": "2.0",
  "method": "quai_gasPrice",
  "params": [],
  "id": 1
}'

​

Accounts

The local network we just spun up starts with a number of accounts pre-loaded with Quai and Qi tokens for each shard. A full list of accounts with pre-loaded balances, sorted by shard and ledger, can be found in the genallocs directory of the quai-local-node repository.

For quick reference, 1 account for each shard and ledger can be found below:

​

Quai Accounts

​

Qi Accounts