generateMnemonic

suspend fun generateMnemonic(strength: MnemonicStrength = MnemonicStrength.BITS_256, language: MnemonicLanguage = MnemonicLanguage.ENGLISH): String

Generates a BIP-39 mnemonic phrase with the specified strength.

Uses cryptographically secure random number generation to produce entropy, which is then converted to a mnemonic phrase using the specified word list.

Return

Space-separated mnemonic phrase

Example:

// Generate a 24-word mnemonic (recommended)
val mnemonic = MnemonicUtils.generateMnemonic()

// Generate a 12-word mnemonic
val shortMnemonic = MnemonicUtils.generateMnemonic(MnemonicStrength.BITS_128)

// Generate a French mnemonic
val frenchMnemonic = MnemonicUtils.generateMnemonic(
strength = MnemonicStrength.BITS_256,
language = MnemonicLanguage.FRENCH
)

Parameters

strength

Entropy strength determining word count (default: 256 bits / 24 words)

language

Word list language (default: English)