docs(proposals): add proposal lifecycle & voting model concepts doc - #526
Open
Ajibola6921 wants to merge 1 commit into
Open
docs(proposals): add proposal lifecycle & voting model concepts doc#526Ajibola6921 wants to merge 1 commit into
Ajibola6921 wants to merge 1 commit into
Conversation
Closes codebestia#472 Write `contracts/docs/concepts-proposal-lifecycle.md` explaining the proposals contract's voting design: how a proposal is created, how votes are weighted and counted, what finalization does, expiry handling, and how a finalized proposal's execution ties back into group_treasury withdrawals. Includes: - Mermaid state diagram covering all ProposalStatus transitions - Pass/fail rule explanation with example scenarios - Expiry finalization rationale (separate function vs normal finalization) - execute_withdraw step-by-step flow and connection to group_treasury - Event reference table
|
@Ajibola6921 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds
contracts/docs/concepts-proposal-lifecycle.mdexplaining theproposalscontract's voting design: how a proposal is created, how votes are weighted and counted, what finalization does, expiry handling, and how a finalized proposal's execution ties back intogroup_treasurywithdrawals.Related Issue
Closes #472
Changes
Documentation
contracts/docs/concepts-proposal-lifecycle.mdProposalStatusvalue and the function calls that cause each transitionfinalize_expired_proposalexists as distinct from normal finalization (semantic clarity, mutual exclusivity, guard condition differences)execute_withdrawflow showing treasury membership verification, balance checks, and the actual withdrawal callgroup_treasuryintegration diagramVerification Results
All 18 tests passed, confirming the documentation accurately reflects the contract behavior.