Install OKTC#

This guide will explain how to install the exchaind and exchaincli entrypoints onto your system. With these installed on a server, you can participate in the testnet as either a Full Node or a Validator.

Install Go#

Install go by following the official docs. Remember to set your $PATH environment variable, for example:

mkdir -p $HOME/go/bin
echo "export PATH=$PATH:$(go env GOPATH)/bin" >> ~/.bash_profile
echo "export GOPATH=$HOME/go" >> ~/.bash_profile
echo "export GOBIN=$GOPATH/bin" >> ~/.bash_profile
echo "export PATH=$PATH:$GOBIN" >> ~/.bash_profile
source ~/.bash_profile

Under Windows, you may set environment variables(HOME or GO111MODULE) through the "Environment Variables" button on the "Advanced" tab of the "System" control panel. Some versions of Windows provide this control panel through the "Advanced System Settings" option inside the "System" control panel.

NOTE: Go 1.17+ is required for the OKTC.

Install the binaries#

Next, let's install the latest version of OKTC. Make sure you git checkout the latest released version.

# mainnet, <latest-release-tag> can be viewed through this link https://github.com/okx/exchain/releases/latest
# testnet, <latest-release-tag> can be viewed through this link https://github.com/okx/exchain/releases, and use latest pre-release version
git clone -b <latest-release-tag> https://github.com/okx/exchain
export GO111MODULE=on
cd exchain 
# mainnet, use make mainnet
make mainnet
# testnet, use make testnet
make testnet

Under Windows, you can execute the below commands on PowerShell to set the environment variable GO111MODULE.

# Enable the go modules feature
$env:GO111MODULE="on"

If this command fails due to the following error message, you might have already set LDFLAGS prior to running this step.

# github.com/okx/exchain/cmd/exchaind
flag provided but not defined: -L
usage: link [options] main.o
...
make: *** [install] Error 2

Unset this environment variable and try again.

LDFLAGS="" make install

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

That will install the exchaind and exchaincli binaries. Verify that everything is OK:

$ exchaind version --long
$ exchaincli version --long

exchaincli for instance should output something similar to:

name: exchain
server_name: exchaind
client_name: exchaincli
version: v1.6.5
commit: 4f496351ab3bdc4ce014706711f31589021dd0de
build_tags: netgo
go: go version go1.19.2 darwin/amd64

Build Tags#

Build tags indicate special features that have been enabled in the binary.

Build TagDescription
netgoName resolution will use pure Go code
ledgerLedger devices are supported (hardware wallets)

Install binary distribution via snap (Linux only)#

Do not use snap at this time to install the binaries for production until we have a reproducible binary system.

Developer Workflow#

To test any changes made in the Cosmos-SDK or Tendermint, a replace clause needs to be added to go.mod providing the correct import path.

  • Make appropriate changes
  • Add replace github.com/cosmos/cosmos-sdk => /path/to/clone/cosmos-sdk to go.mod
  • Run make install or make build
  • Test changes

Next#

Now you can join the mainnet, the public testnet or create you own testnet