Skip to content

Commit 5d15ed6

Browse files
committed
fixed link to video connect-wallet.md
2 parents f9ba15e + 073aa4d commit 5d15ed6

File tree

121 files changed

+414
-413
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+414
-413
lines changed

docs/cdk/concepts/dac.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Data availability in blockchain technology refers to whether or not transaction data is available on-chain or off-chain.
1+
Data availability in blockchain technology refers to whether or not transaction data is available on-chain or off-chain.
22

33
If data is available on-chain, 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.
44

@@ -14,13 +14,13 @@ A DAC is an off-chain network of nodes that implements a data storage layer in a
1414
- **Lower transaction fees**: Reduced computational requirements lead to lower fees and faster finality on the main network.
1515
- **Privacy and security**: The DAC stores secure and private transaction data.
1616
- **Trustless**: Data owners do not have to trust the blockchain operator.
17-
- **Scalable**: Decoupling data storage from the main chain supports more scalable networks.
17+
- **Scalable**: Decoupling data storage from the main chain supports more scalable networks.
1818

1919
DACs store the data required to reconstruct the state of the blockchain and make that data accessible so that, if the main blockchain network goes down, users can still access their assets and data.
2020

2121
Setting up a DAC can be costly and therefore DACs mostly support Enterprise use cases which require cheap and fast transactions with a private and secure data layer.
2222

23-
The CDK validium DAC is a secure consortium of nodes that ensures off-chain data access.
23+
The CDK validium DAC is a secure consortium of nodes that ensures off-chain data access.
2424

2525
## DAC data flow
2626

@@ -40,4 +40,4 @@ The DAC works together with the sequencer to control the flow of data. The proce
4040

4141
6. **Verification on Ethereum**: A designated smart contract on Ethereum verifies the submitted signatures against a list of valid DAC members and confirms that sufficient approval has been provided for the batch hash.
4242

43-
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.
43+
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.

docs/cdk/concepts/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Welcome to Concepts

docs/cdk/concepts/rollup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
Rollups are blockchain layer 2 scaling solutions that speed up the network by *rolling up* multiple transactions into batches which are eventually committed to the layer 1.
1+
Rollups are blockchain layer 2 scaling solutions that speed up the network by *rolling up* multiple transactions into batches which are eventually committed to the layer 1.
22

33
CDK provides zkEVM rollup solutions.
44

55
!!! info "Recommended resource"
6-
See Ethereum.org's detailed [description of zero-knowledge rollups](https://ethereum.org/en/developers/docs/scaling/zk-rollups/).
6+
See Ethereum.org's detailed [description of zero-knowledge rollups](https://ethereum.org/en/developers/docs/scaling/zk-rollups/).

docs/cdk/concepts/validium.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Validiums are blockchain scaling solutions that do not store transaction data.
1+
Validiums are blockchain scaling solutions that do not store transaction data.
22

33
!!! info "Recommended resource"
4-
See Ethereum.org's detailed [description of validiums](https://ethereum.org/en/developers/docs/scaling/validium/).
4+
See Ethereum.org's detailed [description of validiums](https://ethereum.org/en/developers/docs/scaling/validium/).

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,3 @@
44
## Deploy a CDK rollup locally
55

66
The [zkEVM deployment quickstart documentation](../../zkEVM/get-started/deploy-zkevm/index.md) shows you how to deploy a zkEVM rollup on your local machine.
7-

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,16 @@ Follow the steps below to deploy a CDK validium instance.
77

88
First, deploy the relevant contracts.
99

