Class MnemonicPhrase

Hierarchy

MnemonicPhrase

Implements

Wallet

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MnemonicPhrase(mnemonicPhrase: string, passphrase?: string): MnemonicPhrase

- Defined in src/implementations/mnemonic-phrase.ts:32
Construct an instance of the mnemonic phrase wallet class.

Parameters
- mnemonicPhrase: string
- Optional passphrase: string
Returns MnemonicPhrase

Properties

Private Readonly hdNode

hdNode: HDNode

Private Readonly mnemonicPhrase

mnemonicPhrase: string

Private Optional Readonly passphrase

passphrase: undefined | string

Methods

getAddress

getAddress(derivationPath: DerivationPath, index: number): Promise<string>

Implementation of Wallet.getAddress
- Defined in src/implementations/mnemonic-phrase.ts:62
Get an address for the mnemonic phrase based on the derivation path and index.

Parameters
- derivationPath: DerivationPath
- index: number
Returns Promise<string>

getDerivationPaths

getDerivationPaths(): DerivationPath[]

- Defined in src/implementations/mnemonic-phrase.ts:51
Get all derivation paths supported by mnemonic phrases.

Returns DerivationPath[]

getType

getType(): WalletType

Implementation of Wallet.getType
- Defined in src/implementations/mnemonic-phrase.ts:83
Returns WalletType

isHardwareWallet

isHardwareWallet(): this is HardwareWallet

Implementation of Wallet.isHardwareWallet
- Defined in src/implementations/mnemonic-phrase.ts:71
Returns this is HardwareWallet

serialize

serialize(): string

Implementation of Wallet.serialize
- Defined in src/implementations/mnemonic-phrase.ts:75
Returns string

signMessage

signMessage(): Promise<SignedMessage>

- Defined in src/implementations/mnemonic-phrase.ts:67
Returns Promise<SignedMessage>

Static deserialize

deserialize(serializedData: string): MnemonicPhrase

- Defined in src/implementations/mnemonic-phrase.ts:21
Get a class instance from serialized data. Useful for using the class in a web worker.

Parameters
- serializedData: string
Returns MnemonicPhrase

Generated using TypeDoc