Class ServiceWorkerWallet

Core wallet interface for Bitcoin transactions with Arkade protocol support.

This interface defines the contract that all wallet implementations must follow. It provides methods for address management, balance checking, virtual output operations, and transaction management including sending, settling, and unrolling.

See

IReadonlyWallet

Hierarchy (View Summary)

ServiceWorkerReadonlyWallet
- ServiceWorkerWallet

Implements

IWallet

Properties

`Readonly`contractRepository

contractRepository: ContractRepository

`Readonly`identity

identity: Identity

Signing identity associated with the wallet.

`Readonly`serviceWorker

serviceWorker: ServiceWorker

`Readonly`walletRepository

walletRepository: WalletRepository

Accessors

assetManager

get assetManager(): IAssetManager
Asset manager bound to this wallet instance.

Returns IAssetManager
Implementation of IWallet.assetManager
Overrides ServiceWorkerReadonlyWallet.assetManager
- Defined in wallet/serviceWorker/wallet.ts:1340

Methods

clear

clear(): Promise<void>
Clear cached wallet state from both the page and service worker storage.

Returns Promise<void>
Inherited from ServiceWorkerReadonlyWallet.clear
- Defined in wallet/serviceWorker/wallet.ts:932

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Arkade address used for offchain funds.
Implementation of IWallet.getAddress
Inherited from ServiceWorkerReadonlyWallet.getAddress
- Defined in wallet/serviceWorker/wallet.ts:949

getBalance

getBalance(): Promise<WalletBalance>
Returns Promise<WalletBalance>
The wallet's combined onchain and offchain balance.
Implementation of IWallet.getBalance
Inherited from ServiceWorkerReadonlyWallet.getBalance
- Defined in wallet/serviceWorker/wallet.ts:979

getBoardingAddress

getBoardingAddress(): Promise<string>
Returns Promise<string>
Onchain boarding address used to move funds into Arkade.
Implementation of IWallet.getBoardingAddress
Inherited from ServiceWorkerReadonlyWallet.getBoardingAddress
- Defined in wallet/serviceWorker/wallet.ts:964

getBoardingUtxos

getBoardingUtxos(): Promise<ExtendedCoin[]>
Returns Promise<ExtendedCoin[]>
Onchain boarding inputs tracked by the wallet.
Implementation of IWallet.getBoardingUtxos
Inherited from ServiceWorkerReadonlyWallet.getBoardingUtxos
- Defined in wallet/serviceWorker/wallet.ts:994

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
Implementation of IWallet.getContractManager
Inherited from ServiceWorkerReadonlyWallet.getContractManager
- Defined in wallet/serviceWorker/wallet.ts:1078

getDelegateManager

getDelegateManager(): Promise<IDelegateManager | undefined>
Returns Promise<IDelegateManager | undefined>
Delegation manager, when configured.
Implementation of IWallet.getDelegateManager
- Defined in wallet/serviceWorker/wallet.ts:1561

getDelegatorManager

getDelegatorManager(): Promise<IDelegateManager | undefined>
Returns Promise<IDelegateManager | undefined>
Deprecated
alias for

See
ServiceWorkerWallet.getDelegateManager
Implementation of IWallet.getDelegatorManager
- Defined in wallet/serviceWorker/wallet.ts:1619

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
Inherited from ServiceWorkerReadonlyWallet.getStatus
- Defined in wallet/serviceWorker/wallet.ts:1014

getTransactionHistory

getTransactionHistory(): Promise<ArkTransaction[]>
Returns Promise<ArkTransaction[]>
Wallet transaction history derived from boarding and Arkade activity.
Implementation of IWallet.getTransactionHistory
Inherited from ServiceWorkerReadonlyWallet.getTransactionHistory
- Defined in wallet/serviceWorker/wallet.ts:1028

getVtxoManager

getVtxoManager(): Promise<IVtxoManager>
Returns Promise<IVtxoManager>
- Defined in wallet/serviceWorker/wallet.ts:1623

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
Implementation of IWallet.getVtxos
Inherited from ServiceWorkerReadonlyWallet.getVtxos
- Defined in wallet/serviceWorker/wallet.ts:1043

reload

reload(): Promise<boolean>
Trigger a wallet reload inside the service worker.

Returns Promise<boolean>
true when the wallet was reloaded
Inherited from ServiceWorkerReadonlyWallet.reload
- Defined in wallet/serviceWorker/wallet.ts:1064

restore

restore(opts?: { gapLimit?: number }): Promise<void>
Explicitly recover this wallet's contracts and balance on a fresh repo. Mirrors Wallet.restore but drives the scan inside the service worker — the materialize() callback used by scanContracts cannot cross the postMessage boundary, so the entire flow runs worker-side and only the gapLimit / outcome cross the wire.

