stellar-strkey 0.1.0__py3-none-any.whl

stellar_strkey/__init__.py

@@ -0,0 +1,58 @@
+"""Encode and decode Stellar strkeys as defined by SEP-23.
+
+Every strkey type has its own immutable class. Use `parse` when the type is not known
+in advance. See https://stellar-strkey.readthedocs.io/ for the guide.
+"""
+
+from ._errors import (
+    ChecksumMismatchError,
+    MalformedStrkeyError,
+    StrkeyError,
+    UnsupportedVersionError,
+    WrongStrkeyTypeError,
+)
+from ._keys import (
+    ClaimableBalance,
+    Contract,
+    Ed25519PrivateKey,
+    Ed25519PublicKey,
+    Ed25519SignedPayload,
+    HashX,
+    LiquidityPool,
+    MuxedContract,
+    MuxedEd25519Account,
+    PreAuthTx,
+    Strkey,
+    parse,
+)
+
+__all__ = [
+    "ChecksumMismatchError",
+    "ClaimableBalance",
+    "Contract",
+    "Ed25519PrivateKey",
+    "Ed25519PublicKey",
+    "Ed25519SignedPayload",
+    "HashX",
+    "LiquidityPool",
+    "MalformedStrkeyError",
+    "MuxedContract",
+    "MuxedEd25519Account",
+    "PreAuthTx",
+    "Strkey",
+    "StrkeyError",
+    "UnsupportedVersionError",
+    "WrongStrkeyTypeError",
+    "parse",
+]
+
+# Show the public path in tracebacks and pickles, so that old pickles stay loadable when
+# the private modules are reorganized. A union alias has no `__module__` to set.
+#
+# The cost is that inspect.getsource() can't find the classes, so tools that read the
+# source at run time, such as IPython's `??` and Sphinx's viewcode, can't show it. IDEs
+# and mkdocstrings read the files directly and are not affected.
+for _name in __all__:
+    if _name != "Strkey":
+        globals()[_name].__module__ = __name__
+del _name  # pyright: ignore[reportPossiblyUnboundVariable]

stellar_strkey/_codec.py

@@ -0,0 +1,82 @@
+"""The strkey wire format: `base32(version || payload || crc16-xmodem)`."""
+
+import base64
+import binascii
+from typing import Final
+
+from ._errors import ChecksumMismatchError, MalformedStrkeyError
+
+_VERSION_LEN: Final = 1
+_CHECKSUM_LEN: Final = 2
+_BASE32_BLOCK_LEN: Final = 8
+
+# The length is checked before decoding, so that hostile input is rejected without being
+# decoded. The cost is that a future strkey type with a longer payload would be reported
+# as malformed rather than as an unsupported version until this limit is raised for it.
+MAX_PAYLOAD_LEN: Final = 100
+"""The largest payload of any type: a signed payload with a 64-byte inner payload."""
+
+# The padding standard base32 needs for each valid remainder of the encoded length.
+# Lengths congruent to 1, 3 or 6 mod 8 cannot be produced by any byte sequence.
+_PADDING_BY_REMAINDER: Final = {0: 0, 2: 6, 4: 4, 5: 3, 7: 1}
+
+
+def _checksum(data: bytes) -> bytes:
+    return binascii.crc_hqx(data, 0).to_bytes(_CHECKSUM_LEN, "little")
+
+
+def encode(version: int, payload: bytes) -> str:
+    """Encode a version byte and a payload into a strkey."""
+    data = bytes((version,)) + payload
+    return base64.b32encode(data + _checksum(data)).rstrip(b"=").decode("ascii")
+
+
+def decode(value: str) -> tuple[int, bytes]:
+    """Decode a strkey into its version byte and payload.
+
+    The length is checked before any decoding happens, which bounds the work done
+    on hostile input. SEP-23 only accepts a strkey that re-encodes to exactly the
+    same string, which also rejects padding, lower case and non-zero trailing bits.
+
+    Args:
+        value: The strkey to decode.
+
+    Returns:
+        The version byte and the payload.
+
+    Raises:
+        TypeError: If `value` is not a `str`.
+        MalformedStrkeyError: If `value` is not a well-formed strkey.
+    """
+    if not isinstance(value, str):  # pyright: ignore[reportUnnecessaryIsInstance]
+        raise TypeError(f"strkey must be str, got {type(value).__name__}")
+    # A str subclass can override __len__ or encode and so get past the length check
+    # that bounds the work done on hostile input. str.__str__ is implemented in C and
+    # always returns an exact str with the real content, without copying an exact str.
+    value = str.__str__(value)
+
+    padding = _PADDING_BY_REMAINDER.get(len(value) % _BASE32_BLOCK_LEN)
+    if padding is None:
+        raise MalformedStrkeyError("strkey has an impossible base32 length")
+
+    data_len = len(value) * 5 // 8
+    if data_len < _VERSION_LEN + _CHECKSUM_LEN:
+        raise MalformedStrkeyError(
+            "strkey is too short to hold a version and a checksum"
+        )
+    if data_len > _VERSION_LEN + MAX_PAYLOAD_LEN + _CHECKSUM_LEN:
+        raise MalformedStrkeyError(
+            f"strkey payload exceeds {MAX_PAYLOAD_LEN} bytes, the most of any type"
+        )
+
+    try:
+        encoded = value.encode("ascii")
+        data = base64.b32decode(encoded + b"=" * padding)
+    except ValueError:  # UnicodeEncodeError and binascii.Error
+        raise MalformedStrkeyError("strkey is not valid base32") from None
+    if base64.b32encode(data).rstrip(b"=") != encoded:
+        raise MalformedStrkeyError("strkey is not canonical base32")
+
+    if _checksum(data[:-_CHECKSUM_LEN]) != data[-_CHECKSUM_LEN:]:
+        raise ChecksumMismatchError("strkey checksum does not match")
+    return data[0], data[_VERSION_LEN:-_CHECKSUM_LEN]

stellar_strkey/_errors.py

@@ -0,0 +1,69 @@
+"""Exceptions raised when a string is not an acceptable strkey.
+
+Only `from_string` and `parse` raise these, with one exception:
+`ClaimableBalance.from_bytes` raises `UnsupportedVersionError` for an unknown claimable
+balance version, because that is a protocol version problem rather than bad key
+material. Constructors and `from_bytes` otherwise raise a plain `ValueError`, as
+Python's own constructors do, because no strkey is involved there.
+
+Messages never contain the strkey or key material being processed, because the input
+may be a secret seed and exception messages tend to end up in logs.
+"""
+
+
+class StrkeyError(ValueError):
+    """Base class of the errors raised when a string is not an acceptable strkey."""
+
+
+class MalformedStrkeyError(StrkeyError):
+    """The string is not a well-formed strkey.
+
+    For example, it isn't canonical base32, or it has the wrong length or structure for
+    its type. The message says what is wrong.
+    """
+
+
+class ChecksumMismatchError(MalformedStrkeyError):
+    """The checksum does not match, which usually means the strkey was mistyped."""
+
+
+class UnsupportedVersionError(StrkeyError):
+    """The strkey's version is not one this package knows.
+
+    Either its version byte is unknown, or it is a claimable balance of an unknown
+    version. It may be a strkey type introduced after this release of the package.
+    """
+
+
+class WrongStrkeyTypeError(StrkeyError):
+    """The string is a strkey of another type than the one that was asked for.
+
+    Only its encoding, checksum and version byte are checked. The rest is not, since the
+    strkey would be rejected anyway.
+
+    Attributes:
+        expected: The type that was asked for, or `None` when
+            [`parse`][stellar_strkey.parse] refused a private key, since it would have
+            accepted any other type.
+        found: The type of the strkey that was given.
+    """
+
+    expected: type[object] | None
+    found: type[object]
+
+    def __init__(self, expected: type[object] | None, found: type[object]) -> None:
+        # Passing the attributes to the base class keeps the exception picklable.
+        super().__init__(expected, found)
+        self.expected = expected
+        self.found = found
+
+    def __str__(self) -> str:
+        if self.expected is None:
+            return (
+                "parse() does not return private keys; "
+                f"use {self.found.__name__}.from_string"
+            )
+        return (
+            f"expected a strkey of type {self.expected.__name__}, "
+            f"got one of type {self.found.__name__}"
+        )

stellar_strkey/_keys.py

