feat(express): migrated update express wallet to typed routes

TICKET: WP-5416

Author: danielzhao122

modules/express/src/clientRoutes.ts

@@ -1005,9 +1005,11 @@ export async function handleV2EnableTokens(req: express.Request) {
  * Handle Update Wallet
  * @param req
  */
-async function handleWalletUpdate(req: express.Request): Promise<unknown> {
+export async function handleWalletUpdate(
+  req: ExpressApiRouteRequest<'express.wallet.update', 'put'>
+): Promise<unknown> {
   // If it's a lightning coin, use the lightning-specific handler
-  if (isLightningCoinName(req.params.coin)) {
+  if (isLightningCoinName(req.decoded.coin)) {
     return handleUpdateLightningWalletCoinSpecific(req);
   }
 
@@ -1607,7 +1609,7 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
   // generate wallet
   app.post('/api/v2/:coin/wallet/generate', parseBody, prepareBitGo(config), promiseWrapper(handleV2GenerateWallet));
 
-  app.put('/express/api/v2/:coin/wallet/:id', parseBody, prepareBitGo(config), promiseWrapper(handleWalletUpdate));
+  router.put('express.wallet.update', [prepareBitGo(config), typedPromiseWrapper(handleWalletUpdate)]);
 
   // change wallet passphrase
   app.post(

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

@@ -26,6 +26,7 @@ import { PostCreateAddress } from './v2/createAddress';
 import { PutFanoutUnspents } from './v1/fanoutUnspents';
 import { PostOfcSignPayload } from './v2/ofcSignPayload';
 import { PostWalletRecoverToken } from './v2/walletRecoverToken';
+import { PutExpressWalletUpdate } from './v2/expressWalletUpdate';
 
 export const ExpressApi = apiSpec({
   'express.ping': {
@@ -100,6 +101,9 @@ export const ExpressApi = apiSpec({
   'express.v2.wallet.recovertoken': {
     post: PostWalletRecoverToken,
   },
+  'express.wallet.update': {
+    put: PutExpressWalletUpdate,
+  },
 });
 
 export type ExpressApi = typeof ExpressApi;

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

@@ -0,0 +1,58 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+/**
+ *  Parameters for Express Wallet Update
+ */
+export const ExpressWalletUpdateParams = {
+  /** Coin ticker / chain identifier */
+  coin: t.string,
+  /** Wallet ID */
+  id: t.string,
+} as const;
+
+/**
+ *  Request body for Express Wallet Update
+ */
+export const ExpressWalletUpdateBody = {
+  /** The host address of the lightning signer node. */
+  signerHost: t.string,
+  /** The TLS certificate for the lighting signer node encoded to base64. */
+  signerTlsCert: t.string,
+  /** (Optional) The signer macaroon for the lighting signer node. */
+  signerMacaroon: optional(t.string),
+  /** The wallet passphrase (used locally to decrypt and sign). */
+  passphrase: t.string,
+} as const;
+
+/**
+ * Response for Express Wallet Update
+ */
+export const ExpressWalletUpdateResponse = {
+  /** Updated Wallet */
+  200: t.UnknownRecord,
+  /** Bad Request */
+  400: BitgoExpressError,
+  /** Forbidden */
+  403: BitgoExpressError,
+  /** Not Found */
+  404: BitgoExpressError,
+} as const;
+
+/**
+ * Express - Update Wallet
+ * The express update wallet route is meant to be used for lightning (lnbtc/tlnbtc).
+ * For other coins, use the standard wallet update endpoint.
+ *
+ * @operationId express.wallet.update
+ */
+export const PutExpressWalletUpdate = httpRoute({
+  path: '/express/api/v2/{coin}/wallet/{id}',
+  method: 'PUT',
+  request: httpRequest({
+    params: ExpressWalletUpdateParams,
+    body: ExpressWalletUpdateBody,
+  }),
+  response: ExpressWalletUpdateResponse,
+});

modules/express/test/unit/clientRoutes/expressWallet.ts

@@ -0,0 +1,74 @@
+import { TestBitGo, TestBitGoAPI } from '@bitgo/sdk-test';
+import { BitGo } from 'bitgo';
+import { common, decodeOrElse } from '@bitgo/sdk-core';
+import nock from 'nock';
+import { ExpressApiRouteRequest } from '../../../src/typedRoutes/api';
+import { ExpressWalletUpdateResponse } from '../../../src/typedRoutes/api/v2/expressWalletUpdate';
+import { handleWalletUpdate } from '../../../src/clientRoutes';
+import { apiData } from './lightning/lightningSignerFixture';
+
+describe('express.wallet.update (unit)', () => {
+  let bitgo: TestBitGoAPI;
+  let bgUrl: string;
+
+  before(async function () {
+    if (!nock.isActive()) {
+      nock.activate();
+    }
+    bitgo = TestBitGo.decorate(BitGo, { env: 'test' });
+    bitgo.initializeTestVars();
+    bgUrl = common.Environments[bitgo.getEnv()].uri;
+    nock.disableNetConnect();
+    nock.enableNetConnect('127.0.0.1');
+  });
+
+  after(() => {
+    if (nock.isActive()) {
+      nock.restore();
+    }
+  });
+
+  it('decodes successful response', async () => {
+    const walletId = apiData.wallet.id;
+    const coin = apiData.wallet.coin;
+    const wpGet = nock(bgUrl)
+      .get(`/api/v2/${coin}/wallet/${walletId}`)
+      .query({ includeBalance: false })
+      .reply(200, apiData.wallet);
+    const wpKeychainNocks = [
+      nock(bgUrl).get(`/api/v2/${coin}/key/${apiData.userAuthKey.id}`).reply(200, apiData.userAuthKey),
+      nock(bgUrl).get(`/api/v2/${coin}/key/${apiData.nodeAuthKey.id}`).reply(200, apiData.nodeAuthKey),
+    ];
+    const wpPut = nock(bgUrl)
+      .put(`/api/v2/${coin}/wallet/${walletId}`)
+      .reply(200, { id: walletId, label: 'updated', coinSpecific: {} });
+
+    const req = {
+      bitgo,
+      params: { coin: coin, id: walletId },
+      body: {
+        signerHost: 'host.example',
+        signerTlsCert: 'cert',
+        signerMacaroon: 'mac and cheeze',
+        passphrase: apiData.initWalletRequestBody.passphrase,
+      },
+      decoded: {
+        coin: coin,
+        id: walletId,
+        signerHost: 'host.example',
+        signerTlsCert: 'cert',
+        signerMacaroon: 'mac and cheeze',
+        passphrase: apiData.initWalletRequestBody.passphrase,
+      },
+    } as unknown as ExpressApiRouteRequest<'express.wallet.update', 'put'>;
+
+    const res = await handleWalletUpdate(req);
+    decodeOrElse('ExpressWalletUpdateResponse200', ExpressWalletUpdateResponse[200], res, (errors) => {
+      throw new Error(`Response did not match expected codec: ${errors}`);
+    });
+
+    wpPut.done();
+    wpGet.done();
+    wpKeychainNocks.forEach((s) => s.done());
+  });
+});