Staking rewards 9.62 ZETA #489
Conversation
fadeev
requested review from
bbbeeeee,
brewmaster012 and
a team
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe document "Staking Rewards" has been revised to enhance clarity on the distribution of staking rewards among validators, emphasizing the role of voting power. The formula for calculating rewards has been updated to a fixed value of 9.62 ZETA, replacing the previous variable formula. Additionally, the emissions pool address URL has been updated, and minor textual adjustments have been made, including the removal of a bullet point regarding manual funding and a statement on network inflation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Validator
participant Protocol
User->>Protocol: Stake Tokens
Protocol->>Validator: Distribute Rewards
Validator->>Protocol: Calculate Rewards (9.62 ZETA)
Protocol->>User: Provide Staking Rewards
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
src/pages/developers/architecture/rewards.mdx (2)
18-19: Approval: Updated reward formula with suggestion.The simplification of the staking rewards formula to a fixed amount enhances clarity. However, to improve precision, consider adding units to the TransactionFees term in the equation.
Suggested improvement:
$$ StakingRewards = TransactionFees_{ZETA} + 9.62 \text{ ZETA} $$This change explicitly indicates that transaction fees are also in ZETA, maintaining consistency with the fixed reward amount.
20-22: Approval: Source code reference added with suggestion for improvement.The addition of a link to the source code where the fixed amount is defined is commendable, as it enhances transparency and allows for easy verification. However, to ensure long-term maintainability, consider the following suggestion:
Instead of linking to a specific commit, which may become outdated, consider using a link to the main branch or implementing a dynamic link that always points to the latest version of the file. This approach would ensure that the documentation remains current without requiring frequent updates.
Example implementation:
The fixed amount (9.62 ZETA) is defined [in the source code](https://github.com/zeta-chain/node/blob/main/x/emissions/types/keys.go) of the protocol.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- src/pages/developers/architecture/rewards.mdx (1 hunks)
🧰 Additional context used
🔇 Additional comments (3)
src/pages/developers/architecture/rewards.mdx (3)
15-16: Approval: Clear explanation of reward distribution.The addition of this sentence provides crucial information about how staking rewards are distributed among validators. This clarification enhances the overall understanding of the staking mechanism.
Line range hint
1-35: Address removal of information about manual funding and network inflation.It's noted that two bullet points have been removed from the document:
- The statement about the emission pool being funded manually
- The statement about the absence of inflation in the network
While these removals may reflect changes in the system or a desire for brevity, they represent potentially significant aspects of the tokenomics.
Please confirm:
- Has the emission pool funding mechanism changed?
- Is the statement about network inflation still accurate?
If these aspects have indeed changed, consider adding brief explanations about the current state of emission pool funding and network inflation to maintain comprehensive documentation.
25-25: Approval: Updated emissions pool address URL with request for clarification.The update to the emissions pool address URL is noted. This change likely provides more specific information about the emissions pool addresses.
To ensure the correctness and functionality of this URL, please clarify:
- Is this an API endpoint or a web page?
- What specific information does this URL provide?
- Is there any authentication required to access this resource?
Additionally, to verify the URL's functionality, please run the following command:
This will check the HTTP response and confirm that the resource is accessible.
✅ Verification successful
Verified: Emissions pool address URL is functional and accessible.
The GET request to
https://zetachain.blockpi.network/lcd/v1/public/zeta-chain/emissions/list_addressessuccessfully returned the expected JSON data containing the relevant emission addresses. This confirms that the updated URL is correctly configured and provides the necessary information.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
curl -I https://zetachain.blockpi.network/lcd/v1/public/zeta-chain/emissions/list_addressesLength of output: 975
Script:
#!/bin/bash curl -X GET https://zetachain.blockpi.network/lcd/v1/public/zeta-chain/emissions/list_addressesLength of output: 659
Summary by CodeRabbit
New Features
Bug Fixes