Skip to content

Commit

Permalink
remove counting tick crossing
Browse files Browse the repository at this point in the history
  • Loading branch information
@hensha256
hensha256 committed Sep 9, 2024
1 parent 35e0011 commit de00f69
Show file tree
Hide file tree
Showing 4 changed files with 64 additions and 350 deletions.
22 changes: 5 additions & 17 deletions src/interfaces/IQuoter.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {PathKey} from "../libraries/PathKey.sol";

/// @title Quoter Interface
/// @notice Supports quoting the delta amounts for exact input or exact output swaps.
/// @notice For each pool also tells you the number of initialized ticks loaded and the sqrt price of the pool after the swap.
/// @notice For each pool also tells you the sqrt price of the pool after the swap.
/// @dev These functions are not marked view because they rely on calling non-view functions and reverting
/// to compute the result. They are also not gas efficient and should not be called on-chain.
interface IQuoter {
Expand Down Expand Up @@ -46,10 +46,9 @@ interface IQuoter {
/// hookData arbitrary hookData to pass into the associated hooks
/// @return deltaAmounts Delta amounts resulted from the swap
/// @return sqrtPriceX96After The sqrt price of the pool after the swap
/// @return initializedTicksLoaded The number of initialized ticks that the swap loaded
function quoteExactInputSingle(QuoteExactSingleParams memory params)
external
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After, uint32 initializedTicksLoaded);
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After);

/// @notice Returns the delta amounts along the swap path for a given exact input swap
/// @param params the params for the quote, encoded as 'QuoteExactParams'
Expand All @@ -58,14 +57,9 @@ interface IQuoter {
/// exactAmount The desired input amount
/// @return deltaAmounts Delta amounts along the path resulted from the swap
/// @return sqrtPriceX96AfterList List of the sqrt price after the swap for each pool in the path
/// @return initializedTicksLoadedList List of the initialized ticks that the swap loaded for each pool in the path
function quoteExactInput(QuoteExactParams memory params)
external
returns (
int128[] memory deltaAmounts,
uint160[] memory sqrtPriceX96AfterList,
uint32[] memory initializedTicksLoadedList
);
returns (int128[] memory deltaAmounts, uint160[] memory sqrtPriceX96AfterList);

/// @notice Returns the delta amounts for a given exact output swap of a single pool
/// @param params The params for the quote, encoded as `QuoteExactSingleParams`
Expand All @@ -76,10 +70,9 @@ interface IQuoter {
/// hookData arbitrary hookData to pass into the associated hooks
/// @return deltaAmounts Delta amounts resulted from the swap
/// @return sqrtPriceX96After The sqrt price of the pool after the swap
/// @return initializedTicksLoaded The number of initialized ticks that the swap loaded
function quoteExactOutputSingle(QuoteExactSingleParams memory params)
external
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After, uint32 initializedTicksLoaded);
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After);

