refactor(deployment): update deployment scripts for GitHub Actions

- Migrate deployment scripts from Drone to GitHub Actions environment variables
- Update configuration to support multi-environment deployments
- Improve environment-specific whitelisted apps configuration
- Update deployment scripts for new workflow compatibility

Author: abbesBenayache

deployment-dapp/package-lock.json

@@ -18,7 +18,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "iexec": "^8.15.0",
+    "iexec": "^8.16.1",
     "typescript": "^5.0.4",
     "yup": "^1.2.0"
   },

deployment-dapp/package.json

@@ -1,46 +1,11 @@
-import { readFileSync } from 'fs';
-
 //hosting url
-export const HOST = 'https://bellecour.iex.ec';
 
 //deployment parameters
 export const APP_NAME = 'web3mail';
 export const APP_TYPE = 'DOCKER';
 export const FRAMEWORK = 'scone';
 
-//publish sell order parameters
-export const DEFAULT_APP_PRICE = 0;
-export const DEFAULT_APP_VOLUME = 1000000;
 export const APP_TAG = ['tee', 'scone'];
 
-//ENS name
-export const WEB3_MAIL_ENS_NAME_DEV = 'web3mail-dev.apps.iexec.eth';
-export const WEB3_MAIL_ENS_NAME_PROD = 'web3mail.apps.iexec.eth';
-
-//scone image
-const SCONIFIER_VERSION = '5.7.5-v12';
-const dappVersion = JSON.parse(
-  readFileSync('../dapp/package.json', 'utf-8')
-).version;
-
 export const DOCKER_IMAGE_NAMESPACE = 'iexechub';
 export const DOCKER_IMAGE_REPOSITORY = 'web3mail-dapp';
-export const DOCKER_IMAGE_PROD_TAG = `${dappVersion}-sconify-${SCONIFIER_VERSION}-production`;
-export const DOCKER_IMAGE_DEV_TAG = `dev-${process.env.DRONE_COMMIT}-sconify-${SCONIFIER_VERSION}-production`;
-
-//drone target
-export const DRONE_TARGET_DEPLOY_DEV = 'dapp-dev';
-export const DRONE_TARGET_DEPLOY_PROD = 'dapp-prod';
-export const DRONE_TARGET_SELL_ORDER_DEV = 'dapp-publish-sell-order-dev';
-export const DRONE_TARGET_SELL_ORDER_PROD = 'dapp-publish-sell-order-prod';
-export const DRONE_TARGET_REVOKE_SELL_ORDER_DEV = 'dapp-revoke-sell-order-dev';
-export const DRONE_TARGET_REVOKE_SELL_ORDER_PROD =
-  'dapp-revoke-sell-order-prod';
-export const DRONE_TARGET_PUSH_SECRET_DEV = 'dapp-push-secret-dev';
-export const DRONE_TARGET_PUSH_SECRET_PROD = 'dapp-push-secret-prod';
-
-//Previous Web3mail dapp addresses
-export const WEB3MAIL_WHITELISTED_APPS_DEV =
-  '["0x600dc5ad1fdb376a37777298ff2c75a48fd220d2"]';
-export const WEB3MAIL_WHITELISTED_APPS_PROD =
-  '["0x0d8b899f2faa0fe9f0b17bcf4debd0cbc9e574ef"]';

deployment-dapp/src/config/config.ts

@@ -1,45 +1,19 @@
-import {
-  DRONE_TARGET_DEPLOY_DEV,
-  DRONE_TARGET_DEPLOY_PROD,
-  WEB3_MAIL_ENS_NAME_DEV,
-  WEB3_MAIL_ENS_NAME_PROD,
-} from './config/config.js';
-import { getIExec, loadAppAddress } from './utils/utils.js';
 import { configureEnsName } from './singleFunction/configureEnsName.js';
