Fix DSU unwrapping in multi invoker and manager contract #461
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
arjun-io
reviewed
Oct 3, 2024
| /// @param account Account to claim fees for | ||
| /// @param unwrap Wheather to wrap/unwrap collateral on withdrawal | ||
| function withdrawClaimable(address account, bool unwrap) external { | ||
| if (msg.sender != account && !operators[account][msg.sender]) revert MultiInvokerUnauthorizedError(); |
There was a problem hiding this comment.
I think since we use this pattern twice it might make sense to make it an onlyOperator modifier or helper function like below in Manager.sol?
| UFixed6 claimableAmount = claimable[account]; | ||
| claimable[account] = UFixed6Lib.ZERO; | ||
|
|
||
| _withdraw(account, claimableAmount, unwrap); |
There was a problem hiding this comment.
Our pattern has been to push funds to the msg.sender rather than the account (see: https://github.com/equilibria-xyz/perennial-v2/blob/v2.3/packages/perennial/contracts/Market.sol#L322)
| /// @notice withdraw DSU or unwrap DSU to withdraw USDC from this address to `account` | ||
| /// @param account Account to claim fees for | ||
| /// @param unwrap Wheather to wrap/unwrap collateral on withdrawal | ||
| function withdrawClaimable(address account, bool unwrap) external { |
| @@ -137,6 +141,17 @@ abstract contract Manager is IManager, Kept { | |||
| if (interfaceFeeCharged) emit TriggerOrderInterfaceFeeCharged(account, market, order.interfaceFee); | |||
| } | |||
|
|
|||
| /// @inheritdoc IManager | |||
| function withdrawClaimable(address account, bool unwrap) external { | |||
There was a problem hiding this comment.
Same comments on naming, where to send funds as above 👍
arjun-io
reviewed
Oct 3, 2024
| UFixed6 claimAmount = market.claimFee(account); | ||
| _withdraw(account, claimAmount, unwrap); | ||
| claimable[account] = claimable[account].add(claimAmount); |
There was a problem hiding this comment.
Upon further thinking, we might just want to keep this as a atomic claim and withdraw rather than putting it in the claimable map.
Since these fees are already in DSU in the market, there's no real gain to claiming them into the multiinvoker and then withdrawing in a separate tx. The process of doing the claim+unwrap (if the unwrap is non-reverting) or a DSU claim (if the unwrap is reverting) is the same with or without the multiinvoker escrow
EdNoepel
reviewed
Oct 7, 2024
kbrizzle
reviewed
Oct 9, 2024
| /// @param unwrap Wheather to wrap/unwrap collateral on withdrawal | ||
| function claim(address account, bool unwrap) external onlyOperator(account, msg.sender) { | ||
| UFixed6 claimableAmount = claimable[account]; | ||
| claimable[account] = UFixed6Lib.ZERO; |
There was a problem hiding this comment.
nit: delete claimable[account] slightly cleaner here
There was a problem hiding this comment.
The mapping holds a UFixed6, seemingly incompatible with the unary delete operator.
kbrizzle
reviewed
Oct 9, 2024
| @@ -28,14 +28,12 @@ struct StoredTriggerOrder { | |||
| /* slot 1 */ | |||
| address interfaceFeeReceiver1; | |||
| uint48 interfaceFeeAmount1; // <= 281m | |||
| bool interfaceFeeUnwrap1; | |||
| bytes5 __unallocated1__; | |||
| bytes6 __unallocated1__; | |||
There was a problem hiding this comment.
nit: add a note that these contain dirty data until updated post v2.3 migration
| @@ -129,11 +125,9 @@ library TriggerOrderStorageLib { | |||
| bytes6(0), | |||
| newValue.interfaceFee1.receiver, | |||
| uint48(UFixed6.unwrap(newValue.interfaceFee1.amount)), | |||
| newValue.interfaceFee1.unwrap, | |||
| bytes5(0), | |||
| bytes5(0), | ||
| newValue.interfaceFee2.receiver, | ||
| uint48(UFixed6.unwrap(newValue.interfaceFee2.amount)), | ||
| newValue.interfaceFee2.unwrap, | ||
| bytes5(0) |
| } | ||
|
|
||
| /// @notice reads keeper compensation parameters from an action message | ||
| function _compensateKeeperAction(Action calldata action) internal { |
There was a problem hiding this comment.
where are these two new function used? can't see them referenced in any of the other changes.
There was a problem hiding this comment.
Was a merge artifact; removed in bb91a17.
[Periphery] Unit Test Coverage ReportCoverage after merging prateek/pe-1740-fix-unwrapping into v2.3-fix-review will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[Core] Integration Test Coverage ReportCoverage after merging prateek/pe-1740-fix-unwrapping into v2.3-fix-review will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[Periphery] Integration Test Coverage ReportCoverage after merging prateek/pe-1740-fix-unwrapping into v2.3-fix-review will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[Periphery] Combined Test Coverage ReportCoverage after merging prateek/pe-1740-fix-unwrapping into v2.3-fix-review will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[Core] Unit Test Coverage ReportCoverage after merging prateek/pe-1740-fix-unwrapping into v2.3-fix-review will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
[Core] Combined Test Coverage ReportCoverage after merging prateek/pe-1740-fix-unwrapping into v2.3-fix-review will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
kbrizzle
approved these changes
Oct 10, 2024
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.
Issue: sherlock-audit/2024-08-perennial-v2-update-3-judging#16