Class ServiceWorkerReadonlyWallet

ReadonlycontractRepository

Readonlyidentity

ReadonlyserviceWorker

ReadonlywalletRepository

assetManager

• get assetManager(): IReadonlyAssetManager

  Readonly asset manager bound to this wallet instance.

  Returns IReadonlyAssetManager

clear

• clear(): Promise<void>

  Clear cached wallet state from both the page and service worker storage.

  Returns Promise<void>

getAddress

• getAddress(): Promise<string>

  Returns Promise<string>

  Arkade address used for offchain funds.

getBalance

• getBalance(): Promise<WalletBalance>

  Returns Promise<WalletBalance>

  The wallet's combined onchain and offchain balance.

getBoardingAddress

• getBoardingAddress(): Promise<string>

  Returns Promise<string>

  Onchain boarding address used to move funds into Arkade.

getBoardingUtxos

• getBoardingUtxos(): Promise<ExtendedCoin[]>

  Returns Promise<ExtendedCoin[]>

  Onchain boarding inputs tracked by the wallet.

getContractManager

• getContractManager(): Promise<IContractManager>

  Get the contract manager associated with this wallet. This is useful for querying contract state and watching for contract events.

  Returns Promise<IContractManager>

  Contract manager instance

getStatus

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

  Return service-worker wallet status, including connectivity and sync state.

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

  Current service-worker wallet status payload including walletInitalized and xOnlyPublicKey

getTransactionHistory

• getTransactionHistory(): Promise<ArkTransaction[]>

  Returns Promise<ArkTransaction[]>

  Wallet transaction history derived from boarding and Arkade activity.

getVtxos

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

  Get virtual outputs tracked by the wallet.

  Parameters

  • Optionalfilter: GetVtxosFilter

    Optional filtering flags

  Returns Promise<ExtendedVirtualCoin[]>

  virtual outputs with tapscript and witness data

  See

  GetVtxosFilter

reload

• reload(): Promise<boolean>

  Trigger a wallet reload inside the service worker.

  Returns Promise<boolean>

  true when the wallet was reloaded

Staticcreate

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

  Create a readonly service-worker wallet bound to an already-registered worker.

  Parameters

  • options: ServiceWorkerWalletCreateOptions

    Service worker, identity, and backend configuration

  Returns Promise<ServiceWorkerReadonlyWallet>

  Initialized readonly service-worker wallet

  Throws

  Error if service-worker initialization fails

Staticsetup

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

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

  Parameters

  • options: ServiceWorkerWalletSetupOptions

  Returns Promise<ServiceWorkerReadonlyWallet>

  See

  ServiceWorkerReadonlyWallet.create

  Example

  const wallet = await ServiceWorkerReadonlyWallet.setup({
    serviceWorkerPath: '/service-worker.js',
    arkServerUrl: 'https://arkade.computer',
    identity: ReadonlySingleKey.fromPublicKey('your_public_key_hex')
  });
  Copy