Skip to content

@gala-chain/api ∙ API

API > DexPositionOwner

Class: DexPositionOwner

Contents

Extends

Constructors

new DexPositionOwner(owner, poolHash)

new DexPositionOwner(owner, poolHash): DexPositionOwner

Intiializes a new DexPositionOwner instance.

Parameters

▪ owner: string

User alias of the position owner.

▪ poolHash: string

Unique identifier of the pool.

Overrides

ChainObject.constructor

Source

chain-api/src/types/DexPositionOwner.ts:54

Properties

owner

owner: string

Source

chain-api/src/types/DexPositionOwner.ts:36

poolHash

poolHash: string

Source

chain-api/src/types/DexPositionOwner.ts:41

tickRangeMap

tickRangeMap: Record\<string, string[]>

Source

chain-api/src/types/DexPositionOwner.ts:47

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 = "GCDEXCPO"

Source

chain-api/src/types/DexPositionOwner.ts:31

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

addPosition()

addPosition(tickRange, positionId): void

Adds or updates a position ID for the specified tick range.

Parameters

▪ tickRange: string

Tick range string to map (e.g., "10:20").

▪ positionId: string

ID of the position to associate.

Source

chain-api/src/types/DexPositionOwner.ts:66

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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

getPositionId()

getPositionId(tickRange): undefined | string

Retrieves the first position ID of the positions that the user owns in the specified tick range.

Parameters

▪ tickRange: string

Tick range string to look up.

Returns

The associated position ID, or undefined if not found.

Source

chain-api/src/types/DexPositionOwner.ts:91

getTickRangeByPositionId()

getTickRangeByPositionId(positionId): undefined | string

Returns the tick range key that includes the given position ID. Searches through the tickRangeMap to find which tick range the positionId belongs to.

Parameters

▪ positionId: string

The position ID to search for

Returns

The corresponding tick range key, or undefined if not found

Source

chain-api/src/types/DexPositionOwner.ts:101

removePosition()

removePosition(tickRange, positionId): void

Removes the position mapping for the given tick range.

Parameters

▪ tickRange: string

Tick range string to remove.

▪ positionId: string

Source

chain-api/src/types/DexPositionOwner.ts:77

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

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