fix(CL): tick iterator bugs and tests #5526
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 |
|---|---|---|
|
|
@@ -65,7 +65,7 @@ func newSwapState(specifiedAmount sdk.Int, p types.ConcentratedPoolExtension, st | |
| amountSpecifiedRemaining: specifiedAmount.ToDec(), | ||
| amountCalculated: sdk.ZeroDec(), | ||
| sqrtPrice: p.GetCurrentSqrtPrice(), | ||
| tick: p.GetCurrentTick(), | ||
| liquidity: p.GetLiquidity(), | ||
| globalSpreadRewardGrowthPerUnitLiquidity: sdk.ZeroDec(), | ||
| globalSpreadRewardGrowth: sdk.ZeroDec(), | ||
|
|
@@ -362,13 +362,27 @@ func (k Keeper) computeOutAmtGivenIn( | |
| if err != nil { | ||
| return sdk.Coin{}, sdk.Coin{}, 0, sdk.Dec{}, sdk.Dec{}, sdk.Dec{}, err | ||
| } | ||
| // Update the swapState's tick with the tick we retrieved liquidity from | ||
| swapState.tick = swapStrategy.UpdateTickAfterCrossing(nextTick) | ||
| } else if !sqrtPriceStart.Equal(computedSqrtPrice) { | ||
| // Otherwise if the sqrtPrice calculated from ComputeSwapWithinBucketOutGivenIn(...) does not equal the sqrtPriceStart we started with at the | ||
| // beginning of this iteration, we set the swapState tick to the corresponding tick of the computedSqrtPrice calculated from ComputeSwapWithinBucketOutGivenIn(...) | ||
| price := computedSqrtPrice.Mul(computedSqrtPrice) | ||
| newTick := math.CalculatePriceToTick(price) | ||
|
There was a problem hiding this comment. Note to reviewer: see "CHANGE 3" section in the PR description for details about this change |
||
|
|
||
| // TEMPORARY HACK: this is to fix tick rounding error where | ||
| // the tick is off by 1 due to banker's rounding error in CalculatePriceToTick | ||
| // TODO: if this is to remain in the codebase, consider abstracting this into a | ||
| // method of swap strategy. | ||
| isZeroForOne := getZeroForOne(tokenInMin.Denom, p.GetToken0()) | ||
| if isZeroForOne { | ||
| if newTick <= swapState.tick { | ||
| swapState.tick = newTick | ||
| } | ||
| } else { | ||
| if newTick > swapState.tick { | ||
| swapState.tick = newTick | ||
|
There was a problem hiding this comment. Are there any cases where none of these branches would be hit? There was a problem hiding this comment. Prior to merging #5541 all branches were hit. Now, only "11111" is not being hit. I'm going to make an issue to investigate this separately. Merging for now |
||
| } | ||
| } | ||
|
There was a problem hiding this comment. Note to reviewer: see "BUG 2" section in the PR description for details I expect this to be temporary until the following PRs are in:
Would like to intentionally leave this in a visible place and poorly abstracted so that we track this and converge on the right solution |
||
| } | ||
| } | ||
|
|
@@ -554,8 +568,6 @@ func (k Keeper) swapCrossTickLogic(ctx sdk.Context, | |
| newLiquidity := swapState.liquidity.AddMut(liquidityNet) | ||
| swapState.liquidity = newLiquidity | ||
|
|
||
| return swapState, nil | ||
| } | ||
|
|
||
|
|
||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note to reviewer: this is the key realization and fix to the original bug as opposed to tick initialization as originally thought
Once the general change is accepted, I will improve the abstraction by moving it inside the
swapCrossTickLogicmethod. Currently, I cannot put there asswapStrategyis not given as an argument toswapCrossTickLogicI put it here to avoid large code diff and be able to point at the core fix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes sense per discussions!