bsv.Mnemonic

scrypt-ts / bsv / Mnemonic

Class: Mnemonic

bsv.Mnemonic

Table of contents

Constructors

• constructor

Properties

• phrase
• wordList

Methods

• inspect
• toHDPrivateKey
• toSeed
• toString
• fromRandom
• fromSeed
• fromString
• isValid

Constructors

constructor

• new Mnemonic(data, wordList?)

Parameters

Name	Type
data	string | string[]
wordList?	string[]

Defined in

node_modules/bsv/index.d.ts:1108

Properties

phrase

• Readonly phrase: string

Defined in

node_modules/bsv/index.d.ts:1111

---

wordList

• Readonly wordList: string[]

Defined in

node_modules/bsv/index.d.ts:1110

Methods

inspect

▸ inspect(): string

Returns

string

Defined in

node_modules/bsv/index.d.ts:1116

---

toHDPrivateKey

▸ toHDPrivateKey(passphrase, network): HDPrivateKey

Parameters

Name	Type
passphrase	string
network	Type

Returns

HDPrivateKey

Defined in

node_modules/bsv/index.d.ts:1114

---

toSeed

▸ toSeed(passphrase?): Buffer

Parameters

Name	Type
passphrase?	string

Returns

Buffer

Defined in

node_modules/bsv/index.d.ts:1113

---

toString

▸ toString(): string

Returns

string

Defined in

node_modules/bsv/index.d.ts:1115

---

fromRandom

▸ Static fromRandom(wordlist?): Mnemonic

Parameters

Name	Type
wordlist?	string[]

Returns

Mnemonic

Defined in

node_modules/bsv/index.d.ts:1118

---

fromSeed

▸ Static fromSeed(seed, wordlist): Mnemonic

Parameters

Name	Type
seed	Buffer
wordlist	string[]

Returns

Mnemonic

Defined in

node_modules/bsv/index.d.ts:1121

---

fromString

▸ Static fromString(mnemonic, wordList?): Mnemonic

Parameters

Name	Type
mnemonic	string
wordList?	string[]

Returns

Mnemonic

Defined in

node_modules/bsv/index.d.ts:1119

---

isValid

▸ Static isValid(mnemonic, wordList?): boolean

Parameters

Name	Type
mnemonic	string
wordList?	string[]

Returns

boolean

Defined in

node_modules/bsv/index.d.ts:1120