BitcoinWallet

Interface defining the Bitcoin wallet used in the SDK. You can plug your own wallet by passing a custom implementation of this interface to the ComitClient.

Hierarchy

• BitcoinWallet

Implemented by

• InMemoryBitcoinWallet
• MockBitcoinWallet

Index

Methods

• broadcastTransaction
• getAddress
• getBalance
• getFee
• sendToAddress

Methods

broadcastTransaction

▸ broadcastTransaction(transactionHex: string, network: string): Promise‹string›

Defined in bitcoin_wallet.ts:19

Parameters:

Name	Type
transactionHex	string
network	string

Returns: Promise‹string›

---

getAddress

▸ getAddress(): Promise‹string›

Defined in bitcoin_wallet.ts:9

Returns: Promise‹string›

---

getBalance

▸ getBalance(): Promise‹number›

Defined in bitcoin_wallet.ts:11

Returns: Promise‹number›

---

getFee

▸ getFee(): string

Defined in bitcoin_wallet.ts:24

Returns: string

---

sendToAddress

▸ sendToAddress(address: string, satoshis: number, network: string): Promise‹string›

Defined in bitcoin_wallet.ts:13

Parameters:

Name	Type
address	string
satoshis	number
network	string

Returns: Promise‹string›