@arkade-os/sdk Documentation - v0.5.0-rc.11
    Preparing search index...

    Interface BaseWalletConfig

    Base configuration options shared by all wallet types.

    Provider instances are the supported way to connect a wallet to Arkade, indexer, onchain, and delegation services. If a provider is omitted, the wallet constructs the default implementation for that service.

    • WalletConfig
    • ReadonlyWalletConfig
    • StorageConfig
    interface BaseWalletConfig {
        arkProvider?: ArkProvider;
        arkServerPublicKey?: string;
        boardingTimelock?: RelativeTimelock;
        delegateProvider?: DelegateProvider;
        exitTimelock?: RelativeTimelock;
        indexerProvider?: IndexerProvider;
        minBatchExpirySeconds?: bigint;
        minCheckpointExitDelaySeconds?: bigint;
        onchainProvider?: OnchainProvider;
        storage?: StorageConfig;
    }

    Hierarchy (View Summary)

    Index

    Properties

    arkProvider? arkServerPublicKey? boardingTimelock? delegateProvider? exitTimelock? indexerProvider? minBatchExpirySeconds? minCheckpointExitDelaySeconds? onchainProvider? storage?

    Properties

    arkProvider?: ArkProvider

    Optional Arkade provider instance.

    arkServerPublicKey?: string

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

    boardingTimelock?: RelativeTimelock

    Relative timelock applied to boarding scripts.

    delegateProvider?: DelegateProvider

    Optional delegation service instance.

    exitTimelock?: RelativeTimelock

    Relative timelock applied to unilateral exit paths.

    indexerProvider?: IndexerProvider

    Optional indexer provider instance.

    minBatchExpirySeconds?: bigint

    Minimum accepted BatchStartedEvent.batchExpiry, as wall-clock seconds. Defaults per network — see defaultBatchExpiryPolicy. Lowering it below the default relaxes a fund-safety bound; intended for local testing.

    minCheckpointExitDelaySeconds?: bigint

    Minimum accepted checkpoint exit delay decoded from ArkadeInfo.checkpointTapscript, as wall-clock seconds. Defaults per network — see defaultCheckpointExitDelayPolicy, which already carries the value the hosted signet and mutinynet Arkade Services advertise, so neither needs this set. Lowering it below the default relaxes a fund-safety bound; intended for local testing.

    onchainProvider?: OnchainProvider

    Optional onchain provider instance.

    storage?: StorageConfig

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

    Settings

    Member Visibility

    On This Page

    Properties