@arkade-os/sdk Documentation - v0.4.21
    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
    // URL-based configuration
    const wallet = await ReadonlyWallet.create({
      identity: ReadonlySingleKey.fromPublicKey(pubkey),
      arkServerUrl: 'https://arkade.computer',
      esploraUrl: 'https://mempool.space/api'
    });

    // Provider-based configuration (e.g., for Expo/React Native)
    const wallet = await ReadonlyWallet.create({
      identity: ReadonlySingleKey.fromPublicKey(pubkey),
      arkProvider: new ExpoArkProvider('https://arkade.computer'),
      indexerProvider: new ExpoIndexerProvider('https://arkade.computer'),
      onchainProvider: new EsploraProvider('https://mempool.space/api')
    });
    interface ReadonlyWalletConfig {
        arkProvider?: ArkProvider;
        arkServerPublicKey?: string;
        arkServerUrl?: string;
        boardingTimelock?: RelativeTimelock;
        delegatorProvider?: DelegatorProvider;
        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? 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.

    boardingTimelock?: RelativeTimelock

    Relative timelock applied to boarding scripts.

    delegatorProvider?: DelegatorProvider

    Optional delegation service instance.

    esploraUrl?: string

    Optional override for the Esplora API URL.

    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.

    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