Feature/prepare deployment for avalanche and arbitrum (#429)

Co-authored-by: Zied Guesmi <[email protected]>

Author: Le-Caignec

.drone.yml

@@ -73,7 +73,7 @@ steps:
         from_secret: deployer-prod-privatekey
     commands:
       - cd packages/smart-contract
-      - npm run deploy -- --network bellecour
+      - npm run deploy -- --network bellecour --verify
     when:
       target:
         - smart-contract-deploy-prod
@@ -86,8 +86,11 @@ steps:
       ENV: prod
     commands:
       - cd environments
-      - KEY=dataprotectorContractAddress VALUE=$(cat ../packages/smart-contract/deployments/DataProtector/address) npm run update-env
-      - KEY=dataprotectorStartBlock VALUE=$(cat ../packages/smart-contract/deployments/DataProtector/block) npm run update-env
+      - |
+        ADDRESS=$(jq -r '.contractAddress' ../packages/smart-contract/ignition/deployments/chain-134/journal.jsonl)
+        BLOCK=$(jq -r '.blockNumber' ../packages/smart-contract/ignition/deployments/chain-134/journal.jsonl)
+        KEY=dataprotectorContractAddress VALUE=$ADDRESS npm run update-env
+        KEY=dataprotectorStartBlock VALUE=$BLOCK npm run update-env
       - git add environments.json
       - git commit -m "$DRONE_DEPLOY_TO deployment $DRONE_BUILD_NUMBER $DRONE_COMMIT" --author="drone-product <[email protected]>"
     when:
@@ -100,8 +103,11 @@ steps:
       ENV: staging
     commands:
       - cd environments
-      - KEY=dataprotectorContractAddress VALUE=$(cat ../packages/smart-contract/deployments/DataProtector/address) npm run update-env
-      - KEY=dataprotectorStartBlock VALUE=$(cat ../packages/smart-contract/deployments/DataProtector/block) npm run update-env
+      - |
+        ADDRESS=$(jq -r '.contractAddress' ../packages/smart-contract/ignition/deployments/chain-134/journal.json)
+        BLOCK=$(jq -r '.blockNumber' ../packages/smart-contract/ignition/deployments/chain-134/journal.json)
+        KEY=dataprotectorContractAddress VALUE=$ADDRESS npm run update-env
+        KEY=dataprotectorStartBlock VALUE=$BLOCK npm run update-env
       - git add environments.json
       - git commit -m "$DRONE_DEPLOY_TO deployment $DRONE_BUILD_NUMBER $DRONE_COMMIT" --author="drone-product <[email protected]>"
     when:
@@ -120,12 +126,6 @@ steps:
         - smart-contract-deploy-prod
         - smart-contract-deploy-staging
 
-  - name: verify contract
-    image: node:18.19
-    commands:
-      - cd packages/smart-contract
-      - npm run verify -- --network bellecour $(cat deployments/DataProtector/address) $(cat deployments/DataProtector/args)
-
 ---
 # deploy sharing smart contract to prod, staging or dev
 kind: pipeline

.gitignore

@@ -14,5 +14,3 @@ node_modules
 .env
 *.log
 *.env
-
-**/deployments

packages/smart-contract/.env.template

@@ -9,3 +9,6 @@ RPC_URL=
 
 ## Mnemonic for the network
 MNEMONIC=
+
+## Arbiscan API key to verify contracts
+ARBISCAN_API_KEY=

packages/smart-contract/.gitignore

@@ -1,4 +1,4 @@
-n# Hardhat files
+# Hardhat files
 cache
 artifacts
 
@@ -10,6 +10,5 @@ typechain-types
 coverage
 coverage.json
 
-#smart contract
-.smart-contract-address
-.constructor-args-params
+# Deployment files
+**/deployments/chain-31337

packages/smart-contract/CHANGELOG.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 ## Next
 
+### Added
+
+- Support for Arbitrum and Avalanche Fuji testnets (#429).
+
+### Changed
+
+- Integrated Hardhat Ignition for CREATE2 deployment using the CreateX factory for new chain deployments (#429).
+
 ### Changed
 
 - update blockscout url

packages/smart-contract/README.md

@@ -1,10 +1,37 @@
-#Contract Name: DataProtector
+# Contract Name: DataProtector
 
-####Description:
-This contract is use to attach schema on the dataset and publish it as an event.
+## Description
 
-#####Contract deployed Address:
+The `DataProtector` contract is designed to attach schemas to datasets and publish them as events.
 
-```bash
-0x3a4Ab33F3D605e75b6D00A32A0Fa55C3628F6A59
+## Deploying the Contract
+
+To deploy the contract, run the following command:
+
+```sh
+npm run deploy -- --network avalancheFuji
+```
+
+If no network is specified, the local Hardhat network will be used by default.
+
+**Note:** This deployment uses the `createX` factory through Hardhat Ignition. To modify the deployment address, update the `salt` value in the `hardhat.config.json` file.
+
+## Verifying the Contract
+
+To verify the contract during deployment, include the `--verify` option in the deployment command:
+
+```sh
+npm run deploy -- --network avalancheFuji --verify
+```
+
+If the contract has already been deployed, you can verify it separately using the following command:
+
+```sh
+npx hardhat ignition verify chain-43113
 ```
+
+This ensures the contract's source code is verified on the blockchain explorer for the specified network.
+
+## Deployed Contract Address
+
+Refer to the `../../environments/environments.json` file to find the deployed contract address for the respective environment.

packages/smart-contract/config/env.ts

@@ -24,6 +24,9 @@ const envSchema = z.object({
 
     // Mnemonic de déploiement ou interaction réseau
     MNEMONIC: z.string().min(1, 'MNEMONIC cannot be empty').optional().or(z.literal('')),
+
+    // Arbiscan API key
+    ARBISCAN_API_KEY: z.string().optional().or(z.literal('')),
 });
 
 export const env = envSchema.parse(process.env);

packages/smart-contract/hardhat.config.ts

@@ -4,6 +4,18 @@ import { env } from './config/env';
 
 const privateKey = env.WALLET_PRIVATE_KEY;
 
+// Avalanche Fuji specific configuration
+const fujiBaseConfig = {
+    blockGasLimit: 8_000_000,
+    chainId: 43113,
+};
+
+// Arbitrum Sepolia specific configuration
+const arbitrumSepoliaBaseConfig = {
+    blockGasLimit: 30_000_000, // Arbitrum has higher block gas limits
+    chainId: 421614,
+};
+
 const config: HardhatUserConfig = {
     networks: {
         hardhat: {
@@ -18,6 +30,18 @@ const config: HardhatUserConfig = {
             gasPrice: 0,
             accounts: privateKey ? [privateKey] : [],
         },
+        // Add Fuji as a network
+        avalancheFuji: {
+            url: env.RPC_URL || 'https://api.avax-test.network/ext/bc/C/rpc',
+            accounts: privateKey ? [privateKey] : [],
+            ...fujiBaseConfig,
+        },
+        // Add Arbitrum Sepolia as a network
+        arbitrumSepolia: {
+            url: env.RPC_URL || 'https://sepolia-rollup.arbitrum.io/rpc',
+            accounts: privateKey ? [privateKey] : [],
+            ...arbitrumSepoliaBaseConfig,
+        },
         // poco-chain native config
         'dev-native': {
             chainId: 65535,
@@ -31,7 +55,9 @@ const config: HardhatUserConfig = {
     //to verify contract on Blockscout
     etherscan: {
         apiKey: {
-            bellecour: 'abc',
+            bellecour: 'nothing', // a non-empty string is needed by the plugin.
+            avalancheFuji: 'nothing', // a non-empty string is needed by the plugin.
+            arbitrumSepolia: env.ARBISCAN_API_KEY || '',
         },
         customChains: [
             {
@@ -44,9 +70,17 @@ const config: HardhatUserConfig = {
             },
         ],
     },
+    // Create2 deployments: it use crateX factory to deploy the contract
+    ignition: {
+        strategyConfig: {
+            create2: {
+                salt: '0x0000000000000000000000000000000000000000000000000000000000000000',
+            },
+        },
+    },
     //compiler version
     solidity: {
-        version: '0.8.19',
+        version: '0.8.29',
         settings: {
             optimizer: {
                 enabled: true,

packages/smart-contract/ignition/modules/DataProtector.ts

@@ -0,0 +1,14 @@
+import { buildModule } from '@nomicfoundation/hardhat-ignition/modules';
+import { DATASET_REGISTRY_ADDRESS as defaultDatasetRegistryAddress } from '../../config/config';
+import { env } from '../../config/env';
+
+export default buildModule('DataProtectorModule', (m) => {
+    // Get registry address from environment or default
+    const datasetRegistryAddress = env.DATASET_REGISTRY_ADDRESS || defaultDatasetRegistryAddress;
+
+    // Deploy DataProtector with the registry address as constructor argument
+    const dataProtector = m.contract('DataProtector', [datasetRegistryAddress]);
+
+    // Return the deployed contract
+    return { dataProtector };
+});