Skip to content

Commit c4a5d58

Browse files
kmurphypolygonkmurphypolygon
committed
changes to section
1 parent a22a7bd commit c4a5d58

File tree

8 files changed

+32
-38
lines changed

8 files changed

+32
-38
lines changed

‎docs/cdk/cdk-modes.jpg‎

-273 KB
Binary file not shown.

‎docs/cdk/deploy-validium.md‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,3 @@
1-
!!! info
2-
Polygon CDK is in public preview stage and subject to changes.
3-
4-
5-
!!! warning
6-
The CDK in validium mode is in active development, with ongoing feature enhancements and issue resolutions.
7-
8-
For the latest updates, follow our official GitHub repositories.
9-
10-
- [Node](https://github.com/0xPolygon/cdk-validium-node)
11-
- [Data availability](https://github.com/0xPolygon/cdk-data-availability)
12-
- [Contracts](https://github.com/0xPolygon/cdk-validium-contracts)
13-
14-
151
!!! important "Recommendation"
162
Follow the [Quickstart](quickstart.md) for a hands-on introduction to CDK in validium mode.
173

@@ -29,8 +15,10 @@ Next, set up and run the CDK validium node.
2915

3016
Follow the instructions in the [CDK validium node repository's README](https://github.com/0xPolygon/cdk-validium-node).
3117

32-
## 3. Run the data availability (DA) node
3318

34-
Finally, once the CDK validium node is operational, set up and run the data availability node.
19+
!!! danger "There are no instructions - awaiting feedback"
20+
## 3. Run the data availability (DA) node
21+
22+
Finally, once the CDK validium node is operational, set up and run the data availability node.
3523

36-
Instructions for this can be found in the [<ins>CDK DA Node GitHub repository's README</ins>](https://github.com/0xPolygon/cdk-data-availability).
24+
Instructions for this can be found in the [<ins>CDK DA Node GitHub repository's README</ins>](https://github.com/0xPolygon/cdk-data-availability).

‎docs/cdk/edge-suggestion.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Suggestion: migrate the whole of the current WIKI docs into the repo.
2+
3+
[https://github.com/0xPolygon/polygon-edge](https://github.com/0xPolygon/polygon-edge)
4+
5+
In a `docs` directory which spins up how it looks currently in the wiki as a docusaurus site, or we can create a simpler static site if required. We can also review and edit like we're doing here but it might not be priority.
6+
7+
To discuss with Gabriel.
8+

‎docs/cdk/overview.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
Polygon's Chain Development Kit (CDK) is a software tool for blockchain developers which allows easy install and configuration of a variety of chain architectures.
22

33
!!! warning
4-
- At the time of writing, the CDK only supports validium nodes.
5-
- zkEVM rollups and more are in development.
4+
- At the time of writing, the CDK only supports validium nodes. The CDK in validium mode is in active development, with ongoing feature enhancements and issue resolutions.
5+
6+
For the latest updates, follow our official GitHub repositories:
67

7-
![CDK flavors](cdk-modes.jpg)
8+
- [Node](https://github.com/0xPolygon/cdk-validium-node)
9+
- [Data availability](https://github.com/0xPolygon/cdk-data-availability)
10+
- [Contracts](https://github.com/0xPolygon/cdk-validium-contracts)
11+
- CDK zkEVM-rollup mode is in development.
12+
13+
![CDK flavors](../img/cdk/cdk-modes.jpg)

‎docs/cdk/quickstart.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,12 @@
55

66
This tutorial will guide you through the process of setting up a CDK Validium on your local machine using the deployment guidance of [<ins>Snapchain</ins>](https://www.snapchain.dev/).
77

8-
:::info Polygon CDK is in public preview stage and subject to changes
9-
108
Please note that the current Data Availability (DA) configuration in Polygon CDK is using a Data Availability Committee (DAC) node with a local Geth client as the L1. However, the integration with Layer 1 testnets, including Sepoilla, is actively being pursued.
119

1210
The CDK Validium is actively being developed, with ongoing feature enhancements and issue resolutions. For the latest updates, follow our official GitHub repositories.
1311

1412
- [<ins>Node</ins>](https://github.com/0xPolygon/cdk-validium-node)
15-
- [<ins>Data Availability</ins>](https://github.com/0xPolygon/cdk-data-availability)
13+
- [<ins>Data availability</ins>](https://github.com/0xPolygon/cdk-data-availability)
1614
- [<ins>Contracts</ins>](https://github.com/0xPolygon/cdk-validium-contracts)
1715

1816
New features and refinements are designed to enhance user experience without disrupting ongoing activities.

‎docs/cdk/tx-flow.md‎

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎docs/cdk/validium-vs-zkevm.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
Polygon CDK running in validium mode inherits the core functionalities of zkEVM rollup mode and adds a [data availability layer](dac.md).
44

5+
!!! danger
6+
How can we say that validium inherits from zkEVM rollup when zkEVM rollup is unavailable?
7+
58
## Key differences
69

710
| | zkEVM | Validium |
@@ -11,5 +14,6 @@ Polygon CDK running in validium mode inherits the core functionalities of zkEVM
1114
| **Components** | zkEVM components\*\* | zkEVM components\*\* + PostgreSQL database + on-chain committees |
1215
| **Contracts** | [zkEVM smart contracts](https://github.com/0xPolygonHermez/zkevm-contracts) <ul><li>`PolygonZkEVM` (main rollup contract)</li> <li> `PolygonZkEVMBridge`</li> <li>`PolygonZkEVMGlobalExitRoot`</li></ul> | [Validium-specific DAC contract](https://github.com/0xPolygon/cdk-validium-contracts) <ul><li>`CDKDataCommittee.sol`</li><li> `CDKValidium.sol` </li></ul> |
1316
| **Infrastructure** | Standard infrastructure | Dedicated infrastructure for data availability layer and DACs |
17+
| **Tx flow** | All transaction data is published on L1 | Validium only publishes the hash of the transaction data. This `Accumulated Input Hash` must be approved by a majority of DAC members. <br/><br/>The sequencer sends both the hash and the transaction data to the DAC for verification. Once approved, the hash plus signatures, is sent to the Consensus L1 contract of the validium protocol. <br/><br/> After verification, the hash and the zk-proof are added to the L1 state.
1418

1519
<sub><sup>**</sup>JSON RPC, Pool DB, Sequencer, Etherman, Synchronizer, State DB, Aggregator, Prover</sub>

‎mkdocs.yml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,20 +49,21 @@ nav:
4949
- cdk/index.md # marketing landing page
5050
- Get started:
5151
- Overview: cdk/overview.md
52-
- Quickstart: cdk/quickstart.md
52+
- Quickstart validium: cdk/quickstart.md
5353
- Deploy validium: cdk/deploy-validium.md
5454
- How to:
5555
- Manage policies: cdk/how-to/manage-policies.md
56-
- Architecture:
57-
- Tx flow: cdk/tx-flow.md
56+
#- Architecture:
5857
- Specification:
5958
- Validium vs zkEVM: cdk/validium-vs-zkevm.md
6059
- Performance benchmarks: cdk/performance-benchmarks.md
6160
- Concepts:
6261
- Data availability: cdk/dac.md
6362
# - API:
6463
- Troubleshooting:
65-
- Component repos: cdk/component-repos.md
64+
- CDK component repos: cdk/component-repos.md
65+
- Retiring products:
66+
- EDGE: cdk/edge-suggestion.md
6667
- zkEVM:
6768
- Overview: zkEVM/index.md
6869
- Building on zKEVM: zkEVM/building.md

0 commit comments

Comments
 (0)