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

    Interface MigrationLegReport

    Outcome of one migration leg. The VTXO leg migrates through the Ark send path (Wallet.sendSelectedVtxosToSelf); the boarding leg keeps its settle-backed migration (boarding coins are on-chain inputs with no send path). Each leg owns its full sizing pipeline (oversized filtering, count + amount caps, its own dust floor) and reports independently — a failure or skip in one leg never suppresses the other.

    interface MigrationLegReport {
        deferred?: number;
        error?: string;
        migrated: MigrationVtxoRef[];
        notSpendableOffchain?: MigrationVtxoRef[];
        oversized?: MigrationVtxoRef[];
        skipped?: MigrationLegSkipReason;
        txid?: string;
    }
    Index

    Properties

    deferred?: number

    Migratable inputs deferred to a later pass by this leg's own caps (the input count MAX_VTXOS_PER_SETTLEMENT or the per-output amount ceiling vtxoMaxAmount). Present and non-zero only when a cap bound and the leg actually submitted; makes the truncation visible.

    error?: string

    Error message when this leg's submission failed; the other leg still runs.

    migrated: MigrationVtxoRef[]

    Inputs submitted and accepted in this leg's transaction; empty on error/skip.

    notSpendableOffchain?: MigrationVtxoRef[]

    Inputs the leg's submit path would have rejected — for the VTXO leg, no longer cooperatively spendable at this pass's chain tip (past batch expiry, since swept and spent inputs are already excluded upstream) or carrying no batch expiry at all.

    Partitioned out rather than submitted, because the send path validates the batch as a whole: one rejected input would abort the entire leg and strand every other migratable VTXO until the next pass. Present only when non-empty.

    oversized?: MigrationVtxoRef[]

    Inputs whose value alone exceeds the per-output ceiling (vtxoMaxAmount): a single ≤-ceiling output can never hold them, so they never migrate cooperatively and require a unilateral exit. Present only when non-empty; absent when the server advertises no ceiling (vtxoMaxAmount < 0).

    Why this leg submitted nothing (every candidate below dust or oversized).

    txid?: string

    VTXO leg: Ark transaction id from send. Boarding leg: settle commitment txid.