Skip to content

add v15 migration guide#1364

Open
oceans404 wants to merge 3 commits intomasterfrom
v15-migration-guide
Open

add v15 migration guide#1364
oceans404 wants to merge 3 commits intomasterfrom
v15-migration-guide

Conversation

@oceans404
Copy link
Copy Markdown

@oceans404 oceans404 commented Mar 30, 2026

Summary

Adds a migration guide for upgrading from @stellar/stellar-sdk v14.x to v15.0.0 (Protocol 26).

  • Covers SDK-specific breaking changes: AssembledTransaction.fromXDR()/fromJSON() contract ID validation, binding identifier sanitization
  • Inlines all inherited @stellar/stellar-base v15 breaking changes so SDK users don't need to cross-reference two documents
  • Documents behavioral fixes that may affect consumers (Memo.id, parseTokenAmount, Keypair.verify, cloneFrom)
  • Includes TypeScript exhaustive switch updates for new Protocol 26 XDR enum variants
  • Adds step-by-step verification checklist and FAQ mapping common error messages to solutions

Follow-up commit corrects the fromXDR code examples to match the actual synchronous signature (Spec as 3rd param, not rpcServer), fixes grep patterns for macOS portability, and aligns error strings with the actual thrown messages.

Test plan

  • Verify all internal links and anchor tags resolve correctly
  • Confirm fromXDR/fromJSON examples match the actual method signatures in src/contract/assembled_transaction.ts
  • Spot-check grep commands on macOS (BSD grep) and Linux (GNU grep)
  • Cross-reference error message strings against source code

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new migration guide for upgrading consumers from @stellar/stellar-sdk v14.x to v15.0.0 (Protocol 26), consolidating both SDK-specific changes and inherited @stellar/stellar-base v15 breaking changes into a single document.

Changes:

  • Introduces a v15 upgrade guide covering Soroban AssembledTransaction validation changes and binding generator sanitization.
  • Documents inherited stellar-base breaking changes (immutable networkPassphrase, XDR integer overflow behavior, Hermes polyfill removal).
  • Adds troubleshooting/verification steps for common runtime and TypeScript upgrade issues.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/upgrade/v15.md Outdated
Comment thread docs/upgrade/v15.md Outdated
Comment thread docs/upgrade/v15.md Outdated
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 30, 2026

Size Change: 0 B

Total Size: 45.4 MB

ℹ️ View Unchanged
Filename Size
dist/stellar-sdk-minimal.js 6 MB
dist/stellar-sdk-minimal.min.js 5.11 MB
dist/stellar-sdk-no-axios.js 6 MB
dist/stellar-sdk-no-axios.min.js 5.11 MB
dist/stellar-sdk-no-eventsource.js 6.27 MB
dist/stellar-sdk-no-eventsource.min.js 5.33 MB
dist/stellar-sdk.js 6.27 MB
dist/stellar-sdk.min.js 5.33 MB

compressed-size-action

Copy link
Copy Markdown
Contributor

@quietbits quietbits left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same feedback as in stellar/js-stellar-base#955

- 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
- Update cross-reference link to base migration guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Backlog (Not Ready)

Development

Successfully merging this pull request may close these issues.

3 participants