Uses the streaming send path so the bus deadline does not race a long indexer-bound scan. AggregateError thrown by the worker is reconstructed here so callers can inspect .errors.
Parameters
- Optionalopts: { gapLimit?: number }
Returns Promise<void>
- Defined in wallet/serviceWorker/wallet.ts:1523

send

send(...recipients: [Recipient, ...Recipient[]]): Promise<string>
Send bitcoin and/or assets to one or more Arkade recipients.
Parameters
- ...recipients: [Recipient, ...Recipient[]]
  One or more recipients
Returns Promise<string>
Arkade transaction id
Example
```
await wallet.send({ address: 'ark1q...', amount: 1000 })
```
Implementation of IWallet.send
- Defined in wallet/serviceWorker/wallet.ts:1545

sendBitcoin

sendBitcoin(params: SendBitcoinParams): Promise<string>
Send bitcoin to a single Arkade address.
Parameters
- params: SendBitcoinParams
  Destination, amount, fee rate override, etc
Returns Promise<string>
Arkade transaction id
Deprecated
Use send
See
- send
- Recipient
Implementation of IWallet.sendBitcoin
- Defined in wallet/serviceWorker/wallet.ts:1473

settle

settle(
params?: SettleParams,
callback?: (event: SettlementEvent) => void,
): Promise<string>
Settle boarding inputs and/or preconfirmed virtual outputs into settled virtual outputs.
Parameters
- Optionalparams: SettleParams
  Optional explicit settlement inputs and outputs
- Optionalcallback: (event: SettlementEvent) => void
Returns Promise<string>
Arkade transaction id

See
SettleParams
Implementation of IWallet.settle
- Defined in wallet/serviceWorker/wallet.ts:1489

`Static`create

create(options: ServiceWorkerWalletCreateOptions): Promise<ServiceWorkerWallet>
Create a readonly service-worker wallet bound to an already-registered worker.
Parameters
- options: ServiceWorkerWalletCreateOptions
  Service worker, identity, and backend configuration
Returns Promise<ServiceWorkerWallet>
Initialized readonly service-worker wallet

Throws
Error if service-worker initialization fails
Overrides ServiceWorkerReadonlyWallet.create
- Defined in wallet/serviceWorker/wallet.ts:1348

`Static`setup

setup(options: ServiceWorkerWalletSetupOptions): Promise<ServiceWorkerWallet>
Simplified setup method that handles service worker registration and wallet initialization automatically.
Parameters
- options: ServiceWorkerWalletSetupOptions
Returns Promise<ServiceWorkerWallet>
Example
```
const wallet = await ServiceWorkerWallet.setup({
  serviceWorkerPath: '/service-worker.js',
  arkServerUrl: 'https://arkade.computer',
  identity: MnemonicIdentity.fromMnemonic('abandon abandon...')
});
```
Overrides ServiceWorkerReadonlyWallet.setup
- Defined in wallet/serviceWorker/wallet.ts:1459

Class ServiceWorkerWallet

See

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Properties

ReadonlycontractRepository

Readonlyidentity

ReadonlyserviceWorker

ReadonlywalletRepository

Accessors

assetManager

Returns IAssetManager

Methods

clear

Returns Promise<void>

getAddress

Returns Promise<string>

getBalance

Returns Promise<WalletBalance>

getBoardingAddress

Returns Promise<string>

getBoardingUtxos

Returns Promise<ExtendedCoin[]>

getContractManager

Returns Promise<IContractManager>

getDelegateManager

Returns Promise<IDelegateManager | undefined>

getDelegatorManager

Returns Promise<IDelegateManager | undefined>

Deprecated

See

getStatus

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

getTransactionHistory

Returns Promise<ArkTransaction[]>

getVtxoManager

Returns Promise<IVtxoManager>

getVtxos

Parameters

Returns Promise<ExtendedVirtualCoin[]>

See

reload

Returns Promise<boolean>

restore

Parameters

Returns Promise<void>

send

Parameters

Returns Promise<string>

Example

sendBitcoin

Parameters

Returns Promise<string>

Deprecated

See

settle

Parameters

Returns Promise<string>

See

Staticcreate

Parameters

Returns Promise<ServiceWorkerWallet>

Throws

Staticsetup

Parameters

Returns Promise<ServiceWorkerWallet>

Example

Settings

On This Page

`Readonly`contractRepository

`Readonly`identity

`Readonly`serviceWorker

`Readonly`walletRepository

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

`Static`create

`Static`setup