Add Governor documentation #1235
Open
Conversation
This file contains 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
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 <[email protected]>
Co-authored-by: Andrew Fleming <[email protected]>
|
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. |
Comment on lines
+218
to
+229
|
|
||
| pub trait IGovernor2 { | ||
| fn name() -> felt252; | ||
|
|
||
| fn version() -> felt252; | ||
|
|
||
| fn COUNTING_MODE() -> ByteArray; | ||
|
|
||
| fn hash_proposal(calls: Span<Call>, description_hash: felt252) -> felt252; | ||
|
|
||
| // fn state(proposal_id: felt252) -> ProposalState; | ||
|
|
|
|
||
| /// Interface for a contract that implements the ERC-6372 standard. | ||
| #[starknet::interface] | ||
| pub trait IERC6372<TState> { | ||
| /// Clock used for flagging checkpoints. | ||
| /// Can be overridden to implement timestamp based checkpoints (and voting). | ||
| /// Can be overridden to implement block number based checkpoints (and voting). |
There was a problem hiding this comment.
Suggested change
| /// Can be overridden to implement block number based checkpoints (and voting). |
I think we can remove this sentence because it's just the interface and not the impl
Comment on lines
-215
to
220
| /// Returns the token that voting power is sourced from. | ||
| /// Returns the timelock controller address. | ||
| fn timelock(self: @ComponentState<TContractState>) -> ContractAddress { |
| [[GovernorComponent-cast_vote_with_reason_and_params_by_sig]] | ||
| ==== `[.contract-item-name]#++cast_vote_with_reason_and_params_by_sig++#++(proposal_id: felt252, support: u8, voter: ContractAddress, reason: ByteArray, params: Span<felt252>, signature: Span<felt252>) → u256++` [.item-kind]#external# | ||
|
|
||
| Cast a vote with a `reason` and additional serialized `params` using the `voter`'s |
There was a problem hiding this comment.
Suggested change
| Cast a vote with a `reason` and additional serialized `params` using the `voter`'s | |
| Cast a vote with a `reason` and additional serialized `params` using the ``voter``'s |
| [[IGovernor-cast_vote_with_reason_and_params_by_sig]] | ||
| ==== `[.contract-item-name]#++cast_vote_with_reason_and_params_by_sig++#++(proposal_id: felt252, support: u8, voter: ContractAddress, reason: ByteArray, params: Span<felt252>, signature: Span<felt252>) → u256++` [.item-kind]#external# | ||
|
|
||
| Cast a vote on a proposal with a reason and additional encoded parameters using the voter's signature. |
There was a problem hiding this comment.
Suggested change
| Cast a vote on a proposal with a reason and additional encoded parameters using the voter's signature. | |
| Cast a vote on a proposal with a reason and additional encoded parameters using the ``voter``'s signature. |
To match the component description
| [[GovernorTimelockExecutionComponent-timelock_salt]] | ||
| ==== `[.contract-item-name]#++timelock_salt++#++(self: @ContractState, description_hash: felt252) → felt252++` [.item-kind]#internal# | ||
|
|
||
| Computes the `TimelockController` operation salt. |
There was a problem hiding this comment.
Suggested change
| Computes the `TimelockController` operation salt. | |
| Computes the `TimelockController` operation salt as the XOR of the governor address and `description_hash`. |
In case users are curious 🤷♂️
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.
Fixes #1234