Skip to main content

CLI Cheatsheet

Chain ID: grimoria-testnet-1 | Current Node Version: v0.9.0

This cheatsheet collects commonly used CLI commands for node operators to easily copy and paste. A few conventions we follow:

  • Capitalized words indicate placeholders
  • Always use our own [NODERS]TEAM RPC endpoints
  • Always specify --chain-id and --node flags even when they are unnecessary
  • Query CLI command always uses --output json flag and pipes result through jq

Wallet generate and recover

Add new key

sided keys add KEY

Recover key (via existing mnemonic)

sided keys add KEY --recover

List all keys

sided keys list

Delete key

sided keys delete KEY

Wallet

Wallet balance

sided q bank balances $(sided keys show KEY -a) --node https://side-t-rpc.noders.services:443

Send

sided tx bank send YOUR_KEY RECEIVER_ADDRESS 1000000uside \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Withdraw rewards from all validators

sided tx distribution withdraw-all-rewards \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Withdraw Rewards including Commission

sided tx distribution withdraw-rewards VALIDATOR_ADRESS \
--commission \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Delegate tokens to yourself

sided tx staking delegate $(sided keys show KEY --bech val -a) 1000000uside \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Delegate tokens to validator

sided tx staking delegate VALIDATOR_ADDRESS 1000000uside \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Redelegate tokens to another validator

sided tx staking redelegate $(sided keys show KEY --bech val -a) VALIDATOR_ADDRESS 1000000uside \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Unbond tokens from your validator

sided tx staking unbond $(sided keys show KEY --bech val -a) uside \
--chain-id andromeda-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Governance

List of all proposals

sided query gov proposals --node https://side-t-rpc.noders.services:443

Check vote

sided query gov proposal PROPOSAL_NUMBER \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--output json | jq

Vote

Vote options:

  • yes
  • no
  • no_with_veto
  • abstain
sided tx gov vote PROPOSAL_NUMBER VOTE_OPTION \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Validator management

Create Validator

note

We use example filed values instead of capitalized dummy words for demo purpose in this command. Please make sure to adjust accordingly for your use.

sided tx staking create-validator \
--amount 1000000uside \
--commission-max-change-rate "0.05" \
--commission-max-rate "0.10" \
--commission-rate "0.05" \
--min-self-delegation "1" \
--pubkey=$(sided tendermint show-validator) \
--moniker '[NODERS]TEAM SERVICE' \
--website "https://noders.team" \
--identity "220491ADDD660741" \
--details "Trusted blockchain validator and web3 developer team" \
--security-contact="office@noders.team" \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Edit validator

sided tx staking edit-validator \
--new-moniker "YOUR_MONIKER_NAME" \
--identity "YOUR_KEYBASE_ID" \
--details "YOUR_DETAILS" \
--website "YOUR_WEBSITE_URL" \
--chain-id grimoria-testnet-1 \
--commission-rate 0.05 \
--from KEY \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \

Unjail

sided tx slashing unjail \
--chain-id grimoria-testnet-1 \
--node https://side-t-rpc.noders.services:443 --fees 3000uside \
--from KEY

Jail reason

sided query slashing signing-info $(sided tendermint show-validator)

Validator details

sided q staking validator $(sided keys show KEY --bech val -a)

Maintenance

Get validator info

sided status 2>&1 | jq .ValidatorInfo

Get sync info

sided status 2>&1 | jq .SyncInfo

Get node peer

echo $(sided tendermint show-node-id)'@'$(curl -s ifconfig.me)':'$(cat ~/.side/config/config.toml | sed -n '/Address to listen for incoming connection/{n;p;}' | sed 's/.*://; s/".*//')

Check if validator key is correct

[[ $(sided q staking validator $(sided keys show KEY --bech val -a) -oj | jq -r .consensus_pubkey.key) = $(sided status | jq -r .ValidatorInfo.PubKey.value) ]] && echo -e "\n\e[1m\e[32mTrue\e[0m\n" || echo -e "\n\e[1m\e[31mFalse\e[0m\n"

Get live peers

curl -sS https://side-t-rpc.noders.services:443/net_info | jq -r '.result.peers[] | "\(.node_info.id)@\(.remote_ip):\(.node_info.listen_addr)"' | awk -F ':' '{print $1":"$(NF)}'

Set minimum gas price

sed -i -e "s/^minimum-gas-prices *=.*/minimum-gas-prices = \"0.001uside\"/" ~/.side/config/app.toml

###Enable prometheus

sed -i -e "s/prometheus = false/prometheus = true/" ~/.side/config/config.toml

Reset chain data

sided tendermint unsafe-reset-all --keep-addr-book --home ~/.side

Service Management

Reload service configuration

sudo systemctl daemon-reload

Enable service

sudo systemctl enable sided

Disable service

sudo systemctl disable sided

Start service

sudo systemctl start sided

Stop service

sudo systemctl stop sided

Restart service

sudo systemctl restart sided

Check service status

sudo systemctl status sided

Check service logs

sudo journalctl -u sided -f --no-hostname -o cat

Remove node

cd $HOME
sudo systemctl stop sided
sudo systemctl disable sided
sudo rm /etc/systemd/system/sided.service
sudo systemctl daemon-reload
rm -f $(which sided)
rm -rf ~/.side
rm -rf $HOME/sideprotocol