@liquality.bitcoin.<internal>.IBitcoinWallet

Interface: IBitcoinWallet<T, S>

@liquality/bitcoin..IBitcoinWallet

Type parameters

Name	Type
T	T
S	any

Hierarchy

• Wallet<T, S>

  ↳ IBitcoinWallet

Implemented by

• BitcoinHDWalletProvider
• BitcoinNodeWalletProvider

Table of contents

Properties

• chainProvider

Methods

• canUpdateFee
• exportPrivateKey
• getAddress
• getAddresses
• getBalance
• getChainProvider
• getConnectedNetwork
• getSigner
• getUnusedAddress
• getUsedAddresses
• getWalletAddress
• isWalletAvailable
• sendBatchTransaction
• sendSweepTransaction
• sendTransaction
• setChainProvider
• signMessage
• signPSBT
• updateTransactionFee

Properties

chainProvider

• Protected chainProvider: Chain<T, Network>

Inherited from

Wallet.chainProvider

Defined in

client/dist/lib/Wallet.d.ts:4

Methods

canUpdateFee

▸ Abstract canUpdateFee(): boolean

Returns

boolean

Inherited from

Wallet.canUpdateFee

Defined in

client/dist/lib/Wallet.d.ts:22

---

exportPrivateKey

▸ Abstract exportPrivateKey(): Promise<string>

Exports the private key for the account for BTC, https://en.bitcoin.it/wiki/Wallet_import_format for ETH, the privateKey for NEAR, the secretKey

Returns

Promise<string>

Inherited from

Wallet.exportPrivateKey

Defined in

client/dist/lib/Wallet.d.ts:20

---

getAddress

▸ Abstract getAddress(): Promise<AddressType>

Returns

Promise<AddressType>

Inherited from

Wallet.getAddress

Defined in

client/dist/lib/Wallet.d.ts:10

---

getAddresses

▸ Abstract getAddresses(start?, numAddresses?, change?): Promise<Address[]>

Get addresses/accounts of the user.

Parameters

Name	Type
start?	number
numAddresses?	number
change?	boolean

Returns

Promise<Address[]>

Inherited from

Wallet.getAddresses

Defined in

client/dist/lib/Wallet.d.ts:13

---

getBalance

▸ Abstract getBalance(assets): Promise<BigNumber[]>

Parameters

Name	Type
assets	Asset[]

Returns

Promise<BigNumber[]>

Inherited from

Wallet.getBalance

Defined in

client/dist/lib/Wallet.d.ts:19

---

getChainProvider

▸ getChainProvider(): Chain<T, Network>

Returns

Chain<T, Network>

Overrides

Wallet.getChainProvider

Defined in

bitcoin/lib/wallet/IBitcoinWallet.ts:6

---

getConnectedNetwork

▸ Abstract getConnectedNetwork(): Promise<Network>

Retrieve the network connected to by the wallet

Returns

Promise<Network>

Inherited from

Wallet.getConnectedNetwork

Defined in

client/dist/lib/Wallet.d.ts:8

---

getSigner

▸ Abstract getSigner(): S

Returns

S

Inherited from

Wallet.getSigner

Defined in

client/dist/lib/Wallet.d.ts:9

---

getUnusedAddress

▸ Abstract getUnusedAddress(change?, numAddressPerCall?): Promise<Address>

Get unused address/account of the user.

Parameters

Name	Type
change?	boolean
numAddressPerCall?	number

Returns

Promise<Address>

Inherited from

Wallet.getUnusedAddress

Defined in

client/dist/lib/Wallet.d.ts:11

---

getUsedAddresses

▸ Abstract getUsedAddresses(numAddressPerCall?): Promise<Address[]>

Get used addresses/accounts of the user.

Parameters

Name	Type
numAddressPerCall?	number

Returns

Promise<Address[]>

Inherited from

Wallet.getUsedAddresses

Defined in

client/dist/lib/Wallet.d.ts:12

---

getWalletAddress

▸ getWalletAddress(address): Promise<Address>

Parameters

Name	Type
address	string

Returns

Promise<Address>

Defined in

bitcoin/lib/wallet/IBitcoinWallet.ts:12

---

isWalletAvailable

▸ Abstract isWalletAvailable(): Promise<boolean>

Retrieve the availability status of the wallet

Returns

Promise<boolean>

Inherited from

Wallet.isWalletAvailable

Defined in

client/dist/lib/Wallet.d.ts:21

---

sendBatchTransaction

▸ Abstract sendBatchTransaction(txRequests): Promise<Transaction<any>[]>

Create, sign & broad a transaction with multiple outputs.

Parameters

Name	Type
txRequests	TransactionRequest[]

Returns

Promise<Transaction<any>[]>

Inherited from

Wallet.sendBatchTransaction

Defined in

client/dist/lib/Wallet.d.ts:16

---

sendSweepTransaction

▸ Abstract sendSweepTransaction(address, asset, fee?): Promise<Transaction<any>>

Create, sign & broadcast a sweep transaction.

Parameters

Name	Type
address	AddressType
asset	Asset
fee?	FeeType

Returns

Promise<Transaction<any>>

Inherited from

Wallet.sendSweepTransaction

Defined in

client/dist/lib/Wallet.d.ts:17

---

sendTransaction

▸ sendTransaction(txRequest): Promise<Transaction<any>>

Create, sign & broadcast a transaction.

Parameters

Name	Type
txRequest	TransactionRequest

Returns

Promise<Transaction<any>>

Overrides

Wallet.sendTransaction

Defined in

bitcoin/lib/wallet/IBitcoinWallet.ts:8

---

setChainProvider

▸ setChainProvider(chainProvider): void

Parameters

Name	Type
chainProvider	Chain<T, Network>

Returns

void

Inherited from

Wallet.setChainProvider

Defined in

client/dist/lib/Wallet.d.ts:6

---

signMessage

▸ Abstract signMessage(message, from): Promise<string>

Sign a message.

Parameters

Name	Type
message	string
from	AddressType

Returns

Promise<string>

Inherited from

Wallet.signMessage

Defined in

client/dist/lib/Wallet.d.ts:14

---

signPSBT

▸ signPSBT(data, inputs): Promise<string>

Parameters

Name	Type
data	string
inputs	PsbtInputTarget[]

Returns

Promise<string>

Defined in

bitcoin/lib/wallet/IBitcoinWallet.ts:14

---

updateTransactionFee

▸ updateTransactionFee(tx, newFee): Promise<Transaction<any>>

Update the fee of a transaction.

Parameters

Name	Type
tx	string | Transaction<any>
newFee	FeeType

Returns

Promise<Transaction<any>>

Overrides

Wallet.updateTransactionFee

Defined in

bitcoin/lib/wallet/IBitcoinWallet.ts:10