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

    Interface ReadonlyWalletConfig

    Configuration options for readonly wallet initialization.

    Use this config when you only need to query wallet state (balance, addresses, transactions) without the ability to send transactions. This is useful for:

    • Watch-only wallets
    • Monitoring addresses
    • Safe sharing of wallet state without private key exposure
    • BaseWalletConfig
    • IReadonlyWallet
    // Provider-based configuration (e.g., for Expo/React Native)
    const wallet = await ReadonlyWallet.create({
      identity: ReadonlySingleKey.fromPublicKey(pubkey),
      arkProvider: new ExpoArkProvider(),
      indexerProvider: new ExpoIndexerProvider(),
      onchainProvider: new EsploraProvider()
    });
    interface ReadonlyWalletConfig {
        arkProvider?: ArkProvider;
        arkServerPublicKey?: string;
        arkServerUrl?: string;
        boardingTimelock?: RelativeTimelock;
        delegateProvider?: DelegateProvider;
        delegatorProvider?: DelegateProvider;
        esploraUrl?: string;
        exitTimelock?: RelativeTimelock;
        identity: ReadonlyIdentity;
        indexerProvider?: IndexerProvider;
        indexerUrl?: string;
        onchainProvider?: OnchainProvider;
        storage?: StorageConfig;
        watcherConfig?: Partial<Omit<ContractWatcherConfig, "indexerProvider">>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    arkProvider? arkServerPublicKey? arkServerUrl? boardingTimelock? delegateProvider? delegatorProvider? esploraUrl? exitTimelock? identity indexerProvider? indexerUrl? onchainProvider? storage? 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: ReadonlyIdentity

    Readonly identity used to derive wallet addresses.

    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.

    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