Class CachingArkProvider

Decorates an ArkProvider, caching ArkProvider.getInfo for ttlMs (default 60s). Other provider methods pass through. Expired-cache refresh failures propagate; persisted wallet boot fallback lives in arkInfoSnapshot.

Implements

ArkProvider

Index

Constructors

constructor

new CachingArkProvider(inner: ArkProvider, ttlMs?: number): CachingArkProvider
Parameters
- inner: ArkProvider
- ttlMs: number = DEFAULT_TTL_MS
Returns CachingArkProvider
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:32

Accessors

serverUrl

get serverUrl(): string | undefined
Returns string | undefined
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:49

Methods

confirmRegistration

confirmRegistration(intentId: string): Promise<void>
Confirm an already registered intent id.
Parameters
- intentId: string
Returns Promise<void>
Implementation of ArkProvider.confirmRegistration
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:93

deleteIntent

deleteIntent(intent: SignedIntent<DeleteMessage>): Promise<void>
Delete a previously registered intent.
Parameters
- intent: SignedIntent<DeleteMessage>
Returns Promise<void>
Implementation of ArkProvider.deleteIntent
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:89

dispose

dispose(): void
Releases the inner provider's server-info subscription.

Returns void
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:45

finalizeTx

finalizeTx(arkTxid: string, finalCheckpointTxs: string[]): Promise<void>
Finalize a previously submitted Arkade transaction.
Parameters
- arkTxid: string
- finalCheckpointTxs: string[]
Returns Promise<void>
Implementation of ArkProvider.finalizeTx
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:81

getEventStream

getEventStream(
signal: AbortSignal,
topics: string[],
): AsyncIterableIterator<SettlementEvent>
Open the settlement event stream for the given topics.
Parameters
- signal: AbortSignal
- topics: string[]
Returns AsyncIterableIterator<SettlementEvent>
Implementation of ArkProvider.getEventStream
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:109

getInfo

getInfo(): Promise<ArkadeInfo>
Fetch Arkade server configuration and fee settings.

Returns Promise<ArkadeInfo>
Implementation of ArkProvider.getInfo
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:54

getPendingTxs

getPendingTxs(intent: SignedIntent<GetPendingTxMessage>): Promise<PendingTx[]>
Fetch pending transactions for a signed get-pending-tx intent.
Parameters
- intent: SignedIntent<GetPendingTxMessage>
Returns Promise<PendingTx[]>
Implementation of ArkProvider.getPendingTxs
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:117

getTransactionsStream

getTransactionsStream(
signal: AbortSignal,
): AsyncIterableIterator<TxNotificationEvent>
Stream transaction notifications emitted by the Arkade server.
Parameters
- signal: AbortSignal
Returns AsyncIterableIterator<TxNotificationEvent>
Implementation of ArkProvider.getTransactionsStream
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:113

onServerInfoChanged

onServerInfoChanged(listener: (info: ArkadeInfo) => void): () => void
Parameters
- listener: (info: ArkadeInfo) => void
Returns () => void
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:121

registerIntent

registerIntent(intent: SignedIntent<RegisterMessage>): Promise<string>
Register a signed intent with the Arkade server.
Parameters
- intent: SignedIntent<RegisterMessage>
Returns Promise<string>
Implementation of ArkProvider.registerIntent
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:85

submitSignedForfeitTxs

submitSignedForfeitTxs(
signedForfeitTxs: string[],
signedCommitmentTx?: string,
): Promise<void>
Submit signed forfeit transactions for cooperative settlement.
Parameters
- signedForfeitTxs: string[]
- OptionalsignedCommitmentTx: string
Returns Promise<void>
Implementation of ArkProvider.submitSignedForfeitTxs
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:105

submitTreeNonces

submitTreeNonces(
    batchId: string,
    pubkey: string,
    nonces: TreeNonces,
): Promise<void>
Submit musig2 tree nonces for a batch signing session.
Parameters
- batchId: string
- pubkey: string
- nonces: TreeNonces
Returns Promise<void>
Implementation of ArkProvider.submitTreeNonces
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:97

submitTreeSignatures

submitTreeSignatures(
    batchId: string,
    pubkey: string,
    signatures: TreePartialSigs,
): Promise<void>
Submit musig2 partial signatures for a batch signing session.
Parameters
- batchId: string
- pubkey: string
- signatures: TreePartialSigs
Returns Promise<void>
Implementation of ArkProvider.submitTreeSignatures
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:101

submitTx

submitTx(
    signedArkTx: string,
    checkpointTxs: string[],
): Promise<
    { arkTxid: string; finalArkTx: string; signedCheckpointTxs: string[] },
>
Submit a signed Arkade transaction and its checkpoint transactions.
Parameters
- signedArkTx: string
- checkpointTxs: string[]
Returns Promise<{ arkTxid: string; finalArkTx: string; signedCheckpointTxs: string[] }>
Implementation of ArkProvider.submitTx
- Defined in packages/ts-sdk/src/providers/cachingArk.ts:77

Class CachingArkProvider

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns CachingArkProvider

Accessors

serverUrl

Returns string | undefined

Methods

confirmRegistration

Parameters

Returns Promise<void>

deleteIntent

Parameters

Returns Promise<void>

dispose

Returns void

finalizeTx

Parameters

Returns Promise<void>

getEventStream

Parameters

Returns AsyncIterableIterator<SettlementEvent>

getInfo

Returns Promise<ArkadeInfo>

getPendingTxs

Parameters

Returns Promise<PendingTx[]>

getTransactionsStream

Parameters

Returns AsyncIterableIterator<TxNotificationEvent>

onServerInfoChanged

Parameters

Returns () => void

registerIntent

Parameters

Returns Promise<string>

submitSignedForfeitTxs

Parameters

Returns Promise<void>

submitTreeNonces

Parameters

Returns Promise<void>

submitTreeSignatures

Parameters

Returns Promise<void>

submitTx

Parameters

Returns Promise<{ arkTxid: string; finalArkTx: string; signedCheckpointTxs: string[] }>

Settings

On This Page