stellar-strkey 0.1.0__tar.gz

stellar_strkey-0.1.0/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project are documented in this file. The format is based on
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project follows
+[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0](https://github.com/lightsail-network/py-stellar-strkey/releases/tag/v0.1.0) - 2026-11-07
+
+### Features
+
+- Add stellar-strkey, a typed SEP-23 strkey library
+

stellar_strkey-0.1.0/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.

stellar_strkey-0.1.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,134 @@
+# 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/docs/api.md

@@ -0,0 +1,41 @@
+# API reference
+
+## Parsing
+
+::: stellar_strkey.parse
+
+::: stellar_strkey.Strkey
+
+## Strkey types
+
+::: stellar_strkey.Ed25519PublicKey
+
+::: stellar_strkey.Ed25519PrivateKey
+
+::: stellar_strkey.MuxedEd25519Account
+
+::: stellar_strkey.Ed25519SignedPayload
+
+::: stellar_strkey.PreAuthTx
+
+::: stellar_strkey.HashX
+
+::: stellar_strkey.Contract
+
+::: stellar_strkey.LiquidityPool
+
+::: stellar_strkey.ClaimableBalance
+
+::: stellar_strkey.MuxedContract
+
+## Errors
+
+::: stellar_strkey.StrkeyError
+
+::: stellar_strkey.MalformedStrkeyError
+
+::: stellar_strkey.ChecksumMismatchError
+
+::: stellar_strkey.WrongStrkeyTypeError
+
+::: stellar_strkey.UnsupportedVersionError