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

    Interface DeprecatedSignerReport

    Machine-readable status for a single deprecated signer the wallet holds funds under (Section 6). Derived at read time from contract params plus a fresh ArkInfo snapshot — never persisted.

    interface DeprecatedSignerReport {
        awaitingSweepCount: number;
        awaitingSweepValue: number;
        boardingCount: number;
        boardingValue: number;
        cutoffDate?: bigint;
        nextSweepEta?: number;
        recoverableCount: number;
        recoverableValue: number;
        secondsUntilCutoff?: number;
        signerPubKey: string;
        status: SignerStatus;
        totalValue: number;
        vtxoCount: number;
    }
    Index

    Properties

    awaitingSweepCount: number

    Expired-signer VTXOs not yet swept; awaiting the server batch sweep before they become recoverable. Non-zero only on EXPIRED rows — nothing for the user to do but wait (Section 6 / post-cutoff).

    awaitingSweepValue: number
    boardingCount: number

    Number of spendable boarding UTXOs the wallet holds under this signer (Section 7). Counts every confirmed boarding coin, including those whose own CSV exit window has elapsed (they leave via the unilateral sweep).

    boardingValue: number

    Total value of those boarding UTXOs in satoshis (Section 7).

    cutoffDate?: bigint

    Absolute cutoff (Unix seconds), present only when advertised.

    nextSweepEta?: number

    Soonest batch expiry (ms since epoch) among the awaiting-sweep VTXOs, as a recovery ETA hint. Present only when an EXPIRED row has awaiting-sweep VTXOs that carry a batch expiry (Section 6 / post-cutoff).

    recoverableCount: number

    Expired-signer VTXOs already swept and queued for recovery to the active signer (the recover-on-sweep default — see SignerStatus EXPIRED). Non-zero only on EXPIRED rows; these drain on the next recovery pass (Section 6 / post-cutoff).

    recoverableValue: number
    secondsUntilCutoff?: number

    Derived seconds until cutoff; negative once passed.

    signerPubKey: string

    Deprecated signer key (x-only hex).

    status: SignerStatus

    One of migratable | dueNow | expired | unknownSigner.

    totalValue: number

    Total value of those VTXOs in satoshis.

    vtxoCount: number

    Number of spendable VTXOs the wallet holds under this signer.