add support for forkID in the tool 'deployVerifier'

0xPolygonHermez · Jul 16, 2024 · 232149b · 232149b
1 parent 7375833
commit 232149b
Show file tree

Hide file tree

Showing 16 changed files with 2,566 additions and 25 deletions.
diff --git a/compiled-contracts/ClaimCompressor.json b/compiled-contracts/ClaimCompressor.json
diff --git a/compiled-contracts/FflonkVerifier.json b/compiled-contracts/FflonkVerifier.json
diff --git a/compiled-contracts/PolygonRollupManager.json b/compiled-contracts/PolygonRollupManager.json
diff --git a/compiled-contracts/PolygonRollupManagerMock.json b/compiled-contracts/PolygonRollupManagerMock.json
diff --git a/compiled-contracts/PolygonRollupManagerMockInternalTest.json b/compiled-contracts/PolygonRollupManagerMockInternalTest.json
diff --git a/compiled-contracts/PolygonValidiumEtrog.json b/compiled-contracts/PolygonValidiumEtrog.json
diff --git a/compiled-contracts/PolygonZkEVMEtrog.json b/compiled-contracts/PolygonZkEVMEtrog.json
diff --git a/compiled-contracts/PolygonZkEVMEtrogPrevious.json b/compiled-contracts/PolygonZkEVMEtrogPrevious.json
diff --git a/compiled-contracts/PolygonZkEVMExistentEtrog.json b/compiled-contracts/PolygonZkEVMExistentEtrog.json
diff --git a/contracts/verifiers/FflonkVerifier_10.sol b/contracts/verifiers/FflonkVerifier_10.sol
diff --git a/contracts/verifiers/FflonkVerifier_11.sol b/contracts/verifiers/FflonkVerifier_11.sol
diff --git a/docs/v2/lib/PolygonRollupBaseEtrog.md b/docs/v2/lib/PolygonRollupBaseEtrog.md
@@ -236,6 +236,15 @@ Generate Initialize transaction for hte bridge on L2
 |`_gasTokenNetwork` | uint32 | Indicates the native network of the token address
 |`_gasTokenMetadata` | bytes | Abi encoded gas token metadata
 
+### _verifyOrigin
+```solidity
+  function _verifyOrigin(
+  ) internal returns (bytes gasTokenMetadata)
+```
+
+
+
+
 ## Events
 ### SequenceBatches
 ```solidity

diff --git a/tools/deployVerifier/.gitignore b/tools/deployVerifier/.gitignore
@@ -0,0 +1 @@
+deploy_verifier_parameters.json
diff --git a/tools/deployVerifier/README.md b/tools/deployVerifier/README.md
@@ -0,0 +1,36 @@
+# Deploy verifier
+Script to deploy `verifier` smart contract
+
+## Install
+```
+npm i
+```
+
+## Setup
+- Config file
+  - `realVerifier`: select between a real or a mock verifer
+  - `forkID`: Select fork to verifier to be deployed (if a real verfifier is selected)
+  - `deployerPvtKey`: private key deployer
+    - First option will load `deployerPvtKey`. Otherwise, `process.env.MNEMONIC` will be loaded from the `.env` file
+  - `maxFeePerGas`: set custom gas
+  - `maxPriorityFeePerGas`: set custom gas
+  - `multiplierGas`: set custom gas
+- A network should be selected when running the script
+  - examples: `-- sepolia` or `--mainnet`
+  - This uses variables set in `hardhat.config.ts`
+  - Which uses some nvironment variables that should be set in `.env`
+> All paths are from roor repository
+
+## Usage
+> All commands are done from root repository.
+
+- Copy configuration file:
+```
+cp ./tools/deployVerifier/deploy_verifier_parameters.example ./tools/deployVerifier/deploy_verifier_parameters.json
+```
+
+- Set your parameters
+- Run tool:
+```
+npx hardhat run ./tools/addRollupType/deployVerififer.ts --network sepolia
+```
diff --git a/tools/deployVerifier/deployVerifier.ts b/tools/deployVerifier/deployVerifier.ts
@@ -56,27 +56,33 @@ async function main() {
         [deployer] = await ethers.getSigners();
     }
 
-    console.log("deploying with: ", deployer.address);
+    console.log("--> Deploying with: ", deployer.address);
 
     /*
-     *Deployment pol
+     * Deployment Verifier
      */
+    const verifierName = `FflonkVerifier_${deployParameters.forkID}`;
     let verifierContract;
     if (deployParameters.realVerifier === true) {
-        const VerifierRollup = await ethers.getContractFactory("FflonkVerifier", deployer);
+        const VerifierRollup = await ethers.getContractFactory(verifierName, deployer);
+        console.log(`--> Deploying verifier: ${verifierName}`);
         verifierContract = await VerifierRollup.deploy();
         await verifierContract.waitForDeployment();
     } else {
         const VerifierRollupHelperFactory = await ethers.getContractFactory("VerifierRollupHelperMock", deployer);
+        console.log("Deploying verifier VerifierRollupHelperMock");
         verifierContract = await VerifierRollupHelperFactory.deploy();
         await verifierContract.waitForDeployment();
     }
-    console.log("#######################\n");
+    // print contract address deployed
+    console.log("\n#######################");
     console.log("Verifier deployed to:", verifierContract.target);
     console.log("#######################\n");
-    console.log("verifierContract deployed to:", verifierContract.target);
-    console.log("you can verify the new verifierContract address with:");
-    console.log(`npx hardhat verify ${verifierContract.target} --network ${process.env.HARDHAT_NETWORK}\n`);
+    // print verification command line
+    console.log("#######################");
+    console.log("you can verify the new verifierContract address with the following command:");
+    console.log(`npx hardhat verify ${verifierContract.target} --network ${process.env.HARDHAT_NETWORK}`);
+    console.log("#######################");
 }
 
 main().catch((e) => {

diff --git a/tools/deployVerifier/deploy_verifier_parameters.example b/tools/deployVerifier/deploy_verifier_parameters.example
@@ -1,5 +1,6 @@
 {
     "realVerifier": true,
+    "forkID": 10,
     "deployerPvtKey": "",
     "maxFeePerGas":"",
     "maxPriorityFeePerGas":"",