Skip to main content

DurableLiquidityBondStore

@totemsdk/liquidity-bond


@totemsdk/liquidity-bond / DurableLiquidityBondStore

Interface: DurableLiquidityBondStore

Methods

attachAllocation()

attachAllocation(allocation): Promise<void>

Parameters

allocation

LiquidityAllocation

Returns

Promise<void>


attachFeeRecord()

attachFeeRecord(record): Promise<void>

Parameters

record

LiquidityFeeRecord

Returns

Promise<void>


attachReceipt()

attachReceipt(receipt): Promise<void>

Parameters

receipt

LiquidityReceipt

Returns

Promise<void>


attachWithdrawalIntent()

attachWithdrawalIntent(intent): Promise<void>

Parameters

intent

WithdrawalIntent

Returns

Promise<void>


getPool()

getPool(poolId): Promise<LiquidityPoolManifest | undefined>

Parameters

poolId

string

Returns

Promise<LiquidityPoolManifest | undefined>


getPosition()

getPosition(positionId): Promise<LiquidityPosition | undefined>

Parameters

positionId

string

Returns

Promise<LiquidityPosition | undefined>


getReceipt()

getReceipt(receiptId): Promise<LiquidityReceipt | undefined>

Parameters

receiptId

string

Returns

Promise<LiquidityReceipt | undefined>


getRevision()

getRevision(): Promise<number>

Current registry transition counter (0 before the first write).

Returns

Promise<number>


getSnapshot()

getSnapshot(): Promise<LiquidityBondRegistryState>

Returns

Promise<LiquidityBondRegistryState>


hasState()

hasState(): Promise<boolean>

True once any registry record has been persisted.

Returns

Promise<boolean>


listActivePositions()

listActivePositions(): Promise<LiquidityPosition[]>

Returns

Promise<LiquidityPosition[]>


listPools()

listPools(): Promise<LiquidityPoolManifest[]>

Returns

Promise<LiquidityPoolManifest[]>


listPositionsByLp()

listPositionsByLp(lpAddress): Promise<LiquidityPosition[]>

Parameters

lpAddress

string

Returns

Promise<LiquidityPosition[]>


listPositionsByPool()

listPositionsByPool(poolId): Promise<LiquidityPosition[]>

Parameters

poolId

string

Returns

Promise<LiquidityPosition[]>


listWithdrawablePositions()

listWithdrawablePositions(now): Promise<LiquidityPosition[]>

Parameters

now

number

Returns

Promise<LiquidityPosition[]>


registerCommitment()

registerCommitment(commitment): Promise<void>

Parameters

commitment

LiquidityCommitment

Returns

Promise<void>


registerPool()

registerPool(pool): Promise<void>

Parameters

pool

LiquidityPoolManifest

Returns

Promise<void>


registerPosition()

registerPosition(position): Promise<void>

Parameters

position

LiquidityPosition

Returns

Promise<void>


updatePool()

updatePool(pool): Promise<void>

Parameters

pool

LiquidityPoolManifest

Returns

Promise<void>