INonfungiblePositionManager
Wraps DragonswapV2 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:โ
tokenId
uint256
The ID of the token that represents the position
Return Values:โ
nonce
uint96
The nonce for permits
operator
address
The address that is approved for spending
token0
address
The address of the token0 for a specific pool
token1
address
The address of the token1 for a specific pool
fee
uint24
The fee associated with the pool
tickLower
int24
The lower end of the tick range for the position
tickUpper
int24
The higher end of the tick range for the position
liquidity
uint128
The liquidity of the position
feeGrowthInside0LastX128
uint256
The fee growth of token0 as of the last action on the individual position
feeGrowthInside1LastX128
uint256
The fee growth of token1 as of the last action on the individual position
tokensOwed0
uint128
The uncollected amount of token0 owed to the position as of the last computation
tokensOwed1
uint128
The 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:โ
tokenA
address
The contract address of either token0 or token1
tokenB
address
The contract address of the other token
fee
uint24
The fee amount of the v3 pool for the specified token pair
sqrtPriceX96
uint160
The 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:โ
pool
address
Returns 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:โ
params
struct INonfungiblePositionManager.MintParams
The params necessary to mint a position, encoded as MintParams
in calldata
Return Values:โ
tokenId
uint256
The ID of the token that represents the minted position
liquidity
uint128
The amount of liquidity for this position
amount0
uint256
The amount of token0
amount1
uint256
The 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:โ
params
struct INonfungiblePositionManager.IncreaseLiquidityParams
tokenId The ID of the token for which liquidity is being increased,
Return Values:โ
liquidity
uint128
The new liquidity amount as a result of the increase
amount0
uint256
The amount of token0 to acheive resulting liquidity
amount1
uint256
The 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:โ
params
struct INonfungiblePositionManager.DecreaseLiquidityParams
tokenId The ID of the token for which liquidity is being decreased
Return Values:โ
amount0
uint256
The amount of token0 sent to recipient
amount1
uint256
The 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:โ
params
struct INonfungiblePositionManager.CollectParams
tokenId The ID of the NFT for which tokens are being collected,
Return Values:โ
amount0
uint256
The amount of fees collected in token0
amount1
uint256
The 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:โ
tokenId
uint256
The 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:โ
tokenId
uint256
The ID of the token for which liquidity was increased
liquidity
uint128
The amount by which liquidity for the NFT position was increased
amount0
uint256
The amount of token0 that was paid for the increase in liquidity
amount1
uint256
The 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:โ
tokenId
uint256
The ID of the token for which liquidity was decreased
liquidity
uint128
The amount by which liquidity for the NFT position was decreased
amount0
uint256
The amount of token0 that was accounted for the decrease in liquidity
amount1
uint256
The 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:โ
tokenId
uint256
The ID of the token for which underlying tokens were collected
recipient
address
The address of the account that received the collected tokens
amount0
uint256
The amount of token0 owed to the position that was collected
amount1
uint256
The amount of token1 owed to the position that was collected
Last updated