refactor: consolidate CI workflows and update environment variables for smart contract deployment

Author: Le-Caignec

.github/workflows/sharing-smart-contract-ci.yml

@@ -11,72 +11,33 @@ on:
           - hardhat
           - avalancheFujiTestnet
           - arbitrumSepolia
+          - arbitrum
           - bellecour
         default: 'hardhat'
-      environment:
-        description: 'Environment'
-        required: true
-        type: choice
-        options:
-          - testnets
-          - mainnets
-        default: 'testnets'
 
 jobs:
-
-  # Validate deployment network and environment.
-  validate:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      # On Github, the environment `mainnets` is restricted to
-      # the main branch. Here we check that it's only used with
-      # mainnet networks.
-      - name: Validate mainnet deployment
-        run: |
-          if [[ "${{ inputs.environment }}" == "mainnets" && "${{ inputs.network }}" != "bellecour" ]]; then
-              echo "::error::mainnets environment can only be used with mainnet networks."
-              exit 1
-          fi
-          echo "Deploying to network '${{ inputs.network }}' with environment '${{ inputs.environment }}'."
-
   # Build and test before deploying.
-  ci:
-    needs: validate
-    uses: ./.github/workflows/sharing-smart-contracts-reusable.yml
+  build-and-test:
+    uses: ./.github/workflows/sharing-smart-contracts-ci.yml
     with:
-      node-version: 18
+      node-version: 20
 
   # Deploy and verify contract.
   deploy:
-    needs: ci
+    needs: build-and-test
     runs-on: ubuntu-latest
     permissions:
       contents: write # Required to commit deployment files.
-    environment: ${{ inputs.environment }}
+    environment: ${{ inputs.network }}
     steps:
-      - name: Set environment variables
-        id: set-env
-        run: |
-          echo "PRIVATE_KEY=${{ secrets.PRIVATE_KEY }}" >> $GITHUB_ENV
-
-          if [ "${{ inputs.network }}" == "arbitrumSepolia" ]; then
-            echo "POCO_ADDRESS=0x14B465079537655E1662F012e99EBa3863c8B9E0" >> $GITHUB_ENV
-            echo "DATASET_REGISTRY_ADDRESS=0x3441A0C9FE488c51fcABa2bAAA048720f4D4F72D" >> $GITHUB_ENV
-            echo "ETHERSCAN_API_KEY=${{ secrets.ETHERSCAN_API_KEY }}" >> $GITHUB_ENV
-            echo "DEPLOYMENT_ID=chain-421614" >> $GITHUB_ENV
-          fi
-
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0
+          submodules: recursive
 
       - uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
+          cache: 'npm'
 
       - name: Install dependencies
         working-directory: packages/sharing-smart-contract
@@ -90,7 +51,15 @@ jobs:
 
       - name: Deploy contracts
         working-directory: packages/sharing-smart-contract
-        run: npm run deploy -- --network ${{ inputs.network }}
+        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 }}
+          # For Verification
+          ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
+        run: npm run deploy -- --network ${{ inputs.network }} --deployment-id ${{ inputs.network }} --verify
 
       - name: Save deployment artifacts
         if: inputs.network != 'hardhat'
@@ -101,7 +70,3 @@ jobs:
           commit_user_name: 'GitHub Actions Bot'
           commit_user_email: 'github-actions[bot]@users.noreply.github.com'
           commit_author: 'GitHub Actions Bot <github-actions[bot]@users.noreply.github.com>'
-
-      - name: Verify contracts
-        working-directory: packages/sharing-smart-contract
-        run: echo "TODO" # npm run verify:ignition -- $DEPLOYMENT_ID

.github/workflows/sharing-smart-contract-deploy.yml

@@ -1,13 +1,22 @@
-name: Sharing Smart Contract - Reusable
+name: Sharing Smart Contract - Default
 
 on:
