Skip to content

Commit

Permalink
docs: update x/foundation documentation (Finschia#802)
Browse files Browse the repository at this point in the history
* Update descriptions in CLI

* Update x/foundation README.md

* Update CHANGELOG.md
  • Loading branch information
0Tech authored Nov 22, 2022
1 parent 12e60fc commit c973433
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,4 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Document Updates
* (docs) [\#766](https://github.com/line/lbm-sdk/pull/766) fix submit-proposal command on x/foundation
* (docs) [\#802](https://github.com/line/lbm-sdk/pull/802) update x/foundation documentation
14 changes: 7 additions & 7 deletions x/foundation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ Authorization) tuple.

The `MsgUpdateParams` can be used to update the parameters of `foundation`.

+++ https://github.com/line/lbm-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/tx.proto#L62-L71
+++ https://github.com/line/lbm-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L62-L71

It's expected to fail if:

Expand All @@ -361,7 +361,7 @@ It's expected to fail if:

The `MsgUpdateDecisionPolicy` can be used to update the decision policy.

+++ https://github.com/line/lbm-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/tx.proto#L110-L117
+++ https://github.com/line/lbm-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L111-L118

It's expected to fail if:

Expand All @@ -372,7 +372,7 @@ It's expected to fail if:

Foundation members can be updated with the `MsgUpdateMembers`.

+++ https://github.com/line/lbm-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/tx.proto#L97-L105
+++ https://github.com/line/lbm-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L98-L106

In the list of `MemberUpdates`, an existing member can be removed by setting
its `remove` flag to true.
Expand Down Expand Up @@ -456,7 +456,7 @@ If there is already a grant for the `(grantee, Authorization)` tuple, then the
new grant overwrites the previous one. To update or extend an existing grant, a
new grant with the same `(grantee, Authorization)` tuple should be created.

+++ https://github.com/line/lbm-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/tx.proto#L214-L222
+++ https://github.com/line/lbm-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L215-L224

The message handling should fail if:

Expand All @@ -471,7 +471,7 @@ The message handling should fail if:

A grant can be removed with the `MsgRevoke` message.

+++ https://github.com/line/lbm-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/tx.proto#L227-L232
+++ https://github.com/line/lbm-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L229-L235

The message handling should fail if:

Expand All @@ -489,7 +489,7 @@ Anyone can fund treasury with `MsgFundTreasury`.
The foundation can withdraw coins from the treasury with
`MsgWithdrawFromTreasury`.

+++ https://github.com/line/lbm-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/tx.proto#L86-L92
+++ https://github.com/line/lbm-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L86-L93

The message handling should fail if:

Expand All @@ -501,7 +501,7 @@ The message handling should fail if:

Massive minting is possible through 'MsgGovMint' up to 1 time after the chain is started.

+++ https://github.com/line/lbm-sdk/blob/66988a235a0e01f7a1ee76d719d585ff35f0d176/proto/lbm/foundation/v1/tx.proto#L221-L225
+++ https://github.com/line/lbm-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L240-L246

The message handling should fail if:

Expand Down
4 changes: 2 additions & 2 deletions x/foundation/client/cli/tx.go
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ Example of the content of messages-json:
}

flags.AddTxFlagsToCmd(cmd)
cmd.Flags().String(FlagExec, "", "Set to 1 to try to execute proposal immediately after creation")
cmd.Flags().String(FlagExec, "", "Set to 'try' to try to execute proposal immediately after creation (proposers signatures are considered as Yes votes)")

return cmd
}
Expand Down Expand Up @@ -564,7 +564,7 @@ Parameters:
}

flags.AddTxFlagsToCmd(cmd)
cmd.Flags().String(FlagExec, "", "Set to 1 to try to execute proposal immediately after voting")
cmd.Flags().String(FlagExec, "", "Set to 'try' to try to execute proposal immediately after voting")

return cmd
}
Expand Down

0 comments on commit c973433

Please sign in to comment.