Feature gitHub actions deployment pipeline

.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) {

hardhat.config.ts

@@ -175,10 +175,10 @@ const config: HardhatUserConfig = {
             },
         },
         // Add Fuji as a network
-        avalancheFuji: {
+        avalancheFujiTestnet: {
             url: process.env.FUJI_RPC_URL || 'https://api.avax-test.network/ext/bc/C/rpc',
             accounts: [
-                process.env.DEV_PRIVATE_KEY ||
+                process.env.PRIVATE_KEY ||
                     '0x0000000000000000000000000000000000000000000000000000000000000000',
             ],
             ...fujiBaseConfig,
@@ -187,7 +187,7 @@ const config: HardhatUserConfig = {
         arbitrumSepolia: {
             url: process.env.ARBITRUM_SEPOLIA_RPC_URL || 'https://sepolia-rollup.arbitrum.io/rpc',
             accounts: [
-                process.env.DEV_PRIVATE_KEY ||
+                process.env.PRIVATE_KEY ||
                     '0x0000000000000000000000000000000000000000000000000000000000000000',
             ],
             ...arbitrumSepoliaBaseConfig,
@@ -204,7 +204,7 @@ const config: HardhatUserConfig = {
             chainId: 134,
             url: 'https://bellecour.iex.ec',
             accounts: [
-                process.env.PROD_PRIVATE_KEY ||
+                process.env.PRIVATE_KEY ||
                     '0x0000000000000000000000000000000000000000000000000000000000000000',
             ],
             ...bellecourBaseConfig,
@@ -219,7 +219,7 @@ const config: HardhatUserConfig = {
     etherscan: {
         apiKey: {
             mainnet: process.env.ETHERSCAN_API_KEY || '',
-            avalancheFuji: 'nothing', // a non-empty string is needed by the plugin.
+            avalancheFujiTestnet: 'nothing', // a non-empty string is needed by the plugin.
             arbitrumSepolia: process.env.ARBISCAN_API_KEY || '',
             viviani: 'nothing', // a non-empty string is needed by the plugin.
             bellecour: 'nothing', // a non-empty string is needed by the plugin.
@@ -243,6 +243,9 @@ const config: HardhatUserConfig = {
             },
         ],
     },
+    sourcify: {
+        enabled: true,
+    },
     typechain: {
         outDir: 'typechain',
     },
@@ -316,7 +319,7 @@ task('test').setAction(async (taskArgs: any, hre, runSuper) => {
             networkName = 'arbitrumSepolia';
             deploymentsCopied = await copyDeployments(networkName);
         } else if (process.env.FUJI_FORK === 'true') {
-            networkName = 'avalancheFuji';
+            networkName = 'avalancheFujiTestnet';
             deploymentsCopied = await copyDeployments(networkName);
         }
         await runSuper(taskArgs);

package.json

@@ -15,7 +15,7 @@
     "clean": "rm -rf deployments/hardhat",
     "test": "npm run clean && REPORT_GAS=true npx hardhat test",
     "test:arbitrumSepolia": "npm run clean && ARBITRUM_SEPOLIA_FORK=true npx hardhat test",
-    "test:avalancheFuji": "npm run clean && FUJI_FORK=true npx hardhat test",
+    "test:avalancheFujiTestnet": "npm run clean && FUJI_FORK=true npx hardhat test",
     "test:native": "npm run clean && TEST__IS_NATIVE_CHAIN=true npx hardhat test test/byContract/IexecEscrow/IexecEscrowNative.test.ts",
     "coverage": "npx hardhat coverage",
     "verify": "npx hardhat verify",

scripts/boost/0_deploy-modules.ts

@@ -42,6 +42,7 @@ const genericFactoryAddress = require('@amxx/factory/deployments/GenericFactory.
         await deployments.save(module.name, {
             abi: [],
             address: moduleAddress,
+            bytecode: module.bytecode,
         });
     }
 })();

scripts/sponsoring/README.md

@@ -51,7 +51,7 @@ npx hardhat --network bellecour etherscan-verify
 ```
 and embedded `hardhat-verify` plugin of `hardhat` (v2.22.12):
 ```
-npx hardhat run ./scripts/sponsoring/verify.ts --network bellecour
+npx hardhat run ./scripts/verify.ts --network bellecour
 ```
 by previously modifiying the `.json` file produced by:
 ```

scripts/tools/update-config.ts

@@ -0,0 +1,68 @@
+import * as fs from 'fs';
+import { deployments, ethers } from 'hardhat';
+import * as path from 'path';
+import config from '../../utils/config';
+
+// Get the absolute path to the config file
+const configPath = path.resolve('config/config.json');
+
+async function main(): Promise<void> {
+    // Get network info from ethers
+    const network = await ethers.provider.getNetwork();
+    const networkName = network.name;
+    const chainId = network.chainId.toString();
+
+    console.log(`Working with network: ${networkName} (Chain ID: ${chainId})`);
+    const deployment = await deployments.get('ERC1538Proxy');
+    const contractAddress = deployment.address;
+
+    if (!contractAddress || contractAddress === 'null') {
+        console.error(`Failed to extract a valid ERC1538Proxy address from deployment file`);
+        process.exit(1);
+    }
+
+    console.log(`Found ERC1538Proxy address: ${contractAddress}`);
+    const localConfig = config;
+
+    // Ensure the chain structure exists
+    if (!localConfig.chains) {
+        localConfig.chains = {};
+    }
+
+    if (!localConfig.chains[chainId]) {
+        localConfig.chains[chainId] = {
+            _comment: `Chain ${chainId} (${networkName})`,
+            asset: 'Token', // Default value, update as needed
+            v3: {
+                Hub: null,
+                AppRegistry: null,
+                DatasetRegistry: null,
+                WorkerpoolRegistry: null,
+            },
+            v5: {},
+        };
+    }
+
+    if (!localConfig.chains[chainId].v5) {
+        localConfig.chains[chainId].v5 = {};
+    }
+
+    const contractKey = 'ERC1538Proxy';
+    const previousValue = localConfig.chains[chainId].v5[contractKey] || 'null';
+    localConfig.chains[chainId].v5[contractKey] = contractAddress;
+
+    // Write the updated config back to file
+    fs.writeFileSync(configPath, JSON.stringify(localConfig, null, 2));
+
+    console.log(`Updated ${chainId}.v5.${contractKey}:`);
+    console.log(`Previous: ${previousValue}`);
+    console.log(`New: ${contractAddress}`);
+}
+
+// Execute the main function and handle any errors
+main()
+    .then(() => process.exit(0))
+    .catch((error) => {
+        console.error('Error in update-config script:', error);
+        process.exit(1);
+    });