#Deploy Your Own OKBC Localnet

This document describes 2 ways to setup a network of okbc nodes, each serving a different usecase:

  1. Single-node, local, manual testnet
  2. Multi-node, local, automated testnet

Supporting code can be found in the networks directory and additionally the local sub-directories.

#Available Docker images

In case you need to use or deploy okbc as a container you could skip the build steps and use the official images, $TAG stands for the version you are interested in:

  • docker run -it -v ~/.okbchaind:/root/.okbchaind okbchain/fullnode-testnet:$TAG okbchaind init mynode
  • docker run -it -p 26657:26657 -p 26656:26656 -v ~/.okbchaind:/root/.okbchaind okbchain/fullnode-testnet:$TAG okbchaind start
  • ...
  • docker run -it -v ~/.okbchaind:/root/.okbchaind okbchain/fullnode-testnet:$TAG okbchaincli version

The same images can be used to build your own docker-compose stack.

#Single-node, Local, Manual Testnet

This guide helps you create a single validator node that runs a network locally for testing and other development related uses.


#Create Genesis File and Start the Network

# You can run all of these commands from your home directory
cd $HOME

# Initialize the genesis.json file that will help you to bootstrap the network
okbchaind init <your_custom_moniker> --chain-id testchain-1

# Create a key to hold your validator account
okbchaincli keys add validator

# Add that key into the genesis.app_state.accounts array in the genesis file
# NOTE: this command lets you set the number of coins. Make sure this account has some coins
# with the genesis.app_state.staking.params.bond_denom denom, the default is staking
okbchaind add-genesis-account $(okbchaincli keys show validator -a) 1000000000okb

# Generate the transaction that creates your validator
okbchaind gentx --name validator

# Add the generated bonding transaction to the genesis file
okbchaind collect-gentxs

# Now its safe to start `okbchaind`
okbchaind start --chain-id testchain-1

This setup puts all the data for okbchaind in ~/.okbchaind. You can examine the genesis file you created at ~/.okbchaind/config/genesis.json. With this configuration okbchaincli is also ready to use and has an account with tokens (both staking and custom).

#Multi-node, Local, Automated Testnet

From the networks/local directory:



Build the okbchaind binary (linux) and the okbchain/fullnode-testnet docker image required for running the localnet commands. This binary will be mounted into the container and can be updated rebuilding the image, so you only need to build the image once.

# Clone the exchain repo
git clone https://github.com/okx/okbchain.git

# Work from the SDK repo
cd okbchain

# Build okbchain/fullnode-testnet image
make build-docker-okbchainnode

#Run Your Testnet

To start a 4 node testnet run:

make localnet-start

This command creates a 4-node network using the okbchaindnode image. The ports for each node are found in this table:

Node IDP2P PortRPC Port


The make localnet-start creates files for a 4-node testnet in ./build by calling the okbchaind testnet command. This outputs a handful of files in the ./build directory:

$ tree -L 3 build/
├── gentxs
│   ├── node0.json
│   ├── node1.json
│   ├── node2.json
│   └── node3.json
├── node0
│   ├── okbchaincli
│   │   ├── key_seed.json
│   │   └── keyring-test-okbchain
│   └── okbchaind
│       ├── config
│       └── data
├── node1
│   ├── okbchaincli
│   │   ├── key_seed.json
│   │   └── keyring-test-okbchain
│   └── okbchaind
│       ├── config
│       └── data
├── node2
│   ├── okbchaincli
│   │   ├── key_seed.json
│   │   └── keyring-test-okbchain
│   └── okbchaind
│       ├── config
│       └── data
└── node3
    ├── okbchaincli
    │   ├── key_seed.json
    │   └── keyring-test-okbchain
    └── okbchaind
        ├── config
        └── data

Each ./build/nodeN directory is mounted to the /okbchaind directory in each container.


Logs are saved under each ./build/nodeN/okbchaind/okbchaind.log. You can also watch logs directly via Docker, for example:

docker logs -f okbchaindnode0

#Keys & Accounts

To interact with okbchaincli and start querying state or creating txs, you use the okbchaincli directory of any given node as your home, for example:

okbchaincli keys list --home ./build/node0/okbchaincli

Now that accounts exists, you may create new accounts and send those accounts funds!

NOTE: Each node's seed is located at ./build/nodeN/okbchaincli/key_seed.json and can be restored to the CLI using the okbchaincli keys add --restore command

#Special Binaries

If you have multiple binaries with different names, you can specify which one to run with the BINARY environment variable. The path of the binary is relative to the attached volume. For example:

# Run with custom binary
BINARY=okbchainfoo make localnet-start