Class ServiceWorkerWallet

Core wallet interface for Bitcoin transactions with Ark protocol support.

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

Hierarchy (View Summary)

ServiceWorkerReadonlyWallet
- ServiceWorkerWallet

Implements

IWallet

Index

Properties

contractRepository identity serviceWorker walletRepository

Methods

clear getAddress getBalance getBoardingAddress getBoardingUtxos getStatus getTransactionHistory getVtxos reload sendBitcoin settle create setup

Properties

`Readonly`contractRepository

contractRepository: ContractRepository

`Readonly`identity

identity: Identity

`Readonly`serviceWorker

serviceWorker: ServiceWorker

`Readonly`walletRepository

walletRepository: WalletRepository

Methods

clear

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

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Implementation of IWallet.getAddress
Inherited from ServiceWorkerReadonlyWallet.getAddress
- Defined in wallet/serviceWorker/wallet.ts:233

getBalance

getBalance(): Promise<WalletBalance>
Returns Promise<WalletBalance>
Implementation of IWallet.getBalance
Inherited from ServiceWorkerReadonlyWallet.getBalance
- Defined in wallet/serviceWorker/wallet.ts:267

getBoardingAddress

getBoardingAddress(): Promise<string>
Returns Promise<string>
Implementation of IWallet.getBoardingAddress
Inherited from ServiceWorkerReadonlyWallet.getBoardingAddress
- Defined in wallet/serviceWorker/wallet.ts:250

getBoardingUtxos

getBoardingUtxos(): Promise<ExtendedCoin[]>
Returns Promise<ExtendedCoin[]>
Implementation of IWallet.getBoardingUtxos
Inherited from ServiceWorkerReadonlyWallet.getBoardingUtxos
- Defined in wallet/serviceWorker/wallet.ts:284

getStatus

getStatus(): Promise<
    {
        walletInitialized: boolean;
        xOnlyPublicKey: Uint8Array<ArrayBufferLike>
        | undefined;
    },
>
Returns Promise<
    {
        walletInitialized: boolean;
        xOnlyPublicKey: Uint8Array<ArrayBufferLike>
        | undefined;
    },
>
Inherited from ServiceWorkerReadonlyWallet.getStatus
- Defined in wallet/serviceWorker/wallet.ts:301

getTransactionHistory

getTransactionHistory(): Promise<ArkTransaction[]>
Returns Promise<ArkTransaction[]>
Implementation of IWallet.getTransactionHistory
Inherited from ServiceWorkerReadonlyWallet.getTransactionHistory
- Defined in wallet/serviceWorker/wallet.ts:313

getVtxos

getVtxos(filter?: GetVtxosFilter): Promise<ExtendedVirtualCoin[]>
Parameters
- Optionalfilter: GetVtxosFilter
Returns Promise<ExtendedVirtualCoin[]>
Implementation of IWallet.getVtxos
Inherited from ServiceWorkerReadonlyWallet.getVtxos
- Defined in wallet/serviceWorker/wallet.ts:330

reload

reload(): Promise<boolean>
Returns Promise<boolean>
Inherited from ServiceWorkerReadonlyWallet.reload
- Defined in wallet/serviceWorker/wallet.ts:348

sendBitcoin

sendBitcoin(params: SendBitcoinParams): Promise<string>
Parameters
- params: SendBitcoinParams
Returns Promise<string>
Implementation of IWallet.sendBitcoin
- Defined in wallet/serviceWorker/wallet.ts:458

settle

settle(
params?: SettleParams,
callback?: (event: SettlementEvent) => void,
): Promise<string>
Parameters
- Optionalparams: SettleParams
- Optionalcallback: (event: SettlementEvent) => void
Returns Promise<string>
Implementation of IWallet.settle
- Defined in wallet/serviceWorker/wallet.ts:476

`Static`create

create(options: ServiceWorkerWalletCreateOptions): Promise<ServiceWorkerWallet>
Parameters
- options: ServiceWorkerWalletCreateOptions
Returns Promise<ServiceWorkerWallet>
Overrides ServiceWorkerReadonlyWallet.create
- Defined in wallet/serviceWorker/wallet.ts:381

`Static`setup

setup(options: ServiceWorkerWalletSetupOptions): Promise<ServiceWorkerWallet>

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

Parameters

options: ServiceWorkerWalletSetupOptions

Returns Promise<ServiceWorkerWallet>

Example

// One-liner setup - handles everything automatically!
const wallet = await ServiceWorkerWallet.setup({
  serviceWorkerPath: '/service-worker.js',
  arkServerUrl: 'https://mutinynet.arkade.sh'
});

// With custom identity
const identity = SingleKey.fromHex('your_private_key_hex');
const wallet = await ServiceWorkerWallet.setup({
  serviceWorkerPath: '/service-worker.js',
  arkServerUrl: 'https://mutinynet.arkade.sh',
  identity
});

Class ServiceWorkerWallet

Hierarchy (View Summary)

Implements

Index

Properties

Methods

Properties

ReadonlycontractRepository

Readonlyidentity

ReadonlyserviceWorker

ReadonlywalletRepository

Methods

clear

Returns Promise<void>

getAddress

Returns Promise<string>

getBalance

Returns Promise<WalletBalance>

getBoardingAddress

Returns Promise<string>

getBoardingUtxos

Returns Promise<ExtendedCoin[]>

getStatus

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

getTransactionHistory

Returns Promise<ArkTransaction[]>

getVtxos

Parameters

Returns Promise<ExtendedVirtualCoin[]>

reload

Returns Promise<boolean>

sendBitcoin

Parameters

Returns Promise<string>

settle

Parameters

Returns Promise<string>

Staticcreate

Parameters

Returns Promise<ServiceWorkerWallet>

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