Join the Public Testnet

See the testnet repo for information on the latest testnet, including the correct version of OKExChain to use and details about the genesis file.

You need to install okexchain before you go further

Supported Platforms

We support running a full node on Mac OS X, Windows and Linux.

Minimum System Requirements

The hardware must meet certain requirements to run okexchaind.

  • Desktop or laptop hardware running recent versions of Mac OS X, Windows, or Linux.

  • 500 GB of free disk space, accessible at a minimum read/write speed of 100 MB/s.

  • 4 cores of CPU and 8 gigabytes of memory (RAM).

  • A broadband Internet connection with upload/download speeds of at least 1 megabyte per second

Setting Up a New Node

These instructions are for setting up a brand new full node from scratch.

First, initialize the node and create the necessary config files:

okexchaind init <your_custom_moniker>

NOTE: Monikers can contain only ASCII characters. Using Unicode characters will render your node unreachable.

You can edit this moniker later, in the ~/.okexchaind/config/config.toml file:

# A custom human readable name for this node
moniker = "<your_custom_moniker>"

You can edit the ~/.okexchaind/config/okexchaind.toml file in order to enable the anti spam mechanism and reject incoming transactions with less than the minimum gas prices:

# This is a TOML config file.
# For more information, see https://github.com/toml-lang/toml

##### main base config options #####

# The minimum gas prices a validator is willing to accept for processing a
# transaction. A transaction's fees must meet the minimum of any denomination
# specified in this config (Our recommended quantity is  10^-7 tokt).

minimum-gas-prices = ""

Your full node has been initialized!

Genesis & Seeds

Copy the Genesis File

Fetch the testnet’s genesis.json file into okexchaind’s config directory.

Note we use the latest directory in the testnets repo which contains details for the testnet like the latest version and the genesis file.

To verify the correctness of the configuration run:

okexchaind start

Add Seed Nodes

Your node needs to know how to find peers. You’ll need to add healthy seed nodes to $HOME/.okexchaind/config/config.toml. The testnets repo contains links to some seed nodes.

You can add seeds in the ~/.okexchaind/config/config.toml file:

# Comma separated list of seed nodes to connect to
seeds = "b7c6bdfe0c3a6c1c68d6d6849f1b60f566e189dd@3.13.150.20:36656,d7eec05e6449945c8e0fd080d58977d671eae588@35.176.111.229:36656,223b5b41d1dba9057401def49b456630e1ab2599@18.162.106.25:36656"

For more information on seeds and peers, you can read this.

Starting a New Node

Start the full node with this command:

okexchaind start

Check that everything is running smoothly:

okexchaincli status

See the testnet repo for information on testnets, including the correct version of the OKExChain to use and details about the genesis file.

Upgrading Your Node

These instructions are for full nodes that have ran on previous versions of and would like to upgrade to the latest testnet.

Reset Data

First, remove the outdated files and reset the data.

rm $HOME/.okexchaind/config/addrbook.json $HOME/.okexchaind/config/genesis.json
okexchaind unsafe-reset-all

Your node is now in a pristine state while keeping the original priv_validator.json and config.toml. If you had any sentry nodes or full nodes setup before, your node will still try to connect to them, but may fail if they haven’t also been upgraded.

NOTE: Make sure that every node has a unique priv_validator.json. Do not copy the priv_validator.json from an old node to multiple new nodes. Running two nodes with the same priv_validator.json will cause you to double sign.

Software Upgrade

Now it is time to upgrade the software:

git clone https://github.com/okex/okexchain.git
cd okexchain
git fetch --all && git checkout master
make install

NOTE: If you have issues at this step, please check that you have the latest stable version of GO installed.

Note we use master here since it contains the latest stable release. See the testnet repo for details on which version is needed for which testnet, and the OKExChain release page for details on each release.

Your full node has been cleanly upgraded!

Upgrade to Validator Node

You now have an active full node. What’s the next step? You can upgrade your full node to become a OKExChain Validator. The top 100 validators have the ability to propose new blocks to the OKExChain. Continue onto the Validator Setup.