@stellar-fox/redshift - Documentation

Redshift. Stellar HD Address Generator.

License:

Apache-2.0

Source:

index.js, line 1

Members

(inner) ENTROPY

Entropy preset.

Source:

index.js, line 34

(inner) LANGUAGE

Languages.

Source:

index.js, line 47

(inner, constant) version

Library version.

Source:

index.js, line 215

Methods

(inner) genKeypair(seed, pathIndexopt) → {Object}

Generate stellar Keypair object from a given seed and a pathIndex.

Source:

index.js, line 115

Parameters:

Name	Type	Attributes	Default	Description
`seed`	`String`
`pathIndex`	`Number`	<optional>	0

Returns:

Type:: Object

(inner) genMnemonic(languageopt, entropyopt) → {String}

Generate mnemonic. BIP39 implementation.

Source:

index.js, line 66

Parameters:

Name	Type	Attributes	Default	Description
`language`	`String`	<optional>	LANGUAGE.EN
`entropy`	`Number`	<optional>	ENTROPY.HIGH

Returns:

Type:: String

(inner) mnemonicToSeedHex(mnemonic, passphraseopt) → {String}

Generate hex seed from a given mnemonic and passphrase. BIP39 implementation.

Source:

index.js, line 101

Parameters:

Name	Type	Attributes	Default	Description
`mnemonic`	`String`
`passphrase`	`String`	<optional>	""

Returns:

Type:: String

(inner) newAccount(passphraseopt, pathIndexopt, languageopt) → {Object}

Randomly generate object with mnemonic, passphrase, pathIndex, seed and keypair.

Source:

index.js, line 187

Parameters:

Name	Type	Attributes	Default
`passphrase`	`String`	<optional>	""
`pathIndex`	`Number`	<optional>	0
`language`	`String`	<optional>	LANGUAGE.EN

Returns:

Type:: Object

(inner) validateMnemonic(mnemonic, languageopt) → {Boolean}

Check mnemonic validity. BIP39 implementation.

Source:

index.js, line 87

Parameters:

Name	Type	Attributes	Default	Description
`mnemonic`	`String`
`language`	`String`	<optional>	LANGUAGE.EN

Returns:

Type:: Boolean

true if mnemonic checksum is ok, false otherwise