Class ServiceWorkerReadonlyWallet

Readonlyactivity

ReadonlycontractRepository

Readonlyidentity

ReadonlyserviceWorker

ReadonlywalletRepository

assetManager

• get assetManager(): IReadonlyAssetManager

  Readonly asset manager bound to this wallet instance.

  Returns IReadonlyAssetManager

clear

• clear(): Promise<void>

  This tells the service worker to wipe all locally persisted wallet data.

  Returns Promise<void>

getActivityHistory

• getActivityHistory(): Promise<Activity[]>

  Returns Promise<Activity[]>

  Wallet history grouped into logical activities with signed net amounts.

getAddress

• getAddress(): Promise<string>

  Returns Promise<string>

  Arkade address used for offchain funds.

getArkadeInfo

• getArkadeInfo(opts?: GetArkadeInfoOptions): Promise<ArkadeInfo>

  Delegated to the worker, which holds the wallet that owns the connection. The payload crosses raw — see ResponseGetArkadeInfo for why.

  Parameters

  • Optionalopts: GetArkadeInfoOptions

  Returns Promise<ArkadeInfo>

getArkadeReader

• getArkadeReader(): Promise<ArkadeReader>

  An ArkadeReader that speaks to the worker rather than to the server. The page holds no provider, so a caller that built its own from a URL would open a second connection outside the worker's rate gate and caches — this proxy is what keeps chain reads in one place.

  Returns Promise<ArkadeReader>

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

getProviderConnectionState

• getProviderConnectionState(): Promise<ProviderConnectionState>

  Wallet-level provider-connection freshness, delegated to the worker via GET_STATUS. Async by necessity (the worker boundary is asynchronous); no synchronous variant is offered because it would have the same transport mismatch as the contract-manager proxy's cached getSyncState().

  Returns Promise<ProviderConnectionState>

getSpendableVtxos

• getSpendableVtxos(
      filter?: GetVtxosFilter,
  ): Promise<NormalizedExtendedVirtualCoin[]>

  The gate has to run inside the worker (no plugin object or contract row metadata exists on this side), so this is its own message rather than a post-filter over GET_VTXOS.

  A worker predating this message answers "Unknown message" and the call throws. That is deliberate: service workers activate asynchronously, so new page code runs against a stale worker for a window on every deploy, and falling back to GET_VTXOS there would silently spend ungated coins. Fail closed — loud and recoverable — rather than make the gate advisory.

  Parameters

  • Optionalfilter: GetVtxosFilter

  Returns Promise<NormalizedExtendedVirtualCoin[]>

getStatus

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

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

  Returns Promise<
      {
          providerConnectionState?: ProviderConnectionState;
          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<NormalizedExtendedVirtualCoin[]>

  Get virtual outputs tracked by the wallet.

  Parameters

  • Optionalfilter: GetVtxosFilter

    Optional filtering flags

  Returns Promise<NormalizedExtendedVirtualCoin[]>

  virtual outputs with tapscript and witness data, normalized: every canonical fact the capability predicates read is populated, whatever the underlying repository stored

  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',
    arkServer: { url: 'https://arkade.computer' },
    identity: ReadonlySingleKey.fromPublicKey('your_public_key_hex')
  });
  Copy