Merge pull request #36 from BitGo/WP-4769

feat: improved typing for recovery musig

Author: pranavjain97

src/api/enclaved/recoveryMultisigTransaction.ts

@@ -3,6 +3,7 @@ import { MethodNotImplementedError } from 'bitgo';
 import { EnclavedApiSpecRouteRequest } from '../../enclavedBitgoExpress/routers/enclavedApiSpec';
 import logger from '../../logger';
 import { isEthLikeCoin } from '../../shared/coinUtils';
+import { HalfSignedEthLikeRecoveryTx } from '../../types/transaction';
 import { retrieveKmsKey } from './utils';
 
 export async function recoveryMultisigTransaction(
@@ -36,7 +37,7 @@ export async function recoveryMultisigTransaction(
           walletContractAddress,
         });
 
-        const { halfSigned } = halfSignedTx as any;
+        const { halfSigned } = halfSignedTx as HalfSignedEthLikeRecoveryTx;
         const fullSignedTx = await coin.signTransaction({
           isLastSignature: true,
           prv: backupPrv,

src/enclavedBitgoExpress/routers/enclavedApiSpec.ts

@@ -58,8 +58,8 @@ const RecoveryMultisigRequest = {
   userPub: t.string,
   backupPub: t.string,
   apiKey: t.string,
-  // TODO: best typing for this, they come from sdk TS types
   unsignedSweepPrebuildTx: t.any,
+  walletContractAddress: t.string,
   coinSpecificParams: t.union([
     t.undefined,
     t.partial({
@@ -71,8 +71,9 @@ const RecoveryMultisigRequest = {
 
 // Response type for /multisig/recovery endpoint
 const RecoveryMultisigResponse: HttpResponse = {
-  // TODO: Define proper response type for recovery multisig transaction
-  200: t.any, // the full signed tx
+  200: t.type({
+    txHex: t.string,
+  }), // the full signed tx
   500: t.type({
     error: t.string,
     details: t.string,

src/masterBitgoExpress/routers/masterApiSpec.ts

@@ -90,7 +90,9 @@ export const SendManyResponse: HttpResponse = {
 // Response type for /recovery endpoint
 const RecoveryWalletResponse: HttpResponse = {
   // TODO: Get type from public types repo
-  200: t.any,
+  200: t.type({
+    txHex: t.string, // the full signed transaction hex
+  }),
   500: t.type({
     error: t.string,
     details: t.string,

src/types/transaction.ts

@@ -0,0 +1,10 @@
+import { type Recipient, type SignedTransaction } from 'bitgo';
+
+export type HalfSignedEthLikeRecoveryTx = SignedTransaction & {
+  halfSigned: {
+    signatures?: string;
+    recipients?: Recipient[];
+    signingKeyNonce?: number;
+    backupKeyNonce?: number;
+  };
+};