Delegator Guide (CLI)

This document contains all the necessary information for delegators to interact with the OKExChain through the Command-Line Interface (CLI).

NOTE: Please assure that you follow the steps described hereinafter carefully, as negligence in this significant process could lead to an indefinite loss of your okts. Therefore, read through the following instructions in their entirety prior to proceeding and reach out to us in case you need support.

Please also note that you are about to interact with the OKExChain, a blockchain technology containing highly experimental software. While the blockchain has been developed in accordance to the state of the art and audited with utmost care, we can nevertheless expect to have issues, updates and bugs. Furthermore, interaction with blockchain technology requires advanced technical skills and always entails risks that are outside our control. By using the software, you confirm that you understand the inherent risks associated with cryptographic software. Any use of this open source software released under the Apache 2.0 license is done at your own risk and on a “AS IS” basis, without warranties or conditions of any kind.

Please exercise extreme caution!

Installing okexchaincli

okexchaincli: This is the command-line interface to interact with a okexchaind full-node.

NOTE: Please check that you download the latest stable release of okexchaincli that is available

[Download the binaries] Not available yet.

Install from source

okexchaincli is used from a terminal. To open the terminal, follow these steps:

  • Windows: Start > All Programs > Accessories > Command Prompt

  • MacOS: Finder > Applications > Utilities > Terminal

  • Linux: Ctrl + Alt + T

OKExChain Accounts

At the core of every OKExChain account, there is a seed, which takes the form of a 12-words mnemonic. From this mnemonic, it is possible to create any number of OKExChain accounts, i.e. pairs of private key/public key. This is called an HD wallet (see BIP32 for more information on the HD wallet specification).

     Account 0                         Account 1                         Account 2

+------------------+              +------------------+               +------------------+
|                  |              |                  |               |                  |
|    Address 0     |              |    Address 1     |               |    Address 2     |
|        ^         |              |        ^         |               |        ^         |
|        |         |              |        |         |               |        |         |
|        |         |              |        |         |               |        |         |
|        |         |              |        |         |               |        |         |
|        +         |              |        +         |               |        +         |
|  Public key 0    |              |  Public key 1    |               |  Public key 2    |
|        ^         |              |        ^         |               |        ^         |
|        |         |              |        |         |               |        |         |
|        |         |              |        |         |               |        |         |
|        |         |              |        |         |               |        |         |
|        +         |              |        +         |               |        +         |
|  Private key 0   |              |  Private key 1   |               |  Private key 2   |
|        ^         |              |        ^         |               |        ^         |
+------------------+              +------------------+               +------------------+
         |                                 |                                  |
         |                                 |                                  |
         |                                 |                                  |
                                 |                   |
                                 |  Mnemonic (Seed)  |
                                 |                   |

The funds stored in an account are controlled by the private key. This private key is generated using a one-way function from the mnemonic. If you lose the private key, you can retrieve it using the mnemonic. However, if you lose the mnemonic, you will lose access to all the derived private keys. Likewise, if someone gains access to your mnemonic, they gain access to all the associated accounts.

NOTE: Do not lose or share your 12 words with anyone. To prevent theft or loss of funds, it is best to ensure that you keep multiple copies of your mnemonic, and store it in a safe, secure place and that only you know how to access. If someone is able to gain access to your mnemonic, they will be able to gain access to your private keys and control the accounts associated with them.

The address is a public string with a human-readable prefix (e.g. okchain1e9mh6ypht7ncfc482qcl0tj2q6j84fkqtl4x9k) that identifies your account. When someone wants to send you funds, they send it to your address. It is computationally infeasible to find the private key associated with a given address.

Creating an Account

To create an account, you just need to have okexchaincli installed. Before creating it, you need to know where you intend to store and interact with your private keys. The best options are to store them in an offline dedicated computer or a ledger device. Storing them on your regular online computer involves more risk, since anyone who infiltrates your computer through the internet could exfiltrate your private keys and steal your funds.

NOTE: It is more secure to perform this action on an offline computer**

To generate an account, just use the following command:

okexchaincli keys add <yourKeyName>

The command will generate a 24-words mnemonic and save the private and public keys for account 0 at the same time. Each time you want to send a transaction, you will need to unlock your system’s credentials store. If you lose access to your credentials storage, you can always recover the private key with the mnemonic.

