chore: document py-stellar-base v14.0.0 breaking changes#2471
Closed
ElliotFriend wants to merge 1 commit into
Closed
chore: document py-stellar-base v14.0.0 breaking changes#2471ElliotFriend wants to merge 1 commit into
ElliotFriend wants to merge 1 commit into
Conversation
py-stellar-base v14.0.0 (May 2026) introduces several breaking changes: auth API redesign, removed StrKey muxed-account helpers (use MuxedAccount), removed append_create_stellar_asset_contract_from_address_op (use append_create_contract_op), and dropped PyPy 3.10 support. Added a caution callout to the Python SDK section of client-sdks.mdx so developers upgrading from older versions are aware before migrating. https://claude.ai/code/session_0153obE5b1Rb9p6MAFVydK9R
Contributor
There was a problem hiding this comment.
Pull request overview
Documents py-stellar-base v14.0.0 upgrade considerations on the “Client & XDR SDKs” page by adding a prominent caution callout and updating the stated supported Python/PyPy versions.
Changes:
- Updated the Python SDK support statement from Python/PyPy 3.7+ to 3.9+.
- Added a
:::cautionadmonition summarizingpy-stellar-basev14.0.0 breaking changes and linking to release notes.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **The Python SDK is maintained by dedicated community developers.** | ||
|
|
||
| `py-stellar-base` is a Python library for communicating with a Stellar Horizon server. It is used for building Stellar apps on Python. It supports Python 3.7+ as well as PyPy 3.7+. | ||
| `py-stellar-base` is a Python library for communicating with a Stellar Horizon server. It is used for building Stellar apps on Python. It supports Python 3.9+ as well as PyPy 3.9+. |
|
|
||
| `py-stellar-base` v14.0.0 (released May 2026) contains several breaking changes: | ||
|
|
||
| - **Auth API redesign**: `authorize_entry()` now accepts `signers` as `Callable[[HashIDPreimage], SCVal]` instead of returning `(public_key, signature)` tuples. The `authorize_invocation()` parameter `public_key` was renamed to `address`. `AssembledTransaction.sign_auth_entries()` now requires an `address` parameter for non-`Keypair` signers. |
| - **Removed**: `TransactionBuilder.append_create_stellar_asset_contract_from_address_op` — use `append_create_contract_op` instead. | ||
| - **Dropped**: PyPy 3.10 support. | ||
|
|
||
| See the [v14.0.0 release notes](https://github.com/StellarCN/py-stellar-base/releases/latest) for the full changelog. |
|
Preview is available here: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
:::cautioncallout to the Python SDK section ofdocs/tools/sdks/client-sdks.mdxdocumenting the breaking changes introduced inpy-stellar-basev14.0.03.7+→3.9+)Context
py-stellar-basev14.0.0 was released May 3, 2026 with several breaking changes that developers need to be aware of before upgrading:Auth API redesign
authorize_entry()now acceptssignersasCallable[[HashIDPreimage], SCVal]instead of(public_key, signature)tuplesauthorize_invocation()parameterpublic_keyrenamed toaddressAssembledTransaction.sign_auth_entries()now requires anaddressparameter for non-KeypairsignersRemoved APIs
StrKey.encode_muxed_account/StrKey.decode_muxed_account→ useMuxedAccountTransactionBuilder.append_create_stellar_asset_contract_from_address_op→ useappend_create_contract_opDropped support
None of the existing code examples in the docs used the removed APIs, so no example code needed rewriting — only the informational callout was added.
Test plan
https://claude.ai/code/session_0153obE5b1Rb9p6MAFVydK9R
Generated by Claude Code