Skip to content

Commit

Permalink
Merge pull request #190 from terra-money/fix/wording
Browse files Browse the repository at this point in the history
Standardize CLI wording and compatibility matrix
  • Loading branch information
emidev98 authored May 5, 2023
2 parents 5beb406 + 7181ba4 commit 8f42ab3
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ Chains that want to add `x/alliance` must enable the following modules:
- [x/distribution](https://github.com/cosmos/cosmos-sdk/blob/main/x/distribution/README.md)
- [x/gov](https://github.com/cosmos/cosmos-sdk/blob/main/x/gov/README.md)

Compatibility matrix:

| Release | Branch | CosmosSDK |
|---------|----------------|-----------|
| v0.2.0 | release/v0.2.x | 0.47 |
| v0.1.0 | release/v0.1.x | 0.46 |

For an in-depth guide on integrating `x/alliance`, visit the [Alliance Module Integration Guide](https://alliance.terra.money/guides/get-started).

## Development environment
Expand Down
4 changes: 2 additions & 2 deletions x/alliance/client/cli/gov.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import (

func CreateAlliance() *cobra.Command {
cmd := &cobra.Command{
Use: "create-alliance denom rewards-weight rewards-weight-min rewards-weight-max take-rate reward-change-rate reward-change-interval",
Use: "create-alliance denom reward-weight reward-weight-min reward-weight-max take-rate reward-change-rate reward-change-interval",
Args: cobra.ExactArgs(7),
Short: "Create an alliance with the specified parameters",
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down Expand Up @@ -118,7 +118,7 @@ func CreateAlliance() *cobra.Command {

func UpdateAlliance() *cobra.Command {
cmd := &cobra.Command{
Use: "update-alliance denom rewards-weight take-rate reward-change-rate reward-change-interval",
Use: "update-alliance denom reward-weight take-rate reward-change-rate reward-change-interval",
Args: cobra.ExactArgs(5),
Short: "Update an alliance with the specified parameters",
RunE: func(cmd *cobra.Command, args []string) error {
Expand Down
12 changes: 6 additions & 6 deletions x/alliance/client/cli/tx.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ func NewDelegateCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "delegate [validator-addr] [amount]",
Args: cobra.ExactArgs(2),
Short: "Delegate alliance enabled tokens to a validator",
Short: "Delegate alliance-enabled tokens to a validator",
Long: strings.TrimSpace(
fmt.Sprintf(`Delegate an amount of liquid alliance enabled coins to a validator from your wallet.
fmt.Sprintf(`Delegate an amount of liquid alliance-enabled coins to a validator from your wallet.
Example:
$ %s tx alliance delegate %s1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm 1000stake --from mykey
Expand Down Expand Up @@ -79,9 +79,9 @@ func NewRedelegateCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "redelegate [src-validator-addr] [dst-validator-addr] [amount]",
Args: cobra.ExactArgs(3),
Short: "Re-delegate alliance enabled tokens from a validator to another",
Short: "Re-delegate alliance-enabled tokens from a validator to another",
Long: strings.TrimSpace(
fmt.Sprintf(`Re-delegate an amount of liquid alliance enabled coins from a validator to another from your wallet.
fmt.Sprintf(`Re-delegate an amount of liquid alliance-enabled coins from a validator to another from your wallet.
Example:
$ %s tx alliance redelegate %s1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm %ss1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm 1000stake --from mykey
Expand Down Expand Up @@ -133,9 +133,9 @@ func NewUndelegateCmd() *cobra.Command {
cmd := &cobra.Command{
Use: "undelegate validator-addr amount",
Args: cobra.ExactArgs(2),
Short: "Undelegate alliance enabled tokens to a validator",
Short: "Undelegate alliance-enabled tokens to a validator",
Long: strings.TrimSpace(
fmt.Sprintf(`Undelegate an amount of liquid alliance enabled coins from a validator to your wallet (after the unbonding period has passed).
fmt.Sprintf(`Undelegate an amount of liquid alliance-enabled coins from a validator to your wallet (after the unbonding period has passed).
Example:
$ %s tx alliance undelegate %s1l2rsakp388kuv9k8qzq6lrm9taddae7fpx59wm 1000stake --from mykey
Expand Down

0 comments on commit 8f42ab3

Please sign in to comment.