algokit-utils 5.0.0a3__py3-none-any.whl

algokit_algo25/__init__.py

@@ -0,0 +1,38 @@
+"""Algorand 25-word mnemonic encoding/decoding (algokit-algo25)."""
+
+from algokit_algo25.exceptions import (
+    FAIL_TO_DECODE_MNEMONIC_ERROR_MSG,
+    NOT_IN_WORDS_LIST_ERROR_MSG,
+    InvalidMnemonicError,
+    InvalidSeedLengthError,
+    MnemonicError,
+    WordNotFoundError,
+)
+from algokit_algo25.mnemonic import (
+    KEY_LEN_BYTES,
+    MNEMONIC_LEN,
+    master_derivation_key_to_mnemonic,
+    mnemonic_from_seed,
+    mnemonic_to_master_derivation_key,
+    secret_key_to_mnemonic,
+    seed_from_mnemonic,
+)
+
+__all__ = [
+    # Constants
+    "FAIL_TO_DECODE_MNEMONIC_ERROR_MSG",
+    "KEY_LEN_BYTES",
+    "MNEMONIC_LEN",
+    "NOT_IN_WORDS_LIST_ERROR_MSG",
+    # Exceptions
+    "InvalidMnemonicError",
+    "InvalidSeedLengthError",
+    "MnemonicError",
+    "WordNotFoundError",
+    # Functions
+    "master_derivation_key_to_mnemonic",
+    "mnemonic_from_seed",
+    "mnemonic_to_master_derivation_key",
+    "secret_key_to_mnemonic",
+    "seed_from_mnemonic",
+]

algokit_algo25/_encoding.py

@@ -0,0 +1,46 @@
+"""11-bit encoding utilities for mnemonic conversion."""
+
+from typing import Final
+
+BITS_PER_WORD: Final[int] = 11
+BITS_PER_BYTE: Final[int] = 8
+
+
+def bytes_to_11bit_indices(data: bytes) -> list[int]:
+    """Convert bytes to list of 11-bit indices.
+
+    32 bytes (256 bits) -> 24 x 11-bit values (264 bits, 8 padding zeros).
+    """
+    buffer = 0
+    num_bits = 0
+    indices: list[int] = []
+    for byte in data:
+        buffer |= byte << num_bits
+        num_bits += BITS_PER_BYTE
+        while num_bits >= BITS_PER_WORD:
+            indices.append(buffer & 0x7FF)
+            buffer >>= BITS_PER_WORD
+            num_bits -= BITS_PER_WORD
+    if num_bits > 0:
+        indices.append(buffer & 0x7FF)
+    return indices
+
+
+def indices_11bit_to_bytes(indices: list[int]) -> bytes:
+    """Convert 11-bit indices to bytes.
+
+    24 x 11-bit values (264 bits) -> 33 bytes (last byte is padding).
+    """
+    buffer = 0
+    num_bits = 0
+    output: list[int] = []
+    for idx in indices:
+        buffer |= idx << num_bits
+        num_bits += BITS_PER_WORD
+        while num_bits >= BITS_PER_BYTE:
+            output.append(buffer & 0xFF)
+            buffer >>= BITS_PER_BYTE
+            num_bits -= BITS_PER_BYTE
+    if num_bits > 0:
+        output.append(buffer & 0xFF)
+    return bytes(output)