Skip to content

Commit 6ff44fd

Browse files
Merge pull request 0xPolygon#292 from 0xPolygon/cdk/agglayer-api
CDK: Adding the OpenAPI playground to the How Tos
2 parents db335c0 + 4428fa7 commit 6ff44fd

File tree

4 files changed

+39
-28
lines changed

4 files changed

+39
-28
lines changed
Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -17,31 +17,4 @@ Add the respective chain configurations to the [`../agglayer/docker/data/agglaye
1717
* Configure `[L1]` to point to the corresponding L1 chain.
1818
* Configure the `[DB]` section with the managed database details.
1919

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-
4720
</br>
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
The following instructions are for users who may like to test and run a local installation of the AggLayer for research purposes.
2+
3+
## Prerequisites
4+
5+
Make sure you have the following software installations.
6+
7+
- [Docker](https://docs.docker.com/engine/install/)
8+
- [Docker Compose](https://docs.docker.com/compose/install/)
9+
- [Golang](https://go.dev/doc/install)
10+
11+
## Clone the repo.
12+
13+
```sh
14+
git clone https://github.com/0xPolygon/agglayer.git
15+
cd agglayer/
16+
```
17+
18+
## Set up and installation
19+
20+
Run the following command to bring up a zkEVM node, a prover, and a mock L1 network.
21+
22+
```sh
23+
make run-docker
24+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
hide:
3+
- toc
4+
---
5+
6+
Try out the AggLayer OpenRPC methods using playground below.
7+
8+
!!! tip
9+
- Click the full screen icon to hide the code on the left.
10+
11+
<embed type="text/html" src="https://playground.open-rpc.org/?schemaUrl=https://raw.githubusercontent.com/0xPolygon/agglayer/1c61515c98c07d91ee14dc3987839722ed0696e5/docs/openrpc.json" width="100%" height="1000px">

mkdocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,10 @@ 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-
- Configure the AggLayer: cdk/how-to/configure-agglayer.md
87+
- Use the AggLayer:
88+
- Configure the AggLayer: cdk/how-to/agglayer/configure.md
89+
- AggLayer OpenRPC: cdk/how-to/agglayer/openrpc.md
90+
- Local installation: cdk/how-to/agglayer/local-install.md
8891
- Manage allowlists with policies: cdk/how-to/manage-policies.md
8992
- Quickly test a running stack: cdk/how-to/quick-test-stack.md
9093
- Architecture:

0 commit comments

Comments
 (0)