Skip to content

Conversation

@popenta
Copy link
Contributor

@popenta popenta commented Sep 9, 2025

Description of the pull request (what is new / what has changed)

Did you test the changes locally ?

  • yes
  • no

Which category (categories) does this pull request belong to?

  • document new feature
  • update documentation that is not relevant anymore
  • add examples or more information about a component
  • fix grammar issues
  • other

danielailie and others added 30 commits July 29, 2025 13:19
spelling error
docs (governance): update interactions and overview
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copilot uses AI. Check for mistakes.
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.
Copy link

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
"<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
Copy link

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copilot uses AI. Check for mistakes.
raduchis
raduchis previously approved these changes Sep 10, 2025
btc-fan
btc-fan previously approved these changes Sep 12, 2025
elvisboghiu
elvisboghiu previously approved these changes Sep 12, 2025
@popenta popenta dismissed stale reviews from elvisboghiu, btc-fan, and raduchis via 161b9b9 September 12, 2025 09:13
@popenta popenta merged commit 41dcf12 into development Sep 12, 2025
3 checks passed
@popenta popenta deleted the governance-update branch September 12, 2025 12:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants