IWallet.md

beignet / IWallet

Interface: IWallet

Table of contents

Properties

• addressLookAhead
• addressLookBehind
• addressType
• addressTypesToMonitor
• customGetAddress
• customGetScriptHash
• data
• disableMessages
• disableMessagesOnCreate
• electrumOptions
• gapLimitOptions
• id
• mnemonic
• name
• network
• onMessage
• passphrase
• rbf
• remainOffline
• selectedFeeId
• storage

Properties

addressLookAhead

• Optional addressLookAhead: number

Defined in

types/wallet.ts:213

---

addressLookBehind

• Optional addressLookBehind: number

Defined in

types/wallet.ts:212

---

addressType

• Optional addressType: EAddressType

Defined in

types/wallet.ts:190

---

addressTypesToMonitor

• Optional addressTypesToMonitor: EAddressType[]

Defined in

types/wallet.ts:210

---

customGetAddress

• Optional customGetAddress: (data: ICustomGetAddress) => Promise<Result<IGetAddressResponse>>

Type declaration

▸ (data): Promise<Result<IGetAddressResponse>>

Parameters

Name	Type
data	ICustomGetAddress

Returns

Promise<Result<IGetAddressResponse>>

Defined in

types/wallet.ts:202

---

customGetScriptHash

• Optional customGetScriptHash: (data: ICustomGetScriptHash) => Promise<string>

Type declaration

▸ (data): Promise<string>

Parameters

Name	Type
data	ICustomGetScriptHash

Returns

Promise<string>

Defined in

types/wallet.ts:205

---

data

• Optional data: IWalletData

Defined in

types/wallet.ts:191

---

disableMessages

• Optional disableMessages: boolean

Defined in

types/wallet.ts:208

---

disableMessagesOnCreate

• Optional disableMessagesOnCreate: boolean

Defined in

types/wallet.ts:209

---

electrumOptions

• Optional electrumOptions: Object

Type declaration

Name	Type
batchDelay?	number
batchLimit?	number
net?	Server
servers?	TServer | TServer[]
tls?	TLSSocket

Defined in

types/wallet.ts:193

---

gapLimitOptions

• Optional gapLimitOptions: TGapLimitOptions

Defined in

types/wallet.ts:211

---

id

• Optional id: string

Defined in

types/wallet.ts:186

---

mnemonic

• mnemonic: string

Defined in

types/wallet.ts:185

---

name

• Optional name: string

Defined in

types/wallet.ts:187

---

network

• Optional network: EAvailableNetworks

Defined in

types/wallet.ts:189

---

onMessage

• Optional onMessage: TOnMessage

Defined in

types/wallet.ts:201

---

passphrase

• Optional passphrase: string

Defined in

types/wallet.ts:188

---

rbf

• Optional rbf: boolean

Defined in

types/wallet.ts:206

---

remainOffline

• Optional remainOffline: boolean

Defined in

types/wallet.ts:200

---

selectedFeeId

• Optional selectedFeeId: EFeeId

Defined in

types/wallet.ts:207

---

storage

• Optional storage: TStorage

Defined in

types/wallet.ts:192