fix: Fix bug in MerkleDistributor that doesn't decrement remainingAmount for merkle windows correctly #193
Conversation
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
…unt for merkle windows correctly
nicholaspai
commented
Oct 27, 2022
| * @param windowIndex merkle root to check. | ||
| * @return address Reward token address | ||
| */ | ||
| function getRewardTokenForWindow(uint256 windowIndex) public view returns (address) { |
Member
Author
There was a problem hiding this comment.
Adding for usefulness in https://github.com/across-protocol/across-token/pull/32/files
mrice32
approved these changes
Oct 28, 2022
Contributor
mrice32
left a comment
mrice32
left a comment
There was a problem hiding this comment.
LGTM! This is a very nice find! Great simple test, too.
nicholaspai
added a commit
to UMAprotocol/protocol
that referenced
this pull request
Oct 29, 2022
…unt for merkle windows correctly PR takes files changed [here](across-protocol/contracts#193) and copies them unmodified to this repo
nicholaspai
added a commit
to UMAprotocol/protocol
that referenced
this pull request
Nov 1, 2022
…unt for merkle windows correctly (#4209) * fix: Fix bug in MerkleDistributor that doesn't decrement remainingAmount for merkle windows correctly PR takes files changed [here](across-protocol/contracts#193) and copies them unmodified to this repo * update claim and claimMulti to be virtual * Bump package version in prep for release * Fix * Update packages/core/contracts/merkle-distributor/implementation/MerkleDistributorInterface.sol Co-authored-by: Chris Maree <christopher.maree@gmail.com> * Update MerkleDistributor.sol * Update MerkleDistributor.js * lint * Update MerkleDistributor.js * Update MerkleDistributor.js Co-authored-by: Chris Maree <christopher.maree@gmail.com>
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.
I discovered this by while working on this PR for the exact test case I've included. The problem arises when all of the claims for different window indices are for the same token and recipient. If this
ifstatement here is not triggered, thenbatchedAmountaccumulates the amount for each claim. It only gets decremented from a window'sremainingAmountonce the if statement is entered, which is either:If the reward token and account do not change, then its possible that
batchedAmount > window.remainingAmount.We should be decrementing remainingAmount for each claim that executes, this seems intuitive.
The reason why I think we've never run into this is because we've never tried claiming in production across multiple windows. I don't think we've even used multiple windows in the past