Add Governor documentation #1235
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1235 +/- ##
=======================================
Coverage 92.26% 92.26%
=======================================
Files 59 59
Lines 1811 1811
=======================================
Hits 1671 1671
Misses 140 140
Continue to review full report in Codecov by Sentry.
|
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
|
I added the right interface id cc @andrew-fleming. All I needed to do was to add the empty type to the enum variants in ProposalState, and the src5_rs did the trick without issues. I double checked that every Extended Function Selector looked right. |
packages/governance/src/governor/extensions/governor_timelock_execution.cairo
Show resolved
Hide resolved
| @@ -54,6 +54,8 @@ pub mod GovernorVotesQuorumFractionComponent { | |||
| +Drop<TContractState> | |||
| > of GovernorComponent::GovernorQuorumTrait<TContractState> { | |||
| /// See `GovernorComponent::GovernorQuorumTrait::quorum`. | |||
| /// | |||
| /// Returns a percentage of the votes token total supply at a given timepoint in the past. | |||
There was a problem hiding this comment.
Sounds a bit difficult to understand, maybe it could be rephrased
There was a problem hiding this comment.
Agree, tried to rephrase it a bit.
| percentage of the total supply at the block when a proposal’s voting power is retrieved. This requires an initializer | ||
| parameter to set the percentage besides the votes token address. Most Governors nowadays use 4%, so we will initialize | ||
| the module with parameter 40 since the quorum denominator is 1000 for precision (this indicates the percentage, | ||
| resulting in 4%). |
There was a problem hiding this comment.
This part could be rephrased to improve clarity:
"Most Governors nowadays use a quorum of 4%. Since the quorum denominator is 1000 for precision, we initialize the module with a numerator of 40, resulting in a 4% quorum (40/1000 = 0.04 or 4%)"
* docs: document main component * feat: add extensions API References * Update docs/modules/ROOT/pages/governance/governor.adoc Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com> * Update docs/modules/ROOT/pages/governance/governor.adoc Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com> * feat: apply review updates * feat: add interface id * feat: apply review updates * feat: add interface * feat: apply review updates --------- Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
Fixes #1234