Repository navigation
docs(migration): add SDK version migration guides, validator, and progress tracker (#1200) - #1219
Closed
huangji6693-max wants to merge 1 commit into
Closed
huangji6693-max wants to merge 1 commit into
huangji6693-max wants to merge 1 commit into
Conversation
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
Creates comprehensive SDK version migration guides (
v0.x -> v1.xandv1.x -> v2.x) and adds programmatic migration validation and progress tracking utilities (src/migration/versionMigrationGuide.ts).Closes #1200
Changes
docs/MIGRATION.md,src/migration/versionMigrationGuide.ts):v0.x -> v1.0.0(BC-101,BC-102) andv1.0.0 -> v2.0.0(BC-201throughBC-205):BC-101: ReplacedlegacyClient/createLegacySplitClientwithnew StellarSplitClient(config).BC-102: StructuredStellarSplitErrorhierarchy and type guards replace genericErrorstring checks.BC-201: UnifiedWalletAdapter.connect()andSigner.signTransaction()interface replacing connector-specific methods (requestAccess()).BC-202: Strictbigintrequirement for all stroop/token amounts (amount,totalAmount,feeCeiling).BC-203: ExplicitNetworkEnvironmentpresets (getNetworkPreset(NetworkEnvironment.TESTNET)).BC-204: Migrated inlineonLogcallbacks toPluginRegistry(LoggingPlugin) andTelemetryHooks.BC-205: Scoped@stellar-split/sdkpackage name and official subpath exports (/utils,/ui,/react,/testing,/mock,/telemetry,/lazy).docs/MIGRATION.md):v0.x -> v1.xandv1.x -> v2.xwith side-by-side before/after TypeScript examples and verification commands.docs/MIGRATION.md,findTroubleshootingGuide):TS-001throughTS-004) forBigIntmixing errors, removedrequestAccess()calls,UnknownNetworkError, andERR_PACKAGE_PATH_NOT_EXPORTEDdeep import errors.src/migration/versionMigrationGuide.ts):validateSdkMigration(input)to validate consumer configurations, invoice payloads, and code snippets against target version rules and produce actionable remediation steps and readiness scores.MigrationProgressTracker(startStep,completeStep,skipStep,blockStep,validateAndCompleteStep,getSummary,toJSON,fromJSON) to track step-by-step upgrade progress.test/versionMigrationGuide.test.ts):Verification
npx vitest run test/versionMigrationGuide.test.ts test/migration.test.ts(all passing)npm test(all 110 core tests passing)