Skip to main content

Interface: AddLiquidityArgs

gSwap SDK 2.0.0-rc.4


gSwap SDK 2.0.0-rc.4 / AddLiquidityArgs

Interface: AddLiquidityArgs

Defined in: packages/gswap-sdk/dist/index.d.ts:2762

Arguments of Positions.addLiquidityByTicks and Positions.buildAddLiquidity.

Extends​

  • UniqueKeyArg

Properties​

amount​

amount: NumericAmount

Defined in: packages/gswap-sdk/dist/index.d.ts:2768


amountIsToken0​

amountIsToken0: boolean

Defined in: packages/gswap-sdk/dist/index.d.ts:2770

Whether amount is of token0 as the caller passed it (not of the canonical token0).


fee​

fee: FEE_TIER

Defined in: packages/gswap-sdk/dist/index.d.ts:2765


tickLower​

tickLower: number

Defined in: packages/gswap-sdk/dist/index.d.ts:2766


tickUpper​

tickUpper: number

Defined in: packages/gswap-sdk/dist/index.d.ts:2767


token0​

token0: TokenRef

Defined in: packages/gswap-sdk/dist/index.d.ts:2763


token1​

token1: TokenRef

Defined in: packages/gswap-sdk/dist/index.d.ts:2764


uniqueKey?​

optional uniqueKey?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:2759

The attempt's uniqueKey (1-128 characters of A-Za-z0-9._:-). Default: a fresh <uniqueKeyPrefix><uuid>. Supply one to know the key before signing, or to retry the SAME attempt after a lost response; never reuse it for another write.

Inherited from​

UniqueKeyArg.uniqueKey