Skip to content

Commit 6cadf1d

Browse files
update after review
1 parent 4a0f06d commit 6cadf1d

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,18 @@ This section shows you how to create a custom CDK validium DAC contract.
1515

1616
3. Run `npm i` from the root.
1717

18-
4. Go to the [`contracts/v2/consensus/validium`](https://github.com/0xPolygonHermez/zkevm-contracts/tree/feature/etrog/contracts/v2/consensus/validium) directory.
18+
4. Go to the [`contracts/v2/consensus/validium`](https://github.com/0xPolygonHermez/zkevm-contracts/tree/develop/contracts/v2/consensus/validium) directory.
1919

2020
!!! tip
2121
- Until further notice, these contracts run on the [etrog release](https://polygon.technology/blog/polygon-zkevm-the-etrog-upgrade-is-live-on-mainnet).
2222

23-
5. Create your custom contract in the same directory, and make sure it implements the [IDataAvailabilityProtocol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/contracts/v2/interfaces/IDataAvailabilityProtocol.sol) interface.
23+
5. Create your custom contract in the same directory, and make sure it implements the [IDataAvailabilityProtocol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/develop/contracts/v2/interfaces/IDataAvailabilityProtocol.sol) interface.
2424

2525
!!! tip
26-
- Use the Polygon DAC implementation contract: [PolygonDataCommittee.sol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/etrog/contracts/v2/consensus/validium/PolygonDataCommittee.sol) as a guide.
26+
- Use the Polygon DAC implementation contract: [PolygonDataCommittee.sol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/develop/contracts/v2/consensus/validium/PolygonDataCommittee.sol) as a guide.
2727
- The contract supports custom smart contract implementation and, through this, DACs can add their custom on-chain verification logic.
2828

29-
6. You can leave the `verifyMessage` function empty but make sure the `getProcotolName` function returns a unique name (such as Avail, Celestia, etc). The following example code comes from the [PolygonDataCommitee.sol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/contracts/v2/consensus/validium/PolygonDataCommittee.sol) implementation.
29+
6. You can leave the `verifyMessage` function empty but make sure the `getProcotolName` function returns a unique name (such as Avail, Celestia, etc). The following example code comes from the [PolygonDataCommitee.sol](https://github.com/0xPolygonHermez/zkevm-contracts/blob/develop/contracts/v2/consensus/validium/PolygonDataCommittee.sol) implementation.
3030

3131
```solidity
3232
// Name of the data availability protocol
@@ -42,13 +42,13 @@ This section shows you how to create a custom CDK validium DAC contract.
4242
}
4343
```
4444
45-
7. Update the [/deployment/v2/4_createRollup.ts](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/deployment/v2/4_createRollup.ts#L76) script to add your protocol name.
45+
7. Update the [/deployment/v2/4_createRollup.ts](https://github.com/0xPolygonHermez/zkevm-contracts/blob/54f58c8b64806429bc4d5c52248f29cf80ba401c/deployment/v2/4_createRollup.ts#L77) script to add your protocol name.
4646
4747
```ts
4848
const supporteDataAvailabilityProtocols = ["<CONTRACT_NAME>"];
4949
```
5050
51-
8. Make your contract deployable by copying, editing for your custom implementation, and pasting back in, the `if` statement from the [/deployment/v2/4_createRollup.ts#L251](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/deployment/v2/4_createRollup.ts#L251) node creation script.
51+
8. Make your contract deployable by copying, editing for your custom implementation, and pasting back in, the `if` statement from the [/deployment/v2/4_createRollup.ts#L251](https://github.com/0xPolygonHermez/zkevm-contracts/blob/54f58c8b64806429bc4d5c52248f29cf80ba401c/deployment/v2/4_createRollup.ts#L260) node creation script.
5252
5353
!!! info "`PolygonValidiumEtrog.sol` solution"
5454
@@ -87,13 +87,13 @@ This section shows you how to create a custom CDK validium DAC contract.
8787
8888
This section shows you how to deploy the Docker image containing your custom DAC contract.
8989
90-
1. Edit the following parameters in the [`docker/scripts/v2/deploy_parameters_docker.json`](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/docker/scripts/v2/create_rollup_parameters_docker.json) file:
90+
1. Edit the following parameters in the [`docker/scripts/v2/deploy_parameters_docker.json`](https://github.com/0xPolygonHermez/zkevm-contracts/blob/develop/docker/scripts/v2/create_rollup_parameters_docker.json) file:
9191
9292
```json
9393
"minDelayTimelock": 3600, BECOMES "minDelayTimelock": 1,
9494
```
9595
96-
2. Edit the following parameters in the [`/docker/scripts/v2/create_rollup_parameters_docker.json`](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/docker/scripts/v2/create_rollup_parameters_docker.json) file:
96+
2. Edit the following parameters in the [`/docker/scripts/v2/create_rollup_parameters_docker.json`](https://github.com/0xPolygonHermez/zkevm-contracts/blob/develop/docker/scripts/v2/create_rollup_parameters_docker.json) file:
9797
9898
```json
9999
"consensusContract": "PolygonValidiumEtrog", # CHANGE THIS TO YOUR CONTRACT NAME
@@ -106,13 +106,13 @@ This section shows you how to deploy the Docker image containing your custom DAC
106106
cp docker/scripts/v2/hardhat.example.paris hardhat.config.ts
107107
```
108108
109-
4. Edit [docker/scripts/v2/deploy-docker.sh](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/docker/scripts/v2/deploy-docker.sh) to add the following line:
109+
4. Edit [docker/scripts/v2/deploy-docker.sh](https://github.com/0xPolygonHermez/zkevm-contracts/blob/develop/docker/scripts/v2/deploy-docker.sh) to add the following line:
110110
111111
```sh
112112
sudo chmod -R go+rxw docker/gethData before docker build -t hermeznetwork/geth-zkevm-contracts -f docker/Dockerfile .
113113
```
114114
115-
5. In the [deployment/v2/4_createRollup.ts](https://github.com/0xPolygonHermez/zkevm-contracts/blob/feature/Optimizations/deployment/v2/4_createRollup.ts) file, uncomment the following:
115+
5. In the [deployment/v2/4_createRollup.ts](https://github.com/0xPolygonHermez/zkevm-contracts/blob/develop/deployment/v2/4_createRollup.ts) file, uncomment the following:
116116
117117
```ts
118118
// // Setup data committee to 0

0 commit comments

Comments
 (0)