@@ -0,0 +1,526 @@
+"""One immutable class per strkey type, plus `parse` for unknown input."""
+
+import hmac
+from abc import ABC, abstractmethod
+from dataclasses import FrozenInstanceError, dataclass
+from typing import ClassVar, Final, NoReturn, Self, SupportsIndex, TypeAlias, TypeVar
+
+from ._codec import MAX_PAYLOAD_LEN as _MAX_ANY_PAYLOAD_LEN
+from ._codec import decode, encode
+from ._errors import (
+    MalformedStrkeyError,
+    StrkeyError,
+    UnsupportedVersionError,
+    WrongStrkeyTypeError,
+)
+
+_KEY_LEN: Final = 32
+_ID_LEN: Final = 8
+_LENGTH_PREFIX_LEN: Final = 4
+_XDR_ALIGNMENT: Final = 4
+_MAX_ID: Final = 2**64 - 1
+_MIN_INNER_PAYLOAD_LEN: Final = 1
+_MAX_INNER_PAYLOAD_LEN: Final = 64
+_MUXED_PAYLOAD_LEN: Final = _KEY_LEN + _ID_LEN
+_CLAIMABLE_BALANCE_V0: Final = b"\x00"
+
+# SEP-23 version bytes: the key type in the top five bits, the algorithm in the rest.
+_PUBLIC_KEY: Final = 6 << 3
+_PRIVATE_KEY: Final = 18 << 3
+_MUXED_ACCOUNT: Final = 12 << 3
+_SIGNED_PAYLOAD: Final = 15 << 3
+_PRE_AUTH_TX: Final = 19 << 3
+_HASH_X: Final = 23 << 3
+_CONTRACT: Final = 2 << 3
+_LIQUIDITY_POOL: Final = 11 << 3
+_CLAIMABLE_BALANCE: Final = 1 << 3
+_MUXED_CONTRACT: Final = 22 << 3
+
+
+def _require_bytes(name: str, value: bytes) -> bytes:
+    """Return `value` as exact `bytes`, or raise `TypeError` if it isn't bytes."""
+    # Coercing with bytes() would turn the integer 32 into 32 zero bytes.
+    if not isinstance(value, bytes):  # pyright: ignore[reportUnnecessaryIsInstance]
+        raise TypeError(f"{name} must be bytes, got {type(value).__name__}")
+    # A bytes subclass can override __len__, __bool__ or __bytes__ and so get past the
+    # checks below, so its real content is copied out through the buffer protocol,
+    # which Python code can't override. Exact bytes, the usual case, aren't copied.
+    return value if type(value) is bytes else memoryview(value).tobytes()
+
+
+def _require_len(name: str, value: bytes, length: int) -> bytes:
+    value = _require_bytes(name, value)
+    if len(value) != length:
+        raise ValueError(f"{name} must be {length} bytes, got {len(value)}")
+    return value
+
+
+def _require_id(value: int) -> None:
+    if not isinstance(value, int) or isinstance(value, bool):  # pyright: ignore[reportUnnecessaryIsInstance]
+        raise TypeError(f"id must be int, got {type(value).__name__}")
+    if not 0 <= value <= _MAX_ID:
+        raise ValueError("id must fit in an unsigned 64-bit integer")
+
+
+def _xdr_padding_len(length: int) -> int:
+    return -length % _XDR_ALIGNMENT
+
+
+_T = TypeVar("_T", bound="_Strkey")
+
+
+def _from_payload(strkey_type: type[_T], payload: bytes) -> _T:
+    try:
+        return strkey_type.from_bytes(payload)
+    except StrkeyError:
+        raise
+    except ValueError as error:
+        # Invalid key material is a plain ValueError, but inside a strkey it means that
+        # the strkey is malformed. The message never contains the input.
+        raise MalformedStrkeyError(str(error)) from None
+
+
+class _Strkey(ABC):
+    """The operations shared by every strkey type."""
+
+    __slots__ = ()
+
+    _VERSION_BYTE: ClassVar[int]
+
+    @classmethod
+    @abstractmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from the binary form of the strkey.
+
+        Args:
+            data: The binary form, in the layout `to_bytes` returns.
+
+        Raises:
+            TypeError: If `data` is not `bytes`.
+            ValueError: If `data` is not a valid binary form for this type.
+        """
+
+    @abstractmethod
+    def to_bytes(self) -> bytes:
+        """Return the binary form of the strkey, without version byte and checksum."""
+
+    @classmethod
+    def from_string(cls, value: str) -> Self:
+        """Decode a strkey of exactly this type.
+
+        Args:
+            value: The strkey to decode.
+
+        Raises:
+            TypeError: If `value` is not a `str`.
+            MalformedStrkeyError: If `value` is not a well-formed strkey.
+            WrongStrkeyTypeError: If `value` is a strkey of another type.
+            UnsupportedVersionError: If the version of `value` is unknown.
+        """
+        # The type is checked before its length, so an `M...` address given to a
+        # `G...` parser is reported as the wrong type rather than as too long.
+        version, payload = decode(value)
+        if version != cls._VERSION_BYTE:
+            found = _TYPES_BY_VERSION_BYTE.get(version)
+            if found is None:
+                raise UnsupportedVersionError(
+                    f"unsupported version byte {version:#04x}"
+                )
+            raise WrongStrkeyTypeError(cls, found)
+        return _from_payload(cls, payload)
+
+    @classmethod
+    def is_valid(cls, value: object) -> bool:
+        """Return whether `value` is a valid strkey of exactly this type."""
+        if not isinstance(value, str):
+            return False
+        try:
+            cls.from_string(value)
+        except StrkeyError:
+            return False
+        return True
+
+    def __str__(self) -> str:
+        return encode(self._VERSION_BYTE, self.to_bytes())
+
+    def __repr__(self) -> str:
+        return f"{type(self).__name__}.from_string({str(self)!r})"
+
+    def __format__(self, format_spec: str) -> str:
+        return format(str(self), format_spec)
+
+
+@dataclass(frozen=True, slots=True, repr=False)
+class _Hash(_Strkey):
+    """A strkey whose binary form is a single 32-byte hash."""
+
+    hash: bytes
+    """The 32-byte hash."""
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "hash", _require_len("hash", self.hash, _KEY_LEN))
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from a 32-byte hash."""
+        return cls(data)
+
+    def to_bytes(self) -> bytes:
+        """Return the 32-byte hash."""
+        return self.hash
+
+
+@dataclass(frozen=True, slots=True, repr=False)
+class Ed25519PublicKey(_Strkey):
+    """An ed25519 public key (`G...`)."""
+
+    _VERSION_BYTE: ClassVar[int] = _PUBLIC_KEY
+
+    key: bytes
+    """The 32-byte public key."""
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "key", _require_len("key", self.key, _KEY_LEN))
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from a 32-byte public key."""
+        return cls(data)
+
+    def to_bytes(self) -> bytes:
+        """Return the 32-byte public key."""
+        return self.key
+
+
+_NOT_PICKLABLE: Final = (
+    "cannot pickle Ed25519PrivateKey; use reveal() to store or send it explicitly"
+)
+
+
+class Ed25519PrivateKey(_Strkey):
+    """An ed25519 private key seed (`S...`).
+
+    `str()`, `repr()` and f-strings are redacted, so a key cannot leak through logging
+    by accident. Call [`reveal`][stellar_strkey.Ed25519PrivateKey.reveal] to get the
+    strkey. Instances are immutable, compare in constant time and are unhashable.
+
+    Unlike the other types, this is not a dataclass and cannot be pickled, so tools
+    that serialize objects generically, such as `dataclasses.asdict`, msgspec, pydantic
+    and pickle, cannot write the seed out. To store or send a key, use `reveal`.
+    `copy.copy` and `copy.deepcopy` return the key itself. Only `seed` and `to_bytes`
+    return the raw seed, so don't log those. Python cannot erase `bytes` from memory, so
+    this class does not protect against an attacker who can read process memory.
+    """
+
+    # This class is written by hand rather than as a dataclass on purpose. Generic
+    # serializers (dataclasses.asdict, msgspec, pydantic and others) treat a dataclass
+    # as plain data and would write out its fields, including the seed, even when the
+    # key is nested inside the caller's own dataclass. As a plain class it is opaque to
+    # them: asdict keeps the redacted object, and msgspec and pydantic refuse it.
+    __slots__ = ("_seed",)
+    __match_args__ = ("seed",)
+
+    _VERSION_BYTE: ClassVar[int] = _PRIVATE_KEY
+    _seed: bytes
+
+    def __init__(self, seed: bytes) -> None:
+        object.__setattr__(self, "_seed", _require_len("seed", seed, _KEY_LEN))
+
+    @property
+    def seed(self) -> bytes:
+        """The 32-byte seed."""
+        return self._seed
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from a 32-byte seed."""
+        return cls(data)
+
+    def to_bytes(self) -> bytes:
+        """Return the 32-byte seed."""
+        return self._seed
+
+    def reveal(self) -> str:
+        """Return the secret `S...` strkey."""
+        return encode(self._VERSION_BYTE, self._seed)
+
+    def __str__(self) -> str:
+        return "<redacted>"
+
+    def __repr__(self) -> str:
+        return f"{type(self).__name__}(<redacted>)"
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, Ed25519PrivateKey):
+            return NotImplemented
+        return hmac.compare_digest(self._seed, other._seed)
+
+    # Defining __eq__ already makes the class unhashable; this tells type checkers.
+    __hash__: ClassVar[None]  # type: ignore[assignment]  # pyright: ignore[reportIncompatibleMethodOverride]
+
+    # Immutable like the other types, which are frozen dataclasses, so the same
+    # exception is raised.
+    def __setattr__(self, name: str, _value: object, /) -> NoReturn:
+        raise FrozenInstanceError(f"cannot assign to field {name!r}")
+
+    def __delattr__(self, name: str, /) -> NoReturn:
+        raise FrozenInstanceError(f"cannot delete field {name!r}")
+
+    # Pickling is refused because a pickle carries the seed to wherever it goes, such as
+    # a cache, a task queue or a file, without the caller asking for that. cryptography
+    # and pycryptodome also refuse to pickle private keys. Refusing can be relaxed later
+    # without breaking anyone, while allowing it couldn't be taken back. To store or
+    # send a key, use reveal().
+    #
+    # __getstate__ is refused as well because some serializers, such as jsonpickle,
+    # call it directly instead of going through pickle.
+    def __reduce_ex__(self, _protocol: SupportsIndex, /) -> NoReturn:
+        raise TypeError(_NOT_PICKLABLE)
+
+    def __getstate__(self) -> NoReturn:
+        raise TypeError(_NOT_PICKLABLE)
+
+    # copy and deepcopy would otherwise go through __reduce_ex__ and fail. The key is
+    # immutable, so returning it unchanged is a correct copy. This keeps copying
+    # containers that hold a key working, including dataclasses.asdict, which deep
+    # copies the values it doesn't recurse into.
+    def __copy__(self) -> Self:
+        return self
+
+    def __deepcopy__(self, _memo: dict[int, object], /) -> Self:
+        return self
+
+
+@dataclass(frozen=True, slots=True, repr=False)
+class MuxedEd25519Account(_Strkey):
+    """A multiplexed ed25519 account (`M...`)."""
+
+    _VERSION_BYTE: ClassVar[int] = _MUXED_ACCOUNT
+
+    key: bytes
+    """The 32-byte public key of the underlying account."""
+
+    id: int
+    """The unsigned 64-bit multiplexing ID."""
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "key", _require_len("key", self.key, _KEY_LEN))
+        _require_id(self.id)
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from a public key followed by a big-endian ID."""
+        data = _require_len("muxed account", data, _MUXED_PAYLOAD_LEN)
+        return cls(data[:_KEY_LEN], int.from_bytes(data[_KEY_LEN:], "big"))
+
+    def to_bytes(self) -> bytes:
+        """Return the public key followed by the big-endian ID."""
+        return self.key + self.id.to_bytes(_ID_LEN, "big")
+
+
+@dataclass(frozen=True, slots=True, repr=False)
+class Ed25519SignedPayload(_Strkey):
+    """An ed25519 signed payload signer (`P...`, CAP-40)."""
+
+    _VERSION_BYTE: ClassVar[int] = _SIGNED_PAYLOAD
+
+    key: bytes
+    """The 32-byte public key that has to sign the payload."""
+
+    payload: bytes
+    """The payload to sign, 1 to 64 bytes without padding."""
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "key", _require_len("key", self.key, _KEY_LEN))
+        object.__setattr__(self, "payload", _require_bytes("payload", self.payload))
+        # stellar-core rejects empty payloads with SET_OPTIONS_BAD_SIGNER.
+        if not _MIN_INNER_PAYLOAD_LEN <= len(self.payload) <= _MAX_INNER_PAYLOAD_LEN:
+            raise ValueError(
+                f"payload must be {_MIN_INNER_PAYLOAD_LEN} to "
+                f"{_MAX_INNER_PAYLOAD_LEN} bytes, got {len(self.payload)}"
+            )
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from a public key and an XDR-encoded payload."""
+        data = _require_bytes("signed payload", data)
+        payload_start = _KEY_LEN + _LENGTH_PREFIX_LEN
+        if not payload_start + _XDR_ALIGNMENT <= len(data) <= _MAX_ANY_PAYLOAD_LEN:
+            raise ValueError(
+                f"signed payload must be {payload_start + _XDR_ALIGNMENT} to "
+                f"{_MAX_ANY_PAYLOAD_LEN} bytes, got {len(data)}"
+            )
+
+        payload_len = int.from_bytes(data[_KEY_LEN:payload_start], "big")
+        padding_start = payload_start + payload_len
+        padding_end = padding_start + _xdr_padding_len(payload_len)
+        mismatch = "signed payload length prefix does not match the data"
+        if padding_end > len(data):
+            raise ValueError(mismatch)
+        if any(data[padding_start:padding_end]):
+            raise ValueError("signed payload padding must be zero")
+        if padding_end != len(data):
+            raise ValueError(mismatch)
+        return cls(data[:_KEY_LEN], data[payload_start:padding_start])
+
+    def to_bytes(self) -> bytes:
+        """Return the public key followed by the XDR-encoded payload."""
+        length = len(self.payload)
+        return b"".join(
+            (
+                self.key,
+                length.to_bytes(_LENGTH_PREFIX_LEN, "big"),
+                self.payload,
+                bytes(_xdr_padding_len(length)),
+            )
+        )
+
+
+class PreAuthTx(_Hash):
+    """A pre-authorized transaction hash signer (`T...`)."""
+
+    __slots__ = ()
+    _VERSION_BYTE: ClassVar[int] = _PRE_AUTH_TX
+
+
+class HashX(_Hash):
+    """A SHA-256 hash signer, satisfied by revealing its preimage (`X...`)."""
+
+    __slots__ = ()
+    _VERSION_BYTE: ClassVar[int] = _HASH_X
+
+
+class Contract(_Hash):
+    """A smart contract address (`C...`)."""
+
+    __slots__ = ()
+    _VERSION_BYTE: ClassVar[int] = _CONTRACT
+
+
+class LiquidityPool(_Hash):
+    """A liquidity pool ID (`L...`)."""
+
+    __slots__ = ()
+    _VERSION_BYTE: ClassVar[int] = _LIQUIDITY_POOL
+
+
+@dataclass(frozen=True, slots=True, repr=False)
+class ClaimableBalance(_Strkey):
+    """A version 0 claimable balance ID (`B...`)."""
+
+    _VERSION_BYTE: ClassVar[int] = _CLAIMABLE_BALANCE
+
+    hash: bytes
+    """The 32-byte hash."""
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "hash", _require_len("hash", self.hash, _KEY_LEN))
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from a version byte followed by a 32-byte hash.
+
+        Raises:
+            TypeError: If `data` is not `bytes`.
+            UnsupportedVersionError: If the version byte is not 0.
+            ValueError: If `data` is not 33 bytes long.
+        """
+        data = _require_bytes("claimable balance", data)
+        if len(data) > 0 and data[:1] != _CLAIMABLE_BALANCE_V0:
+            raise UnsupportedVersionError(
+                f"unsupported claimable balance version {data[0]:#04x}"
+            )
+        data = _require_len(
+            "claimable balance", data, len(_CLAIMABLE_BALANCE_V0) + _KEY_LEN
+        )
+        return cls(data[1:])
+
+    def to_bytes(self) -> bytes:
+        """Return the version byte followed by the 32-byte hash."""
+        return _CLAIMABLE_BALANCE_V0 + self.hash
+
+
+@dataclass(frozen=True, slots=True, repr=False)
+class MuxedContract(_Strkey):
+    """A multiplexed smart contract address (`W...`, CAP-84)."""
+
+    _VERSION_BYTE: ClassVar[int] = _MUXED_CONTRACT
+
+    hash: bytes
+    """The 32-byte hash of the underlying contract."""
+
+    id: int
+    """The unsigned 64-bit multiplexing ID."""
+
+    def __post_init__(self) -> None:
+        object.__setattr__(self, "hash", _require_len("hash", self.hash, _KEY_LEN))
+        _require_id(self.id)
+
+    @classmethod
+    def from_bytes(cls, data: bytes) -> Self:
+        """Build an instance from a contract hash followed by a big-endian ID."""
+        data = _require_len("muxed contract", data, _MUXED_PAYLOAD_LEN)
+        return cls(data[:_KEY_LEN], int.from_bytes(data[_KEY_LEN:], "big"))
+
+    def to_bytes(self) -> bytes:
+        """Return the contract hash followed by the big-endian ID."""
+        return self.hash + self.id.to_bytes(_ID_LEN, "big")
+
+
+Strkey: TypeAlias = (
+    Ed25519PublicKey
+    | MuxedEd25519Account
+    | Ed25519SignedPayload
+    | PreAuthTx
+    | HashX
+    | Contract
+    | LiquidityPool
+    | ClaimableBalance
+    | MuxedContract
+)
+"""Every strkey type `parse` can return. Private keys are excluded on purpose.
+
+`isinstance(value, Strkey)` works too.
+"""
+
+_TYPES_BY_VERSION_BYTE: Final[dict[int, type[Strkey | Ed25519PrivateKey]]] = {
+    _PUBLIC_KEY: Ed25519PublicKey,
+    _PRIVATE_KEY: Ed25519PrivateKey,
+    _MUXED_ACCOUNT: MuxedEd25519Account,
+    _SIGNED_PAYLOAD: Ed25519SignedPayload,
+    _PRE_AUTH_TX: PreAuthTx,
+    _HASH_X: HashX,
+    _CONTRACT: Contract,
+    _LIQUIDITY_POOL: LiquidityPool,
+    _CLAIMABLE_BALANCE: ClaimableBalance,
+    _MUXED_CONTRACT: MuxedContract,
+}
+
+
+def parse(value: str) -> Strkey:
+    """Decode a strkey whose type is not known in advance.
+
+    Private keys are refused, so input from an untrusted or generic source cannot
+    silently become a secret. Use
+    [`Ed25519PrivateKey.from_string`][stellar_strkey.Ed25519PrivateKey.from_string]
+    for those.
+
+    Args:
+        value: The strkey to decode.
+
+    Returns:
+        An instance of the class that matches the strkey's type.
+
+    Raises:
+        TypeError: If `value` is not a `str`.
+        MalformedStrkeyError: If `value` is not a well-formed strkey.
+        WrongStrkeyTypeError: If `value` is a private key.
+        UnsupportedVersionError: If the version of `value` is unknown.
+    """
+    version, payload = decode(value)
+    strkey_type = _TYPES_BY_VERSION_BYTE.get(version)
+    if strkey_type is None:
+        raise UnsupportedVersionError(f"unsupported version byte {version:#04x}")
+    if issubclass(strkey_type, Ed25519PrivateKey):
+        raise WrongStrkeyTypeError(None, strkey_type)
+    return _from_payload(strkey_type, payload)

stellar_strkey-0.1.0.dist-info/METADATA

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: stellar-strkey
+Version: 0.1.0
+Summary: Strict, typed, dependency-free encoding and decoding of Stellar strkeys (SEP-23).
+Keywords: stellar,strkey,sep-23,base32,soroban
+Author: overcat
+Author-email: overcat <hi@overcat.dev>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Free Threading :: 3 - Stable
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/lightsail-network/py-stellar-strkey
+Project-URL: Documentation, https://stellar-strkey.readthedocs.io/
+Project-URL: Repository, https://github.com/lightsail-network/py-stellar-strkey
+Project-URL: Issues, https://github.com/lightsail-network/py-stellar-strkey/issues
+Project-URL: Changelog, https://github.com/lightsail-network/py-stellar-strkey/blob/main/CHANGELOG.md
+Description-Content-Type: text/markdown
+
+# stellar-strkey
+
+Encode and decode [Stellar strkeys](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0023.md),
+the `G...`, `C...` and `M...` strings that identify accounts, contracts, signers and
+other things on the Stellar network.
+
+- **Complete.** Supports every strkey type defined by SEP-23.
+- **Strict.** Accepts a strkey only in its one canonical form and rejects everything else
+  with a clear error, so invalid input never gets through.
+- **Thoroughly tested.** Verified against the SEP-23 test cases and a shared set of test
+  vectors, with property-based tests and 100% branch coverage.
+- **Safe with secrets.** Secret seeds are never printed or serialized by accident, and
+  error messages never include the input.
+- **Lightweight.** Fully typed, pure Python, no dependencies.
+
+The [documentation](https://stellar-strkey.readthedocs.io/) has the guide and the API
+reference.
+
+## Install
+
+```shell
+pip install stellar-strkey
+```
+
+## Usage
+
+```python
+from stellar_strkey import (
+    Contract,
+    Ed25519PublicKey,
+    MuxedEd25519Account,
+    StrkeyError,
+    parse,
+)
+
+# When you know the type, use its class. Anything else is rejected.
+key = Ed25519PublicKey.from_string(
+    "GA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJVSGZ"
+)
+assert key.key.hex() == (
+    "3f0c34bf93ad0d9971d04ccc90f705511c838aad9734a4a2fb0d7a03fc7fe89a"
+)
+# The same 32 bytes as a contract give a different strkey.
+assert str(Contract(key.key)) == (
+    "CA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUWDA"
+)
+
+# When you don't, parse() returns the matching class.
+match parse("MA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJVAAAAAAAAAAAAAJLK"):
+    case Ed25519PublicKey(key):
+        description = f"account {key.hex()}"
+    case MuxedEd25519Account(key, id):
+        description = f"muxed account {key.hex()} with ID {id}"
+    case other:
+        description = f"something else: {other!r}"
+assert description.endswith("with ID 9223372036854775808")
+
+# Invalid input raises StrkeyError, which is a ValueError.
+try:
+    parse("GA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJVSGA")
+except StrkeyError as error:
+    message = str(error)
+assert message == "strkey checksum does not match"
+```
+
+### Secret seeds
+
+Secret seeds (`S...`) have their own parser, and `parse()` refuses them, so code that
+handles arbitrary addresses can't pick up a secret by accident:
+
+```python
+from stellar_strkey import Ed25519PrivateKey, WrongStrkeyTypeError, parse
+
+# In real code, load the secret from the environment or a secret store, never from
+# source code. This is a well-known test seed.
+secret = "SBU2RRGLXH3E5CQHTD3ODLDF2BWDCYUSSBLLZ5GNW7JXHDIYKXZWHOKR"
+
+key = Ed25519PrivateKey.from_string(secret)
+seed = key.seed  # the raw 32 bytes, for example for an ed25519 signing library
+assert len(seed) == 32
+
+# Printing or logging the key never shows the seed.
+assert str(key) == "<redacted>"
+assert repr(key) == "Ed25519PrivateKey(<redacted>)"
+
+# Get the strkey back only where you mean to.
+assert key.reveal() == secret
+
+try:
+    parse(secret)
+except WrongStrkeyTypeError as error:
+    refused = error.found
+assert refused is Ed25519PrivateKey
+```
+
+## Types
+
+| Prefix | Class                  | Fields           | `to_bytes()` / `from_bytes()` layout  |
+| ------ | ---------------------- | ---------------- | ------------------------------------- |
+| `G`    | `Ed25519PublicKey`     | `key`            | 32-byte key                           |
+| `S`    | `Ed25519PrivateKey`    | `seed`           | 32-byte seed                          |
+| `M`    | `MuxedEd25519Account`  | `key`, `id`      | 32-byte key, 8-byte big-endian ID     |
+| `P`    | `Ed25519SignedPayload` | `key`, `payload` | 32-byte key, XDR `opaque<64>` payload |
+| `T`    | `PreAuthTx`            | `hash`           | 32-byte hash                          |
+| `X`    | `HashX`                | `hash`           | 32-byte hash                          |
+| `C`    | `Contract`             | `hash`           | 32-byte hash                          |
+| `L`    | `LiquidityPool`        | `hash`           | 32-byte hash                          |
+| `B`    | `ClaimableBalance`     | `hash`           | `0x00` version byte, 32-byte hash     |
+| `W`    | `MuxedContract`        | `hash`, `id`     | 32-byte hash, 8-byte big-endian ID    |
+
+See the guide for how to handle errors, and for what private keys are protected
+against and what they aren't.
+
+## Development
+
+```shell
+uv sync --all-groups       # create the environment, including the docs tools
+uv run prek install        # optional: check before each commit
+make check                 # format check, lint, type checks and tests with coverage
+make docs-serve            # preview the documentation
+```
+
+`tests/vectors/strkeys.json` holds the shared test vectors in a language neutral form.
+Add new cases there by hand, with the expected result that SEP-23 requires.
+
+To release, run `make release-prep VERSION=<version>`, which sets the version and adds the
+commits since the last release to `CHANGELOG.md`. Edit the new section where a commit
+title isn't enough, commit it, then push a `v<version>` tag. The publish workflow verifies
+that the tag matches the version and publishes to PyPI with trusted publishing, along with
+PEP 740 attestations.
+
+## License
+
+[Apache-2.0](https://github.com/lightsail-network/py-stellar-strkey/blob/main/LICENSE)

stellar_strkey-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+stellar_strkey/__init__.py,sha256=CWnAZKpsONAvnfei9D5g3skXqD-CCLEhx0hfNCj3tMc,1573
+stellar_strkey/_codec.py,sha256=koubDz4CN6WvM-K5cygX3VNrNOYLDZIcjBKq_COhGUc,3399
+stellar_strkey/_errors.py,sha256=ggJhtNwRolDpbSblbKSCnkSPPMrft63rU9bRaicaq1o,2575
+stellar_strkey/_keys.py,sha256=mE4p1yFjHx33vEze4vifsw_RHE8ZDE2wGUKiiuu_xMc,18464
+stellar_strkey/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+stellar_strkey-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+stellar_strkey-0.1.0.dist-info/WHEEL,sha256=MWx7psoF7KNST9G72pGtiBYuaXRXQXBk9pw5R6FzYko,80
+stellar_strkey-0.1.0.dist-info/METADATA,sha256=WbPyGrvFEYI1qIirUAYJozJnhDOH-vSjYsYQQkRQP1Q,6926
+stellar_strkey-0.1.0.dist-info/RECORD,,

stellar_strkey-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.13.7
+Root-Is-Purelib: true
+Tag: py3-none-any

stellar_strkey-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.