Cheat Sheet

A Tendermint cheat sheet is a quick reference for essential commands to control Tendermint blockchains.

Managing keys

Managing keys on a Tendermint-based chain involves securing and controlling access to cryptographic keys used for chain operations.

Generate new key

sided keys add wallet --key-type="segwit"

Recover key

sided keys add wallet --recover --key-type="segwit"

List all key

sided keys list

Delete key

sided keys delete wallet

Export key

sided keys export wallet

Import key

sided keys import wallet wallet.backup

Query wallet balances

sided q bank balances $(sided keys show wallet -a)

Managing validators

Ensure you've updated moniker, identity, details, and website to match your values.

Create validator

sided tx staking create-validator \
--amount 1000000uside \
--pubkey $(sided tendermint show-validator) \
--moniker "your-moniker-name" \
--identity "your-keybase-id" \
--details "your-details" \
--website "your-website" \
--security-contact "your-email" \
--chain-id sidechain-testnet-4 \
--commission-rate 0.05 \
--commission-max-rate 0.20 \
--commission-max-change-rate 0.01 \
--min-self-delegation 1 \
--from wallet \
--gas-adjustment 1.4 \
--gas auto \
--gas-prices 0.005uside \
-y

Edit validator

sided tx staking edit-validator \
--new-moniker "your-moniker-name" \
--identity "your-keybase-id" \
--details "your-details" \
--website "your-website" \
--security-contact "your-email" \
--chain-id sidechain-testnet-4 \
--commission-rate 0.05 \
--from wallet \
--gas-adjustment 1.4 \
--gas auto \
--gas-prices 0.005uside \
-y

Unjail validator

sided tx slashing unjail --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Validator jail reason

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

List active validator

sided q staking validators -oj --limit=3000 | jq '.validators[] | select(.status=="BOND_STATUS_BONDED")' | jq -r '(.tokens|tonumber/pow(10; 6)|floor|tostring) + " \t " + .description.moniker' | sort -gr | nl

List incative validator

sided q staking validators -oj --limit=3000 | jq '.validators[] | select(.status=="BOND_STATUS_UNBONDED")' | jq -r '(.tokens|tonumber/pow(10; 6)|floor|tostring) + " \t " + .description.moniker' | sort -gr | nl

View validator details

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

Managing Tokens

Withdraw reward from all validator

sided tx distribution withdraw-all-rewards --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Withdraw reward and commission

sided tx distribution withdraw-rewards $(sided keys show wallet --bech val -a) --commission --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Delegate tokens to your validator

sided tx staking delegate $(sided keys show wallet --bech val -a) 1000000uside --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Delegate token to other validator, change <to-valoper-address> as you like

sided tx staking delegate <to-valoper-address> 1000000uside --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Redelegate to another validator

sided tx staking redelegate $(sided keys show wallet --bech val -a) <to-valoper-address> 1000000uside --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Unbond token from your own validator

sided tx staking unbond $(sided keys show wallet --bech val -a) 1000000uside --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Send token to the wallet

sided tx bank send wallet <to-wallet-address> 1000000uside --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Governance

Query list proposal

sided query gov proposals

View proposal by ID

sided query gov proposal 1

Vote option yes

sided tx gov vote 1 yes --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Vote option no

sided tx gov vote 1 no --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Vote option asbtain

sided tx gov vote 1 abstain --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Vote option NoWithVeto

sided tx gov vote 1 NoWithVeto --from wallet --chain-id sidechain-testnet-4 --gas-adjustment 1.4 --gas auto --gas-prices 0.005uside -y

Usefulness

Please note that updating the custom port is optional!

Update custom port

CUSTOM_PORT=238
sed -i -e "s%^proxy_app = \"tcp://127.0.0.1:26658\"%proxy_app = \"tcp://127.0.0.1:${CUSTOM_PORT}58\"%; s%^laddr = \"tcp://127.0.0.1:26657\"%laddr = \"tcp://127.0.0.1:${CUSTOM_PORT}57\"%; s%^pprof_laddr = \"localhost:6060\"%pprof_laddr = \"localhost:${CUSTOM_PORT}60\"%; s%^laddr = \"tcp://0.0.0.0:26656\"%laddr = \"tcp://0.0.0.0:${CUSTOM_PORT}56\"%; s%^prometheus_listen_addr = \":26660\"%prometheus_listen_addr = \":${CUSTOM_PORT}66\"%" $HOME/.side/config/config.toml
sed -i -e "s%^address = \"tcp://0.0.0.0:1317\"%address = \"tcp://0.0.0.0:${CUSTOM_PORT}17\"%; s%^address = \":8080\"%address = \":${CUSTOM_PORT}80\"%; s%^address = \"0.0.0.0:9090\"%address = \"0.0.0.0:${CUSTOM_PORT}90\"%; s%^address = \"0.0.0.0:9091\"%address = \"0.0.0.0:${CUSTOM_PORT}91\"%" $HOME/.side/config/app.toml

Disable indexer

sed -i -e 's|^indexer *=.*|indexer = "null"|' $HOME/.side/config/config.toml

Enable indexer

sed -i -e 's|^indexer *=.*|indexer = "kv"|' $HOME/.side/config/config.toml

Pruning update

sed -i \
  -e 's|^pruning *=.*|pruning = "custom"|' \
  -e 's|^pruning-keep-recent *=.*|pruning-keep-recent = "100"|' \
  -e 's|^pruning-keep-every *=.*|pruning-keep-every = "0"|' \
  -e 's|^pruning-interval *=.*|pruning-interval = "19"|' \
  $HOME/.side/config/app.toml

Maintenance

Get validator information

sided status 2>&1 | jq .ValidatorInfo

Get sync information

sided status 2>&1 | jq .SyncInfo

Get node peer

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

Check validator keys

[[ $(sided q staking validator $(sided keys show wallet --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 http://localhost:23857/net_info | jq -r '.result.peers[] | "\(.node_info.id)@\(.remote_ip):\(.node_info.listen_addr)"' | awk -F ':' '{print $1":"$(NF)}'

Configure minimum gas prices

sed -i -e "s/^minimum-gas-prices *=.*/minimum-gas-prices = \"0aseda\"/" $HOME/.side/config/app.toml

Enable prometheus

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

Reset chain data

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

🚨

Before moving on to the next step, be aware that all chain data will be erased. Ensure you've created a backup of your priv_validator_key.json!

Remove node

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

⚡️ State Sync 🌎 Public RPC