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
const wallet = await Wallet.create({
  identity: SingleKey.fromHex('your_private_key'),
  arkServerUrl: '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
});

Implements

IWallet

Properties

`Readonly`arkProvider

arkProvider: ArkProvider

`Readonly`arkServerPublicKey

arkServerPublicKey: Bytes

`Readonly`boardingTapscript

boardingTapscript: DefaultVtxo.Script

`Readonly`dustAmount

dustAmount: bigint

`Readonly`forfeitOutputScript

forfeitOutputScript: 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`serverUnrollScript

serverUnrollScript: CSVMultisigTapscript.Type

`Static`MIN_FEE_RATE

MIN_FEE_RATE: number = 1

Accessors

arkAddress

get arkAddress(): ArkAddress
Returns ArkAddress
- Defined in src/wallet/wallet.ts:183

Methods

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Implementation of IWallet.getAddress
- Defined in src/wallet/wallet.ts:190

getBalance

getBalance(): Promise<WalletBalance>
Returns Promise<WalletBalance>
Implementation of IWallet.getBalance
- Defined in src/wallet/wallet.ts:198

getBoardingAddress

getBoardingAddress(): Promise<string>
Returns Promise<string>
Implementation of IWallet.getBoardingAddress
- Defined in src/wallet/wallet.ts:194

getBoardingTxs

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

getBoardingUtxos

getBoardingUtxos(): Promise<ExtendedCoin[]>
Returns Promise<ExtendedCoin[]>
Implementation of IWallet.getBoardingUtxos
- Defined in src/wallet/wallet.ts:413

getTransactionHistory

getTransactionHistory(): Promise<ArkTransaction[]>
Returns Promise<ArkTransaction[]>
Implementation of IWallet.getTransactionHistory
- Defined in src/wallet/wallet.ts:293

getVtxos

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

notifyIncomingFunds

notifyIncomingFunds(
eventCallback: (coins: IncomingFunds) => void,
): Promise<() => void>
Parameters
- eventCallback: (coins: IncomingFunds) => void
Returns Promise<() => void>
- Defined in src/wallet/wallet.ts:800

sendBitcoin

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

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 src/wallet/wallet.ts:511

`Static`create

create(config: WalletConfig): Promise<Wallet>
Parameters
- config: WalletConfig
Returns Promise<Wallet>
- Defined in src/wallet/wallet.ts:116

Class Wallet

Example

Implements

Index

Properties

Accessors

Methods

Properties

ReadonlyarkProvider

ReadonlyarkServerPublicKey

ReadonlyboardingTapscript

ReadonlydustAmount

ReadonlyforfeitOutputScript

Readonlyidentity

ReadonlyindexerProvider

Readonlynetwork

ReadonlynetworkName

ReadonlyoffchainTapscript

ReadonlyonchainProvider

ReadonlyserverUnrollScript

StaticMIN_FEE_RATE

Accessors

arkAddress

Returns ArkAddress

Methods

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[]>

notifyIncomingFunds

Parameters

Returns Promise<() => void>

sendBitcoin

Parameters

Returns Promise<string>

settle

Parameters

Returns Promise<string>

Staticcreate

Parameters

Returns Promise<Wallet>

Settings

On This Page

`Readonly`arkProvider

`Readonly`arkServerPublicKey

`Readonly`boardingTapscript

`Readonly`dustAmount

`Readonly`forfeitOutputScript

`Readonly`identity

`Readonly`indexerProvider

`Readonly`network

`Readonly`networkName

`Readonly`offchainTapscript

`Readonly`onchainProvider

`Readonly`serverUnrollScript

`Static`MIN_FEE_RATE

`Static`create