feat(deploy): add multi-chain deployment workflow with configuration management (#218)

* fix: rename avalancheFuji to avalancheFujiTestnet in network configurations
* feat: implement robust deployment workflow with GitHub Actions
* feat: create update-config.ts script to maintain deployment configurations
* feat: integrate contract verification into the deployment process
* feat: add support for additional networks including Avalanche Fuji and Arbitrum Sepolia
* feat: implement mainnet deployment safeguards requiring main branch for Bellecour
* fix: enhance error handling and logging in deployment scripts
* fix: ensure bytecode and constructor args are saved during deployment
* refactor: simplify environment variable handling in CI workflow
* docs: update documentation with improved deployment instructions
* test: skip tests for mainnet environments in deployment workflow

Author: gfournierPro

.github/workflows/deploy-smart-contracts.yml

@@ -0,0 +1,104 @@
+name: Deploy PoCo Contracts
+on:
+  workflow_dispatch:
+    inputs:
+      network:
+        description: 'Network'
+        required: true
+        type: choice
+        options:
+          - hardhat
+          - avalancheFujiTestnet
+          - arbitrumSepolia
+          - bellecour
+        default: 'hardhat'
+      environment:
+        description: 'Environment'
+        required: true
+        type: choice
+        options:
+          - testnets
+          - mainnets
+        default: 'testnets'
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Validate mainnet deployment conditions
+        run: |
+          #TODO remove this when we have other mainnets
+          if [[ "${{ inputs.environment }}" == "mainnets" && !("${{ inputs.network }}" == "bellecour" && "${{ github.ref }}" == "refs/heads/main") ]]; then
+            echo "::error::Bellecour mainnet deployments must be made from the main branch. Current branch: ${GITHUB_REF#refs/heads/}"
+            exit 1
+          fi
+
+          echo "Deployment validation passed!"
+  deploy:
+    needs: validate
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write # Required for saving deployment
+    environment: ${{ inputs.environment }} # Use the selected environment
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Nodejs
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm' # Cache dependencies
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: |
+          if [ "${{ inputs.network }}" == "arbitrumSepolia" ]; then
+            npm run test:arbitrumSepolia
+          elif [ "${{ inputs.network }}" == "avalancheFujiTestnet" ]; then
+            npm run test:fuji
+          else
+            npm run test
+          fi
+
+      - name: Set environment variables
+        id: set-env
+        run: |
+          echo "PRIVATE_KEY=${{ secrets.PRIVATE_KEY }}" >> $GITHUB_ENV
+          if [ "${{ inputs.network }}" == "avalancheFujiTestnet" ]; then
+            echo "FUJI_RPC_URL=${{ secrets.FUJI_RPC_URL }}" >> $GITHUB_ENV
+            echo "SNOWTRACE_API_KEY=${{ secrets.SNOWTRACE_API_KEY }}" >> $GITHUB_ENV  
+          fi
+
+          if [ "${{ inputs.network }}" == "arbitrumSepolia" ]; then
+            echo "ARBITRUM_SEPOLIA_RPC_URL=${{ secrets.ARBITRUM_SEPOLIA_RPC_URL }}" >> $GITHUB_ENV
+            echo "ARBISCAN_API_KEY=${{ secrets.ARBISCAN_API_KEY }}" >> $GITHUB_ENV
+          fi
+
+          if [ "${{ inputs.network }}" == "bellecour" ]; then
+            echo "BELLECOUR_RPC_URL=${{ secrets.BELLECOUR_RPC_URL }}" >> $GITHUB_ENV
+          fi
+
+      - name: Deploy contracts
+        run: |
+          echo "Deploying to: ${{ inputs.network }} with ${{ inputs.environment }} environment"
+          npm run deploy -- --network ${{ inputs.network }}
+
+      - name: Update config.json with ERC1538Proxy address
+        if: inputs.network != 'hardhat'
+        run: npx hardhat run scripts/tools/update-config.ts --network ${{ inputs.network }}
+
+      - name: Save deployment artifacts and updated config
+        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 }})'
+          file_pattern: 'deployments/${{ inputs.network }}/* config/config.json'
+          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>'

CHANGELOG.md

@@ -9,6 +9,7 @@
 - [x] `IexecPoco2Delegate.sol`
 
 ### Features
+- Add gitub action workflow for deployment (#218)
 - Fix new testnets chain name (#217)
 - Deploy on new testnet chains using CreateX factory (#216)
 - Add CreateX factory for new chain deployment (#215)

README.md

@@ -1,3 +1,5 @@
+# iExec PoCo Smart Contracts
+
 [![codecov](https://codecov.io/github/iExecBlockchainComputing/PoCo/graph/badge.svg)](https://codecov.io/github/iExecBlockchainComputing/PoCo)
 
 # Introduction
@@ -117,23 +119,40 @@ npm run test
 
 ## Deploy
 
-You can deploy the smart contracts according to the [deploy/0_deploy.ts](./deploy/0_deploy.ts) content. This will automatically save some addresses of the deployed artifacts to the `./build` folder.
+The iExec PoCo contracts support automated deployment through both command-line interface and GitHub Actions workflows.
+
+### Command Line Deployment
+
+You can deploy the smart contracts according to the [deploy/0_deploy.ts](./deploy/0_deploy.ts) content. This will automatically save some addresses of the deployed artifacts to the `./deployments` folder.
 
-To do so:
+To deploy using the CLI:
 
-1. Make sure you followed the "Configure a deployment" section;
-2. Enter your targeted blockchain parameters in `hardhat.config.ts` configuration file;
+1. Make sure you followed the "Configure a deployment" section above
+2. Enter your targeted blockchain parameters in `hardhat.config.ts`
 3. Run the deployment using:
+
 ```
 npx hardhat deploy --network <your network name>
 ```
 
-Example of "complex" deployment:
+Example with custom salt:
 
 ```
 SALT=0x0000000000000000000000000000000000000000000000000000000000000001 npx hardhat deploy --network hardhat
 ```
 
+
+### Manual Verification
+
+To manually verify contracts:
+
+```
+npx hardhat run ./scripts/verify.ts --network <your network name>
+```
+
+This script automatically reads all deployed contract addresses and their constructor arguments from the deployment artifacts and verifies them on the relevant block explorer.
+
+
 ## Formatting
 
 Format a specific file or files in a directory:

deploy/0_deploy.ts

@@ -53,7 +53,8 @@ import { linkContractToProxy } from '../utils/proxy-tools';
  */
 export default async function deploy() {
     console.log('Deploying PoCo..');
-    const chainId = (await ethers.provider.getNetwork()).chainId;
+    const network = await ethers.provider.getNetwork();
+    const chainId = network.chainId;
     const [owner] = await ethers.getSigners();
     const deploymentOptions = config.getChainConfigOrDefault(chainId);
     const factoryDeployer = new FactoryDeployer(owner, chainId);
@@ -209,6 +210,12 @@ export default async function deploy() {
     for (let i = 0; i < Number(catCountAfter); i++) {
         console.log(`Category ${i}: ${await iexecAccessorsInstance.viewCategory(i)}`);
     }
+
+    if (network.name !== 'hardhat' && network.name !== 'localhost') {
+        console.log('Waiting for block explorer to index the contracts...');
+        await new Promise((resolve) => setTimeout(resolve, 60000));
+        await import('../scripts/verify').then((module) => module.default());
+    }
 }
 
 async function getOrDeployRlc(token: string, owner: SignerWithAddress) {