add v15 migration guide#955
Merged
Merged
Conversation
|
Size Change: 0 B Total Size: 3.54 MB ℹ️ View Unchanged
|
There was a problem hiding this comment.
Pull request overview
Adds a new migration guide to help consumers upgrade @stellar/stellar-base from v14.x to v15.0.0 (Protocol 26), summarizing breaking changes and behavior fixes with actionable steps.
Changes:
- Introduces a v15 upgrade document covering critical breaking changes (immutability, XDR integer overflow, Hermes polyfill removal).
- Documents behavioral fixes (e.g.,
Memo.id,Soroban.parseTokenAmount,Keypair.verify,TransactionBuilder.cloneFrom). - Adds troubleshooting/verification steps, including TypeScript exhaustive-switch updates for new XDR enum variants.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
quietbits
approved these changes
Apr 1, 2026
Comment on lines
+357
to
+358
| **Q: Do I need to update if I'm not on a Protocol 26 network yet?** | ||
| A: Yes — the breaking changes (immutable passphrase, integer overflow, Hermes polyfill) apply regardless of protocol version. The new XDR types only appear on Protocol 26 networks, but the behavioral changes affect all usage. |
Contributor
There was a problem hiding this comment.
Depending on when the user might read this, it might be helpful to add dates on which P26 will be deployed on Testnet/Mainnet (otherwise it might sound like P26 is opt-in).
4 tasks
Contributor
Author
|
todo: put in new folder |
- Use v15.x instead of v15.0.0 to cover future minor releases - Add recommendation that all consumers upgrade - Move guide from docs/upgrade/ to docs/migration-guide/ - Add migration guide link to CHANGELOG.md v15.0.0 section - Fix Hermes polyfill FAQ: clarify silent wrong results, not a crash - Add P26 deployment dates (Testnet Apr 16, Mainnet May 6) with link
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
Adds a migration guide for upgrading from
@stellar/stellar-basev14.x to v15.0.0 (Protocol 26).networkPassphrase, XDR integer overflow/underflow now throws (via@stellar/js-xdrv4), Hermes typed-array polyfill removalMemo.idstricter validation,Soroban.parseTokenAmountexcess decimal rejection,Keypair.verifyreturning false instead of throwing,TransactionBuilder.cloneFromfixestxFrozenKeyAccessed, trustline-frozen result codes, BN254 cost types)Follow-up commit corrects
Memo.iderror strings to match the actual thrown message ("Expects a uint64 as a string. Got <value>"), and fixes all grep patterns to use POSIX-portable ERE syntax (-rnE,[[:space:]]) so they work on macOS BSD grep.Test plan
Memo.iderror strings matchsrc/memo.jsline 99types/curr.d.ts