Ultimate cyberd CLI guide. Testnet: Euler-3

savetheales (42)in #web3 • 5 years ago (edited)

687474703a2f2f692e696d6775722e636f6d2f697a753164384a2e706e67.png

If something wrong...

First of all I would like to encourage you to use --help feature if you want to get better experience of using cyberdcli. This is really easy way to find all necessary commands with options and flags.

For example you can enter:

docker exec cyberd cyberdcli --help

You should see this message:

Command line interface for interacting with cyberd

Usage:
  cyberdcli [command]

Available Commands:
  status      Query remote node for status
  query       Querying subcommands
  tx          Transactions subcommands

  keys        Add or view local private keys

  rest-server Start LCD (light-client daemon), a local REST server

  version     Print the app version
  link        Create and sign a link tx
  help        Help about any command

Flags:
      --chain-id string   Chain Id of cyberd node
  -e, --encoding string   Binary encoding (hex|b64|btc) (default "hex")
  -h, --help              help for cyberdcli
      --home string       directory for config and data (default "/root/.cyberdcli")
  -o, --output string     Output format (text|json) (default "text")
      --trace             print out full stack trace on errors

Help feature working as a stairs - you can use it with any command to find available options, subcommands and flags. For example lets explore query subcommands:

docker exec cyberd cyberdcli query --help

now, you can see subcommand structure:

Usage:
cyberdcli query [command]

and available subcommands and flags:

Available Commands:
tendermint-validator-set Get the full tendermint validator set at given height
block                    Get verified data for a the block at given height
txs                      Search for all transactions that match the given tags.
tx                       Matches this txhash over all committed blocks

account                  Query account balance
gov                      Querying commands for the governance module
distr                    Querying commands for the distribution module
staking                  Querying commands for the staking module
slashing                 Querying commands for the slashing module

Flags:
-h, --help   help for query

Global Flags:
    --chain-id string   Chain Id of cyberd node
-e, --encoding string   Binary encoding (hex|b64|btc) (default "hex")
    --home string       directory for config and data (default "/root/.cyberdcli")
-o, --output string     Output format (text|json) (default "text")
    --trace             print out full stack trace on errors

Alright, lets explore account subcommand:

docker exec cyberd cyberdcli query account --help

Now we see all options available at this subcommands, namely, account address and flags:

Usage:
cyberdcli query account [address] [flags]

In most cases you need just two extra flags:

--from=<your_key_name> \
--chain-id=<testnet_chain_id>

That it. This is very useful ability for using cyberdcli and troubleshooting.

Glossary

Bandwidth - The recovered unit of your account. Used to complete transactions in the cyberd blockchain. The amount of your bandwidth calculates like:

your_cyb_tokens / all_cyb_tokens_in_cyberd * 2000*1000*100.

Messages cost is 500 (exclude link). Transaction consists of one or more messages m_1, m_2, ..., m_n. Transaction cost is 300 + c_1 + c_2 ... + c_n, where c_i - cost of m_i message. Full bandwidth regeneration time is 86400 blocks (24 hours)

commission - tokens that you've earned with validation. You can take them at any time.

illiquid tokens - non-transferable tokens that you've delegated to the validator. Delegation process duration - 1 block. Unbonding process, or taking back share - 3 weeks.

link - reference between CID key and CID value. Link message cost is 100*n, where n is quantity of links in message. Link finalization time is 1 block. New rank for CIDs of link will be recalculated at period from 100 to 200 blocks (from 100 to 200 seconds).

liquid tokens - transferable tokens in cyberd blockchain

local keystore - store with keys in you local machine

rewards - tokens that you've earned with the delegation. To reduce network loads all rewards storing in a pool. You can take your part of bounty at any time by commands at delegator section.

<comission_rate_percentage> - the commission that validator get for the work. Must be fraction >0 and <=1

<delegator_address> - delegator address. Starts with cyber most often coinciding with <key_address>

<key_address> - account address. Starts with cyber

<key_name> - name of account in cybercli

<operator_address> - validator address. Starts with cybervaloper

<shares_percentage> - the part of illiquid tokens that you want to unbonding or redelegate. Must be fraction >0 and <=1

<testnet_chain_id> - version of testnet.

General commands

Show all validators

Return set of all active and jailed validators.

docker exec cyberd cyberdcli query staking validators --trust-node

Show chain status

Return general chain information

docker exec cyberd cyberdcli status --indent

Distribution params

docker exec cyberd cyberdcli query distr params --trust-node

The amount of outstanding rewards

Return the sum of rewards in a pool

docker exec cyberd cyberdcli query distr outstanding-rewards --trust-node

