Skip to main content
Version: V3

INonfungiblePositionManager

Wraps Uniswap V3 positions in a non-fungible token interface which allows for them to be transferred and authorized.

Parameter Structs#

MintParams#

  struct MintParams {        address token0;        address token1;        uint24 fee;        int24 tickLower;        int24 tickUpper;        uint256 amount0Desired;        uint256 amount1Desired;        uint256 amount0Min;        uint256 amount1Min;        address recipient;        uint256 deadline;    }

IncreaseLiquidityParams#

   struct IncreaseLiquidityParams {        uint256 tokenId;        uint256 amount0Desired;        uint256 amount1Desired;        uint256 amount0Min;        uint256 amount1Min;        uint256 deadline;    }

DecreaseLiquidityParams#

    struct DecreaseLiquidityParams {        uint256 tokenId;        uint128 liquidity;        uint256 amount0Min;        uint256 amount1Min;        uint256 deadline;    }

CollectParams#

    struct CollectParams {        uint256 tokenId;        address recipient;        uint128 amount0Max;        uint128 amount1Max;    }

Functions#

positions#

  function positions(    uint256 tokenId  ) external view returns (uint96 nonce, address operator, address token0, address token1, uint24 fee, int24 tickLower, int24 tickUpper, uint128 liquidity, uint256 feeGrowthInside0LastX128, uint256 feeGrowthInside1LastX128, uint128 tokensOwed0, uint128 tokensOwed1)

Returns the position information associated with a given token ID.

Throws if the token ID is not valid.

Parameters:#

NameTypeDescription
tokenIduint256The ID of the token that represents the position

Return Values:#

NameTypeDescription
nonceuint96The nonce for permits
operatoraddressThe address that is approved for spending
token0addressThe address of the token0 for a specific pool
token1addressThe address of the token1 for a specific pool
feeuint24The fee associated with the pool
tickLowerint24The lower end of the tick range for the position
tickUpperint24The higher end of the tick range for the position
liquidityuint128The liquidity of the position
feeGrowthInside0LastX128uint256The fee growth of token0 as of the last action on the individual position
feeGrowthInside1LastX128uint256The fee growth of token1 as of the last action on the individual position
tokensOwed0uint128The uncollected amount of token0 owed to the position as of the last computation
tokensOwed1uint128The uncollected amount of token1 owed to the position as of the last computation

createAndInitializePoolIfNecessary#

  function createAndInitializePoolIfNecessary(    address tokenA,    address tokenB,    uint24 fee,    uint160 sqrtPriceX96  ) external returns (address pool)

Creates a new pool if it does not exist, then initializes if not initialized

This method can be bundled with mint for the first mint of a pool to create, initialize a pool and mint at the same time

Parameters:#

NameTypeDescription
tokenAaddressThe contract address of either token0 or token1
tokenBaddressThe contract address of the other token
feeuint24The fee amount of the v3 pool for the specified token pair
sqrtPriceX96uint160The initial square root price of the pool as a Q64.96 value

We use tokenA and tokenB when we are referring to unsorted, or unordered tokens

Return Values:#

NameTypeDescription
pooladdressReturns the pool address based on the pair of tokens and fee, will return the newly created pool address if necessary

mint#

  function mint(    struct INonfungiblePositionManager.MintParams params  ) external returns (uint256 tokenId, uint128 liquidity, uint256 amount0, uint256 amount1)

Creates a new position wrapped in a NFT

Call this when the pool does exist and is initialized. Note that if the pool is created but not initialized a method does not exist, i.e. the pool is assumed to be initialized.

Parameters:#

NameTypeDescription
paramsstruct INonfungiblePositionManager.MintParamsThe params necessary to mint a position, encoded as MintParams in calldata

Return Values:#

NameTypeDescription
tokenIduint256The ID of the token that represents the minted position
liquidityuint128The amount of liquidity for this position
amount0uint256The amount of token0
amount1uint256The amount of token1

increaseLiquidity#

  function increaseLiquidity(    struct INonfungiblePositionManager.IncreaseLiquidityParams params  ) external returns (uint128 liquidity, uint256 amount0, uint256 amount1)

Increases the amount of liquidity in a position, with tokens paid by the msg.sender

Parameters:#

NameTypeDescription
paramsstruct INonfungiblePositionManager.IncreaseLiquidityParamstokenId The ID of the token for which liquidity is being increased,

Return Values:#

NameTypeDescription
liquidityuint128The new liquidity amount as a result of the increase
amount0uint256The amount of token0 to acheive resulting liquidity
amount1uint256The amount of token1 to acheive resulting liquidity

decreaseLiquidity#

  function decreaseLiquidity(    struct INonfungiblePositionManager.DecreaseLiquidityParams params  ) external returns (uint256 amount0, uint256 amount1)

Decreases the amount of liquidity in a position and accounts it to the position

Parameters:#

NameTypeDescription
paramsstruct INonfungiblePositionManager.DecreaseLiquidityParamstokenId The ID of the token for which liquidity is being decreased

Return Values:#

NameTypeDescription
amount0uint256The amount of token0 sent to recipient
amount1uint256The amount of token1 sent to recipient

collect#

  function collect(    struct INonfungiblePositionManager.CollectParams params  ) external returns (uint256 amount0, uint256 amount1)

Collects up to a maximum amount of fees owed to a specific position to the recipient

Parameters:#

NameTypeDescription
paramsstruct INonfungiblePositionManager.CollectParamstokenId The ID of the NFT for which tokens are being collected,

Return Values:#

NameTypeDescription
amount0uint256The amount of fees collected in token0
amount1uint256The amount of fees collected in token1

burn#

  function burn(    uint256 tokenId  ) external

Burns a token ID, which deletes it from the NFT contract. The token must have 0 liquidity and all tokens must be collected first.

Parameters:#

NameTypeDescription
tokenIduint256The ID of the token that is being burned

Events#

IncreaseLiquidity#

  event IncreaseLiquidity(    uint256 tokenId,    uint128 liquidity,    uint256 amount0,    uint256 amount1  )

Emitted when liquidity is increased for a position NFT

Also emitted when a token is minted

Parameters:#

NameTypeDescription
tokenIduint256The ID of the token for which liquidity was increased
liquidityuint128The amount by which liquidity for the NFT position was increased
amount0uint256The amount of token0 that was paid for the increase in liquidity
amount1uint256The amount of token1 that was paid for the increase in liquidity

DecreaseLiquidity#

  event DecreaseLiquidity(    uint256 tokenId,    uint128 liquidity,    uint256 amount0,    uint256 amount1  )

Emitted when liquidity is decreased for a position NFT

Parameters:#

NameTypeDescription
tokenIduint256The ID of the token for which liquidity was decreased
liquidityuint128The amount by which liquidity for the NFT position was decreased
amount0uint256The amount of token0 that was accounted for the decrease in liquidity
amount1uint256The amount of token1 that was accounted for the decrease in liquidity

Collect#

  event Collect(    uint256 tokenId,    address recipient,    uint256 amount0,    uint256 amount1  )

Emitted when tokens are collected for a position NFT

The amounts reported may not be exactly equivalent to the amounts transferred, due to rounding behavior

Parameters:#

NameTypeDescription
tokenIduint256The ID of the token for which underlying tokens were collected
recipientaddressThe address of the account that received the collected tokens
amount0uint256The amount of token0 owed to the position that was collected
amount1uint256The amount of token1 owed to the position that was collected