Skip to content

Commit db335c0

Browse files
Merge pull request 0xPolygon#291 from 0xPolygon/km/fix-aggl-howto
Updating the AggLayer how to with corrections
2 parents 0c47c21 + 3223d3c commit db335c0

File tree

4 files changed

+50
-86
lines changed

4 files changed

+50
-86
lines changed
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
Polygon AggLayer is a ZK-powered interoperability solution that enables a shared state across multiple chains. It receives zero-knowledge proofs from multiple CDK chains and checks their soundness before sending them on to the 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+
The AggLayer integrates with external CDK chains using an RPC node configuration for each chain.
13+
14+
Add the respective chain configurations to the [`../agglayer/docker/data/agglayer.toml`](https://github.com/0xPolygon/agglayer/blob/main/docker/data/agglayer/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+
32+
### Clone the repo.
33+
34+
```sh
35+
git clone https://github.com/0xPolygon/agglayer.git
36+
cd agglayer/
37+
```
38+
39+
### Set up and installation
40+
41+
Run the following command to bring up a zkEVM node, a prover, and a mock L1 network.
42+
43+
```sh
44+
make run-docker
45+
```
46+
47+
</br>

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

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

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

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

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.
6+
This page links to full guides that some of [our solution providers](https://ecosystem.polygon.technology/spn/explore/) 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,4 +26,4 @@ This page links to full guides that some of [our solution providers](https://eco
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.
29+
Check out the [solution provider page](https://ecosystem.polygon.technology/spn/explore/) to see more info on our partners.

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)