docs: Add inline docs (#11992)
## Description Closes: #XXXX --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
This commit is contained in:
parent
55054282d2
commit
78cafeeb29
|
@ -95,6 +95,7 @@ $ %s query %s grants cosmos1skjw.. cosmos1skjwj.. %s
|
|||
return cmd
|
||||
}
|
||||
|
||||
// GetQueryGranterGrants returns cmd to query for all grants for a granter.
|
||||
func GetQueryGranterGrants() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "granter-grants [granter-addr]",
|
||||
|
@ -143,6 +144,7 @@ $ %s q %s granter-grants cosmos1skj..
|
|||
return cmd
|
||||
}
|
||||
|
||||
// GetQueryGranteeGrants returns cmd to query for all grants for a grantee.
|
||||
func GetQueryGranteeGrants() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "grantee-grants [grantee-addr]",
|
||||
|
|
|
@ -51,6 +51,7 @@ func GetTxCmd() *cobra.Command {
|
|||
return AuthorizationTxCmd
|
||||
}
|
||||
|
||||
// NewCmdGrantAuthorization returns a CLI command handler for creating a MsgGrant transaction.
|
||||
func NewCmdGrantAuthorization() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "grant <grantee> <authorization_type=\"send\"|\"generic\"|\"delegate\"|\"unbond\"|\"redelegate\"> --from <granter>",
|
||||
|
@ -199,6 +200,7 @@ func getExpireTime(cmd *cobra.Command) (*time.Time, error) {
|
|||
return &e, nil
|
||||
}
|
||||
|
||||
// NewCmdRevokeAuthorization returns a CLI command handler for creating a MsgRevoke transaction.
|
||||
func NewCmdRevokeAuthorization() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "revoke [grantee] [msg-type-url] --from=[granter]",
|
||||
|
@ -232,6 +234,7 @@ Example:
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewCmdExecAuthorization returns a CLI command handler for creating a MsgExec transaction.
|
||||
func NewCmdExecAuthorization() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "exec [tx-json-file] --from [grantee]",
|
||||
|
|
|
@ -74,6 +74,7 @@ func newSplitAndApply(
|
|||
return nil
|
||||
}
|
||||
|
||||
// NewWithdrawRewardsCmd returns a CLI command handler for creating a MsgWithdrawDelegatorReward transaction.
|
||||
func NewWithdrawRewardsCmd() *cobra.Command {
|
||||
bech32PrefixValAddr := sdk.GetConfig().GetBech32ValidatorAddrPrefix()
|
||||
|
||||
|
@ -119,6 +120,7 @@ $ %s tx distribution withdraw-rewards %s1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewWithdrawAllRewardsCmd returns a CLI command handler for creating a MsgWithdrawDelegatorReward transaction.
|
||||
func NewWithdrawAllRewardsCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "withdraw-all-rewards",
|
||||
|
@ -182,6 +184,7 @@ $ %[1]s tx distribution withdraw-all-rewards --from mykey
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewSetWithdrawAddrCmd returns a CLI command handler for creating a MsgSetWithdrawAddress transaction.
|
||||
func NewSetWithdrawAddrCmd() *cobra.Command {
|
||||
bech32PrefixAccAddr := sdk.GetConfig().GetBech32AccountAddrPrefix()
|
||||
|
||||
|
@ -220,6 +223,7 @@ $ %s tx distribution set-withdraw-addr %s1gghjut3ccd8ay0zduzj64hwre2fxs9ld75ru9p
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewFundCommunityPoolCmd returns a CLI command handler for creating a MsgFundCommunityPool transaction.
|
||||
func NewFundCommunityPoolCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "fund-community-pool [amount]",
|
||||
|
|
|
@ -24,6 +24,7 @@ func NewTxCmd() *cobra.Command {
|
|||
return slashingTxCmd
|
||||
}
|
||||
|
||||
// NewUnjailTxCmd returns a CLI command handler for creating a MsgUnjail transaction.
|
||||
func NewUnjailTxCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "unjail",
|
||||
|
|
|
@ -51,6 +51,7 @@ func NewTxCmd() *cobra.Command {
|
|||
return stakingTxCmd
|
||||
}
|
||||
|
||||
// NewCreateValidatorCmd returns a CLI command handler for creating a MsgCreateValidator transaction.
|
||||
func NewCreateValidatorCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "create-validator",
|
||||
|
@ -90,6 +91,7 @@ func NewCreateValidatorCmd() *cobra.Command {
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewEditValidatorCmd returns a CLI command handler for creating a MsgEditValidator transaction.
|
||||
func NewEditValidatorCmd() *cobra.Command {
|
||||
cmd := &cobra.Command{
|
||||
Use: "edit-validator",
|
||||
|
@ -145,6 +147,7 @@ func NewEditValidatorCmd() *cobra.Command {
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewDelegateCmd returns a CLI command handler for creating a MsgDelegate transaction.
|
||||
func NewDelegateCmd() *cobra.Command {
|
||||
bech32PrefixValAddr := sdk.GetConfig().GetBech32ValidatorAddrPrefix()
|
||||
|
||||
|
@ -188,6 +191,7 @@ $ %s tx staking delegate %s1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm 1000stake --f
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewRedelegateCmd returns a CLI command handler for creating a MsgBeginRedelegate transaction.
|
||||
func NewRedelegateCmd() *cobra.Command {
|
||||
bech32PrefixValAddr := sdk.GetConfig().GetBech32ValidatorAddrPrefix()
|
||||
|
||||
|
@ -236,6 +240,7 @@ $ %s tx staking redelegate %s1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj %s1l2rsakp3
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewUnbondCmd returns a CLI command handler for creating a MsgUndelegate transaction.
|
||||
func NewUnbondCmd() *cobra.Command {
|
||||
bech32PrefixValAddr := sdk.GetConfig().GetBech32ValidatorAddrPrefix()
|
||||
|
||||
|
@ -279,6 +284,7 @@ $ %s tx staking unbond %s1gghjut3ccd8ay0zduzj64hwre2fxs9ldmqhffj 100stake --from
|
|||
return cmd
|
||||
}
|
||||
|
||||
// NewCancelUnbondingDelegation returns a CLI command handler for creating a MsgCancelUnbondingDelegation transaction.
|
||||
func NewCancelUnbondingDelegation() *cobra.Command {
|
||||
bech32PrefixValAddr := sdk.GetConfig().GetBech32ValidatorAddrPrefix()
|
||||
|
||||
|
|
Loading…
Reference in New Issue