Interface IndexerProvider
interface IndexerProvider { getBatchSweepTransactions( batchOutpoint: Outpoint, ): Promise<{ sweptBy: string[] }>; getCommitmentTx(txid: string): Promise<CommitmentTx>; getCommitmentTxConnectors( txid: string, opts?: PaginationOptions, ): Promise<{ connectors: Tx[]; page?: PageResponse }>; getCommitmentTxForfeitTxs( txid: string, opts?: PaginationOptions, ): Promise<{ page?: PageResponse; txids: string[] }>; getSubscription( subscriptionId: string, abortSignal: AbortSignal, ): AsyncIterableIterator<SubscriptionResponse>; getVirtualTxs( txids: string[], opts?: PaginationOptions, ): Promise<{ page?: PageResponse; txs: string[] }>; getVtxoChain( vtxoOutpoint: Outpoint, opts?: PaginationOptions, ): Promise<VtxoChain>; getVtxos( opts?: PaginationOptions & { outpoints?: Outpoint[]; recoverableOnly?: boolean; scripts?: string[]; spendableOnly?: boolean; spentOnly?: boolean; }, ): Promise<{ page?: PageResponse; vtxos: VirtualCoin[] }>; getVtxoTree( batchOutpoint: Outpoint, opts?: PaginationOptions, ): Promise<{ page?: PageResponse; vtxoTree: Tx[] }>; getVtxoTreeLeaves( batchOutpoint: Outpoint, opts?: PaginationOptions, ): Promise<{ leaves: Outpoint[]; page?: PageResponse }>; subscribeForScripts( scripts: string[], subscriptionId?: string, ): Promise<string>; unsubscribeForScripts( subscriptionId: string, scripts?: string[], ): Promise<void>;} Methods
getBatchSweepTransactions
getBatchSweepTransactions( batchOutpoint: Outpoint,): Promise<{ sweptBy: string[] }> Returns Promise<{ sweptBy: string[] }>
getCommitmentTxConnectors
getCommitmentTxForfeitTxs
getSubscription
getSubscription( subscriptionId: string, abortSignal: AbortSignal,): AsyncIterableIterator<SubscriptionResponse> Parameters
- subscriptionId: string
- abortSignal: AbortSignal
getVtxos
Parameters
Optional
opts: PaginationOptions & {
outpoints?: Outpoint[];
recoverableOnly?: boolean;
scripts?: string[];
spendableOnly?: boolean;
spentOnly?: boolean;
}
subscribeForScripts
subscribeForScripts(scripts: string[], subscriptionId?: string): Promise<string> Parameters
- scripts: string[]
Optional
subscriptionId: string
Returns Promise<string>
unsubscribeForScripts
unsubscribeForScripts(subscriptionId: string, scripts?: string[]): Promise<void> Parameters
- subscriptionId: string
Optional
scripts: string[]
Returns Promise<void>