Reward Distributor #21
Merged
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
gretzke
requested review from
ConjunctiveNormalForm,
zhongeric,
0age and
marktoda
and removed request for
ConjunctiveNormalForm
zhongeric
reviewed
Mar 5, 2025
marktoda
reviewed
Mar 6, 2025
marktoda
reviewed
Mar 12, 2025
codyborn
reviewed
Mar 31, 2025
| import {MessageHashUtils} from '@openzeppelin/contracts/utils/cryptography/MessageHashUtils.sol'; | ||
|
|
||
| /// @title RewardDistributor | ||
| /// @notice Distributes rewards to operators based on their attestations. Operators attest to a group of blocks (windows). Whenever a window is finalized, the reward is distributed to the operators that voted together with the majority of the votes. |
There was a problem hiding this comment.
nit: can add newlines to keep this under 80 chars in length
codyborn
reviewed
Mar 31, 2025
|
|
||
| /// @notice Returns the block number of the scheduled window | ||
| function blockNumber(NextWindow nextWindow) internal pure returns (uint256 blockNumber_) { | ||
| return NextWindow.unwrap(nextWindow) >> 96; |
codyborn
reviewed
Mar 31, 2025
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.
This pull request introduces a new
RewardDistributorcontract along with its associated parameters and interfaces, as well as updates to the testing framework to accommodate these changes. The most important changes include the implementation of theRewardDistributorcontract, the introduction of theRewardDistributorParamscontract, updates to theIFeeSplitterinterface, and the addition of new tests and mock contracts.New Contracts and Interfaces:
src/UVN/L2/RewardDistributor.sol: Implements theRewardDistributorcontract, which manages the distribution of rewards based on attestations. It includes methods for attesting to blocks, scheduling new windows, and processing rewards.src/UVN/L2/RewardDistributorParams.sol: Implements theRewardDistributorParamscontract, which manages parameters such as attestation window length and period. It includes methods for setting and getting these parameters.src/interfaces/UVN/L2/IRewardDistributor.sol: Defines theIRewardDistributorinterface, including events and errors related to the reward distribution process.src/interfaces/UVN/L2/IRewardDistributorParams.sol: Defines theIRewardDistributorParamsinterface, including events and errors related to attestation parameters.Interface Updates:
src/interfaces/FeeSplitter/IFeeSplitter.sol: Adds new methods to theIFeeSplitterinterface for retrieving addresses of various fee recipients.Testing Framework:
test/UVN/RewardDistributor.t.sol: Adds new tests for theRewardDistributorcontract, including tests for attesting to blocks, handling attestation periods, and initializing windows correctly.test/mock/MockFeeSplitter.sol: Introduces a mock implementation of theIFeeSplitterinterface for testing purposes.test/mock/MockVotesToken.sol: Introduces a mock implementation of an ERC20 token with voting capabilities for testing purposes.