monero_mnemonic_encoder

Module for Monero mnemonic encoding.

class MoneroMnemonicEncoderBase(lang: MoneroLanguages = MoneroLanguages.ENGLISH)

Bases: MnemonicEncoderBase, ABC

Monero mnemonic encoder base class. It encodes bytes to the mnemonic phrase.

m_lang: MoneroLanguages

class MoneroMnemonicNoChecksumEncoder(lang: MoneroLanguages = MoneroLanguages.ENGLISH)

Bases: MoneroMnemonicEncoderBase

Monero mnemonic encoder class (no checksum). It encodes bytes to the mnemonic phrase without checksum.

Encode(entropy_bytes: bytes) → Mnemonic

Encode bytes to mnemonic phrase (no checksum).

Parameters:

entropy_bytes (bytes) – Entropy bytes (accepted lengths in bits: 128, 256)

Returns:

Encoded mnemonic (no checksum)

Return type:

Mnemonic object

Raises:

ValueError – If entropy is not valid

m_lang: MoneroLanguages

m_words_list: MnemonicWordsList

class MoneroMnemonicWithChecksumEncoder(lang: MoneroLanguages = MoneroLanguages.ENGLISH)

Bases: MoneroMnemonicEncoderBase

Monero mnemonic encoder class (with checksum). It encodes bytes to the mnemonic phrase with checksum.

Encode(entropy_bytes: bytes) → Mnemonic

Encode bytes to mnemonic phrase (with checksum).

Parameters:

entropy_bytes (bytes) – Entropy bytes (accepted lengths in bits: 128, 256)

Returns:

Encoded mnemonic (with checksum)

Return type:

Mnemonic object

Raises:

ValueError – If entropy is not valid

m_lang: MoneroLanguages

m_words_list: MnemonicWordsList

class MoneroMnemonicEncoder(lang: MoneroLanguages = MoneroLanguages.ENGLISH)

Bases: object

Monero mnemonic encoder class. Helper class to encode bytes to the mnemonic phrase with or without checksum.

m_no_chk_enc: MoneroMnemonicNoChecksumEncoder

m_with_chk_enc: MoneroMnemonicWithChecksumEncoder

EncodeNoChecksum(entropy_bytes: bytes) → Mnemonic

Encode bytes to mnemonic phrase (no checksum).

Parameters:

entropy_bytes (bytes) – Entropy bytes (accepted lengths in bits: 128, 256)

Returns:

Encoded mnemonic (no checksum)

Return type:

Mnemonic object

Raises:

ValueError – If bytes length is not valid

EncodeWithChecksum(entropy_bytes: bytes) → Mnemonic

Encode bytes to mnemonic phrase (with checksum).

Parameters:

entropy_bytes (bytes) – Entropy bytes (accepted lengths in bits: 128, 256)

Returns:

Encoded mnemonic (with checksum)

Return type:

Mnemonic object

Raises:

ValueError – If bytes length is not valid