fix: stop blocking iapp deploy when RLC balance is empty

Author: PierreJeanjacquot

cli/src/cli-helpers/ensureBalances.ts

@@ -1,16 +1,18 @@
 import { warnBox } from './box.js';
-import { emphasis, command } from './color.js';
+import { emphasis, command, promptHelper } from './color.js';
 import type { Spinner } from './spinner.js';
 import { BN, IExec, utils } from 'iexec';
 
 export async function ensureBalances({
   spinner,
   iexec,
+  warnOnlyRlc = false,
   nRlcMin,
   weiMin,
 }: {
   spinner: Spinner;
   iexec: IExec;
+  warnOnlyRlc?: boolean;
   nRlcMin?: BN;
   weiMin?: BN;
 }): Promise<{
@@ -34,36 +36,33 @@ export async function ensureBalances({
     (chainId !== 134 && totalRlc.isZero()) ||
     (!!nRlcMin && totalRlc.lt(nRlcMin));
 
-  if (!missingNative && !missingRlc) {
-    return {
-      wei,
-      nRLC,
-      stake,
-    };
-  }
+  const shouldThrow = missingNative || (missingRlc && !warnOnlyRlc);
 
-  const helpers = [];
-  if (missingNative) {
-    const msg = wei.isZero()
-      ? ' - Native balance is empty'
-      : ' - Native balance is insufficient';
-    const requirement = weiMin
-      ? ` (requires ${utils.formatEth(weiMin as BN)} ether)`
-      : '';
-    helpers.push(`${msg}${requirement}`);
-  }
-  if (missingRlc) {
-    const msg = totalRlc.isZero()
-      ? ' - RLC balance is empty'
-      : ' - RLC balance is insufficient';
-    const requirement = nRlcMin
-      ? ` (requires ${utils.formatRLC(nRlcMin as BN)} RLC)`
-      : '';
-    helpers.push(`${msg}${requirement}`);
-  }
+  // always show missing balance warnings
+  if (missingNative || missingRlc) {
+    const helpers = [];
+    if (missingNative) {
+      const msg =
+        ' - Native asset balance required for blockchain transactions is ' +
+        (wei.isZero() ? 'empty' : 'insufficient');
+      const requirement = weiMin
+        ? ` (requires ${utils.formatEth(weiMin as BN)} ether)`
+        : '';
+      helpers.push(`${msg}${requirement}`);
+    }
+    if (missingRlc) {
+      const msg =
+        ' - RLC token balance required for iapp runs is ' +
+        (totalRlc.isZero() ? 'empty' : 'insufficient') +
+        (warnOnlyRlc ? promptHelper(' (warning only)') : '');
+      const requirement = nRlcMin
+        ? ` (requires ${utils.formatRLC(nRlcMin as BN)} RLC)`
+        : '';
+      helpers.push(`${msg}${requirement}`);
+    }
 
-  spinner.log(
-    warnBox(`Current chain requires ${chainId !== 134 ? 'native asset to pay transaction fees and ' : ''}RLC to pay iApp runs!
+    spinner.log(
+      warnBox(`Current chain requires ${chainId !== 134 ? 'native asset to pay transaction fees and ' : ''}RLC to pay iApp runs!
  
 Your wallet balance is insufficient:
 ${helpers.join('\n')}
@@ -73,6 +72,16 @@ You can either:
  - Import another wallet (run ${command('iapp wallet import')})
  - Select an imported wallet (run ${command('iapp wallet select')})
  - Use another chain (use option ${command('--chain <name>')})`)
-  );
-  throw Error(`Balance is insufficient`);
+    );
+  }
+
+  if (shouldThrow) {
+    throw Error(`Balance is insufficient`);
+  }
+
+  return {
+    wei,
+    nRLC,
+    stake,
+  };
 }

cli/src/cmd/deploy.ts

@@ -46,7 +46,7 @@ export async function deploy({ chain }: { chain?: string }) {
       iexec = getIExec({ ...chainConfig, signer });
     }
 
-    await ensureBalances({ spinner, iexec });
+    await ensureBalances({ spinner, iexec, warnOnlyRlc: true });
 
     const dockerhubUsername = await askForDockerhubUsername({ spinner });
     const dockerhubAccessToken = await askForDockerhubAccessToken({ spinner });