Merge pull request 0xPolygon#238 from 0xPolygon/km/cdk-compats

CKD compatibility version matrix

Author: kmurphypolygon

docs/cdk/version-matrix.md

@@ -0,0 +1,100 @@
+---
+hide:
+- toc
+---
+
+## CDK
+
+The table below shows the version compatibility for CDK releases and related components.
+
+<table>
+<thead>
+  <tr>
+    <th>CDK version</th>
+    <th>Fork ID</th>
+    <th>Equivalent zkEVM node</th>
+    <th>CDK validium node </th>
+    <th>CDK data<br>availability</th>
+    <th>ZK-EVM prover</th>
+    <th>Contracts</th>
+    <th>Bridge</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td>Rollup </td>
+    <td colspan="7">Follow zkEVM: <a href="https://github.com/0xPolygonHermez#testnetmainnet-versions" target="_blank" rel="noopener noreferrer">https://github.com/0xPolygonHermez#testnetmainnet-versions</a><br>Disclaimer: These versions are intended for permissionless nodes.</td>
+  </tr>
+  <tr>
+    <td>Validium </td>
+    <td>5</td>
+    <td>N/A</td>
+    <td><a href="https://github.com/0xPolygon/cdk-validium-node/releases/tag/v0.0.2-hotfix4">v.0.0.2-hotfix4</a></td>
+    <td>v0.0.3</td>
+    <td>v2.2.0</td>
+    <td>v0.0.1</td>
+    <td>v0.2.0</td>
+  </tr>
+  <tr>
+    <td>Upgraded Validium</td>
+    <td>6</td>
+    <td>zkevm-node@0.4.2</td>
+    <td><a href="https://github.com/0xPolygon/cdk-validium-node/releases/tag/v0.0.3-hotfix6">v0.0.3-hotfix6</a></td>
+    <td>v0.0.3</td>
+    <td>zkevm-prover<br>@3.0.2<br>Config files version 3.0.0-RC3-fork.6</td>
+    <td><a href="https://github.com/0xPolygon/cdk-validium-contracts/releases/tag/v0.0.2">v0.0.2</a></td>
+    <td>v0.3.2-RC1</td>
+  </tr>
+  <tr>
+    <td><a href="https://polygontechnology.notion.site/Instructions-zkEVM-Mainnet-Beta-Node-v0-5-7-Prover-v4-0-4-8f5b9d8e2f6a4048b21c608b49a93376">Ares release</a><br>BETA TESTING</td>
+    <td>7</td>
+    <td>zkevm-node@0.5.6 (Etrog+uLxLy)</td>
+    <td><a href="https://github.com/0xPolygon/cdk-validium-node/releases/tag/v0.5.6%2Bcdk">v0.5.6+CDK</a> </td>
+    <td><a href="https://github.com/0xPolygon/cdk-data-availability/releases/tag/v0.0.5">v0.0.5</a></td>
+    <td><a href="https://github.com/0xPolygonHermez/zkevm-prover/releases/tag/v4.0.4">v4.0.4</a></td>
+    <td>Merged: <br>zkevm-contracts</td>
+    <td><a href="https://github.com/0xPolygonHermez/zkevm-bridge-service/releases/tag/v0.4.0">v0.4.0</a></td>
+  </tr>
+</tbody>
+</table>
+
+## zkEVM
+
+The table below shows the version compatibility for Polygon zkEVM releases.
+
+<table>
+<thead>
+  <tr>
+    <th>Node </th>
+    <th>Bridge</th>
+    <th>Prover</th>
+    <th>Fork ID</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td><a href="https://github.com/0xPolygonHermez/zkevm-node/releases/tag/v0.5.10">v0.5.10</a></td>
+    <td>v0.4.0</td>
+    <td>v4.0.4</td>
+    <td>Mainnet &amp; Cardona: 4-7. <br>Testnet (Goerli): 1,- 6.</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/0xPolygonHermez/zkevm-node/releases/v0.4.0">v0.4.0</a></td>
+    <td>v0.3.0</td>
+    <td>v3.0.2</td>
+    <td>Testnet: 1-6<br>Mainnet: 4-6</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/0xPolygonHermez/zkevm-node/releases/v0.3.3">v0.3.3</a></td>
+    <td>v0.2.0</td>
+    <td>v3.0.0</td>
+    <td></td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/0xPolygonHermez/zkevm-node/releases/v0.3.1">v0.3.1</a> </td>
+    <td> v0.2.0</td>
+    <td>v2.2.2</td>
+    <td>Testnet:  <br>1 - 5 Mainnet: 4-5 </td>
+  </tr>
+</tbody>
+</table>

mkdocs.yml

@@ -53,6 +53,7 @@ nav:
   - CDK:
       - CDK: cdk/index.md
       - Overview: cdk/overview.md
+      - Version compatibility matrix: cdk/version-matrix.md
       - Get started:
         - Quickstart: 
           - Validium: cdk/get-started/quickstart-validium.md