Skip to content

@gala-chain/api ∙ API

API > UserPosition

Class: UserPosition

Contents

Extends

Constructors

new UserPosition(user)

new UserPosition(user): UserPosition

Parameters

▪ user: string

Overrides

ChainObject.constructor

Source

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

Properties

positions

positions: PositionsObject

Source

chain-api/src/types/DexUserPositions.ts:37

user

readonly user: string

Source

chain-api/src/types/DexUserPositions.ts:33

COMPOSITEKEY_NS

static COMPOSITEKEY_NS: string = "\x00"

Inherited from

ChainObject.COMPOSITEKEY_NS

Source

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

ID_SPLIT_CHAR

static ID_SPLIT_CHAR: string = "$"

Inherited from

ChainObject.ID_SPLIT_CHAR

Source

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

ID_SUB_SPLIT_CHAR

static ID_SUB_SPLIT_CHAR: string = "|"

Inherited from

ChainObject.ID_SUB_SPLIT_CHAR

Source

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

INDEX_KEY

static INDEX_KEY: string = "GCULP"

Source

chain-api/src/types/DexUserPositions.ts:29

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:43

Methods

deletePosition()

deletePosition(poolAddress, tickLower, tickUpper): void

Parameters

▪ poolAddress: string

▪ tickLower: number

▪ tickUpper: number

Source

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

getCompositeKey()

getCompositeKey(): string

Inherited from

ChainObject.getCompositeKey

Source

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

removeLiquidity()

removeLiquidity(poolAddress, tickLower, tickUpper, liquidity): void

Parameters

▪ poolAddress: string

▪ tickLower: number

▪ tickUpper: number

▪ liquidity: BigNumber

Source

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

serialize()

serialize(): string

Inherited from

ChainObject.serialize

Source

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

toPlainObject()

toPlainObject(): Record\<string, unknown>

Inherited from

ChainObject.toPlainObject

Source

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

updateOrCreate()

updateOrCreate(poolAddress, tickLower, tickUpper, liquidity): void

Parameters

▪ poolAddress: string

▪ tickLower: number

▪ tickUpper: number

▪ liquidity: BigNumber

Source

chain-api/src/types/DexUserPositions.ts:45

validate()

validate(): Promise\<ValidationError[]>

Inherited from

ChainObject.validate

Source

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

validateOrReject()

validateOrReject(): Promise\<void>

Inherited from

ChainObject.validateOrReject

Source

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

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:72

getCompositeKeyFromParts()

static getCompositeKeyFromParts(indexKey, parts): string

Parameters

▪ indexKey: string

▪ parts: unknown[]

Inherited from

ChainObject.getCompositeKeyFromParts

Source

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

getStringKeyFromParts()

static getStringKeyFromParts(parts): string

Parameters

▪ parts: string[]

Inherited from

ChainObject.getStringKeyFromParts

Source

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