Merge pull request #158 from BitGo/WP-6982

fix(mbe): fix return type of certain MBE routes

Author: alextse-bg

masterBitgoExpress.json

@@ -2,7 +2,7 @@
   "openapi": "3.0.3",
   "info": {
     "title": "@bitgo/master-bitgo-express",
-    "version": "0.0.0-semantically-released",
+    "version": "2.0.0",
     "description": "Advanced Wallets - On-Premises Key Management with BitGo Express"
   },
   "paths": {
@@ -952,7 +952,7 @@
     },
     "/api/{coin}/wallet/generate": {
       "post": {
-        "summary": "Generates a new onPrem self-managed cold wallet.",
+        "summary": "Generates a new advanced wallet.",
         "description": "The wallet creation process involves several steps that happen automatically:\n1. User Keychain Creation: Creates the user keychain in the advanced wallet manager and encrypts it with the respective KMS.\n2. Backup Keychain Creation: Creates the backup keychain in the advanced wallet manager and encrypts it with the respective KMS.\n3. Keychain Upload: Uploads the user/backup public keys to BitGo.\n4. BitGo Key Creation: Creates the BitGo key on the BitGo service.\n5. Wallet Creation: Creates the wallet on BitGo with the 3 keys.",
         "parameters": [
           {
@@ -1678,13 +1678,13 @@
                     "status": {
                       "type": "string"
                     },
-                    "advancedWalletManagerResponse": {
+                    "awmResponse": {
                       "$ref": "#/components/schemas/PingResponseType"
                     }
                   },
                   "required": [
                     "status",
-                    "advancedWalletManagerResponse"
+                    "awmResponse"
                   ]
                 }
               }
@@ -1947,15 +1947,6 @@
             "description": "Admin data (wallet policies)",
             "example": {}
           },
-          "pendingApprovals": {
-            "type": "array",
-            "example": [],
-            "items": {
-              "type": "object",
-              "additionalProperties": {},
-              "description": "Pending approvals on the wallet"
-            }
-          },
           "allowBackupKeySigning": {
             "type": "boolean",
             "description": "Flag for allowing signing with backup key",
@@ -2064,6 +2055,13 @@
           "pendingEcdsaTssInitialization": {
             "type": "boolean"
           },
+          "pendingApprovals": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "additionalProperties": {}
+            }
+          },
           "multisigType": {
             "type": "string"
           },
@@ -2103,7 +2101,6 @@
           "isCold",
           "coinSpecific",
           "admin",
-          "pendingApprovals",
           "allowBackupKeySigning",
           "clientFlags",
           "recoverable",

package.json

@@ -17,7 +17,7 @@
     "lint": "eslint --quiet --ignore-pattern scripts/bump-version.ts .",
     "lint:fix": "eslint --quiet --ignore-pattern scripts/bump-version.ts . --fix",
     "generate-test-ssl": "openssl req -x509 -newkey rsa:2048 -keyout demo.key -out demo.crt -days 365 -nodes -subj '/CN=localhost'",
-    "generate:openapi:masterExpress": "npx @api-ts/openapi-generator --name @bitgo/master-bitgo-express ./src/api/master/routers/index.ts > masterBitgoExpress.json",
+    "generate:openapi:masterExpress": "npx @api-ts/openapi-generator --name @bitgo/master-bitgo-express ./src/masterBitgoExpress/routers/index.ts > masterBitgoExpress.json",
     "container:build:master-bitgo-express": "podman build --build-arg PORT=3081 -t master-bitgo-express .",
     "container:build:advanced-wallet-manager": "podman build --build-arg PORT=3080 -t advanced-wallet-manager .",
     "bump-versions": "ts-node scripts/bump-version.ts"

src/masterBitgoExpress/routers/awmExpressHealth.ts

@@ -13,7 +13,7 @@ import { customDecodeErrorFormatter } from '../../shared/errorFormatters';
 const PingAwmResponse: HttpResponse = {
   200: t.type({
     status: t.string,
-    advancedWalletManagerResponse: PingResponseType,
+    awmResponse: PingResponseType,
   }),
   500: t.type({
     error: t.string,

src/masterBitgoExpress/routers/generateWalletRoute.ts

@@ -91,11 +91,6 @@ const WalletType = t.intersection([
      * @example {}
      */
     admin: t.record(t.string, t.unknown),
-    /**
-     * Pending approvals on the wallet
-     * @example []
-     */
-    pendingApprovals: t.array(t.record(t.string, t.unknown)),
     /**
      * Flag for allowing signing with backup key
      * @example false
@@ -159,6 +154,7 @@ const WalletType = t.intersection([
     unspentCount: t.number,
     pendingChainInitialization: t.boolean,
     pendingEcdsaTssInitialization: t.boolean,
+    pendingApprovals: t.array(t.record(t.string, t.unknown)),
     multisigType: t.string,
     multisigTypeVersion: t.string,
     type: t.string,