NonfungiblePositionManager
This contract wraps KLAYswap V3 positions in the ERC721 non-fungible token interface
Code
Github Link: (Will be updated after official launch)
Address
Events, Read-Only Functions, and State-Changing Functions
Events
IncreaseLiquidity
event IncreaseLiquidity(
uint256 indexed 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 indexed 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 indexed tokenId,
address recipient,
uint256 amount0,
uint256 amount1,
uint256 reward
);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
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;
}Read-Only 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
positionRewards
function positionRewards(uint256 tokenId)
external
view
returns (
uint256 rewardGrowthInsideLastX128,
uint128 reward,
uint128 fee0Sum,
uint128 fee1Sum,
uint128 rewardSum
);Parameters:
tokenId
uint256
The ID of the token that represents the position
Return Values:
rewardGrowthInsideLastX128
uint256
The reward growth as of the last action on the individual position
reward
uint128
The uncollected amount of reward
fee0Sum
uint128
The cumulated amountof fee0
fee1Sum
uint128
The cumulated amountof fee1
rewardSum
uint128
The collected amount of reward
getApproved
function getApproved() public view returns (address)Returns the account approved for tokenId token. Requirements:
tokenIdmust exist.
tokenURI
function tokenURI(uint256 tokenId) public view returns (string)Returns a URI describing a particular token ID
Parameters:
tokenId
uint256
The ID of the token that represents the minted position
Return Values:
A base64 string with the URI data.
baseURI
function baseURI() public returns (string)State-Changing Functions
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
The params necessary to increase liquidity on the position, encoded as IncreaseLiquidityParams in calldata
Return Values:
liquidity
uint128
The new liquidity amount as a result of the increase
amount0
uint256
The amount of token0 to achieve resulting liquidity
amount1
uint256
The amount of token1 to achieve 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
The params necessary to decrease liquidity on the position, encoded as IncreaseLiquidityParams in calldata
Return Values:
amount0
uint256
The amount of token0 accounted to the position's tokens owed
amount1
uint256
The amount of token1 accounted to the position's tokens owed
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
The params necessary to collect, encoded as CollectParams in calldata
recipient The account that should receive the tokens, amount0Max The maximum amount of token0 to collect, amount1Max The maximum amount of token1 to collect
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) externalBurns 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
Last updated