Staking params

Chain staking info

docker exec cyberd cyberdcli query staking params --trust-node

Staking pool

docker exec cyberd cyberdcli query staking pool --trust-node

Account management

Import an account by seed phrase and store it in local keystore

docker exec -ti cyberd cyberdcli keys add <your_key_name> --recover

Import an account by private key and store it in local keystore (private key could be your ETH private key)

docker exec -ti cyberd cyberdcli keys add import_private <your_key_name>

Create a new account

docker exec -ti cyberd cyberdcli keys add <your_key_name>

Show account information

Name, address and public key of current account

docker exec cyberd cyberdcli keys show <your_key_name>

Show account balance.

Return account number, balance, public key in 16 and sequence.

Don't work if from current account no outgoing transactions. Issue in progress

docker exec cyberd cyberdcli query account <your_key_address>

List existing keys

Return all keys in cyberdcli

docker exec cyberd cyberdcli keys list

Delete account from cybercli

docker exec -ti cyberd cyberdcli keys delete <deleting_key_name>

Update account password

docker exec -ti cyberd cyberdcli keys update <your_key_name>

Send tokens

docker exec -ti cyberd cyberdcli tx send <to_address> <amount_cyb> \
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Linking content

Just ipfs hashes available as a CID

docker exec -ti cyberd cyberdcli link \
  --from=<your_key_name> \
  --cid-from=<key_phrase_to_link> \
  --cid-to=<content_that_you_want_to_link> \
  --chain-id=<testnet_chain_id>

Validator commands

Get all validators

docker exec cyberd cyberdcli query staking validators \
    --trust-node

The amount of commission

Available to withdraw validator commission.

docker exec cyberd cyberdcli query distr commission <operator_address>

State of current validator

docker exec cyberd cyberdcli query staking validator <operator_address>

Return all delegations to validator

docker exec cyberd cyberdcli query staking delegations-to <operator_address>

Edit commission in existing validator account

docker exec -ti cyberd cyberdcli tx staking edit-validator \
  --from=<your_key_name> \
  --commission-rate=<new_comission_rate_percentage> \
  --chain-id=<testnet_chain_id>

Withdraw commission for either a delegation

docker exec -ti cyberd cyberdcli tx distr withdraw-rewards <operator_address> \
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id> \
  --commission

Edit site and description in existing validator account

Will be available at description section

docker exec -ti cyberd cyberdcli tx staking edit-validator \
  --from=<your_key_name> \
  --details="<description>" \
  --website=<your_website> \
  --chain-id=<testnet_chain_id>

Unjail validator previously jailed for downtime

docker exec -ti cyberd cyberdcli tx slashing unjail \
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Get info about redelegation process from validator

docker exec -ti cyberd cyberdcli query staking redelegations-from <operator_address>

Delegator commands

Return distribution delegator rewards according current validator

docker exec -ti cyberd cyberdcli query distr rewards <delegator_address> <operator_address>

Return delegator shares with current validator

docker exec -ti cyberd cyberdcli query staking delegation <delegator_address> <operator_address>

Return all delegations made from one delegator

docker exec -ti cyberd cyberdcli query staking delegations <delegator_address>

Return all unbonding delegatations from a validator

docker exec -ti cyberd cyberdcli query staking unbonding-delegations-from <operator_address>

Withdraw rewards for either a delegation

docker exec -ti cyberd cyberdcli tx distr withdraw-rewards <operator_address> \
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Withdraw all delegation rewards

docker exec -ti cyberd cyberdcli tx distr withdraw-all-rewards \
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Change the default withdraw address for rewards associated with an address

docker exec -ti cyberd cyberdcli tx distr set-withdraw-addr <your_new_address> \
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Delegate liquid tokens to a validator

docker exec -ti cyberd cyberdcli tx staking delegate <operator_address> <amount_cyb> \
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Redelegate illiquid tokens from one validator to another in absolute cyb value

3 weeks for redelegation. Amount must be less than already delegated.

docker exec -ti cyberd cyberdcli tx staking redelegate <old_operator_address> <new_operator_address> <amount_cyb>
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Redelegate illiquid tokens from one validator to another in percentages

3 weeks for redelegation.

docker exec -ti cyberd cyberdcli tx staking redelegate <old_operator_address> <new_operator_address> <shares_percentage>
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Unbond shares from a validator in absolute cyb value

3 weeks unbonding.

docker exec -ti cyberd cyberdcli tx staking unbond <operator_address> <amount_cyb>
  --from=<your_key_name> \
  --chain-id=<testnet_chain_id>

Unbond shares from a validator in percentages