Class HDWalletInfo

HD wallet information With the master key and specific encryption type

Hierarchy

HDWalletInfo

Index

Constructors

Properties

_derivedWallets _encryptionType _keyEntropy _pathTemplate

Accessors

derivedWallets encryptionType keyEntropy pathTemplate

Methods

removeDerivedWallet setDerivedWallet toJSON

Constructors

constructor

new HDWalletInfo(keyEntropy, encryptionType, pathTemplate): HDWalletInfo
Create a new HD wallet information with master key and encryption type
Parameters
- keyEntropy: Uint8Array
- encryptionType: EncryptionType
- pathTemplate: string
Returns HDWalletInfo
- Defined in user/wallet-info.ts:222

Properties

`Private` _derivedWallets

_derivedWallets: WalletInfo[]

`Private` _encryptionType

_encryptionType: EncryptionType

`Private` _keyEntropy

_keyEntropy: Uint8Array

`Private` _pathTemplate

_pathTemplate: string

Accessors

derivedWallets

get derivedWallets(): WalletInfo[]
Get derived wallets

Returns WalletInfo[]
- Defined in user/wallet-info.ts:249

encryptionType

get encryptionType(): EncryptionType
Get encryption type of wallet

Returns EncryptionType
- Defined in user/wallet-info.ts:242

keyEntropy

get keyEntropy(): Uint8Array
Get master key entropy

Returns Uint8Array
- Defined in user/wallet-info.ts:235

pathTemplate

get pathTemplate(): string
Gets the hd wallet path template

Returns string
- Defined in user/wallet-info.ts:256

Methods

removeDerivedWallet

removeDerivedWallet(derivedPath): void
Remove a derived wallet by path
Parameters
- derivedPath: string
Returns void
- Defined in user/wallet-info.ts:290

setDerivedWallet

setDerivedWallet(derivedPath, encryptionType, info?): void
Set a derived wallet information
Parameters
- derivedPath: string
- encryptionType: EncryptionType
- Optional info: string | WalletDescriptor
Returns void
- Defined in user/wallet-info.ts:266

toJSON

toJSON(): {
    derives: WalletInfo[];
    encryptionType: EncryptionType;
    keyEntropy: number[];
    pathTemplate: string;
}
Override the JSON stringify behavior to have properly properties

Returns {
    derives: WalletInfo[];
    encryptionType: EncryptionType;
    keyEntropy: number[];
    pathTemplate: string;
}
- derives: WalletInfo[]
- encryptionType: EncryptionType
- keyEntropy: number[]
- pathTemplate: string
- Defined in user/wallet-info.ts:299

Generated using TypeDoc