/// @notice Returns the delta amounts along the swap path for a given exact output swap
/// @param params the params for the quote, encoded as 'QuoteExactParams'
Expand All @@ -88,12 +81,7 @@ interface IQuoter {
/// exactAmount The desired output amount
/// @return deltaAmounts Delta amounts along the path resulted from the swap
/// @return sqrtPriceX96AfterList List of the sqrt price after the swap for each pool in the path
/// @return initializedTicksLoadedList List of the initialized ticks that the swap loaded for each pool in the path
function quoteExactOutput(QuoteExactParams memory params)
external
returns (
int128[] memory deltaAmounts,
uint160[] memory sqrtPriceX96AfterList,
uint32[] memory initializedTicksLoadedList
);
returns (int128[] memory deltaAmounts, uint160[] memory sqrtPriceX96AfterList);
}
107 changes: 34 additions & 73 deletions src/lens/Quoter.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import {Currency} from "@uniswap/v4-core/src/types/Currency.sol";
import {PoolKey} from "@uniswap/v4-core/src/types/PoolKey.sol";
import {PoolIdLibrary} from "@uniswap/v4-core/src/types/PoolId.sol";
import {IQuoter} from "../interfaces/IQuoter.sol";
import {PoolTicksCounter} from "../libraries/PoolTicksCounter.sol";
import {PathKey, PathKeyLibrary} from "../libraries/PathKey.sol";
import {StateLibrary} from "@uniswap/v4-core/src/libraries/StateLibrary.sol";
import {SafeCallback} from "../base/SafeCallback.sol";
Expand All @@ -21,24 +20,21 @@ contract Quoter is IQuoter, SafeCallback {
/// @dev cache used to check a safety condition in exact output swaps.
uint128 private amountOutCached;

/// @dev min valid reason is 6-words long (192 bytes)
/// @dev min valid reason is 5-words long (160 bytes)
/// @dev int128[2] includes 32 bytes for offset, 32 bytes for length, and 32 bytes for each element
/// @dev Plus sqrtPriceX96After padded to 32 bytes and initializedTicksLoaded padded to 32 bytes
uint256 internal constant MINIMUM_VALID_RESPONSE_LENGTH = 192;
/// @dev Plus sqrtPriceX96After padded to 32 bytes
uint256 internal constant MINIMUM_VALID_RESPONSE_LENGTH = 160;

struct QuoteResult {
int128[] deltaAmounts;
uint160[] sqrtPriceX96AfterList;
uint32[] initializedTicksLoadedList;
}

struct QuoteCache {
BalanceDelta curDeltas;
uint128 prevAmount;
int128 deltaIn;
int128 deltaOut;
int24 tickBefore;
int24 tickAfter;
Currency prevCurrency;
uint160 sqrtPriceX96After;
}
Expand All @@ -54,7 +50,7 @@ contract Quoter is IQuoter, SafeCallback {
/// @inheritdoc IQuoter
function quoteExactInputSingle(QuoteExactSingleParams memory params)
public
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After, uint32 initializedTicksLoaded)
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After)
{
try poolManager.unlock(abi.encodeCall(this._quoteExactInputSingle, (params))) {}
catch (bytes memory reason) {
Expand All @@ -65,11 +61,7 @@ contract Quoter is IQuoter, SafeCallback {
/// @inheritdoc IQuoter
function quoteExactInput(QuoteExactParams memory params)
external
returns (
int128[] memory deltaAmounts,
uint160[] memory sqrtPriceX96AfterList,
uint32[] memory initializedTicksLoadedList
)
returns (int128[] memory deltaAmounts, uint160[] memory sqrtPriceX96AfterList)
{
try poolManager.unlock(abi.encodeCall(this._quoteExactInput, (params))) {}
catch (bytes memory reason) {
Expand All @@ -80,7 +72,7 @@ contract Quoter is IQuoter, SafeCallback {
/// @inheritdoc IQuoter
function quoteExactOutputSingle(QuoteExactSingleParams memory params)
public
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After, uint32 initializedTicksLoaded)
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After)
{
try poolManager.unlock(abi.encodeCall(this._quoteExactOutputSingle, (params))) {}
catch (bytes memory reason) {
Expand All @@ -92,11 +84,7 @@ contract Quoter is IQuoter, SafeCallback {
/// @inheritdoc IQuoter
function quoteExactOutput(QuoteExactParams memory params)
public
returns (
int128[] memory deltaAmounts,
uint160[] memory sqrtPriceX96AfterList,
uint32[] memory initializedTicksLoadedList
)
returns (int128[] memory deltaAmounts, uint160[] memory sqrtPriceX96AfterList)
{
try poolManager.unlock(abi.encodeCall(this._quoteExactOutput, (params))) {}
catch (bytes memory reason) {
Expand Down Expand Up @@ -126,44 +114,35 @@ contract Quoter is IQuoter, SafeCallback {
function _handleRevertSingle(bytes memory reason)
private
pure
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After, uint32 initializedTicksLoaded)
returns (int128[] memory deltaAmounts, uint160 sqrtPriceX96After)
{
reason = validateRevertReason(reason);
(deltaAmounts, sqrtPriceX96After, initializedTicksLoaded) = abi.decode(reason, (int128[], uint160, uint32));
(deltaAmounts, sqrtPriceX96After) = abi.decode(reason, (int128[], uint160));
}

/// @dev parse revert bytes from a potentially multi-hop quote and return the delta amounts, sqrtPriceX96After, and initializedTicksLoaded
/// @dev parse revert bytes from a potentially multi-hop quote and return the delta amounts, and sqrtPriceX96After
function _handleRevert(bytes memory reason)
private
pure
returns (
int128[] memory deltaAmounts,
uint160[] memory sqrtPriceX96AfterList,
uint32[] memory initializedTicksLoadedList
)
returns (int128[] memory deltaAmounts, uint160[] memory sqrtPriceX96AfterList)
{
reason = validateRevertReason(reason);
(deltaAmounts, sqrtPriceX96AfterList, initializedTicksLoadedList) =
abi.decode(reason, (int128[], uint160[], uint32[]));
(deltaAmounts, sqrtPriceX96AfterList) = abi.decode(reason, (int128[], uint160[]));
}

/// @dev quote an ExactInput swap along a path of tokens, then revert with the result
function _quoteExactInput(QuoteExactParams calldata params) public selfOnly returns (bytes memory) {
uint256 pathLength = params.path.length;

QuoteResult memory result = QuoteResult({
deltaAmounts: new int128[](pathLength + 1),
sqrtPriceX96AfterList: new uint160[](pathLength),
initializedTicksLoadedList: new uint32[](pathLength)
});
QuoteResult memory result =
QuoteResult({deltaAmounts: new int128[](pathLength + 1), sqrtPriceX96AfterList: new uint160[](pathLength)});
QuoteCache memory cache;

for (uint256 i = 0; i < pathLength; i++) {
(PoolKey memory poolKey, bool zeroForOne) =
params.path[i].getPoolAndSwapDirection(i == 0 ? params.exactCurrency : cache.prevCurrency);
(, cache.tickBefore,,) = poolManager.getSlot0(poolKey.toId());

(cache.curDeltas, cache.sqrtPriceX96After, cache.tickAfter) = _swap(
(cache.curDeltas, cache.sqrtPriceX96After) = _swap(
poolKey,
zeroForOne,
-int256(int128(i == 0 ? params.exactAmount : cache.prevAmount)),
Expand All @@ -180,21 +159,16 @@ contract Quoter is IQuoter, SafeCallback {
cache.prevAmount = zeroForOne ? uint128(cache.curDeltas.amount1()) : uint128(cache.curDeltas.amount0());
cache.prevCurrency = params.path[i].intermediateCurrency;
result.sqrtPriceX96AfterList[i] = cache.sqrtPriceX96After;
result.initializedTicksLoadedList[i] =
PoolTicksCounter.countInitializedTicksLoaded(poolManager, poolKey, cache.tickBefore, cache.tickAfter);
}
bytes memory r =
abi.encode(result.deltaAmounts, result.sqrtPriceX96AfterList, result.initializedTicksLoadedList);
assembly {
revert(add(0x20, r), mload(r))
bytes memory encodedResult = abi.encode(result.deltaAmounts, result.sqrtPriceX96AfterList);
assembly ("memory-safe") {
revert(add(0x20, encodedResult), mload(encodedResult))
}
}

/// @dev quote an ExactInput swap on a pool, then revert with the result
function _quoteExactInputSingle(QuoteExactSingleParams calldata params) public selfOnly returns (bytes memory) {
(, int24 tickBefore,,) = poolManager.getSlot0(params.poolKey.toId());

(BalanceDelta deltas, uint160 sqrtPriceX96After, int24 tickAfter) = _swap(
(BalanceDelta deltas, uint160 sqrtPriceX96After) = _swap(
params.poolKey,
params.zeroForOne,
-int256(int128(params.exactAmount)),
Expand All @@ -207,23 +181,18 @@ contract Quoter is IQuoter, SafeCallback {
deltaAmounts[0] = -deltas.amount0();
deltaAmounts[1] = -deltas.amount1();

uint32 initializedTicksLoaded =
PoolTicksCounter.countInitializedTicksLoaded(poolManager, params.poolKey, tickBefore, tickAfter);
bytes memory result = abi.encode(deltaAmounts, sqrtPriceX96After, initializedTicksLoaded);
assembly {
revert(add(0x20, result), mload(result))
bytes memory encodedResult = abi.encode(deltaAmounts, sqrtPriceX96After);
assembly ("memory-safe") {
revert(add(0x20, encodedResult), mload(encodedResult))
}
}

/// @dev quote an ExactOutput swap along a path of tokens, then revert with the result
function _quoteExactOutput(QuoteExactParams calldata params) public selfOnly returns (bytes memory) {
uint256 pathLength = params.path.length;

QuoteResult memory result = QuoteResult({
deltaAmounts: new int128[](pathLength + 1),
sqrtPriceX96AfterList: new uint160[](pathLength),
initializedTicksLoadedList: new uint32[](pathLength)
});
QuoteResult memory result =
QuoteResult({deltaAmounts: new int128[](pathLength + 1), sqrtPriceX96AfterList: new uint160[](pathLength)});
QuoteCache memory cache;
uint128 curAmountOut;

Expand All @@ -235,9 +204,7 @@ contract Quoter is IQuoter, SafeCallback {
params.path[i - 1], i == pathLength ? params.exactCurrency : cache.prevCurrency
);

(, cache.tickBefore,,) = poolManager.getSlot0(poolKey.toId());

(cache.curDeltas, cache.sqrtPriceX96After, cache.tickAfter) =
(cache.curDeltas, cache.sqrtPriceX96After) =
_swap(poolKey, !oneForZero, int256(uint256(curAmountOut)), 0, params.path[i - 1].hookData);

// always clear because sqrtPriceLimitX96 is set to 0 always
Expand All @@ -251,13 +218,10 @@ contract Quoter is IQuoter, SafeCallback {
cache.prevAmount = !oneForZero ? uint128(-cache.curDeltas.amount0()) : uint128(-cache.curDeltas.amount1());
cache.prevCurrency = params.path[i - 1].intermediateCurrency;
result.sqrtPriceX96AfterList[i - 1] = cache.sqrtPriceX96After;
result.initializedTicksLoadedList[i - 1] =
PoolTicksCounter.countInitializedTicksLoaded(poolManager, poolKey, cache.tickBefore, cache.tickAfter);
}
bytes memory r =
abi.encode(result.deltaAmounts, result.sqrtPriceX96AfterList, result.initializedTicksLoadedList);
assembly {
revert(add(0x20, r), mload(r))
bytes memory encodedResult = abi.encode(result.deltaAmounts, result.sqrtPriceX96AfterList);
assembly ("memory-safe") {
revert(add(0x20, encodedResult), mload(encodedResult))
}
}

Expand All @@ -266,8 +230,7 @@ contract Quoter is IQuoter, SafeCallback {
// if no price limit has been specified, cache the output amount for comparison inside the _swap function
if (params.sqrtPriceLimitX96 == 0) amountOutCached = params.exactAmount;

(, int24 tickBefore,,) = poolManager.getSlot0(params.poolKey.toId());
(BalanceDelta deltas, uint160 sqrtPriceX96After, int24 tickAfter) = _swap(
(BalanceDelta deltas, uint160 sqrtPriceX96After) = _swap(
params.poolKey,
params.zeroForOne,
int256(uint256(params.exactAmount)),
Expand All @@ -281,11 +244,9 @@ contract Quoter is IQuoter, SafeCallback {
deltaAmounts[0] = -deltas.amount0();
deltaAmounts[1] = -deltas.amount1();

uint32 initializedTicksLoaded =
PoolTicksCounter.countInitializedTicksLoaded(poolManager, params.poolKey, tickBefore, tickAfter);
bytes memory result = abi.encode(deltaAmounts, sqrtPriceX96After, initializedTicksLoaded);
assembly {
revert(add(0x20, result), mload(result))
bytes memory encodedResult = abi.encode(deltaAmounts, sqrtPriceX96After);
assembly ("memory-safe") {
revert(add(0x20, encodedResult), mload(encodedResult))
}
}

Expand All @@ -297,7 +258,7 @@ contract Quoter is IQuoter, SafeCallback {
int256 amountSpecified,
uint160 sqrtPriceLimitX96,
bytes calldata hookData
) private returns (BalanceDelta deltas, uint160 sqrtPriceX96After, int24 tickAfter) {
) private returns (BalanceDelta deltas, uint160 sqrtPriceX96After) {
deltas = poolManager.swap(
poolKey,
IPoolManager.SwapParams({
Expand All @@ -311,7 +272,7 @@ contract Quoter is IQuoter, SafeCallback {
if (amountOutCached != 0 && amountOutCached != uint128(zeroForOne ? deltas.amount1() : deltas.amount0())) {
revert InsufficientAmountOut();
}
(sqrtPriceX96After, tickAfter,,) = poolManager.getSlot0(poolKey.toId());
(sqrtPriceX96After,,,) = poolManager.getSlot0(poolKey.toId());
}

/// @dev return either the sqrtPriceLimit from user input, or the max/min value possible depending on trade direction
Expand Down
Loading

0 comments on commit de00f69

Please sign in to comment.