MaverickV2Position

Inherits: Nft, Checks, MigrateBins, PayableMulticall, IMaverickV2Position

ERC-721 contract that stores user NFTs that contain Maverick V2 pool liquidity.

The Maverick V2 pool has a concept of storing liquidity according to an address and a "subaccount". When liquidity is minted to an NFT, it is stored in the pool to the address of this Position contract to the subaccount that corresponds to the NFT tokenId. The mechanism of liquidity management is that the tokenId owner is the only user who can remove pool liquidity in the subaccount corresponding to their tokenId.

Additionally, this position NFT has data about the pools and binIds that a given tokenId has liquidity in. But these binId/pool values are essentially self reported and can be updated by the token owner by calling setTokenIdData.

State Variables

positionImage

IPositionImage public immutable positionImage;

dataByTokenId

mapping(uint256 => PositionPoolBinIds[]) private dataByTokenId;

Functions

constructor

constructor(IPositionImage _positionImage) Nft("Maverick v2 Position", "MPv2");

mint

Mint NFT that holds liquidity in a Maverick V2 Pool. To mint liquidity to an NFT, add liquidity to bins in a pool where the add liquidity recipient is this contract and the subaccount is the tokenId. LiquidityManager can be used to simplify minting Position NFTs.

function mint(address recipient, IMaverickV2Pool pool, uint32[] memory binIds) public returns (uint256 tokenId);

unSafeBurn

Burns the specified token without removing liquidity. Once tokenId is burned, it will no longer be possible to remove liquidity.

function unSafeBurn(uint256 tokenId) external onlyTokenIdAuthorizedUser(tokenId);

removeLiquidity

Remove liquidity from tokenId for a given pool. User can specify arbitrary bins to remove from for their subaccount in the pool even if those bins are not in the tokenIdData set.

function removeLiquidity(
    uint256 tokenId,
    address recipient,
    IMaverickV2Pool pool,
    IMaverickV2Pool.RemoveLiquidityParams memory params
) external onlyTokenIdAuthorizedUser(tokenId) returns (uint256 tokenAAmount, uint256 tokenBAmount);

removeLiquidityToSender

Remove liquidity from tokenId for a given pool to sender. User can specify arbitrary bins to remove from for their subaccount in the pool even if those bins are not in the tokenIdData set.

function removeLiquidityToSender(
    uint256 tokenId,
    IMaverickV2Pool pool,
    IMaverickV2Pool.RemoveLiquidityParams memory params
) external onlyTokenIdAuthorizedUser(tokenId) returns (uint256 tokenAAmount, uint256 tokenBAmount);

setTokenIdData

Overwrites tokenId pool/binId information for a given data index.

function setTokenIdData(uint256 tokenId, uint256 index, IMaverickV2Pool pool, uint32[] memory binIds)
    external
    onlyTokenIdAuthorizedUser(tokenId);

setTokenIdData

Overwrites tokenId pool/binId information for a given data index.

function setTokenIdData(uint256 tokenId, PositionPoolBinIds[] memory data)
    external
    onlyTokenIdAuthorizedUser(tokenId);

appendTokenIdData

Append new pool/binIds data array to tokenId.

function appendTokenIdData(uint256 tokenId, IMaverickV2Pool pool, uint32[] memory binIds)
    external
    onlyTokenIdAuthorizedUser(tokenId);

getTokenIdData

Get array pool/binIds data for a given tokenId.

function getTokenIdData(uint256 tokenId) external view returns (PositionPoolBinIds[] memory);

getTokenIdData

Get array pool/binIds data for a given tokenId.

function getTokenIdData(uint256 tokenId, uint256 index) external view returns (PositionPoolBinIds memory);

tokenIdDataLength

Length of array of pool/binIds data for a given tokenId.

function tokenIdDataLength(uint256 tokenId) external view returns (uint256 length);

tokenIdPositionInformation

NFT asset information for a given range of pool/binIds indexes. This function only returns the liquidity in the pools/binIds stored as part of the tokenIdData, but it is possible that the NFT has additional liquidity in pools/binIds that have not been recorded.

function tokenIdPositionInformation(uint256 tokenId, uint256 startIndex, uint256 stopIndex)
    public
    view
    returns (PositionFullInformation[] memory output);

tokenIdPositionInformation

NFT asset information for a given range of pool/binIds indexes. This function only returns the liquidity in the pools/binIds stored as part of the tokenIdData, but it is possible that the NFT has additional liquidity in pools/binIds that have not been recorded.

function tokenIdPositionInformation(uint256 tokenId, uint256 index)
    public
    view
    returns (PositionFullInformation memory output);

getRemoveParams

Get remove paramters for removing a fractional part of the liquidity owned by a given tokenId. The fractional factor to remove is given by proporationD18 in 18-decimal scale.

function getRemoveParams(uint256 tokenId, uint256 index, uint256 proportionD18)
    public
    view
    returns (IMaverickV2Pool.RemoveLiquidityParams memory params);

_checkData

Checks that binIds are unique.

function _checkData(PositionPoolBinIds memory data) internal view;

_checkNoDuplicatePool

Checks that token data does not contain duplicate pool.

function _checkNoDuplicatePool(uint256 tokenId) internal view;

tokenURI

function tokenURI(uint256 tokenId) public view virtual override(Nft, INft) returns (string memory);

name

function name() public view override(INft, Nft) returns (string memory);

symbol

function symbol() public view override(INft, Nft) returns (string memory);