Skip to content

@gala-chain/api ∙ API

API > DexPositionData

Class: DexPositionData

Contents

Extends

Constructors

new DexPositionData(poolHash, positionId, tickUpper, tickLower, token0ClassKey, token1ClassKey, fee)

new DexPositionData(poolHash, positionId, tickUpper, tickLower, token0ClassKey, token1ClassKey, fee): DexPositionData

Initializes a new instance of the pool position.

Parameters

▪ poolHash: string

Unique identifier for the pool.

▪ positionId: string

Unique identifier for this position.

▪ tickUpper: number

Upper tick boundary for the position.

▪ tickLower: number

Lower tick boundary for the position.

▪ token0ClassKey: TokenClassKey

▪ token1ClassKey: TokenClassKey

▪ fee: DexFeePercentageTypes

Overrides

ChainObject.constructor

Source

chain-api/src/types/DexPositionData.ts:96

Properties

fee

readonly fee: DexFeePercentageTypes

Source

chain-api/src/types/DexPositionData.ts:86

feeGrowthInside0Last

feeGrowthInside0Last: BigNumber

Source

chain-api/src/types/DexPositionData.ts:63

feeGrowthInside1Last

feeGrowthInside1Last: BigNumber

Source

chain-api/src/types/DexPositionData.ts:67

liquidity

liquidity: BigNumber

Source

chain-api/src/types/DexPositionData.ts:59

poolHash

poolHash: string

Source

chain-api/src/types/DexPositionData.ts:39

positionId

positionId: string

Source

chain-api/src/types/DexPositionData.ts:55

tickLower

tickLower: number

Source

chain-api/src/types/DexPositionData.ts:50

tickUpper

tickUpper: number

Source

chain-api/src/types/DexPositionData.ts:44

token0ClassKey

readonly token0ClassKey: TokenClassKey

Source

chain-api/src/types/DexPositionData.ts:79

token1ClassKey

readonly token1ClassKey: TokenClassKey

Source

chain-api/src/types/DexPositionData.ts:83

tokensOwed0

tokensOwed0: BigNumber

Source

chain-api/src/types/DexPositionData.ts:71

tokensOwed1

tokensOwed1: BigNumber

Source

chain-api/src/types/DexPositionData.ts:75

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

chain-api/src/types/ChainObject.ts:46

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

chain-api/src/types/ChainObject.ts:49

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

chain-api/src/types/ChainObject.ts:51

INDEX_KEY

static INDEX_KEY: string = "GCDEXCHPD"

Source

chain-api/src/types/DexPositionData.ts:34

MIN_UNICODE_RUNE_VALUE

static MIN_UNICODE_RUNE_VALUE: string = "\u0000"

Inherited from

ChainObject.MIN_UNICODE_RUNE_VALUE

Source

chain-api/src/types/ChainObject.ts:44

Methods

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

chain-api/src/types/ChainObject.ts:80

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

chain-api/src/types/ChainObject.ts:53

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

chain-api/src/types/ChainObject.ts:69

updatePosition()

updatePosition(liquidityDelta, feeGrowthInside0, feeGrowthInside1): void

Updates the position's liquidity and fee tracking data.

Parameters

▪ liquidityDelta: BigNumber

Change in liquidity (can be positive or negative).

▪ feeGrowthInside0: BigNumber

Latest accumulated fee growth for token0 within the tick range.

▪ feeGrowthInside1: BigNumber

Latest accumulated fee growth for token1 within the tick range.

Source

chain-api/src/types/DexPositionData.ts:128

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

chain-api/src/types/ChainObject.ts:57

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

chain-api/src/types/ChainObject.ts:61

decodeFromBase58()

static decodeFromBase58(base58String): string

Parameters

▪ base58String: string

Inherited from

ChainObject.decodeFromBase58

Source

chain-api/src/types/ChainObject.ts:142

deserialize()

static deserialize\<T>(constructor, object): T

Type parameters

▪ T

Parameters

▪ constructor: ClassConstructor\<Inferred\<T, ChainObject>>

▪ object: string | Record\<string, unknown> | Record\<string, unknown>[]

Inherited from

ChainObject.deserialize

Source

chain-api/src/types/ChainObject.ts:73

encodeToBase58()

static encodeToBase58(stringKey): string

Parameters

▪ stringKey: string

Inherited from

ChainObject.encodeToBase58

Source

chain-api/src/types/ChainObject.ts:137

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

chain-api/src/types/ChainObject.ts:105

getEncodableStringKeyFromParts()

static getEncodableStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getEncodableStringKeyFromParts

Source

chain-api/src/types/ChainObject.ts:129

getPartsFromEncodableStringKey()

static getPartsFromEncodableStringKey(stringKey): string[]

Parameters

▪ stringKey: string

Inherited from

ChainObject.getPartsFromEncodableStringKey

Source

chain-api/src/types/ChainObject.ts:133

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

chain-api/src/types/ChainObject.ts:125