liquidstaking.md

Title	Description
Liquidstaking	A high-level overview of how the command-line interfaces (CLI) works for the liquidstaking module.

Liquidstaking Module

Synopsis

This document provides a high-level overview of how the command line (CLI) interface works for the liquidstaking module. To set up a local testing environment, it requires the latest Ignite CLI. If you don't have Ignite CLI set up in your local machine, see this guide to install it. Run this command under the project root directory $ ignite chain serve -c config-test.yml.

Note that jq is recommended to be installed as it is used to process JSON throughout the document.

Command Line Interfaces

• Transaction
  • LiquidStake
  • LiquidUnstake
• Query
  • Params
  • LiquidValidators
  • States
  • VotingPower

Transaction

LiquidStake

Liquid stake coin.

It requires whitelisted_validators to be registered. The config.yml file registers a single whitelist validator for testing purpose.

Usage

liquid-stake [amount]

Argument	Description
amount	amount of coin to liquid stake; it must be the bond denom

Example

squad tx liquidstaking liquid-stake 5000000000stake \
--chain-id localnet \
--from bob \
--keyring-backend test \
--gas 1000000 \
--broadcast-mode block \
--yes \
--output json | jq

#
# Tips
#
# Query account balances
# Notice the newly minted bToken
squad q bank balances cosmos1mzgucqnfr2l8cj5apvdpllhzt4zeuh2cshz5xu -o json | jq

# Query the voter's liquid staking voting power
squad q liquidstaking voting-power cosmos1mzgucqnfr2l8cj5apvdpllhzt4zeuh2cshz5xu -o json | jq

LiquidUnstake

Unstake coin.

Usage

liquid-unstake [amount]

Argument	Description
amount	amount of coin to unstake; it must be the bToken denom

Example

squad tx liquidstaking liquid-unstake 1000000000bstake \
--chain-id localnet \
--from bob \
--keyring-backend test \
--gas 1000000 \
--broadcast-mode block \
--yes \
--output json | jq

#
# Tips
#
# Query account balances
# Notice the newly minted bToken
squad q bank balances cosmos1mzgucqnfr2l8cj5apvdpllhzt4zeuh2cshz5xu -o json | jq

# Query the voter's liquid staking voting power
squad q liquidstaking voting-power cosmos1mzgucqnfr2l8cj5apvdpllhzt4zeuh2cshz5xu -o json | jq

Query

Params

Query the current liquidstaking parameters information.

Usage

params

Example

squad query liquidstaking params -o json | jq

LiquidValidators

Query all liquid validators.

Usage

liquid-validators

Example

squad query liquidstaking liquid-validators -o json | jq

States

Query net amount state.

Usage

states

Example

squad query liquidstaking states -o json | jq

VotingPower

Query the voter’s staking and liquid staking voting power.

Usage

voting-power [voter]

Argument	Description
voter	voter account address

Example

squad query liquidstaking voting-power cosmos1mzgucqnfr2l8cj5apvdpllhzt4zeuh2cshz5xu -o json | jq