Merge pull request #6705 from BitGo/WP-5399-express-migrate-api-v-12-verifyaddress-to-typed-routes

feat(express): migrate verify address to typed routes

Author: kaustubhbitgo

modules/express/src/clientRoutes.ts

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

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

@@ -0,0 +1,26 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+export const VerifyAddressBody = {
+  address: t.string,
+};
+
+/**
+ * Verify Address
+ *
+ * @operationId express.verifyaddress
+ */
+export const PostVerifyAddress = httpRoute({
+  path: '/api/v[12]/verifyaddress',
+  method: 'POST',
+  request: httpRequest({
+    body: VerifyAddressBody,
+  }),
+  response: {
+    200: t.type({
+      verified: t.boolean,
+    }),
+    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 { PostVerifyAddress } from './common/verifyAddress';
 
 export const ExpressApi = apiSpec({
   'express.ping': {
@@ -20,6 +21,9 @@ export const ExpressApi = apiSpec({
   'express.decrypt': {
     post: PostDecrypt,
   },
+  'express.verifyaddress': {
+    post: PostVerifyAddress,
+  },
 });
 
 export type ExpressApi = typeof ExpressApi;

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

@@ -2,6 +2,7 @@ import * as assert from 'assert';
 import * as t from 'io-ts';
 import { DecryptRequestBody } from '../../../src/typedRoutes/api/common/decrypt';
 import { LoginRequest } from '../../../src/typedRoutes/api/common/login';
+import { VerifyAddressBody } from '../../../src/typedRoutes/api/common/verifyAddress';
 
 export function assertDecode<T>(codec: t.Type<T, unknown>, input: unknown): T {
   const result = codec.decode(input);
@@ -39,4 +40,14 @@ describe('io-ts decode tests', function () {
       password: 'password',
     });
   });
+  it('express.verifyaddress', function () {
+    assert.throws(() =>
+      assertDecode(t.type(VerifyAddressBody), {
+        address: 1123,
+      })
+    );
+    assertDecode(t.type(VerifyAddressBody), {
+      address: 'some-address',
+    });
+  });
 });