fix(express): walletRecoverToken type codec

Ticket: WP-6658

Author: lokesh-bitgo

modules/express/src/typedRoutes/api/v2/walletRecoverToken.ts

@@ -1,6 +1,7 @@
 import * as t from 'io-ts';
 import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
 import { BitgoExpressError } from '../../schemas/error';
+import { Recipient } from './coinSignTx';
 
 /**
  * Path parameters for recovering tokens from a wallet
@@ -14,12 +15,14 @@ export const RecoverTokenParams = {
 
 /**
  * Request body for recovering tokens from a wallet
+ *
+ * Note: When broadcast=false (default), either walletPassphrase or prv must be provided for signing.
  */
 export const RecoverTokenBody = {
-  /** The contract address of the unsupported token to recover */
-  tokenContractAddress: optional(t.string),
-  /** The destination address where recovered tokens should be sent */
-  recipient: optional(t.string),
+  /** The contract address of the unsupported token to recover (REQUIRED) */
+  tokenContractAddress: t.string,
+  /** The destination address where recovered tokens should be sent (REQUIRED) */
+  recipient: t.string,
   /** Whether to automatically broadcast the half-signed transaction to BitGo for cosigning and broadcasting */
   broadcast: optional(t.boolean),
   /** The wallet passphrase used to decrypt the user key */
@@ -34,8 +37,8 @@ export const RecoverTokenBody = {
 export const RecoverTokenResponse = t.type({
   halfSigned: t.type({
     /** Recipient information for the recovery transaction */
-    recipient: t.unknown,
-    /** Expiration time for the transaction */
+    recipient: Recipient,
+    /** Expiration time for the transaction (Unix timestamp in seconds) */
     expireTime: t.number,
     /** Contract sequence ID */
     contractSequenceId: t.number,
@@ -61,6 +64,15 @@ export const RecoverTokenResponse = t.type({
  * The transaction can be manually submitted to BitGo for cosigning, or automatically broadcast
  * by setting the 'broadcast' parameter to true.
  *
+ * Requirements:
+ * - tokenContractAddress (REQUIRED): The ERC-20 token contract address
+ * - recipient (REQUIRED): The destination address for recovered tokens
+ * - walletPassphrase or prv (REQUIRED when broadcast=false): For signing the transaction
+ *
+ * Behavior:
+ * - When broadcast=false (default): Returns a half-signed transaction for manual submission
+ * - When broadcast=true: Automatically sends the transaction to BitGo for cosigning and broadcasting
+ *
  * Note: This endpoint is only supported for ETH family wallets.
  *
  * @tag express