Skip to content

Commit aa57b47

Browse files
Merge pull request 0xPolygon#246 from 0xPolygon/cdk/native-gas-token
CDK: add native gas token address to contract deployment step
2 parents add2d52 + 364c219 commit aa57b47

File tree

3 files changed

+46
-3
lines changed

3 files changed

+46
-3
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ Run the following command to bring up a zkEVM node, a prover, and a mock L1 netw
3030
make run-docker
3131
```
3232

33-
### Production
33+
### Production build - managed by Polygon
3434

3535
!!! warning
36+
- The AggLayer in production is currently managed by Polygon.
3637
- Currently only one instance of the AggLayer can run at one time.
3738
- The AggLayer should, therefore, automatically start in the case of failure using a containerized setup or an OS level service manager/monitoring system.
3839

@@ -75,4 +76,7 @@ Add the chain configurations to the `../agglayer/docker/data/agglayer.toml` file
7576

7677
* Configure `[FullNodeRPCs]` to point to the corresponding L2 full node.
7778
* Configure `[L1]` to point to the corresponding L1 chain.
78-
* Configure the `[DB]` section with the managed database details.
79+
* Configure the `[DB]` section with the managed database details.
80+
81+
82+
</br>
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>

mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,10 @@ nav:
8383
- Start services: cdk/get-started/deploy-rollup/start-services.md
8484
- Connect to CDK testnet: cdk/get-started/connect-testnet.md
8585
- How to:
86+
- Use a native token: cdk/how-to/use-native-token.md
8687
- Integrate the AggLayer: cdk/how-to/integrate-agglayer.md
87-
- Quickly test a running stack: cdk/how-to/quick-test-stack.md
8888
- Manage allowlists with policies: cdk/how-to/manage-policies.md
89+
- Quickly test a running stack: cdk/how-to/quick-test-stack.md
8990
- Architecture:
9091
- CDK rollup: cdk/architecture/cdk-zkevm.md
9192
- CDK validium: cdk/architecture/cdk-validium.md

0 commit comments

Comments
 (0)