Class Wallet

Main wallet implementation for Bitcoin transactions with Ark protocol support. The wallet does not store any data locally and relies on Ark and onchain providers to fetch UTXOs and VTXOs.

Example

// Create a wallet with URL configuration
const wallet = await Wallet.create({
  identity: SingleKey.fromHex('your_private_key'),
  arkServerUrl: 'https://ark.example.com',
  esploraUrl: 'https://mempool.space/api'
});

// Or with custom provider instances (e.g., for Expo/React Native)
const wallet = await Wallet.create({
  identity: SingleKey.fromHex('your_private_key'),
  arkProvider: new ExpoArkProvider('https://ark.example.com'),
  indexerProvider: new ExpoIndexerProvider('https://ark.example.com'),
  esploraUrl: 'https://mempool.space/api'
});

// Get addresses
const arkAddress = await wallet.getAddress();
const boardingAddress = await wallet.getBoardingAddress();

// Send bitcoin
const txid = await wallet.sendBitcoin({
  address: 'tb1...',
  amount: 50000
});

Hierarchy (View Summary)

ReadonlyWallet
- Wallet

Implements

IWallet

Properties

`Readonly`arkProvider

arkProvider: ArkProvider

`Readonly`arkServerPublicKey

arkServerPublicKey: Bytes

`Readonly`boardingTapscript

boardingTapscript: DefaultVtxo.Script

`Readonly`contractRepository

contractRepository: ContractRepository

`Readonly`dustAmount

dustAmount: bigint

`Readonly`forfeitOutputScript

forfeitOutputScript: Bytes

`Readonly`forfeitPubkey

forfeitPubkey: Bytes

`Readonly`identity

identity: Identity

`Readonly`indexerProvider

indexerProvider: IndexerProvider

`Readonly`network

network: Network

`Readonly`networkName

networkName: NetworkName

`Readonly`offchainTapscript

offchainTapscript: DefaultVtxo.Script

`Readonly`onchainProvider

onchainProvider: OnchainProvider

`Readonly`renewalConfig

renewalConfig: Required<Omit<RenewalConfig | undefined, "enabled">> & {
enabled: boolean;
thresholdMs: number;
}

`Readonly`serverUnrollScript

serverUnrollScript: CSVMultisigTapscript.Type

`Readonly`walletRepository

walletRepository: WalletRepository

`Static`MIN_FEE_RATE

MIN_FEE_RATE: number = 1

Accessors

arkAddress

get arkAddress(): ArkAddress
Returns ArkAddress
Inherited from ReadonlyWallet.arkAddress
- Defined in wallet/wallet.ts:264

Methods

createBatchHandler

createBatchHandler(
    intentId: string,
    inputs: ExtendedCoin[],
    session?: SignerSession,
): Handler
Parameters
- intentId: string
  The intent ID.
- inputs: ExtendedCoin[]
  The inputs of the intent.
- Optionalsession: SignerSession
  The musig2 signing session, if not provided, the signing will be skipped.
Returns Handler
Implements
Batch.Handler interface.
- Defined in wallet/wallet.ts:1249

fetchPendingTxs

fetchPendingTxs(): Promise<string[]>
Returns Promise<string[]>
Inherited from ReadonlyWallet.fetchPendingTxs
- Defined in wallet/wallet.ts:578

finalizePendingTxs

finalizePendingTxs(
vtxos?: ExtendedVirtualCoin[],
): Promise<{ finalized: string[]; pending: string[] }>
Finalizes pending transactions by retrieving them from the server and finalizing each one.
Parameters
- Optionalvtxos: ExtendedVirtualCoin[]
  Optional list of VTXOs to use instead of retrieving them from the server
Returns Promise<{ finalized: string[]; pending: string[] }>
Array of transaction IDs that were finalized
- Defined in wallet/wallet.ts:1493

getAddress

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

getBalance

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

getBoardingAddress

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

getBoardingTxs

getBoardingTxs(): Promise<
{ boardingTxs: ArkTransaction[]; commitmentsToIgnore: Set<string> },
>
Returns Promise<{ boardingTxs: ArkTransaction[]; commitmentsToIgnore: Set<string> }>
Inherited from ReadonlyWallet.getBoardingTxs
- Defined in wallet/wallet.ts:395

getBoardingUtxos

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

getTransactionHistory

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

getVtxos

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

makeDeleteIntentSignature

makeDeleteIntentSignature(
coins: ExtendedCoin[],
): Promise<SignedIntent<DeleteMessage>>
Parameters
- coins: ExtendedCoin[]
Returns Promise<SignedIntent<DeleteMessage>>
- Defined in wallet/wallet.ts:1450

makeGetPendingTxIntentSignature

makeGetPendingTxIntentSignature(
vtxos: ExtendedVirtualCoin[],
): Promise<SignedIntent<GetPendingTxMessage>>
Parameters
- vtxos: ExtendedVirtualCoin[]
Returns Promise<SignedIntent<GetPendingTxMessage>>
- Defined in wallet/wallet.ts:1469

