Class RestIndexerProvider

constructor

• new RestIndexerProvider(serverUrl: string): RestIndexerProvider

  Parameters

  • serverUrl: string

  Returns RestIndexerProvider

serverUrl

getAssetDetails

• getAssetDetails(assetId: string): Promise<AssetDetails>

  Fetch metadata for a specific asset id.

  Parameters

  • assetId: string

    Asset identifier

  Returns Promise<AssetDetails>

  Asset details

getBatchSweepTransactions

• getBatchSweepTransactions(
      batchOutpoint: Outpoint,
  ): Promise<{ sweptBy: string[] }>

  Fetch sweep transactions that spent a batch.

  Parameters

  • batchOutpoint: Outpoint

    Batch outpoint to inspect

  Returns Promise<{ sweptBy: string[] }>

  Sweep transaction ids

getCommitmentTx

• getCommitmentTx(txid: string): Promise<CommitmentTx>

  Fetch a commitment transaction by txid.

  Parameters

  • txid: string

    Commitment transaction id

  Returns Promise<CommitmentTx>

  Commitment transaction details

getCommitmentTxConnectors

• getCommitmentTxConnectors(
      txid: string,
      opts?: PaginationOptions,
  ): Promise<{ connectors: Tx[]; page?: PageResponse }>

  Fetch connector transactions for a commitment transaction.

  Parameters

  • txid: string

    Commitment transaction id

  • Optionalopts: PaginationOptions

    Optional pagination settings

  Returns Promise<{ connectors: Tx[]; page?: PageResponse }>

  Connector transactions and optional pagination state

getCommitmentTxForfeitTxs

• getCommitmentTxForfeitTxs(
      txid: string,
      opts?: PaginationOptions,
  ): Promise<{ page?: PageResponse; txids: string[] }>

  Fetch forfeit transaction ids for a commitment transaction.

  Parameters

  • txid: string

    Commitment transaction id

  • Optionalopts: PaginationOptions

    Optional pagination settings

  Returns Promise<{ page?: PageResponse; txids: string[] }>

  Forfeit transaction ids and optional pagination state

getSubscription

• getSubscription(
      subscriptionId: string,
      abortSignal: AbortSignal,
  ): AsyncIterableIterator<SubscriptionResponse>

  Open a streamed subscription for a previously created subscription id.

  Parameters

  • subscriptionId: string

    Subscription identifier returned by subscribeForScripts

  • abortSignal: AbortSignal

    Signal used to terminate the stream

  Returns AsyncIterableIterator<SubscriptionResponse>

  Async iterator of subscription responses

getVirtualTxs

• getVirtualTxs(
      txids: string[],
      opts?: PaginationOptions,
  ): Promise<{ page?: PageResponse; txs: string[] }>

  Fetch raw virtual transactions by txid.

  Parameters

  • txids: string[]

    Virtual transaction ids to fetch

  • Optionalopts: PaginationOptions

    Optional pagination settings

  Returns Promise<{ page?: PageResponse; txs: string[] }>

  Raw virtual transactions and optional pagination state

getVtxoChain

• getVtxoChain(
      vtxoOutpoint: Outpoint,
      opts?: PaginationOptions,
  ): Promise<VtxoChain>

  Fetch the ancestry chain for a virtual output.

  Parameters

  • vtxoOutpoint: Outpoint

    Virtual output outpoint to inspect

  • Optionalopts: PaginationOptions

    Optional pagination settings

  Returns Promise<VtxoChain>

  Chain data and optional pagination state

getVtxos

• getVtxos(
      opts?: GetVtxosOptions,
  ): Promise<{ page?: PageResponse; vtxos: VirtualCoin[] }>

  Fetch virtual outputs by script set or outpoints.

  Parameters

  • Optionalopts: GetVtxosOptions

    Virtual output filters and pagination settings

  Returns Promise<{ page?: PageResponse; vtxos: VirtualCoin[] }>

  Virtual outputs and optional pagination state

getVtxoTree

• getVtxoTree(
      batchOutpoint: Outpoint,
      opts?: PaginationOptions,
  ): Promise<{ page?: PageResponse; vtxoTree: Tx[] }>

  Fetch the virtual output tree for a batch outpoint.

  Parameters

  • batchOutpoint: Outpoint

    Batch outpoint whose tree should be fetched

  • Optionalopts: PaginationOptions

    Optional pagination settings

  Returns Promise<{ page?: PageResponse; vtxoTree: Tx[] }>

  virtual output tree nodes and optional pagination state

getVtxoTreeLeaves

• getVtxoTreeLeaves(
      batchOutpoint: Outpoint,
      opts?: PaginationOptions,
  ): Promise<{ leaves: Outpoint[]; page?: PageResponse }>

  Fetch the leaf outpoints for a batch virtual output tree.

  Parameters

  • batchOutpoint: Outpoint

    Batch outpoint whose leaf outpoints should be fetched

  • Optionalopts: PaginationOptions

    Optional pagination settings

  Returns Promise<{ leaves: Outpoint[]; page?: PageResponse }>

  Leaf outpoints and optional pagination state

subscribeForScripts

• subscribeForScripts(scripts: string[], subscriptionId?: string): Promise<string>

  Create or extend a subscription for a set of scripts.

  Parameters

  • scripts: string[]

    Scripts to monitor

  • OptionalsubscriptionId: string

    Existing subscription id to extend

  Returns Promise<string>

  Subscription id

unsubscribeForScripts

• unsubscribeForScripts(subscriptionId: string, scripts?: string[]): Promise<void>

  Remove some or all scripts from an existing subscription.

  Parameters

  • subscriptionId: string

    Subscription identifier to update

  • Optionalscripts: string[]

    Scripts to remove, or omit to remove all

  Returns Promise<void>