From 8e538815bf1a2462036b3fb1b2f1e4625604ff8c Mon Sep 17 00:00:00 2001 From: Hanjun Kim Date: Sun, 11 Aug 2024 21:41:41 +0900 Subject: [PATCH] fix: fix typos in autocli.go --- x/rewards/autocli.go | 16 +---- x/tickers/client/cli/query.go | 129 ---------------------------------- x/tickers/client/cli/tx.go | 23 ------ 3 files changed, 2 insertions(+), 166 deletions(-) delete mode 100644 x/tickers/client/cli/query.go delete mode 100644 x/tickers/client/cli/tx.go diff --git a/x/rewards/autocli.go b/x/rewards/autocli.go index 0371025b..94670c6f 100644 --- a/x/rewards/autocli.go +++ b/x/rewards/autocli.go @@ -18,19 +18,17 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { { RpcMethod: "Params", Use: "params", - Short: "Query the current rewards parameters.", + Short: "Query the current rewards parameters", }, { RpcMethod: "RewardsPlans", Use: "plans", Short: "Query all rewards plans", - Example: fmt.Sprintf(`$ %s query milkyway plans`, version.AppName), }, { RpcMethod: "RewardsPlan", Use: "plan [plan-id]", Short: "Query a specific rewards plan", - Example: fmt.Sprintf(`$ %s query milkyway plan [plan-id]`, version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "plan_id"}, }, @@ -39,7 +37,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "PoolOutstandingRewards", Use: "pool-outstanding-rewards [pool-id]", Short: "Query outstanding (un-withdrawn) rewards for a pool and all their delegations", - Example: fmt.Sprintf("$ %s query milkyway pool-outstanding-rewards [pool-id]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "pool_id"}, }, @@ -48,7 +45,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "OperatorOutstandingRewards", Use: "operator-outstanding-rewards [operator-id]", Short: "Query outstanding (un-withdrawn) rewards for a operator and all their delegations", - Example: fmt.Sprintf("$ %s query milkyway operator-outstanding-rewards [operator-id]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "operator_id"}, }, @@ -57,7 +53,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "ServiceOutstandingRewards", Use: "service-outstanding-rewards [service-id]", Short: "Query outstanding (un-withdrawn) rewards for a service and all their delegations", - Example: fmt.Sprintf("$ %s query milkyway service-outstanding-rewards [service-id]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "service_id"}, }, @@ -66,7 +61,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "OperatorCommission", Use: "operator-commission [operator-id]", Short: "Query operator commission", - Example: fmt.Sprintf("$ %s query milkyway operator-commission [operator-id]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "operator_id"}, }, @@ -75,7 +69,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "PoolDelegationRewards", Use: "pool-rewards [delegator-address] [pool-id]", Short: "Query all delegation rewards from a particular pool", - Example: fmt.Sprintf("$ %s query milkyway pool-rewards [delegator-address] [pool-id]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "delegator_address"}, {ProtoField: "pool_id"}, @@ -85,7 +78,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "OperatorDelegationRewards", Use: "operator-rewards [delegator-address] [operator-id]", Short: "Query all delegation rewards from a particular operator", - Example: fmt.Sprintf("$ %s query milkyway operator-rewards [delegator-address] [operator-id]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "delegator_address"}, {ProtoField: "operator_id"}, @@ -95,7 +87,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "ServiceDelegationRewards", Use: "service-rewards [delegator-address] [service-id]", Short: "Query all delegation rewards from a particular service", - Example: fmt.Sprintf("$ %s query milkyway service-rewards [delegator-address] [service-id]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "delegator_address"}, {ProtoField: "service_id"}, @@ -105,7 +96,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "DelegationTotalRewards", Use: "rewards [delegator-address]", Short: "Query all delegator rewards", - Example: fmt.Sprintf("$ %s query milkyway rewards [delegator-address]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "delegator_address"}, }, @@ -114,7 +104,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "DelegatorWithdrawAddress", Use: "delegator-withdraw-addr [delegator-address]", Short: "Query delegator withdraw address", - Example: fmt.Sprintf("$ %s query milkyway delegator-withdraw-addr [delegator-address]", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "delegator_address"}, }, @@ -129,7 +118,6 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "SetWithdrawAddress", Use: "set-withdraw-addr [withdraw-address]", Short: "Change the default withdraw address for rewards associated with an address", - Example: fmt.Sprintf("%s tx milkyway set-withdraw-addr [withdraw-address] --from mykey", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "withdraw_address"}, }, @@ -138,7 +126,7 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions { RpcMethod: "WithdrawDelegatorReward", Use: "withdraw-rewards [delegation-type] [target-id]", Short: "Withdraw rewards from a given delegation target", - Example: fmt.Sprintf("%s tx milkyway withdraw-rewards pool [pool-id] --from mykey", version.AppName), + Example: fmt.Sprintf("%s tx rewards withdraw-rewards pool [pool-id] --from mykey", version.AppName), PositionalArgs: []*autocliv1.PositionalArgDescriptor{ {ProtoField: "delegation_type"}, {ProtoField: "target_id"}, diff --git a/x/tickers/client/cli/query.go b/x/tickers/client/cli/query.go deleted file mode 100644 index 8c26d8c7..00000000 --- a/x/tickers/client/cli/query.go +++ /dev/null @@ -1,129 +0,0 @@ -package cli - -import ( - "context" - "fmt" - - "github.com/cosmos/cosmos-sdk/client" - "github.com/cosmos/cosmos-sdk/client/flags" - "github.com/cosmos/cosmos-sdk/version" - "github.com/spf13/cobra" - - "github.com/milkyway-labs/milkyway/x/tickers/types" -) - -// GetQueryCmd returns the command allowing to perform queries -func GetQueryCmd() *cobra.Command { - queryCmd := &cobra.Command{ - Use: types.ModuleName, - Short: fmt.Sprintf("Querying commands for the %s module", types.ModuleName), - DisableFlagParsing: true, - SuggestionsMinimumDistance: 2, - RunE: client.ValidateCmd, - } - - queryCmd.AddCommand( - GetCmdQueryParams(), - GetCmdQueryTicker(), - GetCmdQueryDenoms(), - ) - - return queryCmd -} - -// GetCmdQueryParams returns the command to query the module params -func GetCmdQueryParams() *cobra.Command { - cmd := &cobra.Command{ - Use: "params", - Short: "Query the module parameters", - Example: fmt.Sprintf(`%s query %s params`, version.AppName, types.ModuleName), - Args: cobra.NoArgs, - RunE: func(cmd *cobra.Command, args []string) error { - clientCtx, err := client.GetClientQueryContext(cmd) - if err != nil { - return err - } - queryClient := types.NewQueryClient(clientCtx) - - res, err := queryClient.Params(context.Background(), &types.QueryParamsRequest{}) - if err != nil { - return err - } - - return clientCtx.PrintProto(res) - }, - } - - flags.AddQueryFlagsToCmd(cmd) - - return cmd -} - -// GetCmdQueryTicker returns the command allowing to query the ticker by a denom -func GetCmdQueryTicker() *cobra.Command { - cmd := &cobra.Command{ - Use: "ticker [denom]", - Short: "Query the ticker of a given denom", - Example: fmt.Sprintf(`%s query %s ticker umilk`, version.AppName, types.ModuleName), - Args: cobra.ExactArgs(1), - RunE: func(cmd *cobra.Command, args []string) error { - clientCtx, err := client.GetClientQueryContext(cmd) - if err != nil { - return err - } - queryClient := types.NewQueryClient(clientCtx) - - denom := args[0] - - res, err := queryClient.Ticker(cmd.Context(), &types.QueryTickerRequest{Denom: denom}) - if err != nil { - return err - } - - return clientCtx.PrintProto(res) - }, - } - - flags.AddQueryFlagsToCmd(cmd) - - return cmd -} - -// GetCmdQueryDenoms returns the command allowing to query all the denoms for -// a given ticker -func GetCmdQueryDenoms() *cobra.Command { - cmd := &cobra.Command{ - Use: "denoms [ticker]", - Short: "Query all the denoms of a given ticker", - Example: fmt.Sprintf(`%s query %s denoms MILK`, version.AppName, types.ModuleName), - Args: cobra.ExactArgs(1), - RunE: func(cmd *cobra.Command, args []string) error { - clientCtx, err := client.GetClientQueryContext(cmd) - if err != nil { - return err - } - queryClient := types.NewQueryClient(clientCtx) - - ticker := args[0] - - pageReq, err := client.ReadPageRequest(cmd.Flags()) - if err != nil { - return err - } - - res, err := queryClient.Denoms(cmd.Context(), &types.QueryDenomsRequest{ - Ticker: ticker, Pagination: pageReq, - }) - if err != nil { - return err - } - - return clientCtx.PrintProto(res) - }, - } - - flags.AddQueryFlagsToCmd(cmd) - flags.AddPaginationFlagsToCmd(cmd, "denoms") - - return cmd -} diff --git a/x/tickers/client/cli/tx.go b/x/tickers/client/cli/tx.go deleted file mode 100644 index 4c45d69d..00000000 --- a/x/tickers/client/cli/tx.go +++ /dev/null @@ -1,23 +0,0 @@ -package cli - -import ( - "github.com/cosmos/cosmos-sdk/client" - "github.com/spf13/cobra" - - "github.com/milkyway-labs/milkyway/x/tickers/types" -) - -// GetTxCmd returns a new command to perform transactions -func GetTxCmd() *cobra.Command { - txCmd := &cobra.Command{ - Use: types.ModuleName, - Short: "Tickers transaction subcommands", - DisableFlagParsing: true, - SuggestionsMinimumDistance: 2, - RunE: client.ValidateCmd, - } - - txCmd.AddCommand() - - return txCmd -}