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

    Interface IndexerProvider

    interface IndexerProvider {
        getAssetDetails(assetId: string): Promise<AssetDetails>;
        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?: GetVtxosOptions,
        ): 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

    getAssetDetails getBatchSweepTransactions getCommitmentTx getCommitmentTxConnectors getCommitmentTxForfeitTxs getSubscription getVirtualTxs getVtxoChain getVtxos getVtxoTree getVtxoTreeLeaves subscribeForScripts unsubscribeForScripts

    Methods

    • Fetch sweep transactions that spent a batch.

      Parameters

      • batchOutpoint: Outpoint

        Batch outpoint to inspect

      Returns Promise<{ sweptBy: string[] }>

      Sweep transaction ids

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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>

    Settings

    Member Visibility

    On This Page

    Methods