stellar-sdk/com.soneso.stellar.sdk.sep.sep05/MnemonicStrength

MnemonicStrength

enum MnemonicStrength : Enum<MnemonicStrength>

Mnemonic strength levels defining entropy size and resulting word count.

Higher entropy provides stronger security but results in longer mnemonic phrases. The recommended strength for most use cases is BITS_256 (24 words).

The relationship between entropy and word count follows the BIP-39 formula:

Checksum bits = entropy bits / 32
Total bits = entropy bits + checksum bits
Word count = total bits / 11

See also

BIP-39 Specification

Entries

128 bits of entropy resulting in 12 words - adequate security

160 bits of entropy resulting in 15 words - good security

192 bits of entropy resulting in 18 words - strong security

224 bits of entropy resulting in 21 words - very strong security

256 bits of entropy resulting in 24 words - maximum security (recommended)

Types

object Companion

Properties

val entries: EnumEntries<MnemonicStrength>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val entropyBits: Int

The number of entropy bits used to generate the mnemonic

expect val name: String

expect val ordinal: Int

val wordCount: Int

The resulting number of mnemonic words

Functions

fun valueOf(value: String): MnemonicStrength

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<MnemonicStrength>

Returns an array containing the constants of this enum type, in the order they're declared.