Skip to main content

DurableRouterLedger

@totemsdk/omnia-router

@totemsdk/omnia-router / DurableRouterLedger

Interface: DurableRouterLedger

Methods​

getRevision()​

getRevision(): Promise<number>

Returns​

Promise<number>

getSettled()​

getSettled(channelId, htlcId): Promise<SettledSegment | undefined>

Retrieve a previously settled segment.

Parameters​

channelId​

string

htlcId​

string

Returns​

Promise<SettledSegment | undefined>

getSnapshot()​

getSnapshot(): Promise<RouterLedgerState>

Returns​

Promise<RouterLedgerState>

hasState()​

hasState(): Promise<boolean>

Returns​

Promise<boolean>

isSettled()​

isSettled(channelId, htlcId): Promise<boolean>

True when the given channel+HTLC already settled.

Parameters​

channelId​

string

htlcId​

string

Returns​

Promise<boolean>

listSettled()​

listSettled(channelId?): Promise<SettledSegment[]>

All settled segments, optionally filtered by channel.

Parameters​

channelId?​

string

Returns​

Promise<SettledSegment[]>

markReconciled()​

markReconciled(channelId, htlcId): Promise<void>

Mark a settled segment as reconciled with the route state.

Parameters​

channelId​

string

htlcId​

string

Returns​

Promise<void>

recordSettled()​

recordSettled(segment): Promise<void>

Idempotently record a settled segment. Re-recording the same segment is a no-op.

Parameters​

segment​

SettledSegment

Returns​

Promise<void>