You may not be prompted for password each time you send a transaction since most operating systems unlock user’s credentials store upon login by default. If you want to change your credentials store security policies please refer to your operating system manual.
Do not lose or share your 12 words with anyone. To prevent theft or loss of funds, it is best to ensure that you keep multiple copies of your mnemonic, and store it in a safe, secure place and that only you know how to access. If someone is able to gain access to your mnemonic, they will be able to gain access to your private keys and control the accounts associated with them.

After you have secured your mnemonic (triple check!), you can delete bash history to ensure no one can retrieve it:

history -c
rm ~/.bash_history
  • <yourKeyName> is the name of the account. It is a reference to the account number used to derive the key pair from the mnemonic. You will use this name to identify your account when you want to send a transaction.

  • You can add the optional --account flag to specify the path (0, 1, 2, …) you want to use to generate your account. By default, account 0 is generated.

You can generate more accounts from the same mnemonic using the following command:

okexchaincli keys add <yourKeyName> --recover --account 1

This command will prompt you to input a passphrase as well as your mnemonic. Change the account number to generate a different account.

Accessing the OKExChain Network

In order to query the state and send transactions, you need a way to access the network. To do so, you can either run your own full-node, or connect to someone else’s.

NOTE: Do not share your mnemonic (12 or 24 words) with anyone. The only person who should ever need to know it is you. This is especially important if you are ever approached via email or direct message by someone requesting that you share your mnemonic for any kind of blockchain services or support. No one from OKExChain, the Tendermint team or the Interchain Foundation will ever send an email that asks for you to share any kind of account credentials or your mnemonic.”**.

Running Your Own Full-Node

This is the most secure option, but comes with relatively high resource requirements. In order to run your own full-node, you need good bandwidth and at least 1TB of disk space.

You will find the tutorial on how to install okexchaind here, and the guide to run a full-node here.

Connecting to a Remote Full-Node

If you do not want or cannot run your own node, you can connect to someone else’s full-node. You should pick an operator you trust, because a malicious operator could return incorrect query results or censor your transactions. However, they will never be able to steal your funds, as your private keys are stored locally on your computer or ledger device. Possible options of full-node operators include validators, wallet providers or exchanges.

In order to connect to the full-node, you will need an address of the following form: (Note: This is a placeholder). This address has to be communicated by the full-node operator you choose to trust. You will use this address in the following section.

Setting Up okexchaincli

Before setting up okexchaincli, make sure you have set up a way to access the OKExChain network

Please check that you are always using the latest stable release of okexchaincli

okexchaincli is the tool that enables you to interact with the node that runs on the OKExChain network, whether you run it yourself or not. Let us set it up properly.

In order to set up okexchaincli, use the following command:

okexchaincli config <flag> <value>

It allows you to set a default value for each given flag.

First, set up the address of the full-node you want to connect to:

okexchaincli config node <host>:<port

// example: okexchaincli config node

If you run your own full-node, just use tcp://localhost:26657 as the address.

Then, let us set the default value of the --trust-node flag:

okexchaincli config trust-node false

// Set to true if you run a light-client node, false otherwise

Finally, let us set the chain-id of the blockchain we want to interact with:

okexchaincli config chain-id okexchain-testnet1

Querying the State

Before you can bond okts and withdraw rewards, you need to set up okexchaincli

okexchaincli lets you query all relevant information from the blockchain, like account balances, amount of bonded tokens, outstanding rewards, governance proposals and more. Next is a list of the most useful commands for delegator.

// query account balances and other account-related information
okexchaincli query account <yourAddress>

// query the list of validators
okexchaincli query staking validators

// query the information of a validator given their address (e.g. okchainvaloper1alq9na49n9yycysh889rl90g9nhe58lcs50wu5)
okexchaincli query staking validator <validatorAddress>

// query all information of delegations and all shares recently added by a delegator (e.g. okchain1hw4r48aww06ldrfeuq2v438ujnl6alszzzqpph)
okexchaincli query staking delegator <delegatorAddress>

// query the information of all shares recently added to a validator (e.g. okchainvaloper1alq9na49n9yycysh889rl90g9nhe58lcs50wu5) 
okexchaincli query staking shares-added-to <validatorAddress>

