feat: enhance deployment workflow with environment selection and Arbitrum support

gfournierPro · gfournierPro · commit 236ec0d2f556 · 2025-07-25T11:23:43.000+02:00
diff --git a/.github/workflows/sharing-smart-contract-deploy.yml b/.github/workflows/sharing-smart-contract-deploy.yml
@@ -14,30 +14,40 @@ on:
           - arbitrum
           - bellecour
         default: 'hardhat'
+      environment:
+        description: 'Environment'
+        required: true
+        type: choice
+        options:
+          - dev
+          - prod
+        default: 'dev'
+
 
 jobs:
-  # Build and test before deploying.
   build-and-test:
     uses: ./.github/workflows/sharing-smart-contracts-ci.yml
     with:
       node-version: 20
 
-  # Deploy and verify contract.
   deploy:
     needs: build-and-test
     runs-on: ubuntu-latest
+    env:
+      CI: true
     permissions:
       contents: write # Required to commit deployment files.
     environment: ${{ inputs.network }}
     steps:
       - uses: actions/checkout@v4
         with:
-          submodules: recursive
+          fetch-depth: 0
 
       - uses: actions/setup-node@v4
         with:
           node-version: 20
           cache: 'npm'
+          cache-dependency-path: 'packages/sharing-smart-contract'
 
       - name: Install dependencies
         working-directory: packages/sharing-smart-contract
@@ -49,23 +59,56 @@ jobs:
           version: stable
           cache: true
 
+      - name: Validate deployment environment and prepare variables
+        if: inputs.network != 'hardhat'
+        run: |
+          NETWORK="${{ inputs.network }}"
+          ENVIRONMENT="${{ inputs.environment }}"
+          
+          case "$NETWORK" in
+            arbitrum|bellecour)
+              if [ "$ENVIRONMENT" = "dev" ]; then
+                echo "Error: Cannot deploy to mainnet ($NETWORK) with dev environment"
+                exit 1
+              fi
+              echo "IS_MAINNET=true" >> $GITHUB_ENV
+              ;;
+            *)
+              echo "IS_MAINNET=false" >> $GITHUB_ENV
+              ;;
+          esac
+
       - name: Deploy contracts
         working-directory: packages/sharing-smart-contract
         env:
           # For Deployment
           RPC_URL: ${{ secrets.RPC_URL }}
           DEPLOYER_PRIVATE_KEY: ${{ secrets.DEPLOYER_PRIVATE_KEY }}
-          POCO_ADDRESS: ${{ env.POCO_ADDRESS }}
-          DATASET_REGISTRY_ADDRESS: ${{ env.DATASET_REGISTRY_ADDRESS }}
+          POCO_ADDRESS: ${{ vars.POCO_ADDRESS }}
+          DATASET_REGISTRY_ADDRESS: ${{ vars.DATASET_REGISTRY_ADDRESS }}
           # For Verification
-          ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
-        run: npm run deploy -- --network ${{ inputs.network }} --deployment-id ${{ inputs.network }} --verify
+          EXPLORER_API_KEY: ${{ secrets.EXPLORER_API_KEY }}
+          IS_VERIFICATION_API_V2: ${{ vars.IS_VERIFICATION_API_V2 }}
+        run: |
+          if [ "${{ inputs.network }}" = "hardhat" ]; then
+            npm run deploy -- --network ${{ inputs.network }}
+          else
+            # For testnets, use network-environment; for mainnets, use network only
+            if [ "$IS_MAINNET" = false ]; then
+              DEPLOYMENT_ID="${{ inputs.network }}-${{ inputs.environment }}"
+            else
+              DEPLOYMENT_ID="${{ inputs.network }}"
+            fi
+            POCO_ADDRESS="${{ vars.POCO_ADDRESS }}" \
+            DATASET_REGISTRY_ADDRESS="${{ vars.DATASET_REGISTRY_ADDRESS }}" \
+              npm run deploy -- --network ${{ inputs.network }} --deployment-id "$DEPLOYMENT_ID" --verify
+          fi
 
       - name: Save deployment artifacts
         if: inputs.network != 'hardhat'
         uses: stefanzweifel/git-auto-commit-action@v5
         with:
-          commit_message: 'chore: save deployment artifacts for ${{ inputs.network }} (${{ inputs.environment }}, ${{ github.run_id }})'
+          commit_message: 'chore: save deployment artifacts for ${{ inputs.network }} ${{ inputs.environment }} (${{ github.run_id }})'
           file_pattern: 'packages/sharing-smart-contract/ignition/deployments/* packages/sharing-smart-contract/.openzeppelin/*'
           commit_user_name: 'GitHub Actions Bot'
           commit_user_email: 'github-actions[bot]@users.noreply.github.com'
diff --git a/.github/workflows/sharing-smart-contracts-ci.yml b/.github/workflows/sharing-smart-contracts-ci.yml
@@ -10,14 +10,10 @@ on:
     inputs:
       node-version:
         description: Node.js version to use
