From fd97fa880fd138f19dc452536aceb3f1a5bc6166 Mon Sep 17 00:00:00 2001 From: Noam <81436914+nooomski@users.noreply.github.com> Date: Fri, 8 Apr 2022 15:01:43 +0200 Subject: [PATCH] docs: update groups spec & cli instructions (#11516) ## Description Fixes group spec and CLI instructions that were still using timeout instead of voting_period ### 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/master/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/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/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) --- x/group/client/cli/tx.go | 10 +++-- x/group/spec/05_client.md | 92 ++++++++++++++++++++++++++++----------- 2 files changed, 73 insertions(+), 29 deletions(-) diff --git a/x/group/client/cli/tx.go b/x/group/client/cli/tx.go index ff92542e9..b4409aeb4 100644 --- a/x/group/client/cli/tx.go +++ b/x/group/client/cli/tx.go @@ -290,7 +290,8 @@ If group-policy-as-admin flag is set to true, the admin of the newly created gro Example: $ %s tx group create-group-with-policy [admin] [group-metadata] [group-policy-metadata] [members-json-file] \ -'{"@type":"/cosmos.group.v1.ThresholdDecisionPolicy", "threshold":"1", "timeout":"1s"}' +'{"@type":"/cosmos.group.v1.ThresholdDecisionPolicy", "threshold":"1", \ +"windows": {"voting_period": "120h", "min_execution_period": "0s"}}' where members.json contains: @@ -378,10 +379,11 @@ Note, the '--from' flag is ignored as it is implied from [admin]. Example: $ %s tx group create-group-policy [admin] [group-id] [metadata] \ -'{"@type":"/cosmos.group.v1.ThresholdDecisionPolicy", "threshold":"1", "timeout":"1s"}' +'{"@type":"/cosmos.group.v1.ThresholdDecisionPolicy", "threshold":"1", \ +"windows": {"voting_period": "120h", "min_execution_period": "0s"}}' Here, we can use percentage decision policy when needed, where 0 < percentage <= 1. -Ex: '{"@type":"/cosmos.group.v1.PercentageDecisionPolicy", "percentage":"0.5", "timeout":"1s"}' +Ex: '{"@type":"/cosmos.group.v1.PercentageDecisionPolicy", "percentage":"0.5", "windows": {"voting_period": "120h", "min_execution_period": "0s"}} `, version.AppName, ), @@ -560,7 +562,7 @@ Parameters: msg_tx_json_file: path to json file with messages that will be executed if the proposal is accepted. Example: - $ %s tx gov submit-proposal path/to/proposal.json + $ %s tx group submit-proposal path/to/proposal.json Where proposal.json contains: diff --git a/x/group/spec/05_client.md b/x/group/spec/05_client.md index 97db94944..db72e10c0 100644 --- a/x/group/spec/05_client.md +++ b/x/group/spec/05_client.md @@ -1,7 +1,8 @@ - +'{"@type":"/cosmos.group.v1.ThresholdDecisionPolicy", "threshold":"1", \ +"windows": {"voting_period": "120h", "min_execution_period": "0s"}}' # Client ## CLI @@ -62,7 +63,9 @@ admin: cosmos1.. decision_policy: '@type': /cosmos.group.v1beta1.ThresholdDecisionPolicy threshold: "1" - timeout: 600s + windows: + min_execution_period: 0s + voting_period: 432000s group_id: "1" metadata: AQ== version: "1" @@ -157,7 +160,9 @@ group_policies: decision_policy: '@type': /cosmos.group.v1beta1.ThresholdDecisionPolicy threshold: "1" - timeout: 600s + windows: + min_execution_period: 0s + voting_period: 432000s group_id: "1" metadata: AQ== version: "1" @@ -166,7 +171,9 @@ group_policies: decision_policy: '@type': /cosmos.group.v1beta1.ThresholdDecisionPolicy threshold: "1" - timeout: 600s + windows: + min_execution_period: 0s + voting_period: 432000s group_id: "1" metadata: AQ== version: "1" @@ -198,7 +205,9 @@ group_policies: decision_policy: '@type': /cosmos.group.v1beta1.ThresholdDecisionPolicy threshold: "1" - timeout: 600s + windows: + min_execution_period: 0s + voting_period: 432000s group_id: "1" metadata: AQ== version: "1" @@ -207,7 +216,9 @@ group_policies: decision_policy: '@type': /cosmos.group.v1beta1.ThresholdDecisionPolicy threshold: "1" - timeout: 600s + windows: + min_execution_period: 0s + voting_period: 432000s group_id: "1" metadata: AQ== version: "1" @@ -252,7 +263,9 @@ proposal: result: RESULT_UNFINALIZED status: STATUS_SUBMITTED submitted_at: "2021-12-17T07:06:26.310638964Z" - timeout: "2021-12-17T07:06:27.310638964Z" + windows: + min_execution_period: 0s + voting_period: 432000s vote_state: abstain_count: "0" no_count: "0" @@ -299,7 +312,9 @@ proposals: result: RESULT_UNFINALIZED status: STATUS_SUBMITTED submitted_at: "2021-12-17T07:06:26.310638964Z" - timeout: "2021-12-17T07:06:27.310638964Z" + windows: + min_execution_period: 0s + voting_period: 432000s vote_state: abstain_count: "0" no_count: "0" @@ -464,7 +479,7 @@ simd tx group create-group-policy [admin] [group-id] [metadata] [decision-policy Example: ```bash -simd tx group create-group-policy cosmos1.. 1 "AQ==" '{"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold":"1", "timeout":"600s"}' +simd tx group create-group-policy cosmos1.. 1 "AQ==" '{"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold":"1", "windows": {"voting_period": "120h", "min_execution_period": "0s"}}' ``` @@ -479,7 +494,7 @@ simd tx group create-group-with-policy [admin] [group-metadata] [group-policy-me Example: ```bash -simd tx group create-group-with-policy cosmos1.. "AQ==" "AQ==" members.json '{"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold":"1", "timeout":"600s"}' +simd tx group create-group-with-policy cosmos1.. "AQ==" "AQ==" members.json '{"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold":"1", "windows": {"voting_period": "120h", "min_execution_period": "0s"}}' ``` #### update-group-policy-admin @@ -521,7 +536,7 @@ simd tx group update-group-policy-decision-policy [admin] [group-policy-account Example: ```bash -simd tx group update-group-policy-decision-policy cosmos1.. cosmos1.. '{"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold":"2", "timeout":"1000s"}' +simd tx group update-group-policy-decision-policy cosmos1.. cosmos1.. '{"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold":"2", "windows": {"voting_period": "120h", "min_execution_period": "0s"}}' ``` #### create-proposal @@ -652,7 +667,7 @@ Example Output: "groupId": "1", "admin": "cosmos1..", "version": "1", - "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","timeout":"600s"}, + "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","windows": {"voting_period": "120h", "min_execution_period": "0s"}}, } } ``` @@ -764,14 +779,14 @@ Example Output: "groupId": "1", "admin": "cosmos1..", "version": "1", - "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","timeout":"600s"}, + "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","windows":{"voting_period": "120h", "min_execution_period": "0s"}}, }, { "address": "cosmos1..", "groupId": "1", "admin": "cosmos1..", "version": "1", - "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","timeout":"600s"}, + "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","windows":{"voting_period": "120h", "min_execution_period": "0s"}}, } ], "pagination": { @@ -805,14 +820,14 @@ Example Output: "groupId": "1", "admin": "cosmos1..", "version": "1", - "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","timeout":"600s"}, + "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","windows":{"voting_period": "120h", "min_execution_period": "0s"}}, }, { "address": "cosmos1..", "groupId": "1", "admin": "cosmos1..", "version": "1", - "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","timeout":"600s"}, + "decisionPolicy": {"@type":"/cosmos.group.v1beta1.ThresholdDecisionPolicy","threshold":"1","windows":{"voting_period": "120h", "min_execution_period": "0s"}}, } ], "pagination": { @@ -857,7 +872,10 @@ Example Output: "abstainCount": "0", "vetoCount": "0" }, - "timeout": "2021-12-17T07:06:27.310638964Z", + "windows": { + "min_execution_period": "0s", + "voting_period": "432000s" + }, "executorResult": "EXECUTOR_RESULT_NOT_RUN", "msgs": [ {"@type":"/cosmos.bank.v1beta1.MsgSend","amount":[{"denom":"stake","amount":"100000000"}],"fromAddress":"cosmos1..","toAddress":"cosmos1.."} @@ -903,7 +921,10 @@ Example Output: "abstainCount": "0", "vetoCount": "0" }, - "timeout": "2021-12-17T08:13:27.099649352Z", + "windows": { + "min_execution_period": "0s", + "voting_period": "432000s" + }, "executorResult": "EXECUTOR_RESULT_NOT_RUN", "msgs": [ {"@type":"/cosmos.bank.v1beta1.MsgSend","amount":[{"denom":"stake","amount":"100000000"}],"fromAddress":"cosmos1..","toAddress":"cosmos1.."} @@ -1069,7 +1090,10 @@ Example Output: "decision_policy": { "@type": "/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold": "1", - "timeout": "600s" + "windows": { + "voting_period": "120h", + "min_execution_period": "0s" + } }, } } @@ -1186,7 +1210,10 @@ Example Output: "decision_policy": { "@type": "/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold": "1", - "timeout": "600s" + "windows": { + "voting_period": "120h", + "min_execution_period": "0s" + } }, }, { @@ -1198,7 +1225,10 @@ Example Output: "decision_policy": { "@type": "/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold": "1", - "timeout": "600s" + "windows": { + "voting_period": "120h", + "min_execution_period": "0s" + } }, } ], @@ -1237,7 +1267,10 @@ Example Output: "decision_policy": { "@type": "/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold": "1", - "timeout": "600s" + "windows": { + "voting_period": "120h", + "min_execution_period": "0s" + } }, }, { @@ -1249,7 +1282,10 @@ Example Output: "decision_policy": { "@type": "/cosmos.group.v1beta1.ThresholdDecisionPolicy", "threshold": "1", - "timeout": "600s" + "windows": { + "voting_period": "120h", + "min_execution_period": "0s" + } }, } ], @@ -1295,7 +1331,10 @@ Example Output: "abstain_count": "0", "veto_count": "0" }, - "timeout": "2021-12-17T07:06:27.310638964Z", + "windows": { + "min_execution_period": "0s", + "voting_period": "432000s" + }, "executor_result": "EXECUTOR_RESULT_NOT_RUN", "msgs": [ { @@ -1351,7 +1390,10 @@ Example Output: "abstain_count": "0", "veto_count": "0" }, - "timeout": "2021-12-17T08:13:27.099649352Z", + "windows": { + "min_execution_period": "0s", + "voting_period": "432000s" + }, "executor_result": "EXECUTOR_RESULT_NOT_RUN", "msgs": [ {