makeRegisterIntentSignature

makeRegisterIntentSignature(
    coins: ExtendedCoin[],
    outputs: PSBTKeyMapKeys<{}>[],
    onchainOutputsIndexes: number[],
    cosignerPubKeys: string[],
): Promise<SignedIntent<RegisterMessage>>
Parameters
- coins: ExtendedCoin[]
- outputs: PSBTKeyMapKeys<{}>[]
- onchainOutputsIndexes: number[]
- cosignerPubKeys: string[]
Returns Promise<SignedIntent<RegisterMessage>>
- Defined in wallet/wallet.ts:1425

notifyIncomingFunds

notifyIncomingFunds(
eventCallback: (coins: IncomingFunds) => void,
): Promise<() => void>
Parameters
- eventCallback: (coins: IncomingFunds) => void
Returns Promise<() => void>
Inherited from ReadonlyWallet.notifyIncomingFunds
- Defined in wallet/wallet.ts:485

safeRegisterIntent

safeRegisterIntent(intent: SignedIntent<RegisterMessage>): Promise<string>
Parameters
- intent: SignedIntent<RegisterMessage>
Returns Promise<string>
- Defined in wallet/wallet.ts:1397

sendBitcoin

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

settle

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

toReadonly

toReadonly(): Promise<ReadonlyWallet>

Convert this wallet to a readonly wallet.

Returns Promise<ReadonlyWallet>

A readonly wallet with the same configuration but readonly identity

Example

const wallet = await Wallet.create({ identity: SingleKey.fromHex('...'), ... });
const readonlyWallet = await wallet.toReadonly();

// Can query balance and addresses
const balance = await readonlyWallet.getBalance();
const address = await readonlyWallet.getAddress();

// But cannot send transactions (type error)
// readonlyWallet.sendBitcoin(...); // TypeScript error

`Static`create

create(config: WalletConfig): Promise<Wallet>
Parameters
- config: WalletConfig
Returns Promise<Wallet>
Overrides ReadonlyWallet.create
- Defined in wallet/wallet.ts:675

Class Wallet

Example

Hierarchy (View Summary)

Implements

Index

Properties

Accessors

Methods

Properties

ReadonlyarkProvider

ReadonlyarkServerPublicKey

ReadonlyboardingTapscript

ReadonlycontractRepository

ReadonlydustAmount

ReadonlyforfeitOutputScript

ReadonlyforfeitPubkey

Readonlyidentity

ReadonlyindexerProvider

Readonlynetwork

ReadonlynetworkName

ReadonlyoffchainTapscript

ReadonlyonchainProvider

ReadonlyrenewalConfig

ReadonlyserverUnrollScript

ReadonlywalletRepository

StaticMIN_FEE_RATE

Accessors

arkAddress

Returns ArkAddress

Methods

createBatchHandler

Parameters

Returns Handler

Implements

fetchPendingTxs

Returns Promise<string[]>

finalizePendingTxs

Parameters

Returns Promise<{ finalized: string[]; pending: string[] }>

getAddress

Returns Promise<string>

getBalance

Returns Promise<WalletBalance>

getBoardingAddress

Returns Promise<string>

getBoardingTxs

Returns Promise<{ boardingTxs: ArkTransaction[]; commitmentsToIgnore: Set<string> }>

getBoardingUtxos

Returns Promise<ExtendedCoin[]>

getTransactionHistory

Returns Promise<ArkTransaction[]>

getVtxos

Parameters

Returns Promise<ExtendedVirtualCoin[]>

makeDeleteIntentSignature

Parameters

Returns Promise<SignedIntent<DeleteMessage>>

makeGetPendingTxIntentSignature

Parameters

Returns Promise<SignedIntent<GetPendingTxMessage>>

makeRegisterIntentSignature

Parameters

Returns Promise<SignedIntent<RegisterMessage>>

notifyIncomingFunds

Parameters

Returns Promise<() => void>

safeRegisterIntent

Parameters

Returns Promise<string>

sendBitcoin

Parameters

Returns Promise<string>

settle

Parameters

Returns Promise<string>

toReadonly

Returns Promise<ReadonlyWallet>

Example

Staticcreate

Parameters

`Readonly`arkProvider

`Readonly`arkServerPublicKey

`Readonly`boardingTapscript

`Readonly`contractRepository

`Readonly`dustAmount

`Readonly`forfeitOutputScript

`Readonly`forfeitPubkey

`Readonly`identity

`Readonly`indexerProvider

`Readonly`network

`Readonly`networkName

`Readonly`offchainTapscript

`Readonly`onchainProvider

`Readonly`renewalConfig

`Readonly`serverUnrollScript

`Readonly`walletRepository

`Static`MIN_FEE_RATE

`Static`create