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

    Interface WalletConfig

    Configuration options for full wallet initialization.

    This config provides full wallet capabilities including sending transactions, settling virtual outputs, and all readonly operations.

    • ReadonlyWalletConfig
    • IWallet
    // Provider-based configuration
    const wallet = await Wallet.create({
      identity: MnemonicIdentity.fromMnemonic('abandon abandon...'),
      arkProvider: new ExpoArkProvider(),
      indexerProvider: new ExpoIndexerProvider(),
      onchainProvider: new EsploraProvider()
    });

    // With settlement configuration
    const wallet = await Wallet.create({
      identity: MnemonicIdentity.fromMnemonic('abandon abandon...'),
      arkProvider: new RestArkProvider(),
      settlementConfig: {
        vtxoThreshold: 60 * 60 * 24, // 24 hours in seconds
        boardingUtxoSweep: true,
      },
    });
    interface WalletConfig {
        arkProvider?: ArkProvider;
        arkServerPublicKey?: string;
        arkServerUrl?: string;
        boardingTimelock?: RelativeTimelock;
        delegateProvider?: DelegateProvider;
        delegatorProvider?: DelegateProvider;
        esploraUrl?: string;
        exitTimelock?: RelativeTimelock;
        identity: Identity;
        indexerProvider?: IndexerProvider;
        indexerUrl?: string;
        lookAheadWindow?: number;
        onchainProvider?: OnchainProvider;
        renewalConfig?: RenewalConfig;
        settlementConfig?: false | SettlementConfig;
        storage?: StorageConfig;
        walletMode?: WalletMode;
        watcherConfig?: Partial<Omit<ContractWatcherConfig, "indexerProvider">>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    arkProvider? arkServerPublicKey? arkServerUrl? boardingTimelock? delegateProvider? delegatorProvider? esploraUrl? exitTimelock? identity indexerProvider? indexerUrl? lookAheadWindow? onchainProvider? renewalConfig? settlementConfig? storage? walletMode? watcherConfig?

    Properties

    arkProvider?: ArkProvider

    Optional Arkade provider instance.

    arkServerPublicKey?: string

    Optional Arkade server public key used to construct and validate Arkade addresses.

    arkServerUrl?: string

    Base URL of the Arkade server.

    Pass an explicit arkProvider instance instead. URL-based configuration will be removed in a future major version.

    boardingTimelock?: RelativeTimelock

    Relative timelock applied to boarding scripts.

    delegateProvider?: DelegateProvider

    Optional delegation service instance.

    delegatorProvider?: DelegateProvider

    alias for

    BaseWalletConfig.delegateProvider

    esploraUrl?: string

    Optional override for the Esplora API URL.

    Pass an explicit onchainProvider instance instead.

    exitTimelock?: RelativeTimelock

    Relative timelock applied to unilateral exit paths.

    identity: Identity

    Signing identity used to authorize transactions.

    indexerProvider?: IndexerProvider

    Optional indexer provider instance.

    indexerUrl?: string

    Optional override for the indexer URL.

    Pass an explicit indexerProvider instance instead.

    lookAheadWindow?: number

    Per-side width of the HD look-ahead watch window: the wallet watches missing offchain receive scripts across [watermark - N, watermark + N] so funds paid to an address issued by an external party (a merchant backend sharing the seed) arrive without an explicit restore().

    Only meaningful for HD wallets (walletMode: 'hd' or an HD DescriptorProvider); ignored otherwise. Raise it when the issuer is expected to hand out more than N consecutive addresses without any of them being paid. Must be a positive integer.

    20

    onchainProvider?: OnchainProvider

    Optional onchain provider instance.

    renewalConfig?: RenewalConfig

    Legacy renewal configuration.

    This field is still accepted for backwards compatibility, but settlementConfig is the source of truth for new code.

    Use settlementConfig instead.

    settlementConfig?: false | SettlementConfig

    Configuration for automatic settlement and renewal. false = explicitly disabled, undefined or {} = enabled with defaults.

    undefined (enabled with defaults)

    SettlementConfig

    storage?: StorageConfig

    Repository-backed storage configuration overrides. Defaults to IndexedDB if unset.

    walletMode?: WalletMode

    Receive-address strategy. Pass 'static', 'hd', or a DescriptorProvider instance to drive rotation; omit (or pass 'auto') for the built-in auto-detect behaviour. See WalletMode.

    'auto'

    watcherConfig?: Partial<Omit<ContractWatcherConfig, "indexerProvider">>

    Configuration for the ContractManager's watcher. Controls reconnection behavior and failsafe polling.

    ContractWatcherConfig

    Settings

    Member Visibility

    On This Page

    Properties