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

    Type Alias StorageConfig

    Repository implementations used to store wallet and contract state.

    • BaseWalletConfig
    • WalletRepository
    • ContractRepository
    type StorageConfig = {
        contractRepository: ContractRepository;
        exitDataCapture?: {
            minExitWorthSats?: number;
            mode?: ExitCaptureMode;
            sources?: ExitDataSource[];
        };
        intentRepository?: IntentRepository;
        virtualTxRepository?: VirtualTxRepository;
        walletRepository: WalletRepository;
    }
    Index

    Properties

    contractRepository exitDataCapture? intentRepository? virtualTxRepository? walletRepository

    Properties

    contractRepository: ContractRepository

    Contract-state repository implementation.

    exitDataCapture?: {
        minExitWorthSats?: number;
        mode?: ExitCaptureMode;
        sources?: ExitDataSource[];
    }

    Optional exit-data capture settings (only in effect when virtualTxRepository is set). mode "lite" (default) stores structure only; "full" stores PSBTs so a unilateral exit needs no Ark indexer. minExitWorthSats (default 1000) skips dust. sources are extra ExitDataSources (e.g. a wallet-provider) tried before the indexer for both capture and exit reads.

    intentRepository?: IntentRepository

    Optional intent-lifecycle repository. Opt-in: when present, the wallet persists settlement intents and excludes intent-locked VTXOs from spendable balance. Absent ⇒ those code paths are no-ops.

    virtualTxRepository?: VirtualTxRepository

    Experimental / inert. Optional virtual-tx (exit-branch) repository. Today it is only a best-effort raw-PSBT cache that unilateral exit (Unroll) reads and writes when a caller passes it to Unroll.Session.create. Normal wallet/contract sync does NOT populate, maintain, or prune it, and ContractManager is never given it — branch/full-mode persistence is out of scope for this release. Treat this option as experimental until those paths land. Absent ⇒ no-op.

    walletRepository: WalletRepository

    Wallet-state repository implementation.

    Settings

    Member Visibility

    On This Page

    Properties