feat: eth like coins family and follow up feedback

Author: mtexeira-simtlix

src/api/enclaved/recoveryMultisigTransaction.ts

@@ -1,7 +1,8 @@
 import { SignFinalOptions } from '@bitgo/abstract-eth';
+import { MethodNotImplementedError } from 'bitgo';
 import { EnclavedApiSpecRouteRequest } from '../../enclavedBitgoExpress/routers/enclavedApiSpec';
 import logger from '../../logger';
-import { isEthCoin } from '../../shared/coinUtils';
+import { isEthLikeCoin } from '../../shared/coinUtils';
 import { retrieveKmsKey } from './utils';
 
 export async function recoveryMultisigTransaction(
@@ -20,13 +21,13 @@ export async function recoveryMultisigTransaction(
   }
 
   const bitgo = req.bitgo;
-  const coin = bitgo.coin(req.params.coin);
+  const coin = bitgo.coin(req.decoded.coin);
 
   // The signed transaction format depends on the coin type so we do this check as a guard
   // If you check the type of coin before and after the "if", you may see "BaseCoin" vs "AbstractEthLikeCoin"
   if (coin.isEVM()) {
     // Every recovery method on every coin family varies one from another so we need to ensure with a guard.
-    if (isEthCoin(coin)) {
+    if (isEthLikeCoin(coin)) {
       // TODO: populate coinSpecificParams with things like replayProtectionOptions
       // coinSpecificParams type could be "recoverOptions"
       try {
@@ -59,11 +60,11 @@ export async function recoveryMultisigTransaction(
         throw error;
       }
     } else {
-      const errorMsg = 'Unsupported coin type for recovery: ' + req.params.coin;
+      const errorMsg = 'Unsupported coin type for recovery: ' + req.decoded.coin;
       logger.error(errorMsg);
       throw new Error(errorMsg);
     }
   } else {
-    throw new Error('Unsupported coin type for recovery: ' + coin);
+    throw new MethodNotImplementedError('Unsupported coin type for recovery: ' + coin);
   }
 }

src/masterBitgoExpress/recoveryWallet.ts

@@ -1,5 +1,6 @@
 import assert from 'assert';
-import { isEthCoin } from '../shared/coinUtils';
+import { MethodNotImplementedError } from 'bitgo';
+import { isEthLikeCoin } from '../shared/coinUtils';
 import { isMasterExpressConfig } from '../types';
 import { createEnclavedExpressClient } from './enclavedExpressClient';
 import { MasterApiSpecRouteRequest } from './routers/masterApiSpec';
@@ -8,7 +9,7 @@ export async function handleRecoveryWalletOnPrem(
   req: MasterApiSpecRouteRequest<'v1.wallet.recovery', 'post'>,
 ) {
   const bitgo = req.bitgo;
-  const coin = req.params.coin;
+  const coin = req.decoded.coin;
   assert(
     isMasterExpressConfig(req.config),
     'Expected req.config to be of type MasterExpressConfig',
@@ -27,7 +28,7 @@ export async function handleRecoveryWalletOnPrem(
     recoveryDestinationAddress,
     coinSpecificParams,
     apiKey,
-  } = req.body;
+  } = req.decoded;
 
   //construct a common payload for the recovery that it's repeated in any kind of recovery
   const commonRecoveryParams = {
@@ -40,12 +41,10 @@ export async function handleRecoveryWalletOnPrem(
 
   const sdkCoin = bitgo.coin(coin);
 
-  if (isEthCoin(sdkCoin)) {
+  if (isEthLikeCoin(sdkCoin)) {
     try {
       const unsignedSweepPrebuildTx = await sdkCoin.recover({
         ...commonRecoveryParams,
-        //TODO: DELETE. it's needed for keycard debugging, the walletPassphrase
-        //walletPassphrase: passphrase,
       });
       const fullSignedRecoveryTx = await enclavedExpressClient.recoveryMultisig({
         userPub,
@@ -59,10 +58,9 @@ export async function handleRecoveryWalletOnPrem(
 
       return fullSignedRecoveryTx;
     } catch (err) {
-      //TODO: check other error handling for ref on mbe
       throw err;
     }
   } else {
-    throw new Error('Recovery wallet is not supported for this coin: ' + coin);
+    throw new MethodNotImplementedError('Recovery wallet is not supported for this coin: ' + coin);
   }
 }

src/shared/coinUtils.ts

@@ -1,66 +1,57 @@
 import { AbstractEthLikeNewCoins } from '@bitgo/abstract-eth';
+import { CoinFamily } from '@bitgo/statics';
 import { BaseCoin } from 'bitgo';
 import { AbstractUtxoCoin, Eos, Stx, Xtz } from 'bitgo/dist/types/src/v2/coins';
 
-export function isEthCoin(coin: BaseCoin): coin is AbstractEthLikeNewCoins {
-  const isEthPure =
-    isFamily(coin, 'eth', 'gteth') ||
-    isFamily(coin, 'eth', 'hteth') ||
-    isFamily(coin, 'ethw', 'tethw');
+export function isEthLikeCoin(coin: BaseCoin): coin is AbstractEthLikeNewCoins {
+  const isEthPure = isFamily(coin, CoinFamily.ETH);
 
   const isEthLike =
-    isFamily(coin, 'rbtc', 'trbtc') ||
-    isFamily(coin, 'etc', 'tetc') ||
-    isFamily(coin, 'avaxc', 'tavaxc') ||
-    isFamily(coin, 'polygon', 'tpolygon') ||
-    isFamily(coin, 'arbeth', 'tarbeth') ||
-    isFamily(coin, 'opeth', 'topeth') ||
-    isFamily(coin, 'bsc', 'tbsc') ||
-    isFamily(coin, 'baseeth', 'tbaseeth') ||
-    isFamily(coin, 'coredao', 'tcoredao') ||
-    isFamily(coin, 'oas', 'toas') ||
-    isFamily(coin, 'flr', 'tflr') ||
-    isFamily(coin, 'sgb', 'tsgb') ||
-    isFamily(coin, 'wemix', 'twemix') ||
-    isFamily(coin, 'xdc', 'txdc');
+    isFamily(coin, CoinFamily.ETHW) || // ethw has its own family. as the others
+    isFamily(coin, CoinFamily.RBTC) ||
+    isFamily(coin, CoinFamily.ETC) ||
+    isFamily(coin, CoinFamily.AVAXC) ||
+    isFamily(coin, CoinFamily.POLYGON) ||
+    isFamily(coin, CoinFamily.ARBETH) ||
+    isFamily(coin, CoinFamily.OPETH) ||
+    isFamily(coin, CoinFamily.BSC) ||
+    isFamily(coin, CoinFamily.BASEETH) ||
+    isFamily(coin, CoinFamily.COREDAO) ||
+    isFamily(coin, CoinFamily.OAS) ||
+    isFamily(coin, CoinFamily.FLR) ||
+    isFamily(coin, CoinFamily.SGB) ||
+    isFamily(coin, CoinFamily.WEMIX) ||
+    isFamily(coin, CoinFamily.XDC);
 
   return isEthPure || isEthLike;
 }
 
 export function isUtxoCoin(coin: BaseCoin): coin is AbstractUtxoCoin {
-  // how to check if coin is UTXO? so many families
-  const isBtc = isFamily(coin, 'btc', 'tbtc');
+  const isBtc = isFamily(coin, CoinFamily.BTC);
 
   const isBtcLike =
-    isFamily(coin, 'ltc', 'tltc') ||
-    isFamily(coin, 'bch', 'tbch') ||
-    isFamily(coin, 'zec', 'tzec') ||
-    isFamily(coin, 'dash', 'tdash') ||
-    isFamily(coin, 'doge', 'tdoge') ||
-    isFamily(coin, 'btg', 'tbtg');
+    isFamily(coin, CoinFamily.LTC) ||
+    isFamily(coin, CoinFamily.BCH) ||
+    isFamily(coin, CoinFamily.ZEC) ||
+    isFamily(coin, CoinFamily.DASH) ||
+    isFamily(coin, CoinFamily.DASH) ||
+    isFamily(coin, CoinFamily.BTG);
 
   return isBtc || isBtcLike;
 }
 
-//look for those on OVC repo
-//https://github.com/BitGo/offline-vault-console/blob/7f850cdd10c89ceb850c69759349b9e0bbfb56db/frontend/src/pkg/bitgo/transaction-utils.ts#L595
 export function isEosCoin(coin: BaseCoin): coin is Eos {
-  return isFamily(coin, 'eos', 'teos');
+  return isFamily(coin, CoinFamily.EOS);
 }
 
 export function isStxCoin(coin: BaseCoin): coin is Stx {
-  return isFamily(coin, 'stx', 'tstx');
+  return isFamily(coin, CoinFamily.STX);
 }
 
 export function isXtzCoin(coin: BaseCoin): coin is Xtz {
-  // Tezos faucet: https://faucet.ghostnet.teztnets.com/
-  return isFamily(coin, 'xtz', 'txtz');
+  return isFamily(coin, CoinFamily.XTZ);
 }
 
-function isFamily(coin: BaseCoin, coinFamily: string, testFamily: string) {
-  if (!coin) {
-    return false;
-  }
-  const family = coin.getFamily();
-  return family === coinFamily || family === testFamily;
+function isFamily(coin: BaseCoin, family: CoinFamily) {
+  return Boolean(coin && coin.getFamily() === family);
 }