Skip to content

Commit 9db3d70

Browse files
vcastellmvcastellm
authored
Merge pull request 0xPolygon#2558 from 0xPolygon/dev
pushing dev to prod
2 parents 4a1ac26 + 279852b commit 9db3d70

File tree

14 files changed

+180
-123
lines changed

14 files changed

+180
-123
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Polygon Knowledge Layer
22

3-
Welcome to the Polygon Knowledge Layer.
3+
Welcome to the Polygon Knowledge Layer .
44

55
These docs use [the Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/). Our goal is to establish a high-quality, curated, and comprehensive "source of truth" for Polygon's technology.
66

‎docs/agglayer/overview.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ The unified bridge is a single bridge contract for all AggLayer-connected chains
4444

4545
### AggLayer service
4646

47-
The AggLayer service is designed to receive ZK proofs from various CDK and non-CDK chains, and verify their validity before sending them to the L1 Ethereum for final settlement. Currently, the AggLayer service has two implementations: [agglayer-go](agglayer-go.md) and [agglayer-rs](agglayer-rs.md).
47+
The AggLayer service is designed to receive ZK proofs from various CDK and non-CDK chains, and verify their validity before sending them to the L1 Ethereum for final settlement. Currently, the AggLayer service has two implementations: [agglayer-go](agglayer-go.md) and [agglayer-rs](agglayer-rs.md).

