feat: moved mbe ping enclave to api-ts

Ticket: WP-4593

Author: mohammadalfaiyazbitgo

package.json

@@ -14,14 +14,19 @@
     "test:watch": "jest --watch",
     "test:coverage": "jest --coverage",
     "lint": "eslint --quiet .",
-    "generate-test-ssl": "openssl req -x509 -newkey rsa:2048 -keyout test-ssl-key.pem -out test-ssl-cert.pem -days 365 -nodes -subj '/CN=localhost'"
+    "generate-test-ssl": "openssl req -x509 -newkey rsa:2048 -keyout test-ssl-key.pem -out test-ssl-cert.pem -days 365 -nodes -subj '/CN=localhost'",
+    "generate-openapi": "npx openapi-generator ./src/masterExpressApi.ts > src/masterExpressApi.openapi.json"
   },
   "dependencies": {
     "@bitgo/sdk-core": "^33.2.0",
     "bitgo": "^44.2.0",
     "body-parser": "^1.20.3",
     "connect-timeout": "^1.9.0",
     "debug": "^3.1.0",
+    "@api-ts/io-ts-http": "^3.2.1",
+    "@api-ts/express-wrapper": "^1.0.33",
+    "@api-ts/response": "^2.1.0",
+    "io-ts": "~2.1.3",
     "express": "4.17.3",
     "lodash": "^4.17.20",
     "morgan": "^1.9.1",
@@ -31,6 +36,7 @@
     "zod": "^3.25.48"
   },
   "devDependencies": {
+    "@api-ts/openapi-generator": "^5.7.0",
     "@types/body-parser": "^1.17.0",
     "@types/connect-timeout": "^1.9.0",
     "@types/debug": "^4.1.12",

src/config.ts

@@ -209,7 +209,7 @@ function masterExpressEnvConfig(): Partial<MasterExpressConfig> {
     timeout: Number(readEnvVar('BITGO_TIMEOUT')),
     keepAliveTimeout: Number(readEnvVar('BITGO_KEEP_ALIVE_TIMEOUT')),
     headersTimeout: Number(readEnvVar('BITGO_HEADERS_TIMEOUT')),
-    // BitGo API settings
+    // BitGo MasterExpressApi settings
     env: readEnvVar('BITGO_ENV') as EnvironmentName,
     customRootUri: readEnvVar('BITGO_CUSTOM_ROOT_URI'),
     enableSSL: readEnvVar('BITGO_ENABLE_SSL') !== 'false', // Default to true unless explicitly set to false

src/errors.ts

@@ -17,7 +17,7 @@ export class EnclavedError extends Error {
 }
 
 /**
- * Error for API responses
+ * Error for MasterExpressApi responses
  */
 export class ApiResponseError extends EnclavedError {
   public result: any;

src/masterBitgoExpress/enclavedExpressClient.ts

@@ -70,7 +70,7 @@ export class EnclavedExpressClient {
     try {
       debugLogger('Creating independent keychain for coin: %s', this.coin);
       const { body: keychain } = await superagent
-        .post(`${this.url}/api/${this.coin}/key/independent`)
+        .post(`${this.url}/${this.coin}/key/independentkey`)
         .ca(this.sslCert)
         .agent(
           new https.Agent({

src/masterBitgoExpress/generateWallet.ts

@@ -1,68 +1,60 @@
 import {
-  GenerateWalletOptions,
+  AddKeychainOptions,
+  Keychain,
+  KeychainsTriplet,
   promiseProps,
   RequestTracer,
   SupplementGenerateWalletOptions,
-  Keychain,
-  KeychainsTriplet,
-  Wallet,
   WalletWithKeychains,
-  AddKeychainOptions,
+  type Wallet,
 } from '@bitgo/sdk-core';
 import { createEnclavedExpressClient } from './enclavedExpressClient';
-import _ from 'lodash';
-import { BitGoRequest } from '../types/request';
+import { BitGo } from 'bitgo';
+
+export type GenerateMultiSigOnPremWalletParams = {
+  coin: string;
+  label: string;
+  enterprise?: string;
+};
 
 /**
- * This route is used to generate a multisig wallet when enclaved express is enabled
+ * Generate multisig wallet keys using enclaved express and create the wallet in BitGo
+ * @param {BitGo} bitgo the sdk instance
+ * @param {GenerateMultiSigOnPremWalletParams} params
  */
-export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
-  const bitgo = req.bitgo;
-  const baseCoin = bitgo.coin(req.params.coin);
-
-  const enclavedExpressClient = createEnclavedExpressClient(req.params.coin);
+export async function generateMultiSigOnPremWallet({
+  bitgo,
+  params,
+}: {
+  bitgo: BitGo;
+  params: GenerateMultiSigOnPremWalletParams;
+}): Promise<WalletWithKeychains> {
+  const baseCoin = bitgo.coin(params.coin);
+
+  const enclavedExpressClient = createEnclavedExpressClient(params.coin);
   if (!enclavedExpressClient) {
     throw new Error(
       'Enclaved express client not configured - enclaved express features will be disabled',
     );
   }
 
-  const params = req.body as GenerateWalletOptions;
   const reqId = new RequestTracer();
 
-  // Assign the default multiSig type value based on the coin
-  if (!params.multisigType) {
-    params.multisigType = baseCoin.getDefaultMultisigType();
-  }
-
-  if (typeof params.label !== 'string') {
-    throw new Error('missing required string parameter label');
-  }
-
-  const { label, enterprise } = params;
-
   // Create wallet parameters with type assertion to allow 'onprem' subtype
   const walletParams = {
-    label: label,
+    label: params.label,
     m: 2,
     n: 3,
     keys: [],
     type: 'cold',
-    subType: 'onprem',
+    subType: 'onPrem',
     multisigType: 'onchain',
   } as unknown as SupplementGenerateWalletOptions; // TODO: Add onprem to the SDK subType and remove "unknown" type casting
 
-  if (!_.isUndefined(enterprise)) {
-    if (!_.isString(enterprise)) {
-      throw new Error('invalid enterprise argument, expecting string');
-    }
-    walletParams.enterprise = enterprise;
-  }
-
   const userKeychainPromise = async (): Promise<Keychain> => {
     const userKeychain = await enclavedExpressClient.createIndependentKeychain({
       source: 'user',
-      coin: req.params.coin,
+      coin: params.coin,
       type: 'independent',
     });
     const userKeychainParams: AddKeychainOptions = {
@@ -73,13 +65,13 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
     };
 
     const newUserKeychain = await baseCoin.keychains().add(userKeychainParams);
-    return _.extend({}, newUserKeychain, userKeychain);
+    return { ...newUserKeychain, ...userKeychain };
   };
 
   const backupKeychainPromise = async (): Promise<Keychain> => {
     const backupKeychain = await enclavedExpressClient.createIndependentKeychain({
       source: 'backup',
-      coin: req.params.coin,
+      coin: params.coin,
       type: 'independent',
     });
     const backupKeychainParams: AddKeychainOptions = {
@@ -90,7 +82,7 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
     };
 
     const newBackupKeychain = await baseCoin.keychains().add(backupKeychainParams);
-    return _.extend({}, newBackupKeychain, backupKeychain);
+    return { ...newBackupKeychain, ...backupKeychain };
   };
 
   const { userKeychain, backupKeychain, bitgoKeychain }: KeychainsTriplet = await promiseProps({
@@ -99,7 +91,8 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
     bitgoKeychain: baseCoin.keychains().createBitGo({
       enterprise: params.enterprise,
       reqId,
-      isDistributedCustody: params.isDistributedCustody,
+      // not applicable for onPrem wallets
+      isDistributedCustody: false,
     }),
   });
 
@@ -114,15 +107,19 @@ export async function handleGenerateWalletOnPrem(req: BitGoRequest) {
   const finalWalletParams = await baseCoin.supplementGenerateWallet(walletParams, keychains);
 
   bitgo.setRequestTracer(reqId);
-  const newWallet = await bitgo.post(baseCoin.url('/wallet/add')).send(finalWalletParams).result();
-
-  const result: WalletWithKeychains = {
-    wallet: new Wallet(bitgo, baseCoin, newWallet),
+  const wallet = (await baseCoin.wallets().add({
+    ...finalWalletParams,
+    enterprise: params.enterprise,
+    reqId,
+    // Not valid for onPrem wallets
+    isDistributedCustody: false,
+  })) as Wallet;
+
+  return {
+    wallet: wallet,
     userKeychain: userKeychain,
     backupKeychain: backupKeychain,
     bitgoKeychain: bitgoKeychain,
     responseType: 'WalletWithKeychains',
   };
-
-  return { ...result, wallet: result.wallet.toJSON() };
 }