fix: correct getLiquidity docstring to reflect active liquidity#1015
Open
ionodeionode wants to merge 1 commit intoUniswap:mainfrom
Open
fix: correct getLiquidity docstring to reflect active liquidity#1015ionodeionode wants to merge 1 commit intoUniswap:mainfrom
ionodeionode wants to merge 1 commit intoUniswap:mainfrom
Conversation
The docstring previously stated it retrieves 'total the liquidity' but the function returns the active liquidity at the current tick, not the total liquidity across all positions/ticks. Closes Uniswap#984
Author
|
Closing to manage open PR count. Will revisit when capacity allows. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Closes #984
The
getLiquidityfunction's natspec docstring stated it "retrieves total the liquidity" but the function actually returns the active liquidity at the pool's current tick (pools[poolId].liquidity), not the total liquidity across all positions.Single-sided liquidity positions outside the current tick range are not included in this value. Updated the docstring to accurately describe this behavior and avoid confusion.