feat(staking): add autocli query cmd (#16641)

Co-authored-by: Julien Robert <julien@rbrt.fr>
cosmos · Jul 7, 2023 · 5aaadf7 · 5aaadf7
1 parent a897642
commit 5aaadf7
Show file tree

Hide file tree

Showing 4 changed files with 148 additions and 1,303 deletions.
diff --git a/x/staking/autocli.go b/x/staking/autocli.go
@@ -0,0 +1,147 @@
+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",
+					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"},
+					},
+				},
+				{
+					RpcMethod: "HistoricalInfo",
+					Use:       "historical-info [height]",
+					Short:     "Query historical info at given height",
+					Long:      "Query historical info at given height.",
+					Example:   fmt.Sprintf("$ %s query staking historical-info 5", version.AppName),
+					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
+						{ProtoField: "height"},
+					},
+				},
+				{
+					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,
+		},
+	}
+}