Conversation
Development to main
Merge dev in main
Development into main
Development into main
spelling error
docs (governance): update interactions and overview
7 tasks
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the governance documentation to reflect changes in the on-chain governance system, particularly around fees, thresholds, and functionality improvements. The documentation has been restructured to provide clearer explanations of the governance process and updated technical details.
- Updated proposal fee from 1000 EGLD to 500 EGLD
- Restructured overview documentation with clearer sections and improved examples
- Enhanced interaction documentation with additional query endpoints and better explanations
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/governance/overview.md | Comprehensive restructure with updated fees, clearer sections on proposals/voting/thresholds, and improved examples |
| docs/governance/governance-interaction.md | Updated proposal fee, added new query endpoints, enhanced transaction examples, and improved formatting |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| - `nonce` as encoded integer which uniquely identifies the proposals | ||
| - `identifier` the provided 40 hex characters longs identifier | ||
| - `nonce` as encoded integer which uniquely identifies the proposals | ||
| - `identifier` the provided 40 hex characters long identifier |
There was a problem hiding this comment.
Missing article 'is' before 'the provided'. Should be 'identifier is the provided 40 hex characters long identifier'.
Suggested change
| - `identifier` the provided 40 hex characters long identifier | |
| - `identifier` is the provided 40 hex characters long identifier |
| The maximum value for the staked value & the voting power for the liquid-staking contract is known by the governance contract, so it can not counterfeit the voting. If, due to a bug the liquid-staking contract allows, for example, for a user to vote with a larger quota, the liquid-staking contract will deplete its maximum allowance making other voting transactions (on his behalf) to fail. | ||
| ::: | ||
|
|
||
| The user that delegated through a liquid-staking-like contract in order to vote on a proposal, sends a transaction to the liquid-staking-like contract. The smart contract then creates the GovernanceVoteThroughDelegationTransaction based on the users transaction inputs to forward the vote and the computed voting power to the governance contract. |
There was a problem hiding this comment.
Inconsistent naming with the previous misspelled version 'GovernanceVoteThourghDelegationTransaction'. The struct name should be consistent throughout the documentation.
Suggested change
| The user that delegated through a liquid-staking-like contract in order to vote on a proposal, sends a transaction to the liquid-staking-like contract. The smart contract then creates the GovernanceVoteThroughDelegationTransaction based on the users transaction inputs to forward the vote and the computed voting power to the governance contract. | |
| The user that delegated through a liquid-staking-like contract in order to vote on a proposal, sends a transaction to the liquid-staking-like contract. The smart contract then creates the GovernanceVoteThroughDelegationTransaction based on the user's transaction inputs to forward the vote and the computed voting power to the governance contract. |
| "<lost_proposal_fee>", (the amount of EGLD that the issuer loses if the proposal fails) | ||
| "<min_quorum>", (the minimum percentage of total voting power required for a proposal to be considered valid) | ||
| "<min_veto_threshold>", (the minimum percentage of veto votes needed to reject a proposal and slash its fee) | ||
| "<min_pass_threshold>", (the minimum percentage of YES votes required for a proposal to |
There was a problem hiding this comment.
The description for min_pass_threshold is incomplete - it cuts off mid-sentence after 'proposal to'.
Suggested change
| "<min_pass_threshold>", (the minimum percentage of YES votes required for a proposal to | |
| "<min_pass_threshold>", (the minimum percentage of YES votes required for a proposal to pass) |
raduchis
previously approved these changes
Sep 10, 2025
btc-fan
previously approved these changes
Sep 12, 2025
elvisboghiu
previously approved these changes
Sep 12, 2025
popenta
dismissed stale reviews from elvisboghiu, btc-fan, and raduchis
via
161b9b9
elvisboghiu
approved these changes
Sep 12, 2025
raduchis
approved these changes
Sep 12, 2025
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
9 participants
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.
Description of the pull request (what is new / what has changed)
Did you test the changes locally ?
Which category (categories) does this pull request belong to?