Skip to content

Commit c51fc58

Browse files
kmurphypolygonkmurphypolygon
committed
updating to split topics
1 parent 243e0f8 commit c51fc58

File tree

3 files changed

+88
-70
lines changed

3 files changed

+88
-70
lines changed

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

Lines changed: 7 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -10,82 +10,19 @@ This document shows you how to integrate and configure the AggLayer into your st
1010
- The AggLayer is in development and subject to architectural changes.
1111
- The code is still being audited.
1212

13-
## Step 1: Attach a chain to the uLXLY bridge
13+
## Prerequisites
1414

15-
1. If you do not have a CDK chain set up with Polygon, [make a request to register your chain](https://discord.gg/XvpHAxZ).
15+
You should have already deployed a CDK chain stack which has integrated the bridge service.
1616

17-
We will ask you for the following data:
18-
19-
```json
20-
"rollupTypeID": 0,
21-
"chainID": 0000,
22-
"admin": "0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
23-
"sequencer": "0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
24-
"gasTokenAddress": "0x0000000000000000000000000000000000000000",
25-
"sequencerURL": "https://rpc.chain.name",
26-
"networkName": "chain name"
27-
```
28-
29-
!!! note
30-
- If you are using a wrapped-token on the bridge, we use the original token address.
31-
- You can use any token on any network that is attached to the LxLy bridge, including those from the Ethereum mainnet.
32-
33-
2. Once registered, we provide you with the following network parameters:
34-
35-
- `rollupID`
36-
- `rollupAddress`
37-
38-
3. We also give you a pre-configured `genesis.json` file to use.
39-
40-
4. You will need the Polygon bridge configuration details.
41-
42-
```sh
43-
[NetworkConfig]
44-
GenBlockNumber = 1
45-
PolygonBridgeAddress = "0xCca6ECD73932e49633B9307e1aa0fC174525F424"
46-
PolygonZkEVMGlobalExitRootAddress = "0x8A791620dd6260079BF849Dc5567aDC3F2FdC318"
47-
PolygonRollupManagerAddress = "0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e"
48-
PolygonZkEvmAddress = "0x8dAF17A20c9DBA35f005b6324F493785D239719d"
49-
L2PolygonBridgeAddresses = ["0xCca6ECD73932e49633B9307e1aa0fC174525F424"]
50-
```
51-
52-
5. Configure your nodes with the data.
53-
54-
!!! info "Configure your nodes"
55-
- Add the `rollupID` and `rollupAddress` parameters to the `L1config` section of the `genesis.json` file of the CDK node. For example:
56-
57-
```sh
58-
{
59-
"rollupTypeID": 1,
60-
"chainID": 3776,
61-
"admin": "0xxxxx",
62-
"sequencer": "0xxxxx",
63-
"gasTokenAddress": "0x0000000000000000000000000000000000000000",
64-
"sequencerURL": "https://rpc.xxx",
65-
"networkName": "xxx zkEVM",
66-
}
67-
```
68-
69-
6. Polygon registers the CDK chain on the uLxLy bridge.
70-
71-
7. Chain owners then need to add POL and ETH tokens to the sequencer on the CDK chain.
72-
73-
## Step 2: Polygon configuration
17+
Please check our [get started](../../get-started/quickstart-validium.md) section for guidance, quickstarts, and deployment tutorials for more information.
7418

7519
!!! important
76-
- These steps are done by Polygon.
77-
78-
Once registered, Polygon creates a permissionless node that points to the corresponding L2 full node.
79-
80-
We then add your details to our AggLayer configuration file [`../agglayer/docker/data/agglayer.toml`](https://github.com/0xPolygon/agglayer/blob/main/docker/data/agglayer/agglayer.toml); specifically these configurations:
81-
82-
* `[FullNodeRPCs]` points to the corresponding L2 full node.
83-
* `[L1]` points to the corresponding L1 chain.
84-
* The `[DB]` section has the managed database details.
20+
- If you want to register your chain on the uLXLY bridge, follow the [instructions here](../register-configure-ulxly.md).
21+
- However, you may only be interested in integrating the AggLayer with your chain, in which case you do not have to register for the uLXLY bridge.
8522

86-
## Step 3: External CDK chain configuration
23+
## Configure your chain to use the AggLayer
8724

88-
The last step is to update your node configuration to map to the Polygon Agglayer.
25+
To access the Polygon AggLayer, you need to update your node configuration.
8926

9027
Open the `config.toml` file and include the following:
9128

‎docs/cdk/how-to/register-configure-ulxly.md‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
This document describes how to register and configure your CDK chain to use the Polygon uXLXY bridge.
2+
3+
## Prerequisites
4+
5+
You should have already deployed a CDK chain stack which has integrated the bridge service.
6+
7+
Please check our [get started](../get-started/quickstart-validium.md) section for guidance, quickstarts, and deployment tutorials for more information.
8+
9+
## Step 1: Attach a chain to the uLXLY bridge
10+
11+
1. If your CDK chain is not yet registered with Polygon, [make a request to register your chain](https://discord.gg/XvpHAxZ).
12+
13+
We will ask you for the following data:
14+
15+
```json
16+
"rollupTypeID": 0,
17+
"chainID": 0000,
18+
"admin": "0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
19+
"sequencer": "0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
20+
"gasTokenAddress": "0x0000000000000000000000000000000000000000",
21+
"sequencerURL": "https://rpc.chain.name",
22+
"networkName": "chain name"
23+
```
24+
25+
!!! note
26+
- If you are using a wrapped-token on the bridge, we use the original token address.
27+
- You can use any token on any network that is attached to the LxLy bridge, including those from the Ethereum mainnet.
28+
29+
2. Once registered, we provide you with the following network parameters:
30+
31+
- `rollupID`
32+
- `rollupAddress`
33+
34+
3. We also give you a pre-configured `genesis.json` file to use.
35+
36+
4. You will need the Polygon bridge configuration details.
37+
38+
```sh
39+
[NetworkConfig]
40+
GenBlockNumber = 1
41+
PolygonBridgeAddress = "0xCca6ECD73932e49633B9307e1aa0fC174525F424"
42+
PolygonZkEVMGlobalExitRootAddress = "0x8A791620dd6260079BF849Dc5567aDC3F2FdC318"
43+
PolygonRollupManagerAddress = "0xB7f8BC63BbcaD18155201308C8f3540b07f84F5e"
44+
PolygonZkEvmAddress = "0x8dAF17A20c9DBA35f005b6324F493785D239719d"
45+
L2PolygonBridgeAddresses = ["0xCca6ECD73932e49633B9307e1aa0fC174525F424"]
46+
```
47+
48+
5. Configure your nodes with the data.
49+
50+
!!! info "Configure your nodes"
51+
- Add the `rollupID` and `rollupAddress` parameters to the `L1config` section of the `genesis.json` file of the CDK node. For example:
52+
53+
```sh
54+
{
55+
"rollupTypeID": 1,
56+
"chainID": 3776,
57+
"admin": "0xxxxx",
58+
"sequencer": "0xxxxx",
59+
"gasTokenAddress": "0x0000000000000000000000000000000000000000",
60+
"sequencerURL": "https://rpc.xxx",
61+
"networkName": "xxx zkEVM",
62+
}
63+
```
64+
65+
6. Polygon registers the CDK chain on the uLxLy bridge.
66+
67+
7. Chain owners then need to add POL and ETH tokens to the sequencer on the CDK chain.
68+
69+
## Step 2: Polygon configuration
70+
71+
!!! important
72+
- These steps are done by Polygon.
73+
74+
Once registered, Polygon creates a permissionless node that points to the corresponding L2 full node.
75+
76+
We then add your details to our AggLayer configuration file [`../agglayer/docker/data/agglayer.toml`](https://github.com/0xPolygon/agglayer/blob/main/docker/data/agglayer/agglayer.toml); specifically these configurations:
77+
78+
* `[FullNodeRPCs]` points to the corresponding L2 full node.
79+
* `[L1]` points to the corresponding L1 chain.
80+
* The `[DB]` section has the managed database details.

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +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+
- Using the uXLXY bridge: cdk/how-to/register-configure-ulxly.md
8788
- Use the AggLayer:
8889
- Integrate the AggLayer: cdk/how-to/agglayer/integrate.md
8990
- AggLayer OpenRPC: cdk/how-to/agglayer/openrpc.md

0 commit comments

Comments
 (0)