Class RestIndexerProvider

constructor

• new RestIndexerProvider(serverUrl: string): RestIndexerProvider

  Parameters

  • serverUrl: string

  Returns RestIndexerProvider

serverUrl

getBatchSweepTransactions

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

  Parameters

  • batchOutpoint: Outpoint

  Returns Promise<{ sweptBy: string[] }>

getCommitmentTx

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

  Parameters

  • txid: string

  Returns Promise<CommitmentTx>

getCommitmentTxConnectors

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

  Parameters

  • txid: string
  • Optionalopts: PaginationOptions

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

getCommitmentTxForfeitTxs

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

  Parameters

  • txid: string
  • Optionalopts: PaginationOptions

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

getSubscription

• getSubscription(
      subscriptionId: string,
      abortSignal: AbortSignal,
  ): AsyncGenerator<
      {
          checkpointTxs: any;
          newVtxos: any;
          scripts: any;
          spentVtxos: any;
          tx: any;
          txid: any;
      },
      void,
      unknown,
  >

  Parameters

  • subscriptionId: string
  • abortSignal: AbortSignal

  Returns AsyncGenerator<
      {
          checkpointTxs: any;
          newVtxos: any;
          scripts: any;
          spentVtxos: any;
          tx: any;
          txid: any;
      },
      void,
      unknown,
  >

getVirtualTxs

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

  Parameters

  • txids: string[]
  • Optionalopts: PaginationOptions

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

getVtxoChain

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

  Parameters

  • vtxoOutpoint: Outpoint
  • Optionalopts: PaginationOptions

  Returns Promise<VtxoChain>

getVtxos

• getVtxos(
      opts?: PaginationOptions & {
          outpoints?: Outpoint[];
          recoverableOnly?: boolean;
          scripts?: string[];
          spendableOnly?: boolean;
          spentOnly?: boolean;
      },
  ): Promise<{ page?: PageResponse; vtxos: VirtualCoin[] }>

  Parameters

  • Optionalopts: PaginationOptions & {
        outpoints?: Outpoint[];
        recoverableOnly?: boolean;
        scripts?: string[];
        spendableOnly?: boolean;
        spentOnly?: boolean;
    }

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

getVtxoTree

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

  Parameters

  • batchOutpoint: Outpoint
  • Optionalopts: PaginationOptions

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

getVtxoTreeLeaves

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

  Parameters

  • batchOutpoint: Outpoint
  • Optionalopts: PaginationOptions

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

subscribeForScripts

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

  Parameters

  • scripts: string[]
  • OptionalsubscriptionId: string

  Returns Promise<string>

unsubscribeForScripts

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

  Parameters

  • subscriptionId: string
  • Optionalscripts: string[]

  Returns Promise<void>