Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optimize SqrtPriceMath.getAmount1Delta #676

Merged
merged 3 commits into from
May 21, 2024
Merged

Optimize SqrtPriceMath.getAmount1Delta #676

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e3fc6d
Optimize `SqrtPriceMath.getAmount1Delta`
shuhuiluo May 19, 2024
0f4d817
Merge and update snapshots
shuhuiluo May 21, 2024
192b294
Update comments on use of `xor`
shuhuiluo May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_oneForZero_exactInCapped.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2248
1974
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_oneForZero_exactInPartial.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3016
2468
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_oneForZero_exactOutCapped.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1987
1713
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_oneForZero_exactOutPartial.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3256
2982
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_zeroForOne_exactInCapped.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2238
2091
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_zeroForOne_exactInPartial.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
3191
3044
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_zeroForOne_exactOutCapped.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1977
1830
2 changes: 1 addition & 1 deletion .forge-snapshots/SwapMath_zeroForOne_exactOutPartial.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2866
2572
2 changes: 1 addition & 1 deletion .forge-snapshots/add liquidity to already existing position with salt.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
153346
153076
2 changes: 1 addition & 1 deletion .forge-snapshots/addLiquidity CA fee.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
331012
330742
2 changes: 1 addition & 1 deletion .forge-snapshots/addLiquidity with empty hook.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
286005
285735
2 changes: 1 addition & 1 deletion .forge-snapshots/addLiquidity with native token.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
143556
143286
2 changes: 1 addition & 1 deletion .forge-snapshots/create new liquidity to a position with salt.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
301524
301254
2 changes: 1 addition & 1 deletion .forge-snapshots/getAmount1Delta_gasCostForAmount1WhereRoundUpIsFalse.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
525
369
2 changes: 1 addition & 1 deletion .forge-snapshots/getAmount1Delta_gasCostForAmount1WhereRoundUpIsTrue.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
653
370
2 changes: 1 addition & 1 deletion .forge-snapshots/poolManager bytecode size.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
21463
21366
2 changes: 1 addition & 1 deletion .forge-snapshots/removeLiquidity CA fee.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
186473
186330
2 changes: 1 addition & 1 deletion .forge-snapshots/removeLiquidity with empty hook.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
122841
122698
2 changes: 1 addition & 1 deletion .forge-snapshots/removeLiquidity with native token.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
119628
119485
2 changes: 1 addition & 1 deletion .forge-snapshots/simple addLiquidity second addition same range.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
104665
104395
2 changes: 1 addition & 1 deletion .forge-snapshots/simple addLiquidity.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
167157
166887
2 changes: 1 addition & 1 deletion .forge-snapshots/simple removeLiquidity some liquidity remains.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
98257
98114
2 changes: 1 addition & 1 deletion .forge-snapshots/simple removeLiquidity.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
90297
90154
2 changes: 1 addition & 1 deletion .forge-snapshots/simple swap with native.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
116207
115921
2 changes: 1 addition & 1 deletion .forge-snapshots/simple swap.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
131368
131082
2 changes: 1 addition & 1 deletion .forge-snapshots/swap CA fee on unspecified.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
182506
182220
2 changes: 1 addition & 1 deletion .forge-snapshots/swap against liquidity with native token.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
112161
112018
2 changes: 1 addition & 1 deletion .forge-snapshots/swap against liquidity.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
123504
123361
2 changes: 1 addition & 1 deletion .forge-snapshots/swap burn 6909 for input.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
135496
135226
2 changes: 1 addition & 1 deletion .forge-snapshots/swap burn native 6909 for input.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
124759
124473
2 changes: 1 addition & 1 deletion .forge-snapshots/swap mint native output as 6909.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
146753
146213
2 changes: 1 addition & 1 deletion .forge-snapshots/swap mint output as 6909.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
163222
162936
2 changes: 1 addition & 1 deletion .forge-snapshots/swap skips hook call if hook is caller.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
221192
220763
2 changes: 1 addition & 1 deletion .forge-snapshots/swap with dynamic fee.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
147423
147137
2 changes: 1 addition & 1 deletion .forge-snapshots/swap with hooks.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
123516
123373
2 changes: 1 addition & 1 deletion .forge-snapshots/swap with lp fee and protocol fee.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
179603
179174
2 changes: 1 addition & 1 deletion .forge-snapshots/swap with return dynamic fee.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
155282
154996
2 changes: 1 addition & 1 deletion .forge-snapshots/update dynamic fee in before swap.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
157885
157599
36 changes: 31 additions & 5 deletions src/libraries/SqrtPriceMath.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,19 @@ library SqrtPriceMath {
}
}

