NonfungiblePositionManager

Wraps SMB V3 positions in the ERC721 non-fungible token interface

Contract Info

BSC Address: 0x861Df60F27070E60E094763c73B4ff3A89CfeE9e

Solidity API

Position

struct Position {
  uint96 nonce;
  address operator;
  uint80 poolId;
  int24 tickLower;
  int24 tickUpper;
  uint128 liquidity;
  uint256 feeGrowthInside0LastX128;
  uint256 feeGrowthInside1LastX128;
  uint128 tokensOwed0;
  uint128 tokensOwed1;
}

constructor

constructor(address _deployer, address _factory, address _WETH9, address _tokenDescriptor_) public

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

Return Values

mint

function mint(struct INonfungiblePositionManager.MintParams params) external payable 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

Return Values

isAuthorizedForToken

modifier isAuthorizedForToken(uint256 tokenId)

tokenURI

function tokenURI(uint256 tokenId) public view returns (string)

baseURI

function baseURI() public pure returns (string)

_Returns the base URI set via {setBaseURI}. This will be automatically added as a prefix in {tokenURI} to each token's URI, or to the token ID if no specific URI is set for that token ID.

increaseLiquidity

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

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

Parameters

Return Values

decreaseLiquidity

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

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

Parameters

Return Values

collect

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

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

Parameters

Return Values

burn

function burn(uint256 tokenId) external payable

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

_getAndIncrementNonce

function _getAndIncrementNonce(uint256 tokenId) internal returns (uint256)

Gets the current nonce for a token ID and then increments it, returning the original value

getApproved

function getApproved(uint256 tokenId) public view returns (address)

_Returns the account approved for tokenId token.

Requirements:

  • tokenId must exist._

_approve

function _approve(address to, uint256 tokenId) internal

_Overrides approve to use the operator in the position, which is packed with the position permit nonce

Last updated