feat: add durable nonce for sol recovery

mohammadalfaiyazbitgo · mohammadalfaiyazbitgo · commit 7ee080512cea · 2025-07-15T14:33:57.000-04:00
diff --git a/masterBitgoExpress.json b/masterBitgoExpress.json
@@ -719,23 +719,107 @@
                   "coinSpecificParams": {
                     "type": "object",
                     "properties": {
-                      "addressScan": {
-                        "type": "number"
+                      "evmRecoveryOptions": {
+                        "type": "object",
+                        "properties": {
+                          "eip1559": {
+                            "type": "object",
+                            "properties": {
+                              "maxFeePerGas": {
+                                "type": "number"
+                              },
+                              "maxPriorityFeePerGas": {
+                                "type": "number"
+                              }
+                            },
+                            "required": [
+                              "maxFeePerGas",
+                              "maxPriorityFeePerGas"
+                            ]
+                          },
+                          "gasLimit": {
+                            "type": "number"
+                          },
+                          "gasPrice": {
+                            "type": "number"
+                          },
+                          "replayProtectionOptions": {
+                            "type": "object",
+                            "properties": {
+                              "chain": {
+                                "oneOf": [
+                                  {
+                                    "type": "string"
+                                  },
+                                  {
+                                    "type": "number"
+                                  }
+                                ]
+                              },
+                              "hardfork": {
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "chain",
+                              "hardfork"
+                            ]
+                          },
+                          "scan": {
+                            "type": "number"
+                          }
+                        }
                       },
-                      "feeRate": {
-                        "type": "number"
+                      "sol": {
+                        "type": "object",
+                        "properties": {
+                          "closeAtaAddress": {
+                            "type": "string"
+                          },
+                          "durableNonce": {
+                            "type": "object",
+                            "properties": {
+                              "publicKey": {
+                                "type": "string"
+                              },
+                              "secretKey": {
+                                "type": "string"
+                              }
+                            },
+                            "required": [
+                              "publicKey",
+                              "secretKey"
+                            ]
+                          },
+                          "programId": {
+                            "type": "string"
+                          },
+                          "recoveryDestinationAtaAddress": {
+                            "type": "string"
+                          },
+                          "tokenContractAddress": {
+                            "type": "string"
+                          }
+                        }
                       },
-                      "ignoreAddressTypes": {
-                        "type": "array",
-                        "items": {
-                          "type": "string",
-                          "enum": [
-                            "p2sh",
-                            "p2shP2wsh",
-                            "p2wsh",
-                            "p2tr",
-                            "p2trMusig2"
-                          ]
+                      "utxo": {
+                        "type": "object",
+                        "properties": {
+                          "feeRate": {
+                            "type": "number"
+                          },
+                          "ignoreAddressTypes": {
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "scan": {
+                            "type": "number"
+                          },
+                          "userKeyPath": {
+                            "type": "string"
+                          }
                         }
                       }
                     }
diff --git a/src/api/master/handlers/recoveryWallet.ts b/src/api/master/handlers/recoveryWallet.ts
@@ -1,25 +1,26 @@
-import { BaseCoin, BitGoAPI, MethodNotImplementedError } from 'bitgo';
+import { BaseCoin, BitGoAPI, MethodNotImplementedError, MPCRecoveryOptions } from 'bitgo';
 
 import { AbstractEthLikeNewCoins } from '@bitgo/abstract-eth';
 import { AbstractUtxoCoin } from '@bitgo/abstract-utxo';
 
 import assert from 'assert';
 
-import {
-  isEddsaCoin,
-  isEthLikeCoin,
-  isFormattedOfflineVaultTxInfo,
-  isUtxoCoin,
-} from '../../../shared/coinUtils';
-import {
-  DEFAULT_MUSIG_ETH_GAS_PARAMS,
-  getReplayProtectionOptions,
-} from '../../../shared/recoveryUtils';
+import { isEddsaCoin, isEthLikeCoin, isFormattedOfflineVaultTxInfo, isUtxoCoin } from '../../../shared/coinUtils';
+import { DEFAULT_MUSIG_ETH_GAS_PARAMS, getReplayProtectionOptions } from '../../../shared/recoveryUtils';
+
 import { EnclavedExpressClient } from '../clients/enclavedExpressClient';
-import { MasterApiSpecRouteRequest } from '../routers/masterApiSpec';
+import {
+  EvmRecoveryOptions,
+  MasterApiSpecRouteRequest,
+  ScriptType2Of3,
+  SolanaRecoveryOptions,
+  UtxoRecoveryOptions,
+} from '../routers/masterApiSpec';
 import { recoverEddsaWallets } from './recoverEddsaWallets';
 import { EnvironmentName } from '../../../shared/types';
 import logger from '../../../logger';
+import { CoinFamily } from '@bitgo/statics';
+import { type SolRecoveryOptions } from '@bitgo/sdk-coin-sol';
 
 interface RecoveryParams {
   userKey: string;
@@ -34,17 +35,77 @@ interface EnclavedRecoveryParams {
   backupPub: string;
   apiKey: string;
   unsignedSweepPrebuildTx: any; // TODO: type this properly once we have the SDK types
-  coinSpecificParams?: Record<string, undefined>;
+  coinSpecificParams?: EvmRecoveryOptions | UtxoRecoveryOptions | SolanaRecoveryOptions;
   walletContractAddress: string;
 }
 
+// Type guards for recovery options
+function isUtxoRecoveryOptions(params: any): params is UtxoRecoveryOptions {
+  return (
+    params &&
+    (params.ignoreAddressTypes !== undefined ||
+      params.userKeyPath !== undefined ||
+      params.feeRate !== undefined)
+  );
+}
+
+function isEthRecoveryOptions(params: any): params is EvmRecoveryOptions {
+  return (
+    params &&
+    (params.gasPrice !== undefined ||
+      params.gasLimit !== undefined ||
+      params.eip1559 !== undefined ||
+      params.replayProtectionOptions !== undefined)
+  );
+}
+
+function isSolanaRecoveryOptions(params: any): params is SolanaRecoveryOptions {
+  return (
+    params &&
+    (params.tokenContractAddress !== undefined ||
+      params.closeAtaAddress !== undefined ||
+      params.recoveryDestinationAtaAddress !== undefined ||
+      params.programId !== undefined)
+  );
+}
+
+// Validation function to ensure correct params are used with correct coin types
+function validateRecoveryParams(
+  sdkCoin: BaseCoin,
+  params?: EvmRecoveryOptions | UtxoRecoveryOptions | SolanaRecoveryOptions,
+) {
+  if (!params) {
+    return;
+  }
+
+  if (isUtxoCoin(sdkCoin)) {
+    if (isEthRecoveryOptions(params) || isSolanaRecoveryOptions(params)) {
+      throw new Error('Invalid parameters provided for UTXO coin recovery');
+    }
+  }
+
+  if (isEthLikeCoin(sdkCoin)) {
+    if (isUtxoRecoveryOptions(params) || isSolanaRecoveryOptions(params)) {
+      throw new Error('Invalid parameters provided for ETH-like coin recovery');
+    }
+  }
+
+  if (isEddsaCoin(sdkCoin)) {
+    if (isUtxoRecoveryOptions(params) || isEthRecoveryOptions(params)) {
+      throw new Error('Invalid parameters provided for Solana coin recovery');
+    }
+  }
+}
+
 async function handleEthLikeRecovery(
   sdkCoin: BaseCoin,
   commonRecoveryParams: RecoveryParams,
   enclavedExpressClient: any,
   params: EnclavedRecoveryParams,
   env: EnvironmentName,
 ) {
+  // Validate that we have correct parameters for ETH recovery
+  validateRecoveryParams(sdkCoin, params.coinSpecificParams);
   try {
     const { gasLimit, gasPrice, maxFeePerGas, maxPriorityFeePerGas } = DEFAULT_MUSIG_ETH_GAS_PARAMS;
     const unsignedSweepPrebuildTx = await (sdkCoin as AbstractEthLikeNewCoins).recover({
@@ -76,13 +137,34 @@ async function handleEddsaRecovery(
   enclavedExpressClient: EnclavedExpressClient,
   params: EnclavedRecoveryParams,
 ) {
+  // Validate that we have the correct parameters for Solana recovery
+  validateRecoveryParams(sdkCoin, params.coinSpecificParams);
   const { recoveryDestination, userKey } = commonRecoveryParams;
   try {
-    const unsignedSweepPrebuildTx = await recoverEddsaWallets(bitgo, sdkCoin, {
+    const options: MPCRecoveryOptions = {
       bitgoKey: userKey,
       recoveryDestination,
       apiKey: params.apiKey,
-    });
+    };
+    let unsignedSweepPrebuildTx: Awaited<ReturnType<typeof recoverEddsaWallets>>;
+    if (sdkCoin.getFamily() === CoinFamily.SOL) {
+      const solanaParams = params.coinSpecificParams as SolanaRecoveryOptions;
+      console.log(params);
+      const solanaRecoveryOptions: SolRecoveryOptions = {...options}
+      solanaRecoveryOptions.recoveryDestinationAtaAddress = solanaParams.recoveryDestinationAtaAddress;
+      solanaRecoveryOptions.closeAtaAddress = solanaParams.closeAtaAddress;
+      solanaRecoveryOptions.tokenContractAddress = solanaParams.tokenContractAddress;
+      solanaRecoveryOptions.programId = solanaParams.programId;
+      if (solanaParams.durableNonce) {
+        solanaRecoveryOptions.durableNonce = {
+          publicKey: solanaParams.durableNonce.publicKey,
+          secretKey: solanaParams.durableNonce.secretKey,
+        };
+      }
+      unsignedSweepPrebuildTx = await recoverEddsaWallets(bitgo, sdkCoin, solanaRecoveryOptions);
+    } else {
+      unsignedSweepPrebuildTx = await recoverEddsaWallets(bitgo, sdkCoin, options);
+    }
     logger.info('Unsigned sweep tx: ', JSON.stringify(unsignedSweepPrebuildTx, null, 2));
 
     return await enclavedExpressClient.recoveryMPC({
@@ -168,7 +250,7 @@ export async function handleRecoveryWalletOnPrem(
           apiKey: '',
           walletContractAddress: '',
           unsignedSweepPrebuildTx: undefined,
-          coinSpecificParams: undefined,
+          coinSpecificParams: coinSpecificParams?.sol,
         },
       );
     } else {
@@ -219,7 +301,7 @@ export async function handleRecoveryWalletOnPrem(
         backupPub,
         apiKey,
         unsignedSweepPrebuildTx: undefined,
-        coinSpecificParams: undefined,
+        coinSpecificParams: coinSpecificParams?.evmRecoveryOptions,
         walletContractAddress,
       },
       bitgo.env as EnvironmentName,
@@ -234,9 +316,9 @@ export async function handleRecoveryWalletOnPrem(
       userKey: userPub,
       backupKey: backupPub,
       bitgoKey: bitgoPub,
-      ignoreAddressTypes: coinSpecificParams?.ignoreAddressTypes ?? [],
-      scan: coinSpecificParams?.addressScan,
-      feeRate: coinSpecificParams?.feeRate,
+      ignoreAddressTypes: (coinSpecificParams?.utxo?.ignoreAddressTypes as ScriptType2Of3[]) ?? [],
+      scan: coinSpecificParams?.utxo?.scan,
+      feeRate: coinSpecificParams?.utxo?.feeRate,
       recoveryDestination: recoveryDestinationAddress,
       apiKey,
     });
diff --git a/src/api/master/routers/masterApiSpec.ts b/src/api/master/routers/masterApiSpec.ts
