Class ServiceWorkerReadonlyWallet

ReadonlycontractRepository

Readonlyidentity

ReadonlyserviceWorker

ReadonlywalletRepository

clear

• clear(): Promise<void>

  Returns Promise<void>

getAddress

• getAddress(): Promise<string>

  Returns Promise<string>

getBalance

• getBalance(): Promise<WalletBalance>

  Returns Promise<WalletBalance>

getBoardingAddress

• getBoardingAddress(): Promise<string>

  Returns Promise<string>

getBoardingUtxos

• getBoardingUtxos(): Promise<ExtendedCoin[]>

  Returns Promise<ExtendedCoin[]>

getStatus

• getStatus(): Promise<
      {
          walletInitialized: boolean;
          xOnlyPublicKey: Uint8Array<ArrayBufferLike>
          | undefined;
      },
  >

  Returns Promise<
      {
          walletInitialized: boolean;
          xOnlyPublicKey: Uint8Array<ArrayBufferLike>
          | undefined;
      },
  >

getTransactionHistory

• getTransactionHistory(): Promise<ArkTransaction[]>

  Returns Promise<ArkTransaction[]>

getVtxos

• getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>

  Parameters

  • Optionalfilter: GetVtxosFilter

  Returns Promise<ExtendedVirtualCoin[]>

reload

• reload(): Promise<boolean>

  Returns Promise<boolean>

Staticcreate

• create(
      options: ServiceWorkerWalletCreateOptions,
  ): Promise<ServiceWorkerReadonlyWallet>

  Parameters

  • options: ServiceWorkerWalletCreateOptions

  Returns Promise<ServiceWorkerReadonlyWallet>

Staticsetup

• setup(
      options: ServiceWorkerWalletSetupOptions,
  ): Promise<ServiceWorkerReadonlyWallet>

  Simplified setup method that handles service worker registration, identity creation, and wallet initialization automatically.

  Parameters

  • options: ServiceWorkerWalletSetupOptions

  Returns Promise<ServiceWorkerReadonlyWallet>

  Example

  // One-liner setup - handles everything automatically!
  const wallet = await ServiceWorkerReadonlyWallet.setup({
    serviceWorkerPath: '/service-worker.js',
    arkServerUrl: 'https://mutinynet.arkade.sh'
  });
  
  // With custom readonly identity
  const identity = ReadonlySingleKey.fromPublicKey('your_public_key_hex');
  const wallet = await ServiceWorkerReadonlyWallet.setup({
    serviceWorkerPath: '/service-worker.js',
    arkServerUrl: 'https://mutinynet.arkade.sh',
    identity
  });
  Copy