Skip to content

Commit 764628b

Browse files
pushing updates to remote
1 parent c2c11e3 commit 764628b

File tree

9 files changed

+93
-34
lines changed

9 files changed

+93
-34
lines changed

docs/cdk/concepts/dac.md

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,15 @@
1-
!!! note
2-
fix this: https://medium.com/coinmonks/what-is-data-availability-and-why-do-we-need-it-7993c039fc44
1+
Validiums are blockchain solutions that don't store transaction data.
32

3+
!!! quote
4+
See the [definition of validium](https://ethereum.org/en/developers/docs/scaling/validium/) on Ethereum.org's glossary.
45

5-
A data availability committee (DAC) is an optional offchain network of nodes that provides data to a blockchain network. The advantages are:
6+
Data availability in blockchain technology refers to whether or not transaction data is available onchain or off-chain. If data is available onchain, then each node has to store every piece of data related to every transaction. This can be costly for node operators as hardware and storage requirements are high. Moving data off-chain streamlines node architecture and operations.
7+
8+
A data availability committee (DAC) implements a data storage layer in a modular chain architecture like CDK.
9+
10+
## What is a DAC?
11+
12+
A data availability committee (DAC) is an off-chain network of nodes that provides data to a blockchain network. The advantages are:
613

714
- **Lower transaction fees**: Reduced computational requirements lead to lower fees.
815
- **State privacy**: A secure copy of state transitions ensures data integrity and privacy.
@@ -33,3 +40,35 @@ The DAC works together with the sequencer to control the flow of data. The proce
3340

3441
7. **Final settlement with zero-knowledge proof**: The aggregator prepares a proof for the batch via the prover and submits it to Ethereum. This proof confirms the validity of the batch's transactions without revealing their details. The chain state updates on Ethereum.
3542

43+
44+
INCORPORATING:
45+
46+
47+
48+
## What do you Mean by Data Availability Layer?
49+
50+
In the realm of blockchain, data availability ensures that all nodes can access and verify the complete transaction history, which is crucial for maintaining the network's transparency, security, and integrity.
51+
52+
However, storing all transaction data on the main chain (L1) can lead to high costs and compromise privacy. Data availability layers tackle these issues by separating transaction execution from data storage. This allows for transaction data to be stored off-chain, reducing costs and enhancing privacy, while still being accessible for validation.
53+
54+
This separation introduces new challenges, such as ensuring the secure and reliable management of off-chain data. Features like the [<ins>DAC</ins>](#what-are-dacs) within the Polygon CDK framework address these concerns, offering trusted oversight of off-chain data.
55+
56+
The diagram below provides a high-level overview of the Polygon CDK Validium's approach to blockchain infrastructure.
57+
58+
<div align="center">
59+
<img src="" alt="bridge" width="90%" height="30%" />
60+
</div>
61+
62+
## What are DACs?
63+
64+
Data Availability Committees (DACs) are a crucial element in many blockchain protocols, tasked with ensuring the reliability and accessibility of off-chain data. In essence, they verify the availability of data associated with specific blockchain blocks.
65+
66+
In the context of L2 solutions, DACs play a pivotal role in enhancing scalability. They aid in transferring significant computational work and data storage off-chain, thereby alleviating the burden on the main L1 blockchain.
67+
68+
The DAC is an integral element in the validium framework of the CDK, functioning as a secure consortium of nodes to maintain the accessibility and security of off-chain data. For an overview of how the DAC functions within the CDK, please explore the DAC guide, available [<ins>here</ins>](/docs/cdk/validium/dac.md).
69+
70+
> For a more detailed understanding of data availability, the Ethereum Foundation's guide on Data Availability is a great resource, accessible [<ins>here</ins>](https://ethereum.org/en/developers/docs/data-availability/).
71+
## How do L2s Built with Polygon CDK Validium Function as App-chains?
72+
73+
Leveraging the power of Polygon's advanced [zkEVM technology](/docs/zkevm/), chains developed using the Polygon CDK offer a high-performance L2 scaling solution. Developers have the flexibility to choose the validium framework, which integrates a secure data availability layer managed by a [Data Availability Committee (DAC)](/docs/cdk/validium/dac.md). Chains built with the CDK can function like L1 blockchains tailored to specific business logic. However, as L2 solutions, they provide the advantage of near-infinite scalability. Designed with a user-centric approach, these chains prioritize core business functions and user engagement strategies without compromising on performance and scalability. The following diagram illustrates the high-level architecture of a chain developed using the Polygon CDK.
74+
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Deploy a CDK rollup locally
2+
3+
The [zkEVM deployment quickstart documentation](../..//zkEVM/step1-fullzkevm.md) shows you how to deploy a zkEVM rollup on your local machine.
4+
5+
!!! question
6+
What makes this CDK?
7+

docs/cdk/get-started/deploy-validium.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
!!! important "Recommendation"
2-
Follow the [Quickstart](quickstart-validium.md) for a hands-on introduction to CDK in validium mode.
2+
Follow the [quickstart](quickstart-validium.md) for a hands-on introduction to CDK in validium mode.
33

44
Follow the steps below to deploy a CDK validium instance.
55

@@ -21,4 +21,7 @@ Follow the instructions in the [CDK validium node repository's README](https://g
2121

2222
Finally, once the CDK validium node is operational, set up and run the data availability node.
2323

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).
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).
25+
26+
!!! question
27+
What makes this CDK?

docs/cdk/get-started/overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ CDK users choose a chain architecture specific to their needs and use cases.
1212
!!! info
1313
For the latest updates, follow our official GitHub repositories.
1414

15-
- [Rollup node](https://github.com/0xPolygonHermez/zkevm-node)
16-
- [Validium node](https://github.com/0xPolygon/cdk-validium-node)
17-
- [Data availability committee](https://github.com/0xPolygon/cdk-data-availability)
18-
- [zkEVM smart contracts](https://github.com/0xPolygonHermez/zkevm-contracts)
19-
- [Validium smart contracts](https://github.com/0xPolygon/cdk-validium-contracts)
15+
- [Rollup node](https://github.com/0xPolygonHermez/zkevm-node).
16+
- [Validium node](https://github.com/0xPolygon/cdk-validium-node).
17+
- [Data availability committee](https://github.com/0xPolygon/cdk-data-availability).
18+
- [zkEVM smart contracts](https://github.com/0xPolygonHermez/zkevm-contracts).
19+
- [Validium smart contracts](https://github.com/0xPolygon/cdk-validium-contracts).
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1-
Spin up an zkEVM ...
1+
## Run a CDK rollup locally
22

3-
Then ...
3+
The following documentation is a quickstart guide for deploying a CDK rollup on your local machine.
4+
5+
[https://github.com/0xPolygonHermez/zkevm-node/blob/develop/docs/running_local.md](https://github.com/0xPolygonHermez/zkevm-node/blob/develop/docs/running_local.md)
6+
7+
!!! question
8+
What makes this CDK?

docs/cdk/get-started/quickstart-validium.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
This quickstart guides you through the process of setting up a CDK validium on your local machine.
22

3-
!!! danger "Is it true?"
4-
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.
5-
63
## Prerequisites
74

85
### System requirements
@@ -12,7 +9,7 @@ This quickstart guides you through the process of setting up a CDK validium on y
129
- An AMD64 architecture system.
1310

1411
!!! warning
15-
CDK does not support ARM-based Macs
12+
CDK does not support ARM-based Macs.
1613

1714
### Software requirements
1815

@@ -121,6 +118,9 @@ To restart all services:
121118
sudo make restart
122119
```
123120

121+
!!! note
122+
This deployment runs on an L1 Geth instance.
123+
124124
## 3. Test validium
125125

126126
3.1 Verify the block explorer is running by navigating to [localhost:4001](http://localhost:4001/).
@@ -181,55 +181,55 @@ You should see a page similar to this:
181181

182182
CDK has a native bridge with UI that allows you to transfer funds between the L1 and the L2 validium.
183183

184-
### L1 to L2
184+
### 5.1 L1 to L2
185185

186-
5.1 Add the L1 RPC to MetaMask:
186+
5.1.1 Add the L1 RPC to MetaMask:
187187

188188
<div align="center">
189189
<img src="/img/cdk/cdk-metamask-add-l1.png" alt="bridge" width="90%" height="30%" />
190190
</div>
191191

192-
5.2 Switch to the L1 network and you will see the previously imported account with ~999 POL on the L1 chain.
192+
5.1.2 Switch to the L1 network and you will see the previously imported account with ~999 POL on the L1 chain.
193193

194-
5.3 Verify the bridge UI by navigating to [localhost:8088](http://localhost:8088/).
194+
5.1.3 Verify the bridge UI by navigating to [localhost:8088](http://localhost:8088/).
195195

196-
5.4 Click on **Connect a wallet > MetaMask**.
196+
5.1.4 Click on **Connect a wallet > MetaMask**.
197197

198198
<div align="center">
199199
<img src="/img/cdk/cdk-bridge.png" alt="bridge" width="90%" height="30%" />
200200
</div>
201201

202-
5.5 Select the previously imported account (0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266). Once you are connected, you should see a page like this:
202+
5.1.5 Select the previously imported account (0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266). Once you are connected, you should see a page like this:
203203

204204
<div align="center">
205205
<img src="/img/cdk/cdk-bridge-connected.png" alt="bridge" width="90%" height="30%" />
206206
</div>
207207

208-
5.6 Enter the amount (e.g. 5) to bridge and click **Continue**, you will see the **Confirm Bridge** page.
208+
5.1.6 Enter the amount (e.g. 5) to bridge and click **Continue**, you will see the **Confirm Bridge** page.
209209

210-
5.7 Click **Bridge** and approve the transaction on the MetaMask pop-up:
210+
5.1.7 Click **Bridge** and approve the transaction on the MetaMask pop-up:
211211

212212
<div align="center">
213213
<img src="/img/cdk/cdk-bridge-confirm.png" alt="bridge" width="90%" height="30%" />
214214
</div>
215215

216-
5.8 Once bridging is complete, you should see the **Activity** page:
216+
5.1.8 Once bridging is complete, you should see the **Activity** page:
217217

218218
<div align="center">
219219
<img src="/img/cdk/cdk-bridge-completed-l1-to-l2.png" alt="bridge" width="90%" height="30%" />
220220
</div>
221221

222-
### L2 to L1
222+
### 5.2 L2 to L1
223223

224-
5.9 Switch network on MetaMask to your validium chain and navigate back to [localhost:8088](http://localhost:8088/).
224+
5.2.1 Switch network on MetaMask to your validium chain and navigate back to [localhost:8088](http://localhost:8088/).
225225

226-
5.10 You should see both the updated L1 and L2 balances:
226+
5.2.2 You should see both the updated L1 and L2 balances:
227227

228228
<div align="center">
229229
<img src="/img/cdk/cdk-bridge-l2-to-l1.png" alt="bridge" width="90%" height="30%" />
230230
</div>
231231

232-
5.11 Enter an amount and follow the same process to bridge the fund back to the L1.
232+
5.2.3 Enter an amount and follow the same process to bridge the fund back to the L1.
233233

234234
!!! note
235235
You cannot bridge back fund more than what you have previously bridged from L1 to the L2.
@@ -240,12 +240,15 @@ The L2->L1 bridging is slightly different than L1->L2 and you will see the **Act
240240
<img src="/img/cdk/cdk-bridge-l2-to-l1-on-hold.png" alt="bridge" width="90%" height="30%" />
241241
</div>
242242

243-
5.12 Click **Finalise** and approve the transaction (Note: MetaMask will pop up a window to ask you to switch to the L1 network first). Then you will see this once the bridging is completed:
243+
5.2.4 Click **Finalise** and approve the transaction (Note: MetaMask will pop up a window to ask you to switch to the L1 network first). Then you will see this once the bridging is completed:
244244

245245
<div align="center">
246246
<img src="/img/cdk/cdk-bridge-l2-to-l1-completed.png" alt="bridge" width="90%" height="30%" />
247247
</div>
248248

249249
!!! urgent
250250
- First time, I had an error on step 5.12 -> cannot estimate gas.
251-
- Second time, I had an error much earlier on, but that's probably because I didn't clear the images up, even though I restarted.
251+
- Second time, I had an error much earlier on, but that's probably because I didn't clear the images up, even though I restarted.
252+
253+
!!! question
254+
What makes this CDK?
File renamed without changes.

mkdocs.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,14 @@ nav:
5252
- Quickstart:
5353
- Validium: cdk/get-started/quickstart-validium.md
5454
- Rollup: cdk/get-started/quickstart-rollup.md
55-
- Deploy validium: cdk/get-started/deploy-validium.md
55+
- Deploy:
56+
- Validium: cdk/get-started/deploy-validium.md
57+
- Rollup: cdk/get-started/deploy-rollup.md
5658
- How to:
5759
- Manage allowlists: cdk/how-to/manage-allowlists.md
5860
#- Architecture:
5961
- Specification:
60-
- Validium vs zkEVM: cdk/specification/validium-vs-zkevm.md
62+
- Validium vs rollup: cdk/specification/validium-vs-rollup.md
6163
- Performance benchmarks: cdk/specification/performance-benchmarks.md
6264
- Concepts:
6365
- Data availability: cdk/concepts/dac.md

run.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
set -euo pipefail
33

4-
/Users/ammatlala/Library/Python/3.11/bin/virtualenv venv
4+
virtualenv venv
55
source venv/bin/activate
66
pip3 install -r requirements.txt
77
mkdocs serve --strict

0 commit comments

Comments
 (0)