Skip to main content

Interface: GdexLiquidityEvent

gSwap SDK 2.0.0-rc.4

gSwap SDK 2.0.0-rc.4 / GdexLiquidityEvent

Interface: GdexLiquidityEvent

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

One committed add, remove or collect, as the liquidity channel reports it.

Properties​

action​

action: "add" | "remove" | "collect"

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

add, remove or collect.

amount0​

amount0: string

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

Principal moved: deposited by an add, withdrawn by a remove, "0" for a collect.

amount1​

amount1: string

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

blockNumber​

blockNumber: number

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

fees0?​

optional fees0?: string

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

Fees paid out. v2: always present ("0" for an add). v1: present on a collect only.

fees1?​

optional fees1?: string

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

liquidityAfter?​

optional liquidityAfter?: string

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

v2 only: the position's liquidity after the operation; "0" means it is closed.

owner​

owner: string

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

The position's owner (the LP wallet).

pool​

pool: GdexPoolKey

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

poolHash​

poolHash: string

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

positionId?​

optional positionId?: string

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

v1: the position id. v2: the chain position key <pool>|<tickLow>|<tickHigh>|<owner>.

tickLower?​

optional tickLower?: number

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

tickUpper?​

optional tickUpper?: number

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

timestamp​

timestamp: string

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

token0Symbol?​

optional token0Symbol?: string

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

v2 only.

token1Symbol?​

optional token1Symbol?: string

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

transactionId​

transactionId: string

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

version​

version: "v2" | "v1"

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