feat: v1.1.0 FWSS upgrade scripts and documentation #384
There are no files selected for viewing
rjan90 marked this conversation as resolved.
Show resolved
Hide resolved
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| name: Create Release Issue | ||
|
|
||
| on: | ||
| workflow_dispatch: | ||
| inputs: | ||
rjan90 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| network: | ||
| description: 'Target network' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - Calibnet | ||
| - Mainnet | ||
| upgrade_type: | ||
| description: 'Type of upgrade' | ||
| required: true | ||
| type: choice | ||
| options: | ||
| - Routine | ||
| - Breaking Change | ||
| upgrade_registry: | ||
| description: '(Rare) Also upgrading ServiceProviderRegistry?' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
| upgrade_state_view: | ||
| description: '(Rare) Also redeploying FilecoinWarmStorageServiceStateView?' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
| after_epoch: | ||
| description: 'AFTER_EPOCH (block number after which upgrade can execute)' | ||
| required: true | ||
| type: string | ||
| changelog_pr: | ||
| description: 'PR number with changelog updates' | ||
| required: true | ||
| type: string | ||
| changes_summary: | ||
| description: 'Summary of changes (use | for multiple lines)' | ||
| required: true | ||
| type: string | ||
| action_required: | ||
| description: 'Action required for integrators (or "None" if no action needed)' | ||
| required: true | ||
| type: string | ||
| default: 'None' | ||
| release_tag: | ||
| description: 'Release tag if already created (usually added after upgrade completes)' | ||
| required: false | ||
| type: string | ||
| dry_run: | ||
| description: 'Dry run (preview issue without creating)' | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
|
|
||
| jobs: | ||
| create-announcement: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| issues: write | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: '20' | ||
|
|
||
| - name: Create announcement issue | ||
| id: create_issue | ||
| env: | ||
| NETWORK: ${{ inputs.network }} | ||
| UPGRADE_TYPE: ${{ inputs.upgrade_type }} | ||
| UPGRADE_REGISTRY: ${{ inputs.upgrade_registry }} | ||
| UPGRADE_STATE_VIEW: ${{ inputs.upgrade_state_view }} | ||
| AFTER_EPOCH: ${{ inputs.after_epoch }} | ||
| CHANGELOG_PR: ${{ inputs.changelog_pr }} | ||
| CHANGES_SUMMARY: ${{ inputs.changes_summary }} | ||
| ACTION_REQUIRED: ${{ inputs.action_required }} | ||
| RELEASE_TAG: ${{ inputs.release_tag }} | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| GITHUB_REPOSITORY: ${{ github.repository }} | ||
| run: | | ||
| if [ "${{ inputs.dry_run }}" = "true" ]; then | ||
| node .github/scripts/create-upgrade-announcement.js --dry-run | ||
| else | ||
| node .github/scripts/create-upgrade-announcement.js | ||
| fi | ||
|
|
||
| - name: Summary | ||
| run: | | ||
| echo "## Release Issue ${{ inputs.dry_run == true && '(Dry Run)' || 'Created' }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| echo "**Network**: ${{ inputs.network }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "**After Epoch**: ${{ inputs.after_epoch }}" >> $GITHUB_STEP_SUMMARY | ||
| echo "" >> $GITHUB_STEP_SUMMARY | ||
| if [ "${{ inputs.dry_run }}" = "true" ]; then | ||
| echo "This was a dry run. No issue was created." >> $GITHUB_STEP_SUMMARY | ||
| else | ||
| echo "See the created issue for full details." >> $GITHUB_STEP_SUMMARY | ||
| fi | ||
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
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
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
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
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
rjan90 marked this conversation as resolved.
Show resolved
Hide resolved
Contributor
There was a problem hiding this comment. Add documentation about view contracts/addresses? I didn't see anything in https://github.com/FilOzone/filecoin-services/blob/9a18943b4390e37186fe0715789c38b364ce7f96/service_contracts/tools/README.md |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,13 +2,23 @@ | |
|
|
||
| This directory contains scripts for deploying and upgrading the FilecoinWarmStorageService contract on Calibration testnet and Mainnet. | ||
|
|
||
| > **For detailed upgrade procedures**, see [UPGRADE-PROCESS.md](./UPGRADE-PROCESS.md). | ||
|
|
||
| ## Scripts Overview | ||
|
|
||
| ### Deployment Scripts | ||
|
|
||
| - `deploy-warm-storage-calibnet.sh` - Deploy FilecoinWarmStorageService to **Calibnet only** (deploys both the ERC1967 proxy and implementation, plus the SignatureVerificationLib library; requires existing PDPVerifier, FilecoinPayV1, FilBeam, SessionKeyRegistry, and ServiceProviderRegistry contracts) | ||
| - `deploy-warm-storage-implementation-only.sh` - Deploy FWSS implementation only; loads defaults from `deployments.json` and writes back new implementation + metadata (reuses existing signature lib unless redeployed) | ||
|
Contributor
There was a problem hiding this comment. What networks does it deploy to? I'm asking given some scripts specify a network name in the file name.
Collaborator
Author
There was a problem hiding this comment. It can deploy to both. I´m fixing up a lot of the naming issues with regards to the scripts in a PR ontop of this: #414 |
||
| - `deploy-all-warm-storage.sh` - Deploy all contracts to either Calibnet or Mainnet | ||
|
|
||
| ### Upgrade Scripts | ||
|
|
||
rjan90 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| For the [two step upgrade process](#contract-upgrade-process): | ||
| - `announce-planned-upgrade.sh` - Announce a planned FWSS upgrade (two-step process) | ||
| - `upgrade.sh` - Execute a previously announced FWSS upgrade | ||
| - `announce-planned-upgrade-registry.sh` - Announce a planned ServiceProviderRegistry upgrade | ||
| - `upgrade-registry.sh` - Execute a previously announced registry upgrade | ||
|
|
||
| ### Usage | ||
|
|
||
|
|
@@ -19,8 +29,9 @@ This directory contains scripts for deploying and upgrading the FilecoinWarmStor | |
| # Deploy all contracts | ||
| ./tools/deploy-all-warm-storage.sh | ||
|
|
||
| # Upgrade existing deployment (see UPGRADE-PROCESS.md for details) | ||
| ./tools/announce-planned-upgrade.sh # Step 1: Announce | ||
| ./tools/upgrade.sh # Step 2: Execute (after AFTER_EPOCH) | ||
| ``` | ||
|
|
||
| ## Deployment Parameters | ||
|
|
@@ -116,16 +127,13 @@ These scripts now follow forge/cast's environment variable conventions. Set the | |
|
|
||
| ### Required for specific scripts: | ||
| - `deploy-warm-storage-calibnet.sh` requires: | ||
| - `PDP_VERIFIER_PROXY_ADDRESS` - Address of deployed PDPVerifier contract | ||
| - `FILECOIN_PAY_ADDRESS` - Address of deployed FilecoinPayV1 contract | ||
|
|
||
| - `deploy-all-warm-storage.sh` requires: | ||
| - `CHALLENGE_FINALITY` - Challenge finality parameter for PDPVerifier | ||
|
|
||
| - Upgrade scripts - see [UPGRADE-PROCESS.md](./UPGRADE-PROCESS.md) for complete environment variable reference | ||
|
|
||
| ## Usage Examples | ||
|
|
||
|
|
@@ -160,25 +168,24 @@ export FILECOIN_PAY_ADDRESS="0x456..." | |
|
|
||
| ### Upgrade Existing Contract | ||
|
|
||
| See [UPGRADE-PROCESS.md](./UPGRADE-PROCESS.md) for the complete two-step upgrade workflow. | ||
|
|
||
| ## Contract Upgrade Process | ||
|
|
||
| The FilecoinWarmStorageService and ServiceProviderRegistry contracts use a **two-step upgrade process** for security: | ||
|
|
||
| 1. **Announce**: Call `announcePlannedUpgrade()` with the new implementation address and a future epoch | ||
| 2. **Execute**: After the announced epoch, call `upgradeToAndCall()` to complete the upgrade | ||
|
|
||
| This gives stakeholders time to review changes before execution. | ||
|
|
||
| **For complete upgrade documentation**, including: | ||
| - Step-by-step upgrade workflows | ||
| - Environment variable reference | ||
| - Immutable dependency handling | ||
| - Verification procedures | ||
|
|
||
| See [UPGRADE-PROCESS.md](./UPGRADE-PROCESS.md). | ||
|
|
||
| ## Testing | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.