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

    Interface SettlementConfig

    Configuration for automatic settlement and renewal.

    Controls two behaviors:

    1. VTXO renewal: Automatically renew virtual outputs that are close to expiry
    2. Boarding UTXO sweep: Sweep expired boarding inputs back to a fresh boarding address via the unilateral exit path (onchain self-spend to restart the timelock)

    Enabled by default when no config is provided. Pass false to explicitly disable all settlement behavior.

    VTXO renewal and boarding UTXO sweep are both coordinated by VtxoManager, which periodically inspects wallet virtual outputs and boarding inputs and decides whether action is needed.

    DEFAULT_SETTLEMENT_CONFIG

    // Default behavior: virtual output renewal at 3 days, boarding sweep enabled, polling every minute
    const wallet = await Wallet.create({
      identity: MnemonicIdentity.fromMnemonic('abandon abandon...'),
      arkProvider: new RestArkProvider(),
    });

    // Custom expiry threshold of 24 hours
    const wallet = await Wallet.create({
      identity: MnemonicIdentity.fromMnemonic('abandon abandon...'),
      arkProvider: new RestArkProvider(),
      settlementConfig: {
        vtxoThreshold: 60 * 60 * 24, // 24 hours in seconds
      },
    });

    // Explicitly disable
    const wallet = await Wallet.create({
      identity: MnemonicIdentity.fromMnemonic('abandon abandon...'),
      arkProvider: new RestArkProvider(),
      settlementConfig: false,
    });
    interface SettlementConfig {
        boardingUtxoSweep?: boolean;
        deprecatedSignerMigration?: boolean;
        pollIntervalMs?: number;
        vtxoThreshold?: number;
    }
    Index

    Properties

    boardingUtxoSweep? deprecatedSignerMigration? pollIntervalMs? vtxoThreshold?

    Properties

    boardingUtxoSweep?: boolean

    Sweep expired boarding inputs back to a fresh boarding address via the unilateral exit path (onchain self-spend to restart the timelock).

    When enabled, expired boarding inputs are batched into a single onchain transaction with multiple inputs and one output.

    A dust check ensures the sweep is only performed when the output after fees is above dust.

    true

    deprecatedSignerMigration?: boolean

    Automatically migrate VTXOs minted under a now-deprecated server signer back to the wallet's active-signer address before their cutoff window closes (planned arkd key rotation).

    When enabled, each poll cycle cooperatively migrates stale-signer VTXOs via the normal settle() path, applying a mid-session server-signer rotation first when the wallet's own snapshot signer has been deprecated. The explicit IVtxoManager.migrateDeprecatedSignerVtxos method remains available for manual migration regardless of this flag.

    Setting settlementConfig: false disables all background settlement, including migration. Set this field to false to keep renewal/sweep but skip automatic deprecated-signer migration specifically.

    true

    pollIntervalMs?: number

    Polling interval in milliseconds for checking boarding inputs. The poll loop auto-settles new boarding inputs into Arkade and sweeps expired ones (when boardingUtxoSweep is enabled).

    60_000 (1 minute)

    vtxoThreshold?: number

    Seconds before virtual output expiry to trigger renewal.

    259_200 (3 days)

    Settings

    Member Visibility

    On This Page

    Properties