@arkade-os/sdk Documentation - v0.5.0-rc.11
    Preparing search index...

    Type Alias GetVtxosOptions

    GetVtxosOptions: PaginationOptions & {
        after?: number;
        before?: number;
        pendingOnly?: boolean;
        recoverableOnly?: boolean;
        renewableOnly?: boolean;
        spendableOnly?: boolean;
        spentOnly?: boolean;
    } & (
        | { outpoints?: never; scripts: string[] }
        | { outpoints: Outpoint[]; scripts?: never }
    )

    Filters accepted by IndexerProvider.getVtxos.

    Type Declaration

    • Optionalafter?: number

      Only return virtual outputs created after this timestamp.

    • Optionalbefore?: number

      Only return virtual outputs created before this timestamp.

    • OptionalpendingOnly?: boolean

      Only return pending/preconfirmed virtual outputs.

    • OptionalrecoverableOnly?: boolean

      Only return recoverable virtual outputs.

    • OptionalrenewableOnly?: boolean

      Only return renewable virtual outputs (the union of the spendable and recoverable sets).

    • OptionalspendableOnly?: boolean

      Only return spendable virtual outputs.

    • OptionalspentOnly?: boolean

      Only return spent virtual outputs.

    • { outpoints?: never; scripts: string[] }
      • Optionaloutpoints?: never
      • scripts: string[]

        Scripts to search for matching virtual outputs.

    • { outpoints: Outpoint[]; scripts?: never }
      • outpoints: Outpoint[]

        Explicit outpoints to fetch.

      • Optionalscripts?: never

    Exactly one of scripts or outpoints must be supplied.

    IndexerProvider.getVtxos