refactor: handleUpdateLightningWalletCoinSpecific to work with api-ts

TICKET: WP-5416

Author: danielzhao122

modules/express/src/lightning/lightningWalletRoutes.ts

@@ -1,23 +1,13 @@
-import * as express from 'express';
-import { ApiResponseError } from '../errors';
-import { UpdateLightningWalletClientRequest, updateWalletCoinSpecific } from '@bitgo/abstract-lightning';
-import { decodeOrElse } from '@bitgo/sdk-core';
+import { updateWalletCoinSpecific } from '@bitgo/abstract-lightning';
+import { ExpressApiRouteRequest } from '../typedRoutes/api';
 
-export async function handleUpdateLightningWalletCoinSpecific(req: express.Request): Promise<unknown> {
+export async function handleUpdateLightningWalletCoinSpecific(
+  req: ExpressApiRouteRequest<'express.wallet.update', 'put'>
+): Promise<unknown> {
   const bitgo = req.bitgo;
 
-  const params = decodeOrElse(
-    'UpdateLightningWalletClientRequest',
-    UpdateLightningWalletClientRequest,
-    req.body,
-    (_) => {
-      // DON'T throw errors from decodeOrElse. It could leak sensitive information.
-      throw new ApiResponseError('Invalid request body to update lightning wallet coin specific', 400);
-    }
-  );
+  const coin = bitgo.coin(req.decoded.coin);
+  const wallet = await coin.wallets().get({ id: req.decoded.id, includeBalance: false });
 
-  const coin = bitgo.coin(req.params.coin);
-  const wallet = await coin.wallets().get({ id: req.params.id, includeBalance: false });
-
-  return await updateWalletCoinSpecific(wallet, params);
+  return await updateWalletCoinSpecific(wallet, req.decoded);
 }

modules/express/test/unit/lightning/lightningWalletRoutes.test.ts

@@ -1,23 +1,12 @@
 import * as sinon from 'sinon';
 import should from 'should';
-import * as express from 'express';
-import { handleUpdateLightningWalletCoinSpecific } from '../../../src/lightning/lightningWalletRoutes';
 import { BitGo } from 'bitgo';
-import { ApiResponseError } from '../../../src/errors';
+import { ExpressApiRouteRequest } from '../../../src/typedRoutes/api';
 
 describe('Lightning Wallet Routes', () => {
   let bitgo;
   const coin = 'tlnbtc';
 
-  const mockRequestObject = (params: { body?: any; params?: any; query?: any; bitgo?: any }) => {
-    const req: Partial<express.Request> = {};
-    req.body = params.body || {};
-    req.params = params.params || {};
-    req.query = params.query || {};
-    req.bitgo = params.bitgo;
-    return req as express.Request;
-  };
-
   beforeEach(() => {
     const walletStub = {};
     const coinStub = {
@@ -53,11 +42,16 @@ describe('Lightning Wallet Routes', () => {
         },
       });
 
-      const req = mockRequestObject({
+      const req = {
         params: { id: 'testWalletId', coin },
         body: inputParams,
+        decoded: {
+          id: 'testWalletId',
+          coin,
+          ...inputParams,
+        },
         bitgo,
-      });
+      } as unknown as ExpressApiRouteRequest<'express.wallet.update', 'put'>;
 
       const result = await lightningRoutes.handleUpdateLightningWalletCoinSpecific(req);
 
@@ -70,45 +64,5 @@ describe('Lightning Wallet Routes', () => {
       should(secondArg).have.property('signerHost', 'signer.example.com');
       should(secondArg).have.property('passphrase', 'wallet-password-123');
     });
-
-    it('should throw error when passphrase is missing', async () => {
-      const invalidParams = {
-        signerMacaroon: 'encrypted-data',
-        signerHost: 'signer.example.com',
-      };
-
-      const req = mockRequestObject({
-        params: { id: 'testWalletId', coin },
-        body: invalidParams,
-        bitgo,
-      });
-
-      await should(handleUpdateLightningWalletCoinSpecific(req))
-        .be.rejectedWith(ApiResponseError)
-        .then((error) => {
-          should(error.status).equal(400);
-          should(error.message).equal('Invalid request body to update lightning wallet coin specific');
-        });
-    });
-
-    it('should handle invalid request body', async () => {
-      const invalidParams = {
-        signerHost: 12345, // invalid type
-        passphrase: 'valid-pass',
-      };
-
-      const req = mockRequestObject({
-        params: { id: 'testWalletId', coin },
-        body: invalidParams,
-        bitgo,
-      });
-
-      await should(handleUpdateLightningWalletCoinSpecific(req))
-        .be.rejectedWith(ApiResponseError)
-        .then((error) => {
-          should(error.status).equal(400);
-          should(error.message).equal('Invalid request body to update lightning wallet coin specific');
-        });
-    });
   });
 });

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

@@ -15,6 +15,10 @@ import {
 import { UnlockLightningWalletBody, UnlockLightningWalletParams } from '../../../src/typedRoutes/api/v2/unlockWallet';
 import { OfcSignPayloadBody } from '../../../src/typedRoutes/api/v2/ofcSignPayload';
 import { CreateAddressBody, CreateAddressParams } from '../../../src/typedRoutes/api/v2/createAddress';
+import {
+  ExpressWalletUpdateBody,
+  ExpressWalletUpdateParams,
+} from '../../../src/typedRoutes/api/v2/expressWalletUpdate';
 
 export function assertDecode<T>(codec: t.Type<T, unknown>, input: unknown): T {
   const result = codec.decode(input);
@@ -243,4 +247,50 @@ describe('io-ts decode tests', function () {
     assertDecode(t.type(CreateAddressBody), { eip1559: { maxFeePerGas: 1, maxPriorityFeePerGas: 1 } });
     assertDecode(t.type(CreateAddressBody), {});
   });
+  it('express.wallet.update', function () {
+    // missing coin
+    assert.throws(() => assertDecode(t.type(ExpressWalletUpdateParams), { id: 'wallet123' }));
+    // missing id
+    assert.throws(() => assertDecode(t.type(ExpressWalletUpdateParams), { coin: 'tlnbtc' }));
+    // missing required fields
+    assert.throws(() => assertDecode(t.type(ExpressWalletUpdateBody), {}));
+    // signerHost must be string
+    assert.throws(() =>
+      assertDecode(t.type(ExpressWalletUpdateBody), {
+        signerHost: 123,
+        signerTlsCert: 'cert',
+        passphrase: 'p',
+      })
+    );
+    // signerTlsCert must be string
+    assert.throws(() =>
+      assertDecode(t.type(ExpressWalletUpdateBody), {
+        signerHost: 'host.example',
+        signerTlsCert: 456,
+        passphrase: 'p',
+      })
+    );
+    // passphrase must be string and required
+    assert.throws(() =>
+      assertDecode(t.type(ExpressWalletUpdateBody), {
+        signerHost: 'host.example',
+        signerTlsCert: 'cert',
+      })
+    );
+    // valid minimal
+    assertDecode(t.type(ExpressWalletUpdateBody), {
+      signerHost: 'host.example',
+      signerTlsCert: 'cert',
+      passphrase: 'p',
+    });
+    // valid
+    assertDecode(t.type(ExpressWalletUpdateParams), { coin: 'tlnbtc', id: 'wallet123' });
+    // valid with optional signerMacaroon
+    assertDecode(t.type(ExpressWalletUpdateBody), {
+      signerHost: 'host.example',
+      signerTlsCert: 'cert',
+      passphrase: 'p',
+      signerMacaroon: 'mac',
+    });
+  });
 });