Optimize TickMath bounds check in assembly
#669
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
shuhuiluo
force-pushed
the
get-tick-at-sqrt-price-0
branch
from
7a4fa6a
to
dc7a0f3
Compare
A new constant, MAX_SQRT_PRICE_MINUS_MIN_SQRT_PRICE_MINUS_ONE, is introduced for efficient bounds checking. The getTickAtSqrtPrice function is further optimized by using assembly-level operations for checking boundary conditions, which enhances the overall performance. It keeps the price within the specified bounds and throws an "InvalidSqrtPrice" error if the price is out of range.
Updated the MAX_TICK constant value from `-MIN_TICK` to `887272` in TickMath.sol. Enhanced safety check within `getSqrtPriceAtTick` function, replacing previous condition with an assembly block to add memory-safe verification. The new check reverts with `InvalidTick()` if the absolute value of `tick` exceeds `MAX_TICK`.
This commit adds fuzz tests in the `TickMath` test suite to verify that an exception is thrown when exceeding the allowed tick and square root price ranges. The test cases are designed to provide random values that exceed the range of values that the functions `getSqrtPriceAtTick` and `getTickAtSqrtPrice` can operate on without errors.
shuhuiluo
force-pushed
the
get-tick-at-sqrt-price-0
branch
from
dc7a0f3
to
55b7932
Compare
hensha256
reviewed
May 21, 2024
hensha256
approved these changes
May 21, 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.
Factored out of #273.
Related Issue
Which issue does this pull request resolve?
Description of changes
A trick to perform bounds check on fixed bounds has been introduced in
TickMath. A new constantwas also introduced to facilitate the check. In
getTickAtSqrtPrice, it is required thatMIN_SQRT_PRICE <= sqrtPriceX96 < MAX_SQRT_PRICE.sqrtPriceX96 < MIN_SQRT_PRICE,sqrtPriceX96 - MIN_SQRT_PRICEunderflows sosqrtPriceX96 - MIN_SQRT_PRICE > MAX_SQRT_PRICE_MINUS_MIN_SQRT_PRICE_MINUS_ONEistrue.sqrtPriceX96 >= MAX_SQRT_PRICE,sqrtPriceX96 - MIN_SQRT_PRICE > MAX_SQRT_PRICE_MINUS_MIN_SQRT_PRICE_MINUS_ONEis alsotrue.Therefore, the bounds check reduces to