‎docs/agglayer/unified-bridge.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -808,4 +808,4 @@ execute().then(() => {
808808
});
809809
```
810810
811-
3. Claim Message after GlobalExitRootManager is synced on zkyoto using `scripts/src/claim_message.js` Remember to update `bridgeTransactionHash`, and `destinationNetworkId` to `2`, for zkyoto's network id.
811+
3. Claim Message after GlobalExitRootManager is synced on zkyoto using `scripts/src/claim_message.js` Remember to update `bridgeTransactionHash`, and `destinationNetworkId` to `2`, for zkyoto's network id.

docs/cdk/releases/stack-components.md renamed to docs/cdk/concepts/full-execution-proofs.md

File renamed without changes.

docs/cdk/releases/pp-intro-components.md renamed to docs/cdk/concepts/pessimistic-proofs.md

File renamed without changes.

‎docs/cdk/concepts/rollup-vs-validium.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,26 @@ Below is a breakdown of the technical differences between a zkEVM rollup and val
5959
| **Final settlement** | Transaction batches and their corresponding proofs are added to the Ethereum state. | The hash of transaction data and its proof are added to the Ethereum state, referred to as the consolidated state. |
6060
<sub><sup>\*</sup>JSON RPC, Tx pool manager, Sequencer, Etherman, Synchronizer, State DB, Aggregator, Prover</sub>
6161

62+
63+
Polygon CDK running in validium mode inherits the core functionalities of a zkEVM rollup node and adds a [data availability layer](../glossary/index.md#data-availability-committee-dac).
64+
65+
## Key differences
66+
67+
| | Rollup | Validium |
68+
| ------------------------ | ----------------------------------------------------------- | ---------------------------------------------------------------------------------- |
69+
| **Node type** | [cdk-erigon:v1.2.24](https://github.com/0xPolygonHermez/cdk-erigon/releases/tag/v1.2.24) | [cdk-erigon:v2.1.x](https://github.com/0xPolygonHermez/cdk-erigon/releases) |
70+
| **Data availability** | On-chain via L1 | Off-chain via a local option, or a [DAC](../glossary/index.md#data-availability-committee-dac) + [DA node](https://github.com/0xPolygon/cdk-data-availability) |
71+
| **Components** | zkEVM components\* | zkEVM components\* + PostgreSQL database + on-chain committees |
72+
| **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> |
73+
| **Infrastructure** | Standard infrastructure | Dedicated infrastructure for data availability layer and DACs |
74+
| **Tx flow** | All transaction data is published on L1 | Validium only publishes the hash of the transaction data to L1. The sequencer sends both the hash and the transaction data to the DAC for verification. Once approved, the hash+signatures are sent to the Consensus L1 contract of the validium protocol.
75+
| **Security** | High security due to on-chain data availability and zero-knowledge proofs. |Off-chain data availability can affect security if the sequencer goes offline or if DAC members collude to withhold state data. |
76+
| **Gas fees** | High, because all transaction data is stored on Ethereum. | Low, because only the hash of the transaction data is stored on Ethereum. |
77+
| **Proof generation** | Uses Prover to generate proofs of batched transactions for validation. | Uses Prover to generate proofs of batched transactions for validation. |
78+
| **Final settlement** | Transaction batches and their corresponding proofs are added to the Ethereum state. | The hash of transaction data and its proof are added to the Ethereum state, referred to as the consolidated state. |
79+
80+
<sub><sup>*</sup>JSON RPC, Pool DB, Sequencer, Etherman, Synchronizer, State DB, Aggregator, Prover</sub>
81+
6282
## Further reading
6383

6484
- [Ethereum documentation: rollups](https://ethereum.org/en/developers/docs/scaling/#rollups)

docs/cdk/getting-started/cdk-erigon/releases.md renamed to docs/cdk/getting-started/cdk-erigon/release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ At the time of writing, `cdk-erigon` supports the following chains and fork ids:
1414

1515
- `v1.1.x`: RPC (full support).
1616
- `v2.x.x`: Sequencer (full support).
17-
- `v3.x.x`: Erigon 3 based (snapshot support).
17+
- `v3.x.x`: Erigon 3 based (snapshot support).

‎docs/cdk/how-to/migrate/fork.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
This document shows Polygon partners how to migrate an isolated CDK stack.
1+
This document shows Implementation Providers how to migrate an isolated CDK stack.
22

33
## Process to upgrade forks for isolated CDK chains
44

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,4 +305,4 @@ Update FROM node version [0.6.7+cdk.1](https://hub.docker.com/layers/0xpolygon/c
305305

306306
- `cast send $TIMELOCK_ADDR $SCHEDULE_DATA --private-key $ADMIN_KEY --rpc-url $L1_URL`
307307
- Wait timelock delay
308-
- `cast send $TIMELOCK_ADDR $EXECUTE_DATA --private-key $ADMIN_KEY --rpc-url $L1_URL`
308+
- `cast send $TIMELOCK_ADDR $EXECUTE_DATA --private-key $ADMIN_KEY --rpc-url $L1_URL`

‎docs/cdk/overview.md‎

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,42 @@
1-
<!--
2-
---
3-
comments: true
4-
---
5-
-->
6-
7-
The Polygon Chain Development Kit (CDK) is a modular, open-source software toolkit that enables blockchain developers to deploy and configure ZK-powered chain architectures.
8-
9-
With Polygon CDK, developers can launch new chains that use the Polygon zkEVM protocol as custom Layer 2 solutions on Ethereum.
1+
The **Polygon Chain Development Kit (CDK)** is a modular, open-source framework for building scalable and secure Layer 2s (L2s). Designed for flexibility, the Polygon CDK stack has 3 main configurations (with options to customize further): zk rollup config, validium config, and the Agglayer native config.
102

11-
Developers can configure ZK-powered rollups, validium networks, or even sovereign chains with their own tailored finality mechanisms.
12-
13-
## Trustless finality
14-
15-
Why does Polygon CDK focus on ZK-powered chains?
3+
---
164

17-
Polygon CDK focuses on ZK-powered chains because zero-knowledge technology enables chains to achieve *trustless finality*, which means chain users don't need to rely on a small group of individuals to confirm the finality of their transactions, ensuring greater security and a higher degree of decentralization.
5+
## Why Use Polygon CDK?
186

19-
With Polygon CDK, developers can choose between a rollup and validium chain setup, and decide on how they want to configure the chain's proving system.
7+
### **1. Build ZK-Powered Chains**
8+
Polygon CDK enables developers to launch chains using cutting-edge zero-knowledge (ZK) technology for:
9+
- **Trustless Finality**: Transactions are validated without relying on centralized authorities.
10+
- **Maximum Security**: Leverage zk-proofs to safeguard user data and ensure cryptographic integrity.
2011

21-
Polygon has launched the CDK rollup/validium mode enabling developers to configure CDK components that run the Polygon zkEVM protocol.
12+
### **2. Modular Architecture**
13+
- **Customizable Components**: Select and configure modules like consensus, data availability, and proving systems to fit your use case.
14+
- **Future-Ready Design**: Adapt your chain as requirements evolve or new technologies emerge.
2215

23-
## Key advantages
16+
### **3. Interoperability**
17+
- **Agglayer Integration**: Seamlessly connect to Agglayer for cross-chain functionality and ecosystem bootstrapping.
18+
- **Ethereum-Compatible**: Build on a foundation that supports Ethereum tooling, enabling easy adoption and user migration.
2419

25-
Polygon CDK provides the essential components to build a Layer 2 blockchain that is secure, scalable, and interoperable with other chains.
20+
### **4. High Performance**
21+
- **Erigon Client**: Benefit from faster syncing and high transaction throughput powered by the optimized Erigon architecture.
22+
- **Cost Efficiency**: Reduce transaction fees by orders of magnitude compared to Ethereum Layer 1.
2623

27-
- Security: CDK builds highly secure, scalable L2s that utilize the latest innovations in zero-knowledge technology.
28-
- High-performance: CDK Erigon implements fast-syncing Erigon clients that run the battle-tested Polygon zkEVM protocol.
29-
- Modularity: CDK modular components allow developers to easily customize their L2 environment and build a chain that meets their specific needs.
30-
- Interoperability: Opt-in to the [AggLayer](../agglayer/overview.md) to bootstrap your chain’s ecosystem, enable cross-chain transactions while expanding your reach, user base, and liquidity from other established chains.
31-
- Sovereignty: Maintain full control over your chain’s revenue, governance, security, economic policies, and more.
32-
- Low gas fees: Transaction fees are orders of magnitude lower than those on Ethereum and are processed substantially faster. This enables a fast, ultra low-cost, and secure user experience unaffected by any high activity experienced on shared networks.
24+
### **5. Sovereignty**
25+
Maintain full control over your chain’s:
26+
- Governance and revenue.
27+
- Security policies and economic frameworks.
28+
- Finality and operational structure.
3329

34-
### Next steps
30+
---
3531

36-
- [Deploy a local CDK environment using Kurtosis](../cdk/getting-started/local-deployment.md). Follow the guide to deploy a CDK stack on your local machine.
32+
## Key Features at a Glance
3733

38-
- Check out the [concepts documentation](../cdk/concepts/layer2s.md) to gain a high-level understanding of the CDK.
34+
| **Feature** | **Description** |
35+
|-------------------------|---------------------------------------------------------|
36+
| **Trustless Finality** | ZK-powered chains with decentralized validation. |
37+
| **Scalable Design** | Optimized for high transaction throughput and low fees. |
38+
| **Customizability** | Modular components tailored to specific use cases. |
39+
| **Cross-Chain Ready** | Connect seamlessly to other chains via Agglayer. |
40+
| **High-Speed Syncing** | Built on the ultra-efficient Erigon client. |
3941

40-
- Have a look at the [CDK architecture docs](../cdk/concepts/architecture.md) to understand the CDK’s components and how they interact with each other.
42+
---

0 commit comments

Comments
 (0)