Skip to content

Commit 3777d4d

Browse files
Katharine MurphyKatharine Murphy
authored andcommitted
updating the agglayer how to
1 parent b7a90db commit 3777d4d

File tree

3 files changed

+49
-83
lines changed

3 files changed

+49
-83
lines changed
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
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+
!!! important
4+
Polygon manages the AggLayer in production at the current time.
5+
6+
!!! warning
7+
- The AggLayer is in development and subject to architectural changes.
8+
- The code is still being audited.
9+
10+
## Configure the AggLayer
11+
12+
To configure the AggLayer to integrate with external CDK chains, each one requires an RPC node configuration.
13+
14+
Add the chain configurations to the `../agglayer/docker/data/agglayer.toml` file by amending the following details to add the required chain(s).
15+
16+
* Configure `[FullNodeRPCs]` to point to the corresponding L2 full node.
17+
* Configure `[L1]` to point to the corresponding L1 chain.
18+
* Configure the `[DB]` section with the managed database details.
19+
20+
## Run a local AggLayer
21+
22+
The following instructions are for users who may like to test and run a local installation of the AggLayer for research purposes.
23+
24+
### Prerequisites
25+
26+
Make sure you have the following software installations.
27+
28+
- [Docker](https://docs.docker.com/engine/install/)
29+
- [Docker Compose](https://docs.docker.com/compose/install/)
30+
- [Golang](https://go.dev/doc/install)
31+
- [GCloud cli](https://cloud.google.com/sdk/docs/install) - production only.
32+
33+
### Clone the repo.
34+
35+
```sh
36+
git clone https://github.com/0xPolygon/agglayer.git
37+
cd agglayer/
38+
```
39+
40+
### Set up and installation
41+
42+
Run the following command to bring up a zkEVM node, a prover, and a mock L1 network.
43+
44+
```sh
45+
make run-docker
46+
```
47+
48+
</br>

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

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

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ nav:
8484
- Connect to CDK testnet: cdk/get-started/connect-testnet.md
8585
- How to:
8686
- Use a native token: cdk/how-to/use-native-token.md
87-
- Integrate the AggLayer: cdk/how-to/integrate-agglayer.md
87+
- Configure the AggLayer: cdk/how-to/configure-agglayer.md
8888
- Manage allowlists with policies: cdk/how-to/manage-policies.md
8989
- Quickly test a running stack: cdk/how-to/quick-test-stack.md
9090
- Architecture:

0 commit comments

Comments
 (0)