@arkade-os/sdk Documentation - v0.4.0-next.8
    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
    // URL-based configuration
    const wallet = await ReadonlyWallet.create({
      identity: ReadonlySingleKey.fromPublicKey(pubkey),
      arkServerUrl: 'https://ark.example.com',
      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://ark.example.com'),
      indexerProvider: new ExpoIndexerProvider('https://ark.example.com'),
      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
    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">>

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

    Settings

    Member Visibility

    On This Page

    Properties