193 lines
8.7 KiB
Go
193 lines
8.7 KiB
Go
package staking
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
|
|
_ "cosmossdk.io/api/cosmos/crypto/ed25519" // register to that it shows up in protoregistry.GlobalTypes
|
|
stakingv1beta "cosmossdk.io/api/cosmos/staking/v1beta1"
|
|
|
|
"github.com/cosmos/cosmos-sdk/version"
|
|
)
|
|
|
|
func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
|
|
return &autocliv1.ModuleOptions{
|
|
Query: &autocliv1.ServiceCommandDescriptor{
|
|
Service: stakingv1beta.Query_ServiceDesc.ServiceName,
|
|
RpcCommandOptions: []*autocliv1.RpcCommandOptions{
|
|
{
|
|
RpcMethod: "Validators",
|
|
Use: "validators",
|
|
Short: "Query for all validators",
|
|
Long: "Query details about all validators on a network.",
|
|
},
|
|
{
|
|
RpcMethod: "Validator",
|
|
Use: "validator <validator-addr>",
|
|
Short: "Query a validator",
|
|
Long: "Query details about an individual validator.",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "validator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "ValidatorDelegations",
|
|
Use: "delegations-to <validator-addr>",
|
|
Short: "Query all delegations made to one validator",
|
|
Long: "Query delegations on an individual validator.",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{
|
|
ProtoField: "validator_addr",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "ValidatorUnbondingDelegations",
|
|
Use: "unbonding-delegations-from <validator-addr>",
|
|
Short: "Query all unbonding delegatations from a validator",
|
|
Long: "Query delegations that are unbonding _from_ a validator.",
|
|
Example: fmt.Sprintf("$ %s query staking unbonding-delegations-from [val-addr]", version.AppName),
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "validator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "Delegation",
|
|
Use: "delegation <delegator-addr> <validator-addr>",
|
|
Short: "Query a delegation based on address and validator address",
|
|
Long: "Query delegations for an individual delegator on an individual validator",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "delegator_addr"},
|
|
{ProtoField: "validator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "UnbondingDelegation",
|
|
Use: "unbonding-delegation <delegator-addr> <validator-addr>",
|
|
Short: "Query an unbonding-delegation record based on delegator and validator address",
|
|
Long: "Query unbonding delegations for an individual delegator on an individual validator.",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "delegator_addr"},
|
|
{ProtoField: "validator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "DelegatorDelegations",
|
|
Use: "delegations <delegator-addr>",
|
|
Short: "Query all delegations made by one delegator",
|
|
Long: "Query delegations for an individual delegator on all validators.",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "delegator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "DelegatorValidators",
|
|
Use: "delegator-validators <delegator-addr>",
|
|
Short: "Query all validators info for given delegator address",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "delegator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "DelegatorValidator",
|
|
Use: "delegator-validator <delegator-addr> <validator-addr>",
|
|
Short: "Query validator info for given delegator validator pair",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "delegator_addr"},
|
|
{ProtoField: "validator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "DelegatorUnbondingDelegations",
|
|
Use: "unbonding-delegations <delegator-addr>",
|
|
Short: "Query all unbonding-delegations records for one delegator",
|
|
Long: "Query unbonding delegations for an individual delegator.",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "delegator_addr"},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "Redelegations",
|
|
Use: "redelegation <delegator-addr> <src-validator-addr> <dst-validator-addr>",
|
|
Short: "Query a redelegation record based on delegator and a source and destination validator address",
|
|
Long: "Query a redelegation record for an individual delegator between a source and destination validator.",
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{
|
|
{ProtoField: "delegator_addr"},
|
|
{ProtoField: "src_validator_addr"},
|
|
{ProtoField: "dst_validator_addr", Optional: true},
|
|
},
|
|
},
|
|
{
|
|
RpcMethod: "HistoricalInfo", // Deprecated query
|
|
Skip: true,
|
|
},
|
|
{
|
|
RpcMethod: "Pool",
|
|
Use: "pool",
|
|
Short: "Query the current staking pool values",
|
|
Long: "Query values for amounts stored in the staking pool.",
|
|
},
|
|
{
|
|
RpcMethod: "Params",
|
|
Use: "params",
|
|
Short: "Query the current staking parameters information",
|
|
Long: "Query values set as staking parameters.",
|
|
},
|
|
},
|
|
},
|
|
Tx: &autocliv1.ServiceCommandDescriptor{
|
|
Service: stakingv1beta.Msg_ServiceDesc.ServiceName,
|
|
RpcCommandOptions: []*autocliv1.RpcCommandOptions{
|
|
{
|
|
RpcMethod: "Delegate",
|
|
Use: "delegate <validator-addr> <amount> --from <delegator_address>",
|
|
Short: "Delegate liquid tokens to a validator",
|
|
Long: "Delegate an amount of liquid coins to a validator from your wallet.",
|
|
Example: fmt.Sprintf("%s tx staking delegate cosmosvaloper... 1000stake --from mykey", version.AppName),
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "validator_address"}, {ProtoField: "amount"}},
|
|
},
|
|
{
|
|
RpcMethod: "BeginRedelegate",
|
|
Use: "redelegate <src-validator-addr> <dst-validator-addr> <amount> --from <delegator>",
|
|
Short: "Generate multisig signatures for transactions generated offline",
|
|
Long: "Redelegate an amount of illiquid staking tokens from one validator to another.",
|
|
Example: fmt.Sprintf(`%s tx staking redelegate cosmosvaloper... cosmosvaloper... 100stake --from mykey`, version.AppName),
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "validator_src_address"}, {ProtoField: "validator_dst_address"}, {ProtoField: "amount"}},
|
|
},
|
|
{
|
|
RpcMethod: "Undelegate",
|
|
Use: "unbond <validator-addr> <amount> --from <delegator_address>",
|
|
Short: "Unbond shares from a validator",
|
|
Long: "Unbond an amount of bonded shares from a validator.",
|
|
Example: fmt.Sprintf(`%s tx staking unbond cosmosvaloper... 100stake --from mykey`, version.AppName),
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "validator_address"}, {ProtoField: "amount"}},
|
|
},
|
|
{
|
|
RpcMethod: "CancelUnbondingDelegation",
|
|
Use: "cancel-unbond <validator-addr> <amount> <creation-height>",
|
|
Short: "Cancel unbonding delegation and delegate back to the validator",
|
|
Example: fmt.Sprintf(`%s tx staking cancel-unbond cosmosvaloper... 100stake 2 --from mykey`, version.AppName),
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "validator_address"}, {ProtoField: "amount"}, {ProtoField: "creation_height"}},
|
|
},
|
|
{
|
|
RpcMethod: "RotateConsPubKey",
|
|
Use: "rotate-cons-pubkey <validator-address> <new-pubkey>",
|
|
Short: fmt.Sprintf("rotate validator consensus pub key. Note: you have to replace the `~/.%sd/config/priv_validator_key.json` with new key and restart the node after rotating the key", version.AppName),
|
|
Example: fmt.Sprintf(`%s tx staking rotate-cons-pubkey myvalidator {"@type":"/cosmos.crypto.ed25519.PubKey","key":"oWg2ISpLF405Jcm2vXV+2v4fnjodh6aafuIdeoW+rUw="}`, version.AppName),
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "validator_address"}, {ProtoField: "new_pubkey"}},
|
|
},
|
|
{
|
|
RpcMethod: "UpdateParams",
|
|
Use: "update-params-proposal <params>",
|
|
Short: "Submit a proposal to update staking module params. Note: the entire params must be provided.",
|
|
Long: fmt.Sprintf("Submit a proposal to update staking module params. Note: the entire params must be provided.\n See the fields to fill in by running `%s query staking params --output json`", version.AppName),
|
|
Example: fmt.Sprintf(`%s tx staking update-params-proposal '{ "unbonding_time": "504h0m0s", ... }'`, version.AppName),
|
|
PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "params"}},
|
|
GovProposal: true,
|
|
},
|
|
},
|
|
EnhanceCustomCommand: true,
|
|
},
|
|
}
|
|
}
|