-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* refactor: update quoter * chore: resolve issues per comments
- Loading branch information
1 parent
65e09a2
commit 6e2ac42
Showing
13 changed files
with
531 additions
and
864 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // SPDX-License-Identifier: GPL-2.0-or-later | ||
| // Copyright (C) 2024 PancakeSwap | ||
| pragma solidity ^0.8.24; | ||
|
|
||
| import {SafeCallback} from "./SafeCallback.sol"; | ||
| import {QuoterRevert} from "../libraries/QuoterRevert.sol"; | ||
| import {IVault} from "pancake-v4-core/src/interfaces/IVault.sol"; | ||
| import {IQuoter} from "../interfaces/IQuoter.sol"; | ||
| import {ILockCallback} from "pancake-v4-core/src/interfaces/ILockCallback.sol"; | ||
| import {IPoolManager} from "../interfaces/IPoolManager.sol"; | ||
|
|
||
| abstract contract BaseV4Quoter is SafeCallback, IQuoter { | ||
| using QuoterRevert for bytes; | ||
|
|
||
| constructor(address _poolManager) SafeCallback(IPoolManager(_poolManager).vault()) {} | ||
|
|
||
| /// @dev Only this address may call this function. Used to mimic internal functions, using an | ||
| /// external call to catch and parse revert reasons | ||
| modifier selfOnly() { | ||
| if (msg.sender != address(this)) revert NotSelf(); | ||
| _; | ||
| } | ||
|
|
||
| function _lockAcquired(bytes calldata data) internal override returns (bytes memory) { | ||
| (bool success, bytes memory returnData) = address(this).call(data); | ||
| // Every quote path gathers a quote, and then reverts either with QuoteSwap(quoteAmount) or alternative error | ||
| if (success) revert UnexpectedCallSuccess(); | ||
| // Bubble the revert string, whether a valid quote or an alternative error | ||
| returnData.bubbleReason(); | ||
| } | ||
| } |
This file was deleted.
Oops, something went wrong.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| // SPDX-License-Identifier: GPL-2.0-or-later | ||
| // Copyright (C) 2024 PancakeSwap | ||
| pragma solidity ^0.8.24; | ||
|
|
||
| import {ParseBytes} from "pancake-v4-core/src/libraries/ParseBytes.sol"; | ||
|
|
||
| library QuoterRevert { | ||
| using QuoterRevert for bytes; | ||
| using ParseBytes for bytes; | ||
|
|
||
| /// @notice error thrown when invalid revert bytes are thrown by the quote | ||
| error UnexpectedRevertBytes(bytes revertData); | ||
|
|
||
| /// @notice error thrown containing the quote as the data, to be caught and parsed later | ||
| error QuoteSwap(uint256 amount); | ||
|
|
||
| /// @notice reverts, where the revert data is the provided bytes | ||
| /// @dev called when quoting, to record the quote amount in an error | ||
| /// @dev QuoteSwap is used to differentiate this error from other errors thrown when simulating the swap | ||
| function revertQuote(uint256 quoteAmount) internal pure { | ||
| revert QuoteSwap(quoteAmount); | ||
| } | ||
|
|
||
| /// @notice reverts using the revertData as the reason | ||
| /// @dev to bubble up both the valid QuoteSwap(amount) error, or an alternative error thrown during simulation | ||
| function bubbleReason(bytes memory revertData) internal pure { | ||
| // mload(revertData): the length of the revert data | ||
| // add(revertData, 0x20): a pointer to the start of the revert data | ||
| assembly ("memory-safe") { | ||
| revert(add(revertData, 0x20), mload(revertData)) | ||
| } | ||
| } | ||
|
|
||
| /// @notice validates whether a revert reason is a valid swap quote or not | ||
| /// if valid, it decodes the quote to return. Otherwise it reverts. | ||
| function parseQuoteAmount(bytes memory reason) internal pure returns (uint256 quoteAmount) { | ||
| // If the error doesnt start with QuoteSwap, we know this isnt a valid quote to parse | ||
| // Instead it is another revert that was triggered somewhere in the simulation | ||
| if (reason.parseSelector() != QuoteSwap.selector) { | ||
| revert UnexpectedRevertBytes(reason); | ||
| } | ||
|
|
||
| // reason -> reason+0x1f is the length of the reason string | ||
| // reason+0x20 -> reason+0x23 is the selector of QuoteSwap | ||
| // reason+0x24 -> reason+0x43 is the quoteAmount | ||
| assembly ("memory-safe") { | ||
| quoteAmount := mload(add(reason, 0x24)) | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.