-        required: true
+        required: false
         type: number
         default: 20
 
-concurrency:
-  group: ${{ github.ref }}-sharing-smart-contract-ci
-  cancel-in-progress: true
-
 jobs:
   build-and-test:
     runs-on: ubuntu-latest
@@ -52,7 +48,7 @@ jobs:
         working-directory: packages/sharing-smart-contract
         run: npm run check-format
 
-      - name: Lint
+      - name: Check Lint
         working-directory: packages/sharing-smart-contract
         run: npm run lint
 
diff --git a/packages/sharing-smart-contract/.env.template b/packages/sharing-smart-contract/.env.template
@@ -16,4 +16,8 @@ RPC_URL=
 ## Mnemonic for the network
 MNEMONIC=
 
-ETHERSCAN_API_KEY=
+## API key to verify contracts
+EXPLORER_API_KEY=
+
+## Whether to use API V2 verification format
+IS_VERIFICATION_API_V2=
diff --git a/packages/sharing-smart-contract/CHANGELOG.md b/packages/sharing-smart-contract/CHANGELOG.md
@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
 
 ### Changed
 
+- CI fixes and add support for Arbitrum mainnet deployment (#)
 - Deploy on testnet and save artifacts (#444, #445)
 - Deploy DPS contract using Github action (#443)
 - Refactor sharing contract CI to use reusable workflows (#442)
diff --git a/packages/sharing-smart-contract/config/env.cjs b/packages/sharing-smart-contract/config/env.cjs
@@ -9,7 +9,7 @@ const privateKeyRegex = /(^|\b)(0x)?[0-9a-fA-F]{64}(\b|$)/;
 
 const envSchema = z.object({
     // Private key of the wallet used for transactions
-    PRIVATE_KEY: z
+    DEPLOYER_PRIVATE_KEY: z
         .string()
         .regex(privateKeyRegex, 'Invalid private key format')
         .optional()
@@ -45,7 +45,18 @@ const envSchema = z.object({
         .url('ARBITRUM_SEPOLIA_RPC_URL must be a valid URL')
         .optional(),
 
-    ETHERSCAN_API_KEY: z.string().optional(),
+    // API key for contract verification
+    EXPLORER_API_KEY: z.string().optional().or(z.literal('')),
+
+    // Whether to use API V2 verification format
+    IS_VERIFICATION_API_V2: z
+        .string()
+        .optional()
+        .default('true')
+        .refine((val) => val === 'true' || val === 'false', {
+            message: 'IS_VERIFICATION_API_V2 must be "true" or "false"',
+        })
+        .transform((val) => val === 'true'),
 });
 
 module.exports = envSchema.parse(process.env);
diff --git a/packages/sharing-smart-contract/hardhat.config.cjs b/packages/sharing-smart-contract/hardhat.config.cjs
@@ -55,6 +55,12 @@ module.exports = {
       ],
       blockGasLimit: 30_000_000,
     },
+    arbitrum: {
+      chainId: 42161,
+      url: env.RPC_URL || 'https://arb1.arbitrum.io/rpc',
+      accounts: env.DEPLOYER_PRIVATE_KEY ? [env.DEPLOYER_PRIVATE_KEY] : [],
+      blockGasLimit: 30_000_000,
+    },
     // poco-chain native config
     'dev-native': {
       chainId: 65535,
@@ -71,11 +77,14 @@ module.exports = {
   },
   // to verify smart-contract on Blockscout
   etherscan: {
-    apiKey: {
-      bellecour: 'nothing', // a non-empty string is needed by the plugin.
-      avalancheFujiTestnet: 'nothing', // a non-empty string is needed by the plugin.
-      arbitrumSepolia: env.ETHERSCAN_API_KEY || '',
-    },
+    apiKey: env.IS_VERIFICATION_API_V2
+      ? env.EXPLORER_API_KEY
+      : {
+          bellecour: env.EXPLORER_API_KEY || 'nothing', // a non-empty string is needed by the plugin.
+          avalancheFujiTestnet: env.EXPLORER_API_KEY || 'nothing', // a non-empty string is needed by the plugin.
+          arbitrumSepolia: env.EXPLORER_API_KEY || '',
+          arbitrum: env.EXPLORER_API_KEY || '',
+        },
     customChains: [
       {
         network: 'bellecour',
@@ -85,6 +94,15 @@ module.exports = {
           browserURL: 'https://blockscout.bellecour.iex.ec',
         },
       },
+      {
+        network: 'avalancheFujiTestnet',
+        chainId: 43113,
+        urls: {
+          // Snowtrace explorer.
+          apiURL: 'https://api.routescan.io/v2/network/testnet/evm/43113/etherscan/api',
+          browserURL: 'https://testnet.snowtrace.io/',
+        },
+      },
     ],
   },
   sourcify: {
