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

    Interface BaseWalletConfig

    Base configuration options shared by all wallet types.

    Supports URL-based and provider-based configuration.

    URL-based configuration starts from arkServerUrl and can optionally override derived service URLs such as indexerUrl and esploraUrl.

    Provider-based configuration supplies concrete provider instances directly, including the ArkProvider, IndexerProvider, OnchainProvider, and DelegateProvider.

    The wallet will use provided URLs to create default providers if custom provider instances are not supplied. If optional parameters are not provided, the wallet will fetch configuration from the Arkade server.

    URL-based and provider-based configuration can be mixed, but provider instances always take precedence over URLs for the corresponding service.

    • WalletConfig
    • ReadonlyWalletConfig
    • StorageConfig
    interface BaseWalletConfig {
        arkProvider?: ArkProvider;
        arkServerPublicKey?: string;
        arkServerUrl?: string;
        boardingTimelock?: RelativeTimelock;
        delegateProvider?: DelegateProvider;
        delegatorProvider?: DelegateProvider;
        esploraUrl?: string;
        exitTimelock?: RelativeTimelock;
        indexerProvider?: IndexerProvider;
        indexerUrl?: string;
        onchainProvider?: OnchainProvider;
        storage?: StorageConfig;
    }

    Hierarchy (View Summary)

    Index

    Properties

    arkProvider? arkServerPublicKey? arkServerUrl? boardingTimelock? delegateProvider? delegatorProvider? esploraUrl? exitTimelock? indexerProvider? indexerUrl? onchainProvider? storage?

    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.

    indexerProvider?: IndexerProvider

    Optional indexer provider instance.

    indexerUrl?: string

    Optional override for the indexer URL.

    Pass an explicit indexerProvider instance instead.

    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