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

    Type Alias WalletMode

    WalletMode: "auto" | "static" | "hd" | DescriptorProvider

    Wallet receive-address strategy.

    • 'auto' (default): short-term — currently identical to 'static'. The 'auto' name is reserved for a future change that will re-enable identity-probing once HD rotation has matured in the field. Until then, opt into HD explicitly via 'hd' or a DescriptorProvider. (See TODO(hd-maturation) in src/wallet/walletReceiveRotator.ts:resolveDescriptorProvider for the flip-back criteria.)
    • 'static': never rotate. The wallet uses one receive address derived from identity.xOnlyPublicKey().
    • 'hd': must rotate, using the built-in HD provider derived from the identity. Throws at Wallet.create if the identity isn't HD-capable or its descriptor isn't rangeable — no silent fallback.
    • A DescriptorProvider instance: rotate via the supplied provider on every incoming VTXO. The wallet does not probe the identity; the caller is responsible for ensuring the identity can sign for whatever pubkey the provider returns. Errors thrown by the provider propagate — there is no silent fallback for an explicit provider.