Release/1.1.0

.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,39 @@
+name: Upgrade
+on:
+  workflow_dispatch:
+      inputs:
+        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.network }} # 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: Upgrade
+      env:
+        NETWORK: ${{ inputs.network }}
+        IS_LOCAL_FORK: ${{ inputs.network == 'hardhat'}}
+        PROD_PRIVATE_KEY: ${{ inputs.network == 'bellecour' && secrets.PROD_PRIVATE_KEY || '' }}
+      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

.prettierignore

@@ -0,0 +1,3 @@
+*.yml
+*json
+*.md

.prettierrc

@@ -8,16 +8,12 @@
         "prettier-plugin-organize-imports",
         "prettier-plugin-solidity"
     ],
-    "pluginsComments": {
-        "prettier-plugin-organize-import": "Supports .ts files (not .sol)",
-        "prettier-plugin-solidity": "Does not support imports sorting yet. See prettier-solidity/prettier-plugin-solidity#918"
-    },
     "overrides": [
         {
-          "files": "*.sol",
-          "options": {
-                "singleQuote": false 
-            }    
+            "files": "*.sol",
+            "options": {
+                "singleQuote": false
+            }
         }
-      ]
+    ]
 }

.solhint.json

@@ -0,0 +1,22 @@
+{
+  "extends": [
+    "solhint:recommended"
+  ],
+  "plugins": [],
+  "rules": {
+    "compiler-version": [
+      "error",
+      "^0.8.20"
+    ],
+    "func-visibility": [
+      "warn",
+      {
+        "ignoreConstructors": true
+      }
+    ],
+    "quotes": [
+      "error",
+      "double"
+    ]
+  }
+}

.solhintignore

@@ -0,0 +1 @@
+hardhat-dependency-compiler

CHANGELOG.md

@@ -1,15 +1,35 @@
 # Changelog
 
