Class OnchainWallet

Onchain Bitcoin wallet implementation for traditional Bitcoin transactions.

This wallet handles regular Bitcoin transactions on the blockchain without using the Ark protocol. It supports P2TR (Pay-to-Taproot) addresses and provides basic Bitcoin wallet functionality.

Example

const wallet = await OnchainWallet.create(identity, 'mainnet');
const balance = await wallet.getBalance();
const txid = await wallet.send({
  address: 'bc1...',
  amount: 50000
});

Implements

AnchorBumper

Index

Properties

`Readonly`network

network: Network

`Readonly`onchainP2TR

onchainP2TR: P2TR

`Readonly`provider

provider: OnchainProvider

`Static`DUST_AMOUNT

DUST_AMOUNT: number = 546

`Static`MIN_FEE_RATE

MIN_FEE_RATE: number = 1

Accessors

address

get address(): string
Returns string
- Defined in wallet/onchain.ts:74

Methods

bumpP2A

bumpP2A(parent: Transaction): Promise<[string, string]>
Parameters
- parent: Transaction
Returns Promise<[string, string]>
Implementation of AnchorBumper.bumpP2A
- Defined in wallet/onchain.ts:159

getBalance

getBalance(): Promise<number>
Returns Promise<number>
- Defined in wallet/onchain.ts:82

getCoins

getCoins(): Promise<Coin[]>
Returns Promise<Coin[]>
- Defined in wallet/onchain.ts:78

send

send(params: SendBitcoinParams): Promise<string>
Parameters
- params: SendBitcoinParams
Returns Promise<string>
- Defined in wallet/onchain.ts:94

`Static`create

create(
    identity: Identity,
    networkName: NetworkName,
    provider?: OnchainProvider,
): Promise<OnchainWallet>
Parameters
- identity: Identity
- networkName: NetworkName
- Optionalprovider: OnchainProvider
Returns Promise<OnchainWallet>
- Defined in wallet/onchain.ts:51

Class OnchainWallet

Example

Implements

Index

Properties

Accessors

Methods

Properties

`Readonly`network

`Readonly`onchainP2TR

`Readonly`provider

`Static`DUST_AMOUNT

`Static`MIN_FEE_RATE

Accessors

address

Returns string

Methods

bumpP2A

Parameters

Returns Promise<[string, string]>

getBalance

Returns Promise<number>

getCoins

Returns Promise<Coin[]>

send

Parameters

Returns Promise<string>

`Static`create

Parameters

Returns Promise<OnchainWallet>

Settings

On This Page

Class OnchainWallet

Example

Implements

Index

Properties

Accessors

Methods

Properties

Readonlynetwork

ReadonlyonchainP2TR

Readonlyprovider

StaticDUST_AMOUNT

StaticMIN_FEE_RATE

Accessors

address

Returns string

Methods

bumpP2A

Parameters

Returns Promise<[string, string]>

getBalance

Returns Promise<number>

getCoins

Returns Promise<Coin[]>

send

Parameters

Returns Promise<string>

Staticcreate

Parameters

Returns Promise<OnchainWallet>

Settings

On This Page

`Readonly`network

`Readonly`onchainP2TR

`Readonly`provider

`Static`DUST_AMOUNT

`Static`MIN_FEE_RATE

`Static`create