feat(express): migrate encrypt to typed routes

Ticket: WP-5398

Author: adityasoni-bitgo

modules/express/src/clientRoutes.ts

@@ -96,7 +96,7 @@ function handleDecrypt(req: ExpressApiRouteRequest<'express.decrypt', 'post'>) {
   };
 }
 
-function handleEncrypt(req: express.Request) {
+function handleEncrypt(req: ExpressApiRouteRequest<'express.encrypt', 'post'>) {
   return {
     encrypted: req.bitgo.encrypt(req.body),
   };
@@ -1564,7 +1564,7 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
   router.post('express.login', [prepareBitGo(config), typedPromiseWrapper(handleLogin)]);
 
   router.post('express.decrypt', [prepareBitGo(config), typedPromiseWrapper(handleDecrypt)]);
-  app.post('/api/v[12]/encrypt', parseBody, prepareBitGo(config), promiseWrapper(handleEncrypt));
+  router.post('express.encrypt', [prepareBitGo(config), typedPromiseWrapper(handleEncrypt)]);
   router.post('express.verifyaddress', [prepareBitGo(config), typedPromiseWrapper(handleVerifyAddress)]);
   app.post(
     '/api/v[12]/calculateminerfeeinfo',

modules/express/src/typedRoutes/api/common/encrypt.ts

@@ -0,0 +1,28 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+export const EncryptRequestBody = {
+  input: t.string,
+  password: optional(t.string),
+  adata: optional(t.string),
+};
+
+/**
+ * Encrypt
+ *
+ * @operationId express.encrypt
+ */
+export const PostEncrypt = httpRoute({
+  path: '/api/v[12]/encrypt',
+  method: 'POST',
+  request: httpRequest({
+    body: EncryptRequestBody,
+  }),
+  response: {
+    200: t.type({
+      encrypted: t.string,
+    }),
+    404: BitgoExpressError,
+  },
+});

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

@@ -6,6 +6,7 @@ import { GetPing } from './common/ping';
 import { GetPingExpress } from './common/pingExpress';
 import { PostLogin } from './common/login';
 import { PostDecrypt } from './common/decrypt';
+import { PostEncrypt } from './common/encrypt';
 import { PostVerifyAddress } from './common/verifyAddress';
 import { PostAcceptShare } from './v1/acceptShare';
 import { PostSimpleCreate } from './v1/simpleCreate';
@@ -25,6 +26,9 @@ export const ExpressApi = apiSpec({
   'express.decrypt': {
     post: PostDecrypt,
   },
+  'express.encrypt': {
+    post: PostEncrypt,
+  },
   'express.verifyaddress': {
     post: PostVerifyAddress,
   },

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

@@ -1,6 +1,7 @@
 import * as assert from 'assert';
 import * as t from 'io-ts';
 import { DecryptRequestBody } from '../../../src/typedRoutes/api/common/decrypt';
+import { EncryptRequestBody } from '../../../src/typedRoutes/api/common/encrypt';
 import { LoginRequest } from '../../../src/typedRoutes/api/common/login';
 import { VerifyAddressBody } from '../../../src/typedRoutes/api/common/verifyAddress';
 import { SimpleCreateRequestBody } from '../../../src/typedRoutes/api/v1/simpleCreate';
@@ -41,6 +42,46 @@ describe('io-ts decode tests', function () {
       password: 'password',
     });
   });
+  it('express.encrypt', function () {
+    // input is required field
+    assert.throws(() =>
+      assertDecode(t.type(EncryptRequestBody), {
+        password: 'password',
+      })
+    );
+
+    // input must be a string
+    assert.throws(() =>
+      assertDecode(t.type(EncryptRequestBody), {
+        input: 123,
+      })
+    );
+
+    // valid with just input
+    assertDecode(t.type(EncryptRequestBody), {
+      input: 'data to encrypt',
+    });
+
+    // valid with input and password
+    assertDecode(t.type(EncryptRequestBody), {
+      input: 'data to encrypt',
+      password: 'password',
+    });
+
+    // valid with all fields
+    assertDecode(t.type(EncryptRequestBody), {
+      input: 'data to encrypt',
+      password: 'password',
+      adata: 'additional authenticated data',
+    });
+
+    // password and adata are optional, should accept undefined
+    assertDecode(t.type(EncryptRequestBody), {
+      input: 'data to encrypt',
+      password: undefined,
+      adata: undefined,
+    });
+  });
   it('express.verifyaddress', function () {
     assert.throws(() =>
       assertDecode(t.type(VerifyAddressBody), {