+## vNEXT
+
+## v1.1.0
+
+- Index first parameter of match an claim events in `Voucher` contract. (#61, #72)
+- Add upgrade workflow. (#64)
+- Add Halborn "Poco v5.5 & Voucher v1.0" audit report ( #70)
+- Add type-checking script (#53)
+- Run partial upgrade tests on fork.
+  - Should maintain consistent voucher addresses (#61)
+  - Should upgrade decimals (#58)
+- Implement `VoucherHub` upgrade and test it on GitHub Action CI using a local fork. (#57)
+- Relocate `decimals()` function in VoucherHub smart contract. (#56)
+- Better handling for env variables. (#55)
+- Remove references to blockscout v5. (#49)
+- Override the decimals function of ERC-20 to set the token's decimal precision to 9, aligning with RLC standards. (#50)
+- Verify VoucherProxy contracts. (#51)
+
 ## v1.0.0
 
 ### What's new?
+
 - Allow users to access resources of the iExec network via a sponsorship voucher.
 
 ### More details
+
 - Upgrade Solidity Compiler to `v0.8.27`. (#45)
 - Bump dependencies: (#44)
-    - `@openzeppelin/hardhat-upgrades`, `hardhat`, `ethers`, `prettier`, and others [minor version bump]
-    - `prettier-plugin-organize-imports@4`
+  - `@openzeppelin/hardhat-upgrades`, `hardhat`, `ethers`, `prettier`, and others [minor version bump]
+  - `prettier-plugin-organize-imports@4`
 - Add `getVoucherProxyCodeHash(..)` & `isRefundedTask(..)` view functions. (#43)
 - Add `predictVoucher(..)` & `isVoucher(..)` functions. (#42)
 - Generate UML class diagram for contracts. (#41)
@@ -40,12 +60,12 @@
 - Match orders through voucher. (#12)
 - Add external-hardhat network configuration. (#11)
 - Add voucher credit and SRLC manipulation. (#10)
-    - SRLC and iExec poco is mocked.
-    - set voucher credit as VoucherHub is ERC20.
+  - SRLC and iExec poco is mocked.
+  - set voucher credit as VoucherHub is ERC20.
 - Upgrade configuration: (#9)
-    - Upgrade dependencies: hardhat, husky, iExec Poco.
-    - Ignore mocks in coverage.
-    - Add solidity optimizer and use Bellecour network config.
+  - Upgrade dependencies: hardhat, husky, iExec Poco.
+  - Ignore mocks in coverage.
+  - Add solidity optimizer and use Bellecour network config.
 - Add role-based access control to VoucherHub. (#8)
 - Create voucher from VoucherHub with : type, expiration, authorize list. (#6)
 - Create vouchers with create2. (#5)

README.md

@@ -25,33 +25,49 @@ Deployment configuration can also be provided/overridden using env variables:
 * `IEXEC_VOUCHER_MINTER_ACCOUNT_INDEX`
 
 Run:
+
 ```
 npx hardhat deploy --network <name>
 ```
 
 #### Local Bellecour fork
 
+Complete the `.env` file with the following variables:
+
 ```
-LOCAL_FORK=true MNEMONIC=<mnemonic> npx hardhat deploy --network hardhat
+IS_LOCAL_FORK=true
+MNEMONIC=<mnemonic>
+```
+
+If a `MNEMONIC` is not provided, the default Hardhat one will be used.
+
+```
+npx hardhat node
 ```
 
 #### Bellecour
 
 With appropriate deployer key:
+
 ```
 npx hardhat deploy --network bellecour
 ```
 
 ### Verify contracts
 
-- Blockscout v5
-
 ```
-BLOCKSCOUT_VERSION=v5 npx hardhat run ./scripts/verify.ts --network bellecour
+npx hardhat run ./scripts/verify.ts --network bellecour
 ```
 
-- Blockscout v6
+Once a Voucher (proxy) is deployed, it can be verified with:
 
 ```
-npx hardhat run ./scripts/verify.ts --network bellecour
+npx hardhat verify <voucherProxyAddress> --network bellecour <beaconAddress>
 ```
+
+Note: no need to verify all VoucherProxy contracts because Blockscout automatically
+matches all similar contracts with the submitted source code.
+
+## Audits
+
+All contract audit files can be found in [audit/](./audit/) folder.

config/deployment.json

@@ -2,7 +2,8 @@
     "31337": {
         "factory": true,
         "salt": "0x0000000000000000000000000000000000000000000000000000000000000000",
-        "pocoAddress": "0x123456789a123456789b123456789b123456789d"
+        "pocoAddress": "0x123456789a123456789b123456789b123456789d",
+        "voucherHubAddress": "0x63264C515d0121B0C167098aF1661d8ADE7BCD3d"
     },
     "65535": {
         "factory": true,
@@ -12,6 +13,7 @@
     "134": {
         "factory": true,
         "salt": "0x0000000000000000000000000000000000000000000000000000000000000000",
-        "pocoAddress": "0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f"
+        "pocoAddress": "0x3eca1B216A7DF1C7689aEb259fFB83ADFB894E7f",
+        "voucherHubAddress": "0x3137B6DF4f36D338b82260eDBB2E7bab034AFEda"
     }
 }

config/deployment.ts

@@ -1,13 +1,15 @@
 // SPDX-FileCopyrightText: 2024 IEXEC BLOCKCHAIN TECH <contact@iex.ec>
 // SPDX-License-Identifier: Apache-2.0
 
-const deploymentConfig = require('./deployment.json') as DeploymentConfig;
-export default deploymentConfig;
+import deploymentConfigRaw from './deployment.json';
 
 export type DeploymentConfig = {
     [chainId: string]: {
         factory: boolean;
         salt: string;
         pocoAddress: string;
+        voucherHubAddress?: string; //some chains used doesn't have the voucher deployed
     };
 };
+
+export default deploymentConfigRaw as DeploymentConfig;