Class AccountMnemonicFactory

A factory class that generates instances of AccountMemory based on provided mnemonic phrase.

Hierarchy (View Summary)

default
- AccountMnemonicFactory

Index

Constructors

Methods

discover getWallet getWalletSync initialize initializeSync

Constructors

constructor

new AccountMnemonicFactory(
mnemonicOrWalletOrSeed: string | Uint8Array | Wallet,
): AccountMnemonicFactory
Parameters
- mnemonicOrWalletOrSeed: string | Uint8Array | Wallet
  BIP39-compatible mnemonic phrase or a wallet/seed derived from mnemonic
Returns AccountMnemonicFactory
Overrides default.constructor
- Defined in account/MnemonicFactory.ts:52

Methods

discover

discover(node: Node): Promise<AccountBase[]>
Discovers accounts in set that already have been used (has any on-chain transactions). It returns an empty array if none of accounts been used. If a used account is preceded by an unused account then it would be ignored.
Parameters
- node: Node
  Instance of Node to get account information from
Returns Promise<AccountBase[]>
Inherited from default.discover
- Defined in account/BaseFactory.ts:21

getWallet

getWallet(): Promise<Wallet>
Get a wallet to initialize AccountMnemonicFactory instead mnemonic phrase. In comparison with mnemonic, the wallet can be used to derive aeternity accounts only.

Returns Promise<Wallet>
- Defined in account/MnemonicFactory.ts:86

getWalletSync

getWalletSync(): Wallet
The same as getWallet but synchronous.

Returns Wallet
- Defined in account/MnemonicFactory.ts:93

initialize

initialize(accountIndex: number): Promise<AccountMemory>
Get an instance of AccountMemory for a given account index.
Parameters
- accountIndex: number
  Index of account
Returns Promise<AccountMemory>
Overrides default.initialize
- Defined in account/MnemonicFactory.ts:110

initializeSync

initializeSync(accountIndex: number): AccountMemory
The same as initialize but synchronous.
Parameters
- accountIndex: number
Returns AccountMemory
- Defined in account/MnemonicFactory.ts:118