chore: document contract upgrade strategy - #307
Open
Rayyanah0 wants to merge 1 commit into
Open
Conversation
Add 'Upgrades and Migrations' section to docs/MAINNET_DEPLOYMENT.md. Covers: - How Soroban WASM upgrades work (env.deployer().update_current_contract_wasm) - Step-by-step upgrade procedure with stellar CLI commands - Upgrade authorization (admin key requirement per contract) - Storage migration patterns (versioned enum, lazy vs eager strategies) - Upgrade abort conditions - Three-part upgrade checklist (pre-upgrade, execution, post-upgrade) Closes WHEELBACK#193
|
@Rayyanah0 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
1 participant
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
Add an Upgrades and Migrations section to
docs/MAINNET_DEPLOYMENT.mddocumenting how invoice, treasury, and compliance contracts can be upgraded post-mainnet-deployment via Soroban's WASM hash update mechanism.Changes
env.deployer().update_current_contract_wasm, the fact that the contract address is unchanged, and theSYSTEMevent emitted on upgrade.upgrade.Testing
Documentation only. Markdownlint passes on
docs/MAINNET_DEPLOYMENT.mdwith 0 issues.Closes #193