feat(mbe): use generated client for type safety

Ticket: WP-000000

Author: mohammadalfaiyazbitgo

masterBitgoExpress.json

@@ -264,6 +264,23 @@
       }
     },
     "/ping": {
+      "post": {
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PingResponseType"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/ping/enclavedExpress": {
       "post": {
         "parameters": [],
         "responses": {
@@ -277,13 +294,35 @@
                     "status": {
                       "type": "string"
                     },
-                    "timestamp": {
-                      "type": "string"
+                    "enclavedResponse": {
+                      "$ref": "#/components/schemas/PingResponseType"
                     }
                   },
                   "required": [
                     "status",
-                    "timestamp"
+                    "enclavedResponse"
+                  ]
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    },
+                    "details": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "error",
+                    "details"
                   ]
                 }
               }
@@ -298,21 +337,48 @@
         "responses": {
           "200": {
             "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VersionResponseType"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/version/enclavedExpress": {
+      "get": {
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/VersionResponseType"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
             "content": {
               "application/json": {
                 "schema": {
                   "type": "object",
                   "properties": {
-                    "version": {
+                    "error": {
                       "type": "string"
                     },
-                    "name": {
+                    "details": {
                       "type": "string"
                     }
                   },
                   "required": [
-                    "version",
-                    "name"
+                    "error",
+                    "details"
                   ]
                 }
               }
@@ -323,6 +389,39 @@
     }
   },
   "components": {
-    "schemas": {}
+    "schemas": {
+      "VersionResponseType": {
+        "title": "VersionResponseType",
+        "type": "object",
+        "properties": {
+          "version": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "version",
+          "name"
+        ]
+      },
+      "PingResponseType": {
+        "title": "PingResponseType",
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string"
+          },
+          "timestamp": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "status",
+          "timestamp"
+        ]
+      }
+    }
   }
 }

src/__tests__/masterBitgoExpress/generateWallet.test.ts

@@ -5,6 +5,7 @@ import nock from 'nock';
 import { app as expressApp } from '../../masterExpressApp';
 import { AppMode, MasterExpressConfig, TlsMode } from '../../types';
 import { Environments } from '@bitgo/sdk-core';
+import assert from 'assert';
 
 describe('POST /api/:coin/wallet/generate', () => {
   let agent: request.SuperAgentTest;
@@ -45,8 +46,6 @@ describe('POST /api/:coin/wallet/generate', () => {
     const userKeychainNock = nock(enclavedExpressUrl)
       .post(`/api/${coin}/key/independent`, {
         source: 'user',
-        coin: coin,
-        type: 'independent',
       })
       .reply(200, {
         pub: 'xpub_user',
@@ -57,8 +56,6 @@ describe('POST /api/:coin/wallet/generate', () => {
     const backupKeychainNock = nock(enclavedExpressUrl)
       .post(`/api/${coin}/key/independent`, {
         source: 'backup',
-        coin: coin,
-        type: 'independent',
       })
       .reply(200, {
         pub: 'xpub_backup',
@@ -155,18 +152,11 @@ describe('POST /api/:coin/wallet/generate', () => {
       allowSelfSigned: true,
     };
 
-    const app = expressApp(invalidConfig as MasterExpressConfig);
-    const testAgent = request.agent(app);
-
-    const response = await testAgent
-      .post(`/api/${coin}/wallet/generate`)
-      .set('Authorization', `Bearer ${accessToken}`)
-      .send({
-        label: 'test-wallet',
-      });
-
-    response.status.should.equal(500);
-    response.body.should.have.property('error');
-    response.body.error.should.equal('Please configure enclaved express configs.');
+    try {
+      expressApp(invalidConfig as MasterExpressConfig);
+      assert(false, 'Expected error to be thrown when enclaved express client is not configured');
+    } catch (e) {
+      (e as Error).message.should.equal('enclavedExpressUrl and enclavedExpressCert are required');
+    }
   });
 });

src/__tests__/masterBitgoExpress/sendMany.test.ts

@@ -7,6 +7,7 @@ import { app as expressApp } from '../../masterExpressApp';
 import { AppMode, MasterExpressConfig, TlsMode } from '../../types';
 import { Environments, Wallet } from '@bitgo/sdk-core';
 import { Coin } from 'bitgo';
+import assert from 'assert';
 
 describe('POST /api/:coin/wallet/:walletId/sendmany', () => {
   let agent: request.SuperAgentTest;
@@ -277,26 +278,14 @@ describe('POST /api/:coin/wallet/:walletId/sendmany', () => {
       allowSelfSigned: true,
     };
 
-    const app = expressApp(invalidConfig as MasterExpressConfig);
-    const testAgent = request.agent(app);
-
-    const response = await testAgent
-      .post(`/api/${coin}/wallet/${walletId}/sendMany`)
-      .set('Authorization', `Bearer ${accessToken}`)
-      .send({
-        recipients: [
-          {
-            address: 'tb1qtest1',
-            amount: '100000',
-          },
-        ],
-        source: 'user',
-        pubkey: 'xpub_user',
-      });
-
-    response.status.should.equal(500);
-    response.body.should.have.property('error');
-    response.body.error.should.equal('Please configure enclaved express configs.');
+    try {
+      expressApp(invalidConfig as MasterExpressConfig);
+      assert(false, 'Expected error to be thrown when enclaved express client is not configured');
+    } catch (error) {
+      (error as Error).message.should.equal(
+        'enclavedExpressUrl and enclavedExpressCert are required',
+      );
+    }
   });
 
   it('should fail when transaction verification returns false', async () => {

src/enclavedBitgoExpress/routers/enclavedApiSpec.ts

@@ -84,7 +84,7 @@ export const EnclavedAPiSpec = apiSpec({
   'v1.multisig.sign': {
     post: httpRoute({
       method: 'POST',
-      path: '/{coin}/multisig/sign',
+      path: '/api/{coin}/multisig/sign',
       request: httpRequest({
         params: {
           coin: t.string,
@@ -98,7 +98,7 @@ export const EnclavedAPiSpec = apiSpec({
   'v1.multisig.recovery': {
     post: httpRoute({
       method: 'POST',
-      path: '/{coin}/multisig/recovery',
+      path: '/api/{coin}/multisig/recovery',
       request: httpRequest({
         params: {
           coin: t.string,
@@ -112,7 +112,7 @@ export const EnclavedAPiSpec = apiSpec({
   'v1.key.independent': {
     post: httpRoute({
       method: 'POST',
-      path: '/{coin}/key/independent',
+      path: '/api/{coin}/key/independent',
       request: httpRequest({
         params: {
           coin: t.string,

src/enclavedBitgoExpress/routers/healthCheck.ts

@@ -1,24 +1,17 @@
-import * as t from 'io-ts';
 import { apiSpec, httpRoute, httpRequest, HttpResponse } from '@api-ts/io-ts-http';
 import { createRouter, type WrappedRouter } from '@api-ts/typed-express-router';
 import { Response } from '@api-ts/response';
 import pjson from '../../../package.json';
 import { responseHandler } from '../../shared/middleware';
+import { PingResponseType, VersionResponseType } from '../../types/health';
 
-// Response type for /ping endpoint
+// API Response types
 const PingResponse: HttpResponse = {
-  200: t.type({
-    status: t.string,
-    timestamp: t.string,
-  }),
+  200: PingResponseType,
 };
 
-// Response type for /version endpoint
 const VersionResponse: HttpResponse = {
-  200: t.type({
-    version: t.string,
-    name: t.string,
-  }),
+  200: VersionResponseType,
 };
 
 // API Specification

src/enclavedBitgoExpress/routers/index.ts

@@ -0,0 +1,8 @@
+import { EnclavedAPiSpec as ApiSpec } from './enclavedApiSpec';
+import { HealthCheckApiSpec } from './healthCheck';
+
+export const EnclavedApiSpec = {
+  ...HealthCheckApiSpec,
+  ...ApiSpec,
+};
+export type EnclavedApiSpec = typeof EnclavedApiSpec;