fix: StateLibrary change @param #959
Open
Conversation
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
saucepoint
reviewed
Mar 14, 2025
There was a problem hiding this comment.
thanks for the feedback, I can see how its confusing
I would actually suggest reverting back to the owner naming, and just improving the natspec. Not all liquidity managers will conventionally follow a PosM-style contract
For example, a hook can manage liquidity or developers can write a contract which manages a single position; therefore, I think its misleading to call the param posm
| @@ -219,7 +219,7 @@ library StateLibrary { | |||
| * @notice Retrieves the position information of a pool without needing to calculate the `positionId`. | |||
| * @dev Corresponds to pools[poolId].positions[positionId] | |||
| * @param poolId The ID of the pool. | |||
| * @param owner The owner of the liquidity position. | |||
| * @param posm The position manager. | |||
There was a problem hiding this comment.
Suggested change
| * @param posm The position manager. | |
| * @param owner The owner contract of the liquidity position. Typically a periphery contract like PositionManager |
There was a problem hiding this comment.
reverting back to the owner naming, and just improving the natspec is good enough!
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.
Related Issue
Trying to get position liquidity like in guide https://docs.uniswap.org/contracts/v4/guides/read-pool-state#getpositioninfo
Function getPositionInfo(
IPoolManager manager,
PoolId poolId,
address owner,
int24 tickLower,
int24 tickUpper,
bytes32 salt
) doesn't work with @param owner The owner of the liquidity position.
Works with @param address of the position manager.
In v4-periphery -> PositionManager.sol ->
bytes32 positionId = Position.calculatePositionKey(address(this), tickLower, tickUpper, bytes32(tokenId));
The same calculatePositionKey with address(this) == address(positionManager)
Description of changes
Changed in StateLibrary.sol function getPositionInfo @param owner The owner of the liquidity position. to @param posm The position manager.