Release/1.0.1 (#77)

Author: gfournierPro

.env.template

@@ -0,0 +1,26 @@
+# The mnemonic phrase used to derive the wallet's private keys
+MNEMONIC=
+
+# Index of the account generated from the mnemonic to be used as the Voucher Manager
+IEXEC_VOUCHER_MANAGER_ACCOUNT_INDEX=
+
+# Index of the account generated from the mnemonic to be used as the Voucher Minter
+IEXEC_VOUCHER_MINTER_ACCOUNT_INDEX=
+
+# The private key for accessing the production account
+PROD_PRIVATE_KEY=
+
+# Flag to indicate whether to use a local blockchain fork (set to 'true' for local fork development)
+IS_LOCAL_FORK=
+
+# Override the default iExec PoCo (Proof-of-Contribution) contract address
+IEXEC_POCO_ADDRESS=
+
+# Override the default iExec Voucher Hub contract address
+IEXEC_VOUCHER_HUB_ADDRESS=
+
+# Indicates whether the deployment involves a factory contract
+USE_FACTORY=
+
+# enable to display hardhat report on gas usage
+REPORT_GAS=

.github/workflows/main.yml

@@ -1,38 +1,68 @@
+name: Voucher Smart Contract CI
+
 on:
   push:
     branches:
       - feature/*
       - bugfix/*
-      - develop
       - release/*
       - hotfix/*
+      - develop
       - main
 
+concurrency:
+  group: ci-${{ github.head_ref }}
+  cancel-in-progress: true
+
 jobs:
   coverage:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Init
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+      - name: Install Dependencies
         run: npm ci
-      - name: Run coverage
-        run: npm run coverage
+      - name: Check Format
+        run: npm run check-format
+      - name: Check Lint
+        run: npm run check-lint
+      - name: Build
+        run: npm run build
+      - name: Check Types
+        run: npm run check-types
+      - name: Generate UML
+        run: npm run uml
+      - name: Run partial upgrade tests on fork
+        env:
+          IS_LOCAL_FORK: true
+        run: npm run test test/NextVersionUpgrade.test.ts
+      - name: Simulate upgrade on fork
+        env:
+          USE_FACTORY: false
+          IS_LOCAL_FORK: true
+        run: npm run upgrade
+      - name: Run Tests
+        run: npm run test -- --bail
+      - name: Run Coverage
+        run: npm run coverage #coverage only works on a non-fork hardhat node
       - name: Upload coverage reports to Codecov
         uses: codecov/codecov-action@v4.0.1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           slug: iExecBlockchainComputing/iexec-voucher-contracts
       - name: Run static analysis with slither
         uses: crytic/slither-action@v0.4.0
-        id: slither
         with:
           target: "contracts/"
           slither-args: --checklist --markdown-root ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}/
-          node-version: "20"
           fail-on: none # TODO set this to high or other
           sarif: results.sarif
       - name: Upload SARIF file
         uses: github/codeql-action/upload-sarif@v3
         with:
-          sarif_file: ${{ steps.slither.outputs.sarif }}
+          sarif_file: results.sarif

.github/workflows/upgrade.yml

@@ -0,0 +1,56 @@
+name: Upgrade
+on:
+  workflow_dispatch:
+      inputs:
+        environment:  
+          description: 'Github environnment (mainnets or testnets)'
+          required: true
+          type: choice
+          options:
+          - mainnets
+          - testnets
+        network:
+          description: 'Network'
+          required: true
+          type: choice
+          options:
+          - hardhat
+          - bellecour
+jobs:
+  upgrade:
+    runs-on: ubuntu-latest
+    permissions:
+        contents: write # required by git-auto-commit-action
+    environment: ${{ inputs.environment }} # Secrets for an environment are already limited to deployments on specific branches
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: 22
+        cache: 'npm'
+    - name: Install dependencies
+      run: npm ci
+    - name: Set private key based on network
+      id: set-private-key
+      run: |
+        case "${{ inputs.network }}" in
+          "bellecour")
+            echo "PROD_PRIVATE_KEY=${{ secrets.BELLECOUR_PRIVATE_KEY }}" >> $GITHUB_ENV
+            ;;
+          *)
+            echo "PROD_PRIVATE_KEY=''" >> $GITHUB_ENV
+            ;;
+        esac
+    - name: Upgrade
+      env:
+        NETWORK: ${{ inputs.network }}
+        IS_LOCAL_FORK: ${{ inputs.network == 'hardhat'}}
+      run: |
+        echo "Network: $NETWORK"
+        echo "Local fork: $IS_LOCAL_FORK"
+        npm run upgrade -- --network $NETWORK
+    - uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: Save files changed during upgrade

.gitignore

@@ -13,6 +13,7 @@ node_modules
 /coverage
 /coverage.json
 
+# deployments files
 /deployments/hardhat
 /deployments/external-hardhat
 /deployments/localhost