IPositionDescriptor

Git Source - Generated with forge doc

Interface for the PositionDescriptor contract

Functions

tokenURI

Produces the URI describing a particular token ID

Note this URI may be a data: URI with the JSON contents directly inlined

function tokenURI(IPositionManager positionManager, uint256 tokenId) external view returns (string memory);

Parameters

Name	Type	Description
positionManager	IPositionManager	The position manager for which to describe the token
tokenId	uint256	The ID of the token for which to produce a description, which may not be valid

Returns

Name	Type	Description
<none>	string	The URI of the ERC721-compliant metadata

flipRatio

Returns true if currency0 has higher priority than currency1

function flipRatio(address currency0, address currency1) external view returns (bool);

Parameters

Name	Type	Description
currency0	address	The first currency address
currency1	address	The second currency address

Returns

Name	Type	Description
<none>	bool	True if currency0 has higher priority than currency1

currencyRatioPriority

Returns the priority of a currency. For certain currencies on mainnet, the smaller the currency, the higher the priority And those with the higher priority values (more positive values) will be in the numerator of the price ratio

function currencyRatioPriority(address currency) external view returns (int256);

Parameters

Name	Type	Description
currency	address	The currency address

Returns

Name	Type	Description
<none>	int256	The priority of the currency

wrappedNative

function wrappedNative() external view returns (address);

Returns

Name	Type	Description
<none>	address	The wrapped native token for this descriptor

nativeCurrencyLabel

function nativeCurrencyLabel() external view returns (string memory);

Returns

Name	Type	Description
<none>	string	The native currency label for this descriptor

poolManager

function poolManager() external view returns (IPoolManager);

Returns

Name	Type	Description
<none>	IPoolManager	The pool manager for this descriptor

Errors

InvalidTokenId

error InvalidTokenId(uint256 tokenId);