docs: guide to modify param via governance #3832
Conversation
rootulp
requested review from
cmwaters and
ninabarbakadze
and removed request for
a team
WalkthroughWalkthroughA new document titled "Modify Param" has been introduced to guide users in modifying governance parameters within the Celestia application. It provides a structured approach for changing the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Governance Module
participant Validator
User->>Governance Module: Verify current value of `AllowMessages`
User->>User: Create `proposal.json` with changes
User->>Governance Module: Submit proposal
Governance Module->>Validator: Notify proposal submission
Validator->>Governance Module: Vote on proposal
Governance Module->>User: Confirm proposal status
User->>Governance Module: Verify updated `AllowMessages`
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (1)
Additional comments not posted (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
docs/maintainers/modify-param.md (1)
15-38: Add brief explanations for each command.The commands are clear and correctly formatted. However, adding brief explanations for each command would improve readability and understanding.
Consider adding explanations like this:
# Create a proposal.json file with the desired changes echo '{"title": "Modify ICA host allow messages", "description": "Modify ICA host allow messages", "changes": [{"subspace": "icahost", "key": "AllowMessages", "value": ["/ibc.applications.transfer.v1.MsgTransfer","/cosmos.bank.v1beta1.MsgSend","/cosmos.staking.v1beta1.MsgDelegate","/cosmos.staking.v1beta1.MsgBeginRedelegate","/cosmos.staking.v1beta1.MsgUndelegate","/cosmos.staking.v1beta1.MsgCancelUnbondingDelegation","/cosmos.distribution.v1beta1.MsgSetWithdrawAddress","/cosmos.distribution.v1beta1.MsgWithdrawDelegatorReward","/cosmos.distribution.v1beta1.MsgFundCommunityPool","/cosmos.gov.v1.MsgVote","/cosmos.feegrant.v1beta1.MsgGrantAllowance","/cosmos.feegrant.v1beta1.MsgRevokeAllowance"]}], "deposit": "10000000000utia"}' > proposal.json # Export a variable for the key that will be used to submit the proposal export FROM="validator" export FEES="210000utia" export GAS="auto" export GAS_ADJUSTMENT="1.5" # Submit the proposal celestia-appd tx gov submit-legacy-proposal param-change proposal.json --from $FROM --fees $FEES --gas $GAS --gas-adjustment $GAS_ADJUSTMENT --yes # Query the proposals celestia-appd query gov proposals --output json | jq . # Export a variable for the relevant proposal ID based on the output from the previous command export PROPOSAL_ID=1 # Vote yes on the proposal celestia-appd tx gov vote $PROPOSAL_ID yes --from $FROM --fees $FEES --gas $GAS --gas-adjustment $GAS_ADJUSTMENT --yes
I created a doc to prepare for #3827
I created a doc to prepare for #3827