Skip to content

Commit c5c43d0

Browse files
kmurphypolygonkmurphypolygon
committed
sort conflicts
2 parents c89a4c3 + 4b8cb0f commit c5c43d0

File tree

12 files changed

+144
-21
lines changed

12 files changed

+144
-21
lines changed

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,4 @@ node_modules/
99
.DS_Store
1010
**/.DS_Store
1111
*.iml
12+
temp_dir/

docs/cdk/architecture/cdk-validium-option.md renamed to docs/cdk/architecture/cdk-validium.md

File renamed without changes.

docs/cdk/architecture/cdk-zkevm-option.md renamed to docs/cdk/architecture/cdk-zkevm.md

File renamed without changes.

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
This quick start takes you through the process of deploying a full CDK zkRollup, EVM-compatible network on Goerli.
1+
This tutorial takes you through the process of deploying a full CDK zkRollup, EVM-compatible network on Goerli.
2+
3+
It relies on specific component versions so we have hidden most of the configuration complexity in scripts to make the process straightforward.
24

35
!!! warning
4-
- These instructions are subject to frequent updates as the software remains at an early development stage.
6+
- The tutorial is for learning purposes only and is not intended to describe a latest stable version build.
57
- Report any content issues on our docs repo: https://github.com/0xPolygon/polygon-docs
68