// query the addresses of delegators by a specific proxy (e.g. okchain1hw4r48aww06ldrfeuq2v438ujnl6alszzzqpph) 
okexchaincli query staking proxy <proxyAddress> 

// query all proposals currently open for depositing
okexchaincli query gov proposals --status deposit_period

// query all proposals currently open for voting
okexchaincli query gov proposals --status voting_period

// query a proposal given its proposalID
okexchaincli query gov proposal <proposalID>

For more commands, just type:

okexchaincli query

For each command, you can use the -h or --help flag to get more information.

Sending Transactions

On OKExChain testnet, the accepted denom is tokt, If you need to get tokt, you can get it here.

A Note on Gas and Fees

Transactions on the OKExChain network need to include a transaction fee in order to be processed. This fee pays for the gas required to run the transaction. The formula is the following:

fees = ceil(gas * gasPrices)

The gas is dependent on the transaction. Different transaction require different amount of gas. The gas amount for a transaction is calculated as it is being processed, but there is a way to estimate it beforehand by using the auto value for the gas flag. Of course, this only gives an estimate. You can adjust this estimate with the flag --gas-adjustment (default 1.0) if you want to be sure you provide enough gas for the transaction. For the remainder of this tutorial, we will use a --gas-adjustment of 1.5.

The gasPrice is the price of each unit of gas. Each validator sets a min-gas-price value, and will only include transactions that have a gasPrice greater than their min-gas-price.

The transaction fees are the product of gas and gasPrice. As a user, you have to input 2 out of 3. The higher the gasPrice/fees, the higher the chance that your transaction will get included in a block.

For testnet, the recommended gas-prices is 0.005tokt.

Sending Tokens

Before you can bond okts and withdraw rewards, you need to set up okexchaincli and create an account

NOTE: These commands need to be run on an online computer. It is more secure to perform them commands using a Ledger Nano S device. For the offline procedure, click here.**

// Send a certain amount of tokens to an address

// Ex value for parameters (do not actually use these values in your tx!!): <to_address>=okchain1hw4r48aww06ldrfeuq2v438ujnl6alszzzqpph <amount>=1024okt 
// Ex value for flags: <gasPrice>=0.005okt

okexchaincli tx send <from_key_or_address> <to_address> <amount> --from <yourKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>

Bonding okts and Withdrawing Rewards

Before you can bond okts and withdraw rewards, you need to set up okexchaincli and create an account

Before bonding okts, please read the delegator faq to understand the risk and responsibilities involved with delegating

NOTE: These commands need to be run on an online computer. It is more secure to perform them commands using a ledger device. For the offline procedure, click here.**

// Deposit an amount of okt to delegator account. Deposited okt in delegator account is a prerequisite for adding shares
// ex value for flags: <amountToDeposit>=1024okt, <gasPrice>=0.005okt

okexchaincli tx staking deposit <amountToDeposit> --from <delegatorKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>

// Add shares to one or more validators by all deposited okt
// ex value for flags: <validator-addr1, validator-addr2, validator-addr3, ... validator-addrN>=okchainvaloper1alq9na49n9yycysh889rl90g9nhe58lcs50wu5,okchainvaloper1svzxp4ts5le2s4zugx34ajt6shz2hg42a3gl7g,okchainvaloper10q0rk5qnyag7wfvvt7rtphlw589m7frs863s3m,okchainvaloper1g7znsf24w4jc3xfca88pq9kmlyjdare6mph5rx, <gasPrice>=0.005okt

okexchaincli tx staking add-shares <validator-addr1, validator-addr2, validator-addr3, ... validator-addrN> --from <delegatorKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>

// Withdraw an amount of okt and the corresponding shares from all validators.
// You will have to wait 3 weeks before your okts are fully unbonded and transferrable 
// ex value for flags: <amountToWithdraw>=1024okt, <gasPrice>=0.005okt

okexchaincli tx staking withdraw <amountToWithdraw> --from <delegatorKeyName> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice>

NOTE: If you use a connected Ledger, you will be asked to confirm the transaction on the device before it is signed and broadcast to the network. Note that the command will only work while the Ledger is plugged in and unlocked.

To confirm that your transaction went through, you can use the following queries:

// your balance should change after you bond okts or withdraw rewards
okexchaincli query account