+  pull_request:
+    branches:
+      - '*'
+    paths:
+      - 'packages/sharing-smart-contract/**'
   workflow_call:
     inputs:
       node-version:
         description: Node.js version to use
         required: true
         type: number
-        default: 18
+        default: 20
+
+concurrency:
+  group: ${{ github.ref }}-sharing-smart-contract-ci
+  cancel-in-progress: true
 
 jobs:
   build-and-test:
@@ -23,6 +32,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ inputs.node-version }}
+          cache: 'npm'
 
       - name: Install Dependencies
         working-directory: packages/sharing-smart-contract
@@ -51,12 +61,13 @@ jobs:
         run: npm run uml
 
       - name: Static Analyzer
-        uses: crytic/[email protected].0
+        uses: crytic/[email protected].1
         id: slither
         with:
-          sarif: result.sarif
-          fail-on: none
           target: 'packages/sharing-smart-contract/'
+          slither-args: --checklist --markdown-root ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}/
+          fail-on: none
+          sarif: result.sarif
 
       - name: Start Anvil
         run: |

…ows/sharing-smart-contracts-reusable.yml …workflows/sharing-smart-contracts-ci.yml.github/workflows/sharing-smart-contracts-reusable.yml renamed to .github/workflows/sharing-smart-contracts-ci.yml .github/workflows/sharing-smart-contracts-reusable.yml renamed to .github/workflows/sharing-smart-contracts-ci.yml

@@ -1,5 +1,5 @@
 # wallet used for transactions
-PRIVATE_KEY=...
+DEPLOYER_PRIVATE_KEY=...
 
 # environment to use for configuration (prod/staging). The default is prod.
 ENV=...

packages/sharing-smart-contract/.env.template

@@ -1 +1 @@
-18
+20

packages/sharing-smart-contract/.nvmrc

@@ -35,22 +35,22 @@ module.exports = {
     bellecour: {
       ...bellecourBase,
       url: 'https://bellecour.iex.ec',
-      accounts: env.PRIVATE_KEY ? [env.PRIVATE_KEY] : [],
+      accounts: env.DEPLOYER_PRIVATE_KEY ? [env.DEPLOYER_PRIVATE_KEY] : [],
     },
     avalancheFujiTestnet: {
       chainId: 43113,
-      url: env.FUJI_RPC_URL || 'https://api.avax-test.network/ext/bc/C/rpc',
+      url: env.RPC_URL || 'https://api.avax-test.network/ext/bc/C/rpc',
       accounts: [
-        env.PRIVATE_KEY ||
+        env.DEPLOYER_PRIVATE_KEY ||
           '0x0000000000000000000000000000000000000000000000000000000000000000',
       ],
       blockGasLimit: 8_000_000,
     },
     arbitrumSepolia: {
       chainId: 421614,
-      url: env.ARBITRUM_SEPOLIA_RPC_URL || 'https://sepolia-rollup.arbitrum.io/rpc',
+      url: env.RPC_URL || 'https://sepolia-rollup.arbitrum.io/rpc',
       accounts: [
-        env.PRIVATE_KEY ||
+        env.DEPLOYER_PRIVATE_KEY ||
           '0x0000000000000000000000000000000000000000000000000000000000000000',
       ],
       blockGasLimit: 30_000_000,

packages/sharing-smart-contract/hardhat.config.cjs

@@ -9,7 +9,6 @@
     "clean": "hardhat clean",
     "compile": "hardhat clean && hardhat compile && npm run artifact-to-abis",
     "verify:ignition": "hardhat ignition verify --include-unrelated-contracts",
-    "verify": "hardhat verify",
     "deploy": "hardhat run scripts/deploy.js",
     "update-env": "hardhat run ./scripts/updateEnv.js",
     "upgrade": "hardhat run ./scripts/upgrade.js",
@@ -58,4 +57,4 @@
     "iexec": "^8.15.0",
     "rimraf": "^6.0.1"
   }
-}
+}