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

    Interface DiscoveryDeps

    Read-only context the scanner injects into every discoverAt call. The boltz/swap handler does NOT receive its Boltz client here — it closes over its own client at registration time.

    interface DiscoveryDeps {
        boardingTimelock?: RelativeTimelock;
        csvTimelocks: RelativeTimelock[];
        delegatePubKey?: Uint8Array<ArrayBufferLike>;
        deprecatedSignerPubKeys?: Uint8Array<ArrayBufferLike>[];
        indexerProvider: IndexerProvider;
        network: { hrp: string };
        onchainNetwork?: Network;
        onchainProvider: OnchainProvider;
        serverPubKey: Uint8Array;
    }
    Index

    Properties

    boardingTimelock? csvTimelocks delegatePubKey? deprecatedSignerPubKeys? indexerProvider network onchainNetwork? onchainProvider serverPubKey

    Properties

    boardingTimelock?: RelativeTimelock

    Boarding-exit CSV timelock. Distinct from DiscoveryDeps.csvTimelocks (the unilateral-exit matrix): boarding scripts source their CSV from the server's boarding-exit delay. Present only when boarding discovery is plumbed; when absent, boarding discoverAt no-ops (so the scanner unit harness, which never sets it, is unaffected).

    csvTimelocks: RelativeTimelock[]

    Relative timelocks the wallet treats as its baseline matrix.

    delegatePubKey?: Uint8Array<ArrayBufferLike>

    Present only for delegate wallets.

    deprecatedSignerPubKeys?: Uint8Array<ArrayBufferLike>[]

    The server's deprecated signer keys (x-only, 32 bytes) from the same snapshot. A VTXO minted under a now-rotated signer is anchored to a different script; L2 discovery scans these keys alongside DiscoveryDeps.serverPubKey so signer rotation does not strand funds. Empty/absent when the server advertises no deprecated signers. Boarding discovery does not consult this set (current UTXO set only).

    indexerProvider: IndexerProvider
    network: { hrp: string }

    Ark-address network data. The { hrp } shape is all the L2 (default/delegate) discovery path needs to render an Ark address.

    onchainNetwork?: Network

    Full Bitcoin network descriptor for on-chain (P2TR) address rendering. Required by the boarding discovery probe, which derives an on-chain Taproot address via VtxoScript.onchainAddress — the { hrp }-only DiscoveryDeps.network lacks the bech32 data that needs. Absent only when no boarding discovery is plumbed (e.g. the scanner unit harness), in which case boarding discoverAt no-ops.

    onchainProvider: OnchainProvider
    serverPubKey: Uint8Array

    The server's current signer key (x-only, 32 bytes), taken from a fresh server-info snapshot at restore time. L2 (default/delegate) discovery probes this key first.

    Settings

    Member Visibility

    On This Page

    Properties