// you should have delegations after you bond okt
okexchaincli query staking delegator <delegatorAddress>

// this returns your tx if it has been included
// use the tx hash that was displayed when you created the tx
okexchaincli query tx <txHash>

Double check with a block explorer if you interact with the network through a trusted full-node.

Participating in Governance

Primer on Governance

The OKExChain has a built-in governance system that lets bonded okt holders vote on proposals. There are three types of proposal:

  • Text Proposals: These are the most basic type of proposals. They can be used to get the opinion of the network on a given topic.

  • Parameter Proposals: These are used to update the value of an existing parameter.

  • Software Upgrade Proposal: These are used to propose an upgrade of the Hub’s software.

Any okt holder can submit a proposal. In order for the proposal to be open for voting, it needs to come with a deposit that is greater than a parameter called minDeposit. The deposit need not be provided in its entirety by the submitter. If the initial proposer’s deposit is not sufficient, the proposal enters the deposit_period status. Then, any okt holder can increase the deposit by sending a depositTx.

Once the deposit reaches minDeposit, the proposal enters the voting_period, which lasts 2 weeks. Any bonded okt holder can then cast a vote on this proposal. The options are Yes, No, NoWithVeto and Abstain. The weight of the vote is based on the amount of bonded okts of the sender. If they don’t vote, delegator inherit the vote of their validator. However, delegators can override their validator’s vote by sending a vote themselves.

At the end of the voting period, the proposal is accepted if there are more than 50% Yes votes (excluding Abstain votes) and less than 33.33% of NoWithVeto votes (excluding Abstain votes).

In Practice

Before you can bond okts and withdraw rewards, you need to bond okts

NOTE: These commands need to be run on an online computer. It is more secure to perform them commands using a ledger device. For the offline procedure, click here.**

// Submit a Proposal
// <type>=text/parameter_change/software_upgrade
// ex value for flag: <gasPrice>=0.005okt

okexchaincli tx gov submit-proposal --title "Test Proposal" --description "My awesome proposal" --type <type> --deposit=100okt --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --from <delegatorKeyName>

// Increase deposit of a proposal
// Retrieve proposalID from $okexchaincli query gov proposals --status deposit_period
// ex value for parameter: <deposit>=100okt

okexchaincli tx gov deposit <proposalID> <deposit> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --from <delegatorKeyName>

// Vote on a proposal
// Retrieve proposalID from $okexchaincli query gov proposals --status voting_period 
// <option>=yes/no/no_with_veto/abstain

okexchaincli tx gov vote <proposalID> <option> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --from <delegatorKeyName>

Signing Transactions From an Offline Computer

If you do not have a ledger device and want to interact with your private key on an offline computer, you can use the following procedure. First, generate an unsigned transaction on an online computer with the following command (example with a bonding transaction):

// Bond okts 
// ex value for flags: <amountToDeposit>=1024okt, <gasPrice>=0.005okt, <delegatorAddress>=okchain1hw4r48aww06ldrfeuq2v438ujnl6alszzzqpph

okexchaincli tx staking deposit <amountToDeposit> --from <delegatorAddress> --gas auto --gas-adjustment 1.5 --gas-prices <gasPrice> --generate-only > unsignedTX.json

In order to sign, you will also need the chain-id, account-number and sequence. The chain-id is a unique identifier for the blockchain on which you are submitting the transaction. The account-number is an identifier generated when your account first receives funds. The sequence number is used to keep track of the number of transactions you have sent and prevent replay attacks.

Get the chain-id from the genesis file (okexchain), and the two other fields using the account query:

okexchaincli query account <yourAddress> --chain-id okexchain-testnet1

Then, copy unsignedTx.json and transfer it (e.g. via USB) to the offline computer. If it is not done already, create an account on the offline computer. For additional security, you can double check the parameters of your transaction before signing it using the following command:

cat unsignedTx.json

Now, sign the transaction using the following command. You will need the chain-id, sequence and account-number obtained earlier:

okexchaincli tx sign unsignedTx.json --from <delegatorKeyName> --offline --chain-id okexchain-testnet1 --sequence <sequence> --account-number <account-number> > signedTx.json

Copy signedTx.json and transfer it back to the online computer. Finally, use the following command to broadcast the transaction:

okexchaincli tx broadcast signedTx.json