10-
Follow the steps in the [CDK validium contracts repository's README</ins>](https://github.com/0xPolygon/cdk-validium-contracts).
10+
Follow the steps in the [CDK validium contracts repository's README](https://github.com/0xPolygon/cdk-validium-contracts).
1111

1212
## 2. Run the CDK validium node
1313

14-
Next, set up and run the CDK validium node.
14+
Next, set up and run the CDK validium node.
1515

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

18-
1918
## 3. Run the data availability (DA) node (optional step)
2019

21-
Finally, once the CDK validium node is operational, set up and run the data availability node.
20+
Finally, once the CDK validium node is operational, set up and run the data availability node.
2221

23-
Check for instructions here: [<ins>CDK DA Node GitHub running instructions</ins>](https://github.com/0xPolygon/cdk-data-availability/blob/main/docs/running.md).
22+
Check for instructions here: [CDK DA Node GitHub running instructions](https://github.com/0xPolygon/cdk-data-availability/blob/main/docs/running.md).
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ This section documents the two most popular deployments currently supported by C
55
- Validium
66
- Rollup
77

8-
Users select a chain architecture specific to their needs from a set of supported, open source options. Alternatively, users can select custom components for specific requirements.
8+
Users select a chain architecture specific to their needs from a set of supported, open source options. Alternatively, users can select custom components for specific requirements.
99

1010
!!! important "Why are there zkEVM docs in the CDK section?"
1111
Several of the docs point to zkEVM specific deployment documentation because the rollup flavor of CDK uses zkEVM deployment defaults.
1212

1313
The diagram below shows the two supported configuration options for data availability (DA), rollup or validium. Rollups post transaction data from the CDK directly onto Ethereum whereas validiums only post the transaction hash.
1414

15-
![CDK architecture choices](../img/cdk/cdk-architecture.png)
15+
![CDK architecture choices](../../img/cdk/cdk-architecture.png)
1616

17-
Check out the [data availability docs](concepts/dac.md) for more information.
17+
Check out the [data availability docs](../concepts/dac.md) for more information.
1818

1919
!!! important
2020
The documentation describes standard deployments. You can edit the configuration files to implement your own custom set ups.

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ cd zkValidium-quickstart
2626
```
2727

2828
Create the `.env` file by copying the example:
29+
2930
```bash
3031
cp .env.example .env
3132
```
@@ -93,6 +94,7 @@ zkevm-bridge-service /bin/sh -c /app/zkevm-brid ... Up
9394
0.0.0.0:9090->9090/tcp,:::9090->9090/tcp
9495
zkevm-bridge-ui /bin/sh /app/scripts/deploy.sh Up 0.0.0.0:8088->80/tcp,:::8088->80/tcp
9596
```
97+
9698
</details>
9799

98100
2.3.1 If a service isn't running (i.e. it is in `Exit 1` state), investigate further using the logs:
@@ -123,7 +125,7 @@ sudo make restart
123125

124126
## 3. Test validium
125127

126-
3.1 Verify the block explorer is running by navigating to [localhost:4001](http://localhost:4001/).
128+
3.1 Verify the block explorer is running by navigating to [localhost:4001](http://localhost:4001/).
127129

128130
You should see a page similar to this:
129131

@@ -135,8 +137,8 @@ You should see a page similar to this:
135137

136138
4.1 Follow MetaMask's instructions on [how to set up a network manually](https://support.metamask.io/hc/en-us/articles/360043227612-How-to-add-a-custom-network-RPC).
137139

138-
- Set the chain ID to **1001**.
139-
- The currency symbol can be anything but we will use **POL** by default.
140+
- Set the chain ID to **1001**.
141+
- The currency symbol can be anything but we will use **POL** by default.
140142
- The RPC node and block explorer containers can be found at ports **8123** and **4001**, respectively.
141143

142144
<div align="center">
@@ -191,7 +193,7 @@ CDK has a native bridge with UI that allows you to transfer funds between the L1
191193

192194
5.1.2 Switch to the L1 network and you will see the previously imported account with ~999 POL on the L1 chain.
193195

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

196198
5.1.4 Click on **Connect a wallet > MetaMask**.
197199

@@ -205,7 +207,7 @@ CDK has a native bridge with UI that allows you to transfer funds between the L1
205207
<img src="/img/cdk/cdk-bridge-connected.png" alt="bridge" width="90%" height="30%" />
206208
</div>
207209

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

210212
5.1.7 Click **Bridge** and approve the transaction on the MetaMask pop-up:
211213

@@ -221,7 +223,7 @@ CDK has a native bridge with UI that allows you to transfer funds between the L1
221223

222224
### 5.2 L2 to L1
223225

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

226228
5.2.2 You should see both the updated L1 and L2 balances:
227229

@@ -244,4 +246,4 @@ The L2->L1 bridging is slightly different than L1->L2 and you will see the **Act
244246

245247
<div align="center">
246248
<img src="/img/cdk/cdk-bridge-l2-to-l1-completed.png" alt="bridge" width="90%" height="30%" />
247-
</div>
249+
</div>

docs/cdk/how-to/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This introduction to the how to section is being written.
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Managing allowlists, denylists, and ACLs is done with policies.
55

66
## Policy overview
77

8-
A **policy** is a set of rules that govern what actions are allowed or denied in the transaction pool.
8+
A **policy** is a set of rules that govern what actions are allowed or denied in the transaction pool.
99

1010
- **Fine-grained control**: Developers can specify policies at a granular level, allowing or denying specific actions for specific addresses.
1111
- **Dynamic updates**: Policies and ACLs can be updated on-the-fly without requiring a node restart.
@@ -21,7 +21,7 @@ Currently, there are two defined policies:
2121
- **SendTx**: governs whether an address may send transactions to the pool.
2222
- **Deploy**: governs whether an address may deploy a contract.
2323

24-
The CDK validium node offers policy management features that include allowlisting[^1], denylisting[^2], and access control lists (ACLs)[^3]. These features are beneficial for validium-based app-chains that require fine-grained control over transaction pools.
24+
The CDK validium node offers policy management features that include allowlisting[^1], denylisting[^2], and access control lists (ACLs)[^3]. These features are beneficial for validium-based app-chains that require fine-grained control over transaction pools.
2525

2626
### Code definitions
2727

@@ -83,7 +83,6 @@ docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy describe -
8383
docker exec -it cdk-validium-aggregator /app/cdk-validium-node policy describe
8484
```
8585

86-
8786
[^1]: **Allowlisting**: The process of explicitly allowing addresses to perform certain actions.
8887
[^2]: **Denylisting**: The process of explicitly denying addresses from performing certain actions.
89-
[^3]: **ACL (access control list)**: A list of addresses that are exceptions to a given policy.
88+
[^3]: **ACL (access control list)**: A list of addresses that are exceptions to a given policy.

0 commit comments

Comments
 (0)