@arkade-os/sdk Documentation - v0.3.11
    Preparing search index...

    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>;
    }

    Implemented by

    Index

    Methods

    • Parameters

      • scripts: string[]
      • OptionalsubscriptionId: string

      Returns Promise<string>

    • Parameters

      • subscriptionId: string
      • Optionalscripts: string[]

      Returns Promise<void>