Toggle Doc Menu

Install OKC

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.12+ is required for the OKC.

Install the binaries

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

git clone -b <latest-release-tag> https://github.com/okex/exchain
export GO111MODULE=on
cd exchain && make install

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/okex/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: okexchain
server_name: exchaind
client_name: exchaincli
version: v0.18.10
commit: 20a720f38c6c60540a739351e485779a098ee413
build_tags: netgo
go: go version go1.14.2 darwin/amd64
cosmos_sdk: v0.37.9
tendermint: v0.32.10

Build Tags

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

Build Tag Description
netgo Name resolution will use pure Go code
ledger Ledger 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
Edit on GitHub