79
The process is split into the following sections:

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
!!! info "Computing resources"
88
- Running a full prover is an enterprise level installation and extremely resource-heavy.
99
- These instructions run the mock prover instead.
10-
- Check out the [configure prover](configure-prover.md#configure-the-prover) section for more information.
1110

1211
## Software
1312

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
comments: true
33
---
44

5-
This guide takes you through the process of deploying a fully EVM-compatible, CDK validium on the Sepolia network.
5+
This tutorial takes you through the process of deploying a fully EVM-compatible, CDK validium on the Sepolia network.
66

7-
We have hidden most of the configuration complexity in scripts to make the process straightforward and easy to follow.
7+
It relies on specific component versions so we have hidden most of the configuration complexity in scripts to make the process straightforward and easy to follow.
8+
9+
The tutorial is for learning only and is not intended to describe a latest stable version build.
810

911
## Process steps
1012

‎docs/cdk/how-to/integrate-agglayer.md‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
Polygon AggLayer is a web service that receives zero-knowledge proofs from different CDK chains and checks their soundness before sending the proof to L1 for verification.
2+
3+
!!! warning
4+
- The AggLayer is in development and subject to architectural changes.
5+
- The code is still being audited.
6+
7+
## Prerequisites
8+
9+
Make sure you have the following software installations.
10+
11+
- [Docker](https://docs.docker.com/engine/install/)
12+
- [Docker Compose](https://docs.docker.com/compose/install/)
13+
- [Golang](https://go.dev/doc/install)
14+
- [GCloud cli](https://cloud.google.com/sdk/docs/install) - production only.
15+
16+
### Clone the repo.
17+
18+
```sh
19+
git clone https://github.com/0xPolygon/agglayer.git
20+
cd agglayer/
21+
```
22+
23+
## Set up and installation
24+
25+
### Local
26+
27+
Run the following command to bring up a zkEVM node, a prover, and a mock L1 network.
28+
29+
```sh
30+
make run-docker
31+
```
32+
33+
### Production build - managed by Polygon
34+
35+
!!! warning
36+
- The AggLayer in production is currently managed by Polygon.
37+
- Currently only one instance of the AggLayer can run at one time.
38+
- The AggLayer should, therefore, automatically start in the case of failure using a containerized setup or an OS level service manager/monitoring system.
39+
40+
Install the Golang dependencies.
41+
42+
```sh
43+
go install .
44+
```
45+
46+
#### Key-signing configurations
47+
48+
Install polygon-cli:
49+
50+
```sh
51+
go install github.com/maticnetwork/polygon-cli@latest
52+
```
53+
54+
Create a new signature:
55+
56+
```sh
57+
polygon-cli signer create --kms GCP --gcp-project-id gcp-project --key-id mykey-tmp
58+
```
59+
60+
Set up ADC in GCloud:
61+
62+
```sh
63+
gcloud auth application-default login
64+
```
65+
66+
In the `../agglayer/docker/data/agglayer/agglayer.toml` file, add the `KMSKeyName` from GCloud.
67+
68+
## Setting up the AggLayer
69+
70+
Each CDK chain requires a corresponding RPC node configuration that is synced with the target CDK. This node checks the state root after executions of L2 batches.
71+
72+
!!! info "Storage recommendations"
73+
- Use a durable HA PostgresDB for storage; ideally AWS Aurora PostgreSQL or Cloud SQL for PostgreSQL in GCP.
74+
75+
Add the chain configurations to the `../agglayer/docker/data/agglayer/agglayer.toml` file by amending the following details to add the required chain(s).
76+
77+
* Configure `[FullNodeRPCs]` to point to the corresponding L2 full node.
78+
* Configure the `[DB]` section with the managed database details.
79+
* Configure `[L1]` to point to the corresponding L1 chain.
80+
81+
82+
83+
</br>

‎docs/cdk/how-to/use-native-token.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## Prerequisite steps
2+
3+
- You should have a running CDK stack.
4+
- Follow one of the tutorials linked below if you haven't yet spun up a CDK stack.
5+
6+
### Deployment guides
7+
8+
- [Deploy a validium CDK](../get-started/deploy-validium/intro.md)
9+
- [Deploy a zkEVM CDK](../get-started/deploy-rollup/intro.md)
10+
11+
!!! warning
12+
The rollup documentation is currently being updated.
13+
14+
## Use a custom native token
15+
16+
1. Go to the `...contracts/deployment` folder and find the `deploy_parameters.json` file.
17+
18+
!!! warning
19+
The directory naming is dependent on your build type (rollup or validium).
20+
21+
2. Open the `deploy_parameters.json` file and add a new entry:
22+
23+
```json
24+
{
25+
"...":"...",
26+
"...":"...",
27+
"maxPriorityFeePerGas":"",
28+
"multiplierGas": ""
29+
"gasTokenAddress": "<TOKEN-ADDRESS>"
30+
}
31+
```
32+
33+
`TOKEN-ADDRESS` is the address of a deployed ERC20 L1 token.
34+
35+
If you leave the value as empty string, the ETH token address is used as a default.
36+
37+
38+
</br>

‎docs/cdk/resources/third-party-guides.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ hide:
33
- toc
44
---
55

6-
This page is a catalogue of third-party and partner quick starts and guides that explain how to spin up and deploy validium and rollup CDK stacks, and more.
6+
This page links to full guides that some of [our solution providers](https://ecosystem.polygon.technology/spn/explore/?search=&competency=All&chain=All) have developed, including quick starts and guides that explain how to spin up and deploy validium and rollup CDK stacks.
77

88
<div class="grid-container">
99
<div class="grid-item">
@@ -26,3 +26,4 @@ This page is a catalogue of third-party and partner quick starts and guides that
2626
</div>
2727
</div>
2828

29+
Check out the [solution provider page]((https://ecosystem.polygon.technology/spn/explore/?search=&competency=All&chain=All)) to see more info on our partners.

‎docs/cdk/version-matrix.md‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,6 @@ The table below shows the version compatibility for CDK releases and related com
4141
<td> <a href="https://github.com/0xPolygonHermez/zkevm-rom/tree/v4.0.0-fork.7">v4.0.0-fork.7</a></td>
4242
<td>Bridge: <a href="https://github.com/0xPolygonHermez/zkevm-bridge-service/releases/tag/v0.4.2">v0.4.2</a></td>
4343
</tr>
44-
<tr>
45-
<td>Ares release Edlerberry + 2 weeks</td>
46-
<td>8</td>
47-
<td>Elderberry </td>
48-
<td></td>
49-
<td></td>
50-
<td></td>
51-
<td></td>
52-
<td></td>
53-
</tr>
5444
</tbody>
5545
</table>
5646

0 commit comments

Comments
 (0)