/// @notice Equivalent to: `a >= b ? a - b : b - a`
function absDiff(uint160 a, uint160 b) internal pure returns (uint256 res) {
assembly {
let diff := sub(a, b)
// mask = 0 if a >= b else -1 (all 1s)
let mask := sar(255, diff)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

could you add a similar comment to absTick? just something like
mask is all 1s if b > a or all 0s when a >= b
b-a = -(a-b) = invert (a-b-1)

// if a >= b, res = a - b = 0 ^ (a - b)
// if a < b, res = b - a = ~~(b - a) = ~(-(b - a) - 1) = ~(a - b - 1) = (-1) ^ (a - b - 1)
// either way, res = mask ^ (a - b + mask)
res := xor(mask, add(mask, diff))
}
}

/// @notice Gets the amount1 delta between two prices
/// @dev Calculates liquidity * (sqrt(upper) - sqrt(lower))
/// @param sqrtPriceAX96 A sqrt price
Expand All @@ -181,11 +194,24 @@ library SqrtPriceMath {
pure
returns (uint256 amount1)
{
if (sqrtPriceAX96 > sqrtPriceBX96) (sqrtPriceAX96, sqrtPriceBX96) = (sqrtPriceBX96, sqrtPriceAX96);

return roundUp
? FullMath.mulDivRoundingUp(liquidity, sqrtPriceBX96 - sqrtPriceAX96, FixedPoint96.Q96)
: FullMath.mulDiv(liquidity, sqrtPriceBX96 - sqrtPriceAX96, FixedPoint96.Q96);
uint256 numerator = absDiff(sqrtPriceAX96, sqrtPriceBX96);
uint256 denominator = FixedPoint96.Q96;
uint256 _liquidity;
assembly {
// avoid implicit upcasting
_liquidity := liquidity
}
/**
* Equivalent to:
* amount1 = roundUp
* ? FullMath.mulDivRoundingUp(liquidity, sqrtPriceBX96 - sqrtPriceAX96, FixedPoint96.Q96)
* : FullMath.mulDiv(liquidity, sqrtPriceBX96 - sqrtPriceAX96, FixedPoint96.Q96);
* Cannot overflow because `type(uint128).max * type(uint160).max >> 96 < (1 << 192)`.
*/
amount1 = FullMath.mulDiv(_liquidity, numerator, denominator);
assembly {
amount1 := add(amount1, and(gt(mulmod(_liquidity, numerator, denominator), 0), roundUp))
}
}

/// @notice Helper that gets signed currency0 delta
Expand Down
8 changes: 4 additions & 4 deletions src/libraries/TickMath.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ library TickMath {
unchecked {
uint256 absTick;
assembly {
// mask = 0 if tick >= 0 else -1
// mask = 0 if tick >= 0 else -1 (all 1s)
let mask := sar(255, tick)
// If tick >= 0, |tick| = tick = 0 ^ tick
// If tick < 0, |tick| = ~~|tick| = ~(-|tick| - 1) = ~(tick - 1) = (-1) ^ (tick - 1)
// Either case, |tick| = mask ^ (tick + mask)
// if tick >= 0, |tick| = tick = 0 ^ tick
// if tick < 0, |tick| = ~~|tick| = ~(-|tick| - 1) = ~(tick - 1) = (-1) ^ (tick - 1)
// either way, |tick| = mask ^ (tick + mask)
absTick := xor(mask, add(mask, tick))
}
// Equivalent: if (absTick > MAX_TICK) revert InvalidTick();
Expand Down
Loading