Skip to content

Commit dc907c9

Browse files
authored
Update forkid-9-12.md
resolved comments from @sharon
1 parent 3819916 commit dc907c9

File tree

1 file changed

+14
-27
lines changed

1 file changed

+14
-27
lines changed

docs/cdk/how-to/migrate/forkid-9-12.md

Lines changed: 14 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44
55
## 1. Summary of the Procedure
66

7-
To initiate a CDK chain upgrade, the Implementation Provider can request support from Polygon by submitting the "*Request Help for an Issue with an Existing CDK Chain*" through the service desk.
7+
To initiate a CDK chain upgrade, the Implementation Provider can request support from Polygon by submitting the "*Request Help for an Issue with an Existing CDK Chain*" through the [service desk](https://cdk.polygon.technology/).
88

99
<table>
1010
<tr>
1111
<td>
12-
<img alt="CDK Service Desk" src="https://github.com/mitchpolygon/polygon-docs/blob/main/docs/img/cdk/CDK-service-desk.png?raw=true" width="300"/>
12+
<img alt="CDK Service Desk" src="https://github.com/mitchpolygon/polygon-docs/blob/main/docs/img/cdk/CDK-service-desk.png?raw=true" width="300" height="200"/>
1313
</td>
1414
<td>
15-
<img alt="Example Request" src="https://github.com/mitchpolygon/polygon-docs/blob/main/docs/img/cdk/Example-request.png?raw=true" width="300"/>
15+
<img alt="Example Request" src="https://github.com/mitchpolygon/polygon-docs/blob/main/docs/img/cdk/Example-request.png?raw=true" width="300" height="200"/>
1616
</td>
1717
</tr>
1818
<tr>
19-
<td><strong>CDK service desk</strong></td>
20-
<td><strong>Example request</strong></td>
19+
<td align="center"><strong>CDK Service Desk</strong></td>
20+
<td align="center"><strong>Example Request</strong></td>
2121
</tr>
2222
</table>
2323

@@ -44,11 +44,10 @@ The table below lists the CDK Fork ID 9 components and the new CDK FEP Fork ID 1
4444
4545
| **CDK Components** | **Fork ID 9** | **CDK Components** | **Fork ID 12** |
4646
|--------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
47-
| CDK Validium node<br>Sequence sender<br>Aggregator | [0.6.7+cdk.1](https://hub.docker.com/layers/0xpolygon/cdk-validium-node/0.6.7-cdk.1/images/sha256-dafb15f9355331b4b7174f47ac416b275915ff24a9ed89c211c7c15c8adfc6b8?context=explore) | CDK Erigon RPC & CDK node | [cdk-erigon](https://github.com/0xPolygonHermez/cdk-erigon) 2.1.1 -- forkid.12 release *(Will link final version when released)* |
48-
| | | CDK node<br>Sequence sender<br>Aggregator | 0.3.0-rc2 |
47+
| CDK Validium node<br>Sequence sender<br>Aggregator | [0.6.7+cdk.1](https://hub.docker.com/layers/0xpolygon/cdk-validium-node/0.6.7-cdk.1/images/sha256-dafb15f9355331b4b7174f47ac416b275915ff24a9ed89c211c7c15c8adfc6b8?context=explore) | CDK Erigon RPC & CDK node | [cdk-erigon:v2.1.x](https://github.com/0xPolygonHermez/cdk-erigon/releases) -- forkid.12 release *(Will link final version when released)* |
48+
| | | CDK node<br>Sequence sender<br>Aggregator | [cdk:v0.3.x](https://github.com/0xPolygonHermez/cdk-erigon/releases) |
4949
| Tx pool manager | [zkevm-pool-manager](https://github.com/0xPolygon/zkevm-pool-manager) | Tx pool manager | [zkevm-pool-manager](https://github.com/0xPolygon/zkevm-pool-manager) |
50-
| Executor | | Executor | hermeznetwork/zkevm-prover:v8.0.0-RC14-fork.12 |
51-
| Prover | [v6.0.0](https://github.com/0xPolygonHermez/zkevm-prover/releases/tag/v6.0.0) | Prover | hermeznetwork/zkevm-prover:v8.0.0-RC14-fork.12 |
50+
| Prover | [v6.0.0](https://github.com/0xPolygonHermez/zkevm-prover/releases/tag/v6.0.0) | Prover | [zkevm-prover v8.0.0-RC14](https://hub.docker.com/r/hermeznetwork/zkevm-prover/tags) |
5251
| CDK data availability | [v0.0.7](https://hub.docker.com/layers/0xpolygon/cdk-data-availability/0.0.7/images/sha256-17590789a831259d7a07d8a042ea87e381c5708dec3a7daef6f3f782f50b2c00?context=explore) | CDK data availability | [cdk-data-availability](https://github.com/0xPolygon/cdk-data-availability) v0.0.10 |
5352
| zkEVM rollup node | [v6.0.0](https://github.com/0xPolygonHermez/zkevm-prover/releases/tag/v6.0.0) | zkEVM rollup node | N/A |
5453
| Contracts | [v6.0.0](https://github.com/0xPolygonHermez/zkevm-contracts/releases/tag/v6.0.0-rc.1-fork.9) | Contracts | [zkevm-contracts](https://github.com/0xPolygonHermez/zkevm-contracts) |
@@ -59,7 +58,7 @@ The table below lists the CDK Fork ID 9 components and the new CDK FEP Fork ID 1
5958

6059
The Implementation Provider must prepare in advance for the upgrade to ensure a smooth transition from fork ID 9 to fork ID 12. Failure to complete these steps ahead of time could result in delays or even cancellation of the scheduled upgrade.
6160

62-
1. The Implementation Provider downloads CDK Fork 12 components binaries/images in advance so they are ready to deploy.
61+
1. The Implementation Provider downloads [CDK Fork 12 components](https://docs.polygon.technology/cdk/releases/stack-components/#cdk-fep-components) in advance so they are ready to deploy.
6362
2. Map to the latest prover files which can be found here: [https://storage.googleapis.com/zkevm/zkproverc/v8.0.0-rc.9-fork.12.tgz](https://storage.googleapis.com/zkevm/zkproverc/v8.0.0-rc.9-fork.12.tgz)
6463
3. Scale up the number of provers in advance. It is recommended that you at least double the number of provers up and running for the scheduled upgrade maintenance window.
6564
- Ensure all (majority) of the network batches are verified before starting the upgrade process, otherwise there will be additional downtime as we wait for the network to be ready.
@@ -74,7 +73,7 @@ The Implementation Provider must prepare in advance for the upgrade to ensure a
7473
- Wait for it to sync to the tip.
7574
- CDK-Erigon can be stopped. The generated files will be used later during the upgrade process.
7675

77-
The whole process should look more orr less like this:
76+
The whole process should look more or less like this:
7877
```bash
7978
# PREREQUISITES: Install GO 1.23
8079
WORK_DIR=/tmp
@@ -104,7 +103,7 @@ go run ./zk/debug_tools/datastream-host \
104103
- Rolluptype for fork 12
105104
- Upgrade transaction to fork 12
106105
4. For chains attached to the Polygon Agglayer, Polygon will handle steps to upgrade the permissionless node.
107-
5. Polygon will share [example communication](https://docs.google.com/document/d/1zyXojlg4n2Th6P3y3Wqe8px15HL8FnBpSIWd54co1tE/edit) that Implementation Providers can use to prepare their customer network partners and communities.
106+
5. [See example communication](#example-maintenance-communication-to-network-partners) that Implementation Providers can use to prepare their customer network partners and communities.
108107

109108
## 5. Operational Steps
110109

@@ -165,7 +164,7 @@ go run ./zk/debug_tools/datastream-host \
165164

166165
### Steps to Deploy CDK FEP Fork 12 Components
167166

168-
1. [With the network stopped, repeat Erigon sync to get it fully synced to the current state.](https://www.notion.so/CDK-chain-upgrade-procedure-from-Fork-ID9-to-Fork-ID12-11980500116a802ab22cec6f7eea6080?pvs=21)
167+
1. [With the network stopped, repeat Erigon sync to get it fully synced to the current state.](#5-operational-steps)
169168
- This instance is ready to act as Sequencer and/or RPC. Clone the whole Erigon config/datadir as many times as instances are needed. Pick one to be the new Sequencer (by setting the environment variable **`CDK_ERIGON_SEQUENCER=1`**), and configure all other instances (permissionless RPCs) to point to the Sequencer:
170169

171170
```yaml
@@ -184,19 +183,7 @@ go run ./zk/debug_tools/datastream-host \
184183

185184
### Polygon Steps for CDK Chains Attached to the Agglayer
186185

187-
Polygon will be accountable for upgrading the Agglayer permissionless nodes during the upgrade process.
188-
189-
1. When the Implementation Provider has stopped the sequencer.
190-
2. Polygon's v-team shuts down the CDK chain permissionless nodes hosted by Polygon:
191-
- Set `replicaCount` to 0 for `rpc`, `synchronizer`, and `executor` in the desired node definition as found [here](https://github.com/0xPolygon/helm-charts/tree/main/charts/permissionless-nodes/nodes).
192-
- Run helm update to deploy changes, which will shut down the permissionless nodes.
193-
3. Polygon v-team updates the Agglayer config:
194-
- Change the `image.tag` to the desired version [here](https://github.com/0xPolygon/helm-charts/tree/main/charts/permissionless-nodes/nodes).
195-
4. When the Implementation Provider restarts the sequencer and everything is running as expected:
196-
5. Polygon starts the upgraded permissionless nodes to ID12:
197-
- Set `replicaCount` to 3 for `rpc` and `executor`; set `replicaCount` to 1 for `synchronizer`.
198-
- Run helm update to deploy changes.
199-
- Monitor logs/service status in Datadog for progress.
186+
Polygon's DevOps team will be accountable for upgrading the Agglayer permissionless nodes during the upgrade process.
200187
201188
### Post-Upgrade Validations
202189
@@ -211,7 +198,7 @@ There is a planned maintenance window upgrade of the xxxx network on the followi
211198
212199
**Date:** TBD by Implementation Provider
213200
214-
**Time:** 00:00 PM EDT / 12:00 PM UTC
201+
**Time:** 00:00 PM EDT / 00:00 PM UTC
215202
216203
**Duration:** 2 Hours
217204

0 commit comments

Comments
 (0)