position.gno

Adds or removes liquidity from pools. Includes minting and burning of positions.

Mint

func Mint(
	token0 string,
	token1 string,
	fee uint32,
	tickLower int32,
	tickUpper int32,
	amount0Desired string,
	amount1Desired string,
	amount0Min string,
	amount1Min string,
	deadline int64,
	mintTo string
) (uint64, string, string, string)

Adds liquidity to a pool. Internally calls the mint function of the pool contract.

Parameters

NameTypeDescription

token0

string

The path of the token0 of the desired pool.

token1

string

The path of the token1 of the desired pool.

fee

uint32

The fee tier of the pool.

tickLower

int32

The lower tick of the price range of the position.

tickUpper

int32

The upper tick of the price range of the position.

amount0Desired

string

The maximum amount of token0 to add.

amount1Desired

string

The maximum amount of token1 to add.

amount0Min

string

The minimum amount of token0 to add.

amount1Min

string

The minimum amount of token1 to add.

deadline

int64

The deadline at which the transaction will expire.

mintTo

string

The address to receive the minted position.

Return Values

NameTypeDescription

tokenId

uint64

The ID of the position that was minted.

liquidity

string

The amount of liquidity added to the pool.

amount0

string

The amount of token0 added to the pool.

amount1

string

The amount of token1 added to the pool.

IncreaseLiquidity

func IncreaseLiquidity(
	tokenId uint64,
	_amount0Desired string,
	_amount1Desired string,
	_amount0Min string,
	_amount1Min string,
	deadline int64,
) (uint64, string, string, string, string)

Adds additional liquidity to an existing position.

Parameters

NameTypeDescription

tokenId

uint64

The ID of the position NFT in which to increase liquidity.

amount0Desired

string

The maximum amount of token0 to increase.

amount1Desired

string

The maximum amount of token1 to increase.

amount0Min

string

The minimum amount of token0 to increase.

amount1Min

string

The minimum amount of token1 to increase.

deadline

int64

The deadline at which the transaction will expire.

Return Values

NameTypeDescription

tokenId

uint64

The ID of the position that the liquidity was increased.

liquidity

string

The amount of liquidity added to the position.

amount0

string

The amount of token0 added to the position.

amount1

string

The amount of token1 added to the position.

poolPath

string

The path of the pool from which the position exists.

DecreaseLiquidity

func DecreaseLiquidity(
	tokenId uint64,
	liquidityRatio uint64,
	_amount0Min string,
	_amount1Min string,
	deadline int64,
	unwrapResult bool,
) (uint64, string, string, string, string)

Decreases liquidity of an existing position.

Parameters

NameTypeDescription

tokenId

uint64

The ID of the position to decrease liquidity from.

liquidityRatio

string

The amount of liquidity to decrease.

amount0Min

string

The minimum amount of token0 to decrease.

amount1Min

string

The minimum amount of token1 to decrease.

deadline

int64

The deadline at which the transaction will expire.

unwrapResult

bool

Whether or not to receive tokens in native ugnot if either token0 or token1 is wugnot.

Return Values

NameTypeDescription

tokenId

uint64

The ID of the position that the liquidity was decreased.

liquidity

string

The amount of liquidity decreased from the position.

fee0

string

The amount of token0 fees collected.

fee1

string

The amount of token1 fees collected.

amount0

string

The amount of token0 decreased from the position.

amount1

string

The amount of token1 decreased from the position.

poolPath

string

The path of the pool in which the position exists.

CollectFee

func CollectFee(
	tokenId uint64,
) (uint64, string, string, string)

Collects fee accrued to a position.

Parameters

NameTypeDescription

tokenId

uint64

The ID of the position.

Return Values

NameTypeDescription

tokenId

uint64

The ID of the position.

tokensOwed0

string

The amount of token0 that was collected.

tokensOwed1

string

The amount of token1 that was collected.

poolPath

string

The path of the pool from which the position exists.

Last updated