feat: move wallet sweep API to typed routes

Ticket: WP-5432

Author: adityasoni-bitgo

modules/express/src/clientRoutes.ts

@@ -833,7 +833,7 @@ async function handleV2FanOutUnspents(req: express.Request) {
  * handle wallet sweep
  * @param req
  */
-async function handleV2Sweep(req: express.Request) {
+async function handleV2Sweep(req: ExpressApiRouteRequest<'express.v2.wallet.sweep', 'post'>) {
   const bitgo = req.bitgo;
   const coin = bitgo.coin(req.params.coin);
   const wallet = await coin.wallets().get({ id: req.params.id });
@@ -1687,7 +1687,7 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
     promiseWrapper(handleV2FanOutUnspents)
   );
 
-  app.post('/api/v2/:coin/wallet/:id/sweep', parseBody, prepareBitGo(config), promiseWrapper(handleV2Sweep));
+  router.post('express.v2.wallet.sweep', [prepareBitGo(config), typedPromiseWrapper(handleV2Sweep)]);
 
   // CPFP
   app.post(

modules/express/src/typedRoutes/api/index.ts

@@ -16,6 +16,7 @@ import { PostSignTransaction } from './v1/signTransaction';
 import { PostKeychainLocal } from './v2/keychainLocal';
 import { PostLightningInitWallet } from './v2/lightningInitWallet';
 import { PostVerifyCoinAddress } from './v2/verifyAddress';
+import { PostSweep } from './v2/sweep';
 
 export const ExpressApi = apiSpec({
   'express.ping': {
@@ -60,6 +61,9 @@ export const ExpressApi = apiSpec({
   'express.calculateminerfeeinfo': {
     post: PostCalculateMinerFeeInfo,
   },
+  'express.v2.wallet.sweep': {
+    post: PostSweep,
+  },
 });
 
 export type ExpressApi = typeof ExpressApi;

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

@@ -0,0 +1,71 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+/**
+ * Path parameters for wallet sweep operation.
+ * @property coin - Ticker or identifier of the coin (e.g. 'btc', 'eth').
+ * @property id - Wallet ID
+ */
+export const SweepRequestParams = {
+  /** Coin ticker / chain identifier */
+  coin: t.string,
+  /** Wallet ID */
+  id: t.string,
+};
+
+/**
+ * Request body for wallet sweep operation.
+ *
+ * @property address - The address to sweep funds to
+ * @property walletPassphrase - Wallet passphrase for signing
+ * @property xprv - Extended private key (alternative to walletPassphrase)
+ * @property otp - One-time password for 2FA
+ * @property feeRate - Fee rate in satoshis per kilobyte
+ * @property maxFeeRate - Maximum fee rate in satoshis per kilobyte
+ * @property feeTxConfirmTarget - Number of blocks to target for confirmation
+ * @property allowPartialSweep - Whether to allow partial sweep if full sweep fails
+ */
+export const SweepRequestBody = {
+  /** Address to sweep funds to */
+  address: optional(t.string),
+  /** Wallet passphrase for signing the transaction */
+  walletPassphrase: optional(t.string),
+  /** Extended private key (alternative to walletPassphrase) */
+  xprv: optional(t.string),
+  /** One-time password for 2FA */
+  otp: optional(t.string),
+  /** Fee rate in satoshis per kilobyte */
+  feeRate: optional(t.number),
+  /** Maximum fee rate in satoshis per kilobyte */
+  maxFeeRate: optional(t.number),
+  /** Number of blocks to target for confirmation */
+  feeTxConfirmTarget: optional(t.number),
+  /** Whether to allow partial sweep if full sweep fails */
+  allowPartialSweep: optional(t.boolean),
+};
+
+/**
+ * Sweep wallet
+ *
+ * Sweep all funds from a wallet to a specified address.
+ * This operation consolidates all unspent outputs in the wallet and sends them to the target address.
+ *
+ * @operationId express.v2.wallet.sweep
+ */
+export const PostSweep = httpRoute({
+  path: '/api/v2/{coin}/wallet/{id}/sweep',
+  method: 'POST',
+  request: httpRequest({
+    params: SweepRequestParams,
+    body: SweepRequestBody,
+  }),
+  response: {
+    /** Successful sweep transaction */
+    200: t.unknown, // The actual response varies by coin type
+    /** Invalid request parameters */
+    400: BitgoExpressError,
+    /** Wallet not found */
+    404: BitgoExpressError,
+  },
+});

modules/express/test/unit/typedRoutes/sweep.ts

@@ -0,0 +1,42 @@
+import { PostSweep, SweepRequestParams, SweepRequestBody } from '../../../src/typedRoutes/api/v2/sweep';
+import * as t from 'io-ts';
+import { isRight } from 'fp-ts/Either';
+
+describe('Sweep Typed Route', () => {
+  it('should have correct path', () => {
+    expect(PostSweep.path).toBe('/api/v2/{coin}/wallet/{id}/sweep');
+  });
+
+  it('should have POST method', () => {
+    expect(PostSweep.method).toBe('POST');
+  });
+
+  it('should validate params correctly', () => {
+    const validParams = { coin: 'btc', id: 'wallet123' };
+    const paramsCodec = t.type(SweepRequestParams);
+    const result = paramsCodec.decode(validParams);
+    expect(isRight(result)).toBe(true);
+  });
+
+  it('should validate body correctly', () => {
+    const validBody = {
+      address: '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
+      walletPassphrase: 'test-passphrase',
+      feeRate: 10000,
+      maxFeeRate: 50000,
+      allowPartialSweep: true,
+    };
+
+    const bodyCodec = t.partial(SweepRequestBody);
+    const result = bodyCodec.decode(validBody);
+    expect(isRight(result)).toBe(true);
+  });
+
+  it('should allow optional body fields', () => {
+    const minimalBody = {};
+
+    const bodyCodec = t.partial(SweepRequestBody);
+    const result = bodyCodec.decode(minimalBody);
+    expect(isRight(result)).toBe(true);
+  });
+});