+import { getIExec, loadAppAddress } from './utils/utils.js';
 
 const main = async () => {
-  // get env variables from drone
-  const { DRONE_DEPLOY_TO, WALLET_PRIVATE_KEY_DEV, WALLET_PRIVATE_KEY_PROD } =
-    process.env;
-
-  if (
-    !DRONE_DEPLOY_TO ||
-    (DRONE_DEPLOY_TO !== DRONE_TARGET_DEPLOY_DEV &&
-      DRONE_DEPLOY_TO !== DRONE_TARGET_DEPLOY_PROD)
-  )
-    throw Error(`Invalid promote target ${DRONE_DEPLOY_TO}`);
+  const { RPC_URL, WALLET_PRIVATE_KEY, DAPP_ENS_NAME } = process.env;
 
   const appAddress = await loadAppAddress();
 
-  let privateKey;
-  let ensName;
-  if (DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_DEV) {
-    privateKey = WALLET_PRIVATE_KEY_DEV;
-    ensName = WEB3_MAIL_ENS_NAME_DEV;
-  } else if (DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_PROD) {
-    privateKey = WALLET_PRIVATE_KEY_PROD;
-    ensName = WEB3_MAIL_ENS_NAME_PROD;
-  }
-
-  if (!privateKey)
-    throw Error(`Failed to get privateKey for target ${DRONE_DEPLOY_TO}`);
-
-  if (!ensName)
-    throw Error(`Failed to get ens name for target ${DRONE_DEPLOY_TO}`);
+  if (!WALLET_PRIVATE_KEY)
+    throw Error(`Failed to get privateKey from environment variables`);
 
-  const iexec = getIExec(privateKey);
+  if (!DAPP_ENS_NAME)
+    throw Error(`Failed to get DAPP_ENS_NAME from environment variables`);
 
-  await configureEnsName(iexec, appAddress, ensName);
+  const iexec = getIExec(WALLET_PRIVATE_KEY, RPC_URL);
+  await configureEnsName(iexec, appAddress, DAPP_ENS_NAME);
 };
 
 main().catch((e) => {

deployment-dapp/src/configureEnsNameScript.ts

@@ -1,47 +1,30 @@
 import { deployApp } from './singleFunction/deployApp.js';
-import {
-  DOCKER_IMAGE_DEV_TAG,
-  DOCKER_IMAGE_PROD_TAG,
-  DRONE_TARGET_DEPLOY_DEV,
-  DRONE_TARGET_DEPLOY_PROD,
-} from './config/config.js';
 import { getIExec, saveAppAddress } from './utils/utils.js';
 
 const main = async () => {
-  // get env variables from drone
-  const { DRONE_DEPLOY_TO, WALLET_PRIVATE_KEY_DEV, WALLET_PRIVATE_KEY_PROD } =
-    process.env;
-
-  if (
-    !DRONE_DEPLOY_TO ||
-    (DRONE_DEPLOY_TO !== DRONE_TARGET_DEPLOY_DEV &&
-      DRONE_DEPLOY_TO !== DRONE_TARGET_DEPLOY_PROD)
-  )
-    throw Error(`Invalid promote target ${DRONE_DEPLOY_TO}`);
-
-  let privateKey;
-  if (DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_DEV) {
-    privateKey = WALLET_PRIVATE_KEY_DEV;
-  } else if (DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_PROD) {
-    privateKey = WALLET_PRIVATE_KEY_PROD;
-  }
-
-  if (!privateKey)
-    throw Error(`Failed to get privateKey for target ${DRONE_DEPLOY_TO}`);
-
-  const iexec = getIExec(privateKey);
-
-  let dockerImageTag;
-  if (DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_DEV) {
-    dockerImageTag = DOCKER_IMAGE_DEV_TAG;
-  } else if (DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_PROD) {
-    dockerImageTag = DOCKER_IMAGE_PROD_TAG;
+  // get env variables from GitHub Actions
+  const {
+    RPC_URL,
+    WALLET_PRIVATE_KEY,
+    DOCKER_IMAGE_TAG,
+    CHECKSUM,
+    FINGERPRINT,
+  } = process.env;
+
+  if (!WALLET_PRIVATE_KEY)
+    throw Error(`Missing WALLET_PRIVATE_KEY environment variable`);
+
+  const iexec = getIExec(WALLET_PRIVATE_KEY, RPC_URL);
+
+  if (!DOCKER_IMAGE_TAG) {
+    throw Error(`Missing DOCKER_IMAGE_TAG environment variable.`);
   }
 
-  //deploy app
   const address = await deployApp({
     iexec,
-    dockerTag: dockerImageTag,
+    dockerTag: DOCKER_IMAGE_TAG,
+    checksum: CHECKSUM,
+    fingerprint: FINGERPRINT,
   });
   await saveAppAddress(address);
 };

deployment-dapp/src/deployScript.ts

@@ -1,84 +1,26 @@
-import { getIExec, loadAppAddress } from './utils/utils.js';
 import { publishSellOrder } from './singleFunction/publishSellOrder.js';
-import { resolveName } from './singleFunction/resolveName.js';
-import {
-  DRONE_TARGET_SELL_ORDER_DEV,
-  DRONE_TARGET_SELL_ORDER_PROD,
-  DRONE_TARGET_DEPLOY_DEV,
-  DRONE_TARGET_DEPLOY_PROD,
-  WEB3_MAIL_ENS_NAME_DEV,
-  WEB3_MAIL_ENS_NAME_PROD,
-  DEFAULT_APP_PRICE,
-  DEFAULT_APP_VOLUME,
-} from './config/config.js';
+import { getIExec, loadAppAddress } from './utils/utils.js';
 import {
-  positiveStrictIntegerSchema,
   positiveNumberSchema,
+  positiveStrictIntegerSchema,
 } from './utils/validator.js';
 
 const main = async () => {
-  // get env variables from drone
-  const {
-    DRONE_DEPLOY_TO,
-    WALLET_PRIVATE_KEY_DEV,
-    WALLET_PRIVATE_KEY_PROD,
-    PRICE,
-    VOLUME,
-  } = process.env;
-
-  if (
-    !DRONE_DEPLOY_TO ||
-    ![
-      DRONE_TARGET_DEPLOY_DEV,
-      DRONE_TARGET_SELL_ORDER_DEV,
-      DRONE_TARGET_DEPLOY_PROD,
-      DRONE_TARGET_SELL_ORDER_PROD,
-    ].includes(DRONE_DEPLOY_TO)
-  )
-    throw Error(`Invalid promote target ${DRONE_DEPLOY_TO}`);
-
-  let privateKey;
-  if (
-    [DRONE_TARGET_DEPLOY_DEV, DRONE_TARGET_SELL_ORDER_DEV].includes(
-      DRONE_DEPLOY_TO
-    )
-  ) {
-    privateKey = WALLET_PRIVATE_KEY_DEV;
-  } else if (
-    [DRONE_TARGET_DEPLOY_PROD, DRONE_TARGET_SELL_ORDER_PROD].includes(
-      DRONE_DEPLOY_TO
-    )
-  ) {
-    privateKey = WALLET_PRIVATE_KEY_PROD;
-  }
-
-  if (!privateKey)
-    throw Error(`Failed to get privateKey for target ${DRONE_DEPLOY_TO}`);
+  const { RPC_URL, WALLET_PRIVATE_KEY, PRICE, VOLUME } = process.env;
 
-  const iexec = getIExec(privateKey);
+  const iexec = getIExec(WALLET_PRIVATE_KEY, RPC_URL);
 
-  const appAddress = await loadAppAddress().catch(() => {
-    console.log('No app address found falling back to ENS');
-    let ensName;
-    if (DRONE_DEPLOY_TO === DRONE_TARGET_SELL_ORDER_DEV) {
-      ensName = WEB3_MAIL_ENS_NAME_DEV;
-    } else if (DRONE_DEPLOY_TO === DRONE_TARGET_SELL_ORDER_PROD) {
-      ensName = WEB3_MAIL_ENS_NAME_PROD;
-    }
-    if (!ensName)
-      throw Error(`Failed to get ens name for target ${DRONE_DEPLOY_TO}`);
-    return resolveName(iexec, ensName);
-  });
+  const appAddress = await loadAppAddress();
 
   if (!appAddress) throw Error('Failed to get app address'); // If the app was not deployed, do not continue
 
   // validate params
   const price = await positiveNumberSchema()
-    .default(DEFAULT_APP_PRICE)
+    .required()
     .label('PRICE')
     .validate(PRICE);
   const volume = await positiveStrictIntegerSchema()
-    .default(DEFAULT_APP_VOLUME)
+    .required()
     .label('VOLUME')
     .validate(VOLUME);
 

deployment-dapp/src/publishSellOrderScript.ts

@@ -1,86 +1,39 @@
-import {
-  DRONE_TARGET_DEPLOY_DEV,
-  DRONE_TARGET_DEPLOY_PROD,
-  DRONE_TARGET_PUSH_SECRET_DEV,
-  DRONE_TARGET_PUSH_SECRET_PROD,
-  WEB3_MAIL_ENS_NAME_DEV,
-  WEB3_MAIL_ENS_NAME_PROD,
-  WEB3MAIL_WHITELISTED_APPS_DEV,
-  WEB3MAIL_WHITELISTED_APPS_PROD,
-} from './config/config.js';
 import { pushSecret } from './singleFunction/pushSecret.js';
-import { resolveName } from './singleFunction/resolveName.js';
 import { getIExec, loadAppAddress } from './utils/utils.js';
 
 const main = async () => {
-  // get env variables from drone
   const {
-    DRONE_DEPLOY_TO,
-    WALLET_PRIVATE_KEY_DEV,
-    WALLET_PRIVATE_KEY_PROD,
+    RPC_URL,
+    WALLET_PRIVATE_KEY,
     MJ_APIKEY_PUBLIC,
     MJ_APIKEY_PRIVATE,
     MJ_SENDER,
     MAILGUN_APIKEY,
+    WEB3MAIL_WHITELISTED_APPS,
   } = process.env;
 
-  if (
-    !DRONE_DEPLOY_TO ||
-    ![
-      DRONE_TARGET_DEPLOY_DEV,
-      DRONE_TARGET_DEPLOY_PROD,
-      DRONE_TARGET_PUSH_SECRET_DEV,
-      DRONE_TARGET_PUSH_SECRET_PROD,
-    ].includes(DRONE_DEPLOY_TO)
-  )
-    throw Error(`Invalid promote target ${DRONE_DEPLOY_TO}`);
-
+  if (!WALLET_PRIVATE_KEY)
+    throw Error(`Missing WALLET_PRIVATE_KEY environment variable`);
   if (!MJ_APIKEY_PUBLIC) throw Error('Missing env MJ_APIKEY_PUBLIC');
   if (!MJ_APIKEY_PRIVATE) throw Error('Missing env MJ_APIKEY_PRIVATE');
   if (!MJ_SENDER) throw Error('Missing env MJ_SENDER');
   if (!MAILGUN_APIKEY) throw Error('Missing env MAILGUN_APIKEY');
+  if (WEB3MAIL_WHITELISTED_APPS === undefined)
+    throw Error('Missing env WEB3MAIL_WHITELISTED_APPS');
 
-  let privateKey;
-  let baseWhitelistedApps;
-
-  if (
-    DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_DEV ||
-    DRONE_DEPLOY_TO === DRONE_TARGET_PUSH_SECRET_DEV
-  ) {
-    privateKey = WALLET_PRIVATE_KEY_DEV;
-    baseWhitelistedApps = JSON.parse(WEB3MAIL_WHITELISTED_APPS_DEV);
-  } else if (
-    DRONE_DEPLOY_TO === DRONE_TARGET_DEPLOY_PROD ||
-    DRONE_DEPLOY_TO === DRONE_TARGET_PUSH_SECRET_PROD
-  ) {
-    privateKey = WALLET_PRIVATE_KEY_PROD;
-    baseWhitelistedApps = JSON.parse(WEB3MAIL_WHITELISTED_APPS_PROD);
-  }
-
-  if (!privateKey)
-    throw Error(`Failed to get privateKey for target ${DRONE_DEPLOY_TO}`);
+  if (!WALLET_PRIVATE_KEY)
+    throw Error(`Missing WALLET_PRIVATE_KEY environment variable`);
 
-  const iexec = getIExec(privateKey);
+  const iexec = getIExec(WALLET_PRIVATE_KEY, RPC_URL);
 
-  const appAddress = await loadAppAddress().catch(() => {
-    console.log('No app address found falling back to ENS');
-    let ensName;
-    if (DRONE_DEPLOY_TO === DRONE_TARGET_PUSH_SECRET_DEV) {
-      ensName = WEB3_MAIL_ENS_NAME_DEV;
-    } else if (DRONE_DEPLOY_TO === DRONE_TARGET_PUSH_SECRET_PROD) {
-      ensName = WEB3_MAIL_ENS_NAME_PROD;
-    }
-    if (!ensName)
-      throw Error(`Failed to get ens name for target ${DRONE_DEPLOY_TO}`);
-    return resolveName(iexec, ensName);
-  });
+  const appAddress = await loadAppAddress();
 
   if (!appAddress) throw Error('Failed to get app address'); // If the app was not deployed, do not continue
+
   const fullWhitelistedApps = [
-    ...new Set([...baseWhitelistedApps, appAddress]),
+    ...new Set([...JSON.parse(WEB3MAIL_WHITELISTED_APPS), appAddress]),
   ];
-  //deploy app
-  //push app secret to the secret management
+
   const jsonSecret = JSON.stringify({
     MJ_APIKEY_PUBLIC,
     MJ_APIKEY_PRIVATE,