Class RestArkProvider

constructor

• new RestArkProvider(serverUrl: string): RestArkProvider

  Parameters

  • serverUrl: string

  Returns RestArkProvider

serverUrl

confirmRegistration

• confirmRegistration(intentId: string): Promise<void>

  Confirm an already registered intent id.

  Parameters

  • intentId: string

  Returns Promise<void>

deleteIntent

• deleteIntent(intent: SignedIntent<DeleteMessage>): Promise<void>

  Delete a previously registered intent.

  Parameters

  • intent: SignedIntent<DeleteMessage>

  Returns Promise<void>

finalizeTx

• finalizeTx(arkTxid: string, finalCheckpointTxs: string[]): Promise<void>

  Finalize a previously submitted Arkade transaction.

  Parameters

  • arkTxid: string
  • finalCheckpointTxs: string[]

  Returns Promise<void>

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>

getInfo

• getInfo(): Promise<ArkInfo>

  Fetch Arkade server configuration and fee settings.

  Returns Promise<ArkInfo>

getPendingTxs

• getPendingTxs(intent: SignedIntent<GetPendingTxMessage>): Promise<PendingTx[]>

  Fetch pending transactions for a signed get-pending-tx intent.

  Parameters

  • intent: SignedIntent<GetPendingTxMessage>

  Returns Promise<PendingTx[]>

getTransactionsStream

• getTransactionsStream(
      signal: AbortSignal,
  ): AsyncIterableIterator<
      { arkTx?: TxNotification; commitmentTx?: TxNotification },
  >

  Stream transaction notifications emitted by the Arkade server.

  Parameters

  • signal: AbortSignal

  Returns AsyncIterableIterator<{ arkTx?: TxNotification; commitmentTx?: TxNotification }>

registerIntent

• registerIntent(intent: SignedIntent<RegisterMessage>): Promise<string>

  Register a signed intent with the Arkade server.

  Parameters

  • intent: SignedIntent<RegisterMessage>

  Returns Promise<string>

submitSignedForfeitTxs

• submitSignedForfeitTxs(
      signedForfeitTxs: string[],
      signedCommitmentTx?: string,
  ): Promise<void>

  Submit signed forfeit transactions for cooperative settlement.

  Parameters

  • signedForfeitTxs: string[]
  • OptionalsignedCommitmentTx: string

  Returns Promise<void>

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>

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>

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[] }>