Merge pull request #95 from BitGo/WP-5454-fix-btc-recovery-validation

fix(mbe): fix validation params for recovery

Author: pranavjain97

src/__tests__/api/master/recoveryWallet.test.ts

@@ -232,7 +232,9 @@ describe('Recovery Tests', () => {
       response.status.should.equal(422);
       response.body.should.have.property('error');
       response.body.should.have.property('details');
-      response.body.details.should.containEql('Invalid parameters provided for UTXO coin recovery');
+      response.body.details.should.containEql(
+        'UTXO recovery options are required for UTXO coin recovery',
+      );
     });
 
     it('should reject incorrect Solana parameters for a UTXO coin', async () => {
@@ -267,7 +269,9 @@ describe('Recovery Tests', () => {
       response.status.should.equal(422);
       response.body.should.have.property('error');
       response.body.should.have.property('details');
-      response.body.details.should.containEql('Invalid parameters provided for UTXO coin recovery');
+      response.body.details.should.containEql(
+        'UTXO recovery options are required for UTXO coin recovery',
+      );
     });
 
     it('should reject using legacy coinSpecificParams format', async () => {
@@ -294,9 +298,12 @@ describe('Recovery Tests', () => {
           },
         });
 
-      response.status.should.equal(500);
-      // Since we test that the incorrect format doesn't work anymore
+      response.status.should.equal(422);
       response.body.should.have.property('error');
+      response.body.should.have.property('details');
+      response.body.details.should.containEql(
+        'UTXO recovery options are required for UTXO coin recovery',
+      );
     });
   });
 
@@ -355,7 +362,7 @@ describe('Recovery Tests', () => {
       response.body.should.have.property('error');
       response.body.should.have.property('details');
       response.body.details.should.containEql(
-        'Invalid parameters provided for ETH-like coin recovery',
+        'EVM recovery options are required for ETH-like coin recovery',
       );
     });
 
@@ -393,7 +400,7 @@ describe('Recovery Tests', () => {
       response.body.should.have.property('error');
       response.body.should.have.property('details');
       response.body.details.should.containEql(
-        'Invalid parameters provided for ETH-like coin recovery',
+        'EVM recovery options are required for ETH-like coin recovery',
       );
     });
   });
@@ -448,7 +455,7 @@ describe('Recovery Tests', () => {
       response.body.should.have.property('error');
       response.body.should.have.property('details');
       response.body.details.should.containEql(
-        'Invalid parameters provided for Solana coin recovery',
+        'Solana recovery options are required for EdDSA coin recovery',
       );
     });
 
@@ -479,7 +486,7 @@ describe('Recovery Tests', () => {
       response.body.should.have.property('error');
       response.body.should.have.property('details');
       response.body.details.should.containEql(
-        'Invalid parameters provided for Solana coin recovery',
+        'Solana recovery options are required for EdDSA coin recovery',
       );
     });
   });

src/__tests__/api/master/recoveryWalletMpcV2.test.ts

@@ -203,7 +203,7 @@ describe('MBE mpcv2 recovery', () => {
     response.status.should.equal(422);
     response.body.should.have.property('error');
     response.body.error.should.equal(
-      'Invalid parameters provided for ETH-like MPC V2 coin recovery',
+      'ECDSA ETH-like recovery specific parameters are required for MPC recovery',
     );
   });
 });

src/api/master/handlers/recoveryWallet.ts

@@ -53,41 +53,57 @@ interface EnclavedRecoveryParams {
   walletContractAddress: string;
 }
 
-function validateRecoveryParams(sdkCoin: BaseCoin, params?: CoinSpecificParams) {
+function validateRecoveryParams(
+  sdkCoin: BaseCoin,
+  params?: CoinSpecificParams,
+  isMpcRecovery = false,
+) {
   if (!params) {
     return;
   }
 
+  if (isUtxoCoin(sdkCoin)) {
+    // UTXO coins need utxoRecoveryOptions for standard recovery
+    if (!isMpcRecovery && !params.utxoRecoveryOptions) {
+      throw new ValidationError('UTXO recovery options are required for UTXO coin recovery');
+    }
+    return;
+  }
+
   if (isEddsaCoin(sdkCoin)) {
-    if (params.evmRecoveryOptions || params.utxoRecoveryOptions) {
-      throw new ValidationError('Invalid parameters provided for Solana coin recovery');
+    // EdDSA coins (like Solana) need solanaRecoveryOptions for standard recovery
+    if (!params.solanaRecoveryOptions) {
+      throw new ValidationError('Solana recovery options are required for EdDSA coin recovery');
     }
-  } else if (isEcdsaCoin(sdkCoin)) {
+    return;
+  }
+
+  if (isEcdsaCoin(sdkCoin) && isMpcRecovery) {
     if (isEthLikeCoin(sdkCoin)) {
       if (!params.ecdsaEthLikeRecoverySpecificParams) {
-        throw new ValidationError('Invalid parameters provided for ETH-like MPC V2 coin recovery');
+        throw new ValidationError(
+          'ECDSA ETH-like recovery specific parameters are required for MPC recovery',
+        );
       }
     } else if (isCosmosLikeCoin(sdkCoin)) {
+      // ECDSA Cosmos-like MPC recovery needs ecdsaCosmosLikeRecoverySpecificParams
       if (!params.ecdsaCosmosLikeRecoverySpecificParams) {
         throw new ValidationError(
-          'Invalid parameters provided for Cosmos-like MPC V2 coin recovery',
+          'ECDSA Cosmos-like recovery specific parameters are required for MPC recovery',
         );
       }
     } else {
       throw new NotImplementedError(
         `MPC V2 recovery is not supported for coin family: ${sdkCoin.getFamily()}`,
       );
     }
-  } else {
-    if (isUtxoCoin(sdkCoin)) {
-      if (params.solanaRecoveryOptions || params.evmRecoveryOptions) {
-        throw new ValidationError('Invalid parameters provided for UTXO coin recovery');
-      }
-    } else if (isEthLikeCoin(sdkCoin)) {
-      if (params.solanaRecoveryOptions || params.utxoRecoveryOptions) {
-        throw new ValidationError('Invalid parameters provided for ETH-like coin recovery');
-      }
+  }
+  if (!isMpcRecovery && isEthLikeCoin(sdkCoin)) {
+    // Non-ECDSA ETH-like coins need evmRecoveryOptions for standard recovery
+    if (!params.evmRecoveryOptions) {
+      throw new ValidationError('EVM recovery options are required for ETH-like coin recovery');
     }
+    return;
   }
 }
 
@@ -216,7 +232,7 @@ export async function handleRecoveryWalletOnPrem(
 
   const sdkCoin = await coinFactory.getCoin(coin, bitgo);
   // Validate that we have correct parameters for recovery
-  validateRecoveryParams(sdkCoin, coinSpecificParams);
+  validateRecoveryParams(sdkCoin, coinSpecificParams, req.decoded.isTssRecovery);
 
   // Handle TSS recovery
   if (req.decoded.isTssRecovery) {