Bug fixes discovered during testing.

packages/snap/snap.manifest.json

@@ -7,7 +7,7 @@
     "url": "https://github.com/celo-org/gas-snap.git"
   },
   "source": {
-    "shasum": "Aglj//sQdE+aaLIrYZNEA9WcyK0iWd3JH+JGANbCXRQ=",
+    "shasum": "4QjBeigCYVIjhJXBCYDqJCEA+Rcos8XVuDjvnvXO+XA=",
     "location": {
       "npm": {
         "filePath": "dist/bundle.js",

packages/snap/src/constants.ts

@@ -6,3 +6,7 @@
 export const REGISTRY_ADDRESS = '0x000000000000000000000000000000000000ce10';
 export const CELO_MAINNET = 'mainnet';
 export const CELO_ALFAJORES = 'alfajores';
+export const REJECTION_MESSAGE = 'User rejected the request';
+export const INVALID_CURRENCY_MESSAGE = 'Invalid Currency';
+export const INSUFFICIENT_FUNDS_MESSAGE = `Insufficient funds for the provided gas currency to complete the operation. Please try again using another currency.`;
+export const VALID_CURRENCIES = ['cusd', 'ceur', 'creal', 'celo'];

packages/snap/src/currency.ts

@@ -151,8 +151,8 @@ export async function getOptimalFeeCurrency(
   const gasLimit = (await wallet.estimateGas(tx)).mul(5);
   const celoBalance = await wallet.getBalance();
   const tokenAddresses = await feeCurrencyWhitelistContract.getWhitelist();
-
-  if (gasLimit.add(tx.value ?? 0) >= celoBalance) {
+  const gasLimitPlusValue = gasLimit.add(tx.value ?? 0);
+  if (gasLimitPlusValue.gt(celoBalance)) {
     console.log('using stable token for gas');
     const tokens: Contract[] = tokenAddresses.map(
       (tokenAddress: string) =>

packages/snap/src/index.ts

@@ -3,7 +3,7 @@
 import { constants } from 'ethers';
 import { getNetworkConfig } from './utils/network';
 import { RequestParamsSchema } from './utils/types';
-import { handleNumber, isInsufficientFundsError } from './utils/utils';
+import { handleNumber } from './utils/utils';
 import { sendTransaction } from './sendTransaction';
 import { getKeyPair } from './getKeyPair';
 import {
@@ -12,6 +12,12 @@
   getOptimalFeeCurrency,
 } from './currency';
 import { invokeSnapDialog } from './utils/snapDialog';
+import {
+  INSUFFICIENT_FUNDS_MESSAGE,
+  INVALID_CURRENCY_MESSAGE,
+  REJECTION_MESSAGE,
+  VALID_CURRENCIES,
+} from './constants';
 
 /**
  * Handle incoming JSON-RPC requests, sent through `wallet_invokeSnap`.
@@ -32,38 +38,44 @@
   }
 
   const { tx } = request.params;
-  tx.value = handleNumber(tx.value); // todo find way to do this within io-ts transformation
+  tx.value = handleNumber(tx.value);
   const network = await getNetworkConfig();
   const provider = new CeloProvider(network.url);
   const keyPair = await getKeyPair(snap, tx.from);
   const wallet = new CeloWallet(keyPair.privateKey).connect(provider);
+  tx.from = tx.from ? tx.from : wallet.address;
   if (tx.value === constants.Zero) {
     delete tx.value;
   }
 
   switch (request.method) {
-    case 'celo_sendTransaction': {
-      const result = await invokeSnapDialog({
-        type: 'confirmation',
-        contentArray: [
-          'Please approve the following transaction',
-          tx.to ? `to: ${tx.to}` : '',
-          tx.from ? `from: ${tx.from}` : '',
-          tx.nonce ? `nonce: ${tx.nonce}` : '',
-          tx.gasLimit ? `gasLimit: ${tx.gasLimit}` : '',
-          tx.gasPrice ? `gasPrice: ${tx.gasPrice}` : '',
-          tx.data ? `data: ${tx.data}` : '',
-          tx.value ? `value: ${BigInt(tx.value?.toString())} wei` : '',
-          tx.chainId ? `chainId: ${tx.chainId}` : '',
-          tx.feeCurrency ? `feeCurrency: ${tx.feeCurrency}` : '',
-          tx.gatewayFeeRecipient
-            ? `gatewayFeeRecipient: ${tx.gatewayFeeRecipient}`
-            : '',
-          tx.gatewayFee ? `gatewayFee: ${tx.gatewayFee}` : '',
-        ].filter(Boolean), // This will remove any empty strings
-      });
+    case 'celo_sendTransaction':
+      {
+        const result = await invokeSnapDialog({
+          type: 'confirmation',
+          contentArray: [
+            'Please approve the following transaction',
+            tx.to ? `to: ${tx.to}` : '',
+            tx.from ? `from: ${tx.from}` : '',
+            tx.nonce ? `nonce: ${tx.nonce}` : '',
+            tx.gasLimit ? `gasLimit: ${tx.gasLimit}` : '',
+            tx.gasPrice ? `gasPrice: ${tx.gasPrice}` : '',
+            tx.data ? `data: ${tx.data}` : '',
+            tx.value ? `value: ${BigInt(tx.value?.toString())} wei` : '',
+            tx.chainId ? `chainId: ${tx.chainId}` : '',
+            tx.feeCurrency ? `feeCurrency: ${tx.feeCurrency}` : '',
+            tx.gatewayFeeRecipient
+              ? `gatewayFeeRecipient: ${tx.gatewayFeeRecipient}`
+              : '',
+            tx.gatewayFee ? `gatewayFee: ${tx.gatewayFee}` : '',
+          ].filter(Boolean), // This will remove any empty strings
+        });
+
+        if (result === false) {
+          // user did not proceed approve the request in the tx summary screen
+          throw new Error(REJECTION_MESSAGE);
+        }
 
-      if (result === true) {
         tx.feeCurrency ??= await getOptimalFeeCurrency(tx, wallet);
         const suggestedFeeCurrency = getFeeCurrencyNameFromAddress(
           tx.feeCurrency,
@@ -73,25 +85,25 @@
         const overrideFeeCurrency = await invokeSnapDialog({
           type: 'prompt',
           contentArray: [
-            `The suggested gas currency for your tx is ${suggestedFeeCurrency}`,
+            `The suggested gas currency for your tx is [${suggestedFeeCurrency.toUpperCase()}]`,
             `If you would like to use a different gas currency, please enter it below`,
             `Otherwise, press submit`,
           ],
-          placeholder: `'cusd', 'ceur', 'creal', 'celo'`,
+          placeholder: `cusd, ceur, creal, celo`,
         });
-        if (
-          // TODO find a cleaner way to do this, probably use an enum
-          overrideFeeCurrency === 'cusd' ||
-          overrideFeeCurrency === 'ceur' ||
-          overrideFeeCurrency === 'creal' ||
-          overrideFeeCurrency === 'celo'
-        ) {
+
+        if (VALID_CURRENCIES.includes(overrideFeeCurrency.toLowerCase())) {
           tx.feeCurrency = getFeeCurrencyAddressFromName(
-            overrideFeeCurrency,
+            overrideFeeCurrency.toLowerCase(),
             network.name,
           );
-        } else if (overrideFeeCurrency === null) {
-          return;
+        } else {
+          // user either rejected the request in the currency screen or entered an invalid currency
+          throw new Error(
+            overrideFeeCurrency === null
+              ? REJECTION_MESSAGE
+              : INVALID_CURRENCY_MESSAGE,
+          );
         }
 
         try {
@@ -100,24 +112,22 @@
             type: 'alert',
             contentArray: [
               'Your transaction succeeded!',
-              `${network.explorer}/tx/${txReceipt.transactionHash}`,
+              `${network.explorer}/tx/${txReceipt?.transactionHash}`,
             ],
           });
-        } catch (error) {
-          let message = JSON.stringify(error);
-
-          if (isInsufficientFundsError(error)) {
-            message = `Oops! Looks like you don't have sufficient funds in the chosen gas currency to complete the operation. Please try again using another currency.`;
-          }
-
+          return txReceipt?.transactionHash;
+        } catch (e) {
+          const message = (e as Error).message.includes('insufficient funds')
+            ? INSUFFICIENT_FUNDS_MESSAGE
+            : (e as Error).message;
           await invokeSnapDialog({
             type: 'alert',
             contentArray: ['Your transaction failed!', `error: ${message}`],
           });
+          throw new Error(message);
         }
       }
       break;
-    }
     default:
       throw new Error('Method not found.');
   }