Companion

object Companion

Functions

Link copied to clipboard

Detects the language of a mnemonic phrase.

Link copied to clipboard
suspend fun from(mnemonic: String, language: MnemonicLanguage? = null, passphrase: String = ""): Mnemonic

Creates a Mnemonic instance from a BIP-39 mnemonic phrase.

Link copied to clipboard
suspend fun fromBip39HexSeed(hexSeed: String): Mnemonic

Creates a Mnemonic instance from a BIP-39 seed in hexadecimal format.

Link copied to clipboard

Creates a Mnemonic instance from a BIP-39 seed as bytes.

Link copied to clipboard
suspend fun fromEntropy(entropy: ByteArray, language: MnemonicLanguage = MnemonicLanguage.ENGLISH, passphrase: String = ""): Mnemonic

Creates a Mnemonic instance from raw entropy bytes.

Link copied to clipboard
suspend fun generate12WordsMnemonic(language: MnemonicLanguage = MnemonicLanguage.ENGLISH): String

Generates a 12-word BIP-39 mnemonic phrase (128 bits of entropy).

Link copied to clipboard
suspend fun generate15WordsMnemonic(language: MnemonicLanguage = MnemonicLanguage.ENGLISH): String

Generates a 15-word BIP-39 mnemonic phrase (160 bits of entropy).

Link copied to clipboard
suspend fun generate18WordsMnemonic(language: MnemonicLanguage = MnemonicLanguage.ENGLISH): String

Generates an 18-word BIP-39 mnemonic phrase (192 bits of entropy).

Link copied to clipboard
suspend fun generate21WordsMnemonic(language: MnemonicLanguage = MnemonicLanguage.ENGLISH): String

Generates a 21-word BIP-39 mnemonic phrase (224 bits of entropy).

Link copied to clipboard
suspend fun generate24WordsMnemonic(language: MnemonicLanguage = MnemonicLanguage.ENGLISH): String

Generates a 24-word BIP-39 mnemonic phrase (256 bits of entropy).

Link copied to clipboard
suspend fun validate(mnemonic: String, language: MnemonicLanguage = MnemonicLanguage.ENGLISH): Boolean

Validates a BIP-39 mnemonic phrase.