feat(mbe): update api spec

feat(mbp): swagger update

Author: cpatino-intive

masterBitgoExpress.json

@@ -73,14 +73,171 @@
               }
             }
           },
-          "202": {
-            "description": "Accepted",
+          "400": {
+            "description": "Bad Request",
             "content": {
               "application/json": {
                 "schema": {}
               }
             }
           },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    },
+                    "details": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "error",
+                    "details"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/{coin}/wallet/{walletId}/consolidateunspents": {
+      "post": {
+        "parameters": [
+          {
+            "name": "walletId",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "coin",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "pubkey": {
+                    "type": "string"
+                  },
+                  "source": {
+                    "type": "string",
+                    "enum": [
+                      "user",
+                      "backup"
+                    ]
+                  },
+                  "walletPassphrase": {
+                    "type": "string"
+                  },
+                  "feeRate": {
+                    "type": "number"
+                  },
+                  "maxFeeRate": {
+                    "type": "number"
+                  },
+                  "maxFeePercentage": {
+                    "type": "number"
+                  },
+                  "feeTxConfirmTarget": {
+                    "type": "number"
+                  },
+                  "bulk": {
+                    "type": "boolean"
+                  },
+                  "minValue": {
+                    "oneOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "number"
+                      }
+                    ]
+                  },
+                  "maxValue": {
+                    "oneOf": [
+                      {
+                        "type": "string"
+                      },
+                      {
+                        "type": "number"
+                      }
+                    ]
+                  },
+                  "minHeight": {
+                    "type": "number"
+                  },
+                  "minConfirms": {
+                    "type": "number"
+                  },
+                  "enforceMinConfirmsForChange": {
+                    "type": "boolean"
+                  },
+                  "limit": {
+                    "type": "number"
+                  },
+                  "numUnspentsToMake": {
+                    "type": "number"
+                  },
+                  "targetAddress": {
+                    "type": "string"
+                  },
+                  "txFormat": {
+                    "type": "string",
+                    "enum": [
+                      "legacy",
+                      "psbt",
+                      "psbt-lite"
+                    ]
+                  }
+                },
+                "required": [
+                  "pubkey",
+                  "source"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "tx": {
+                      "type": "string"
+                    },
+                    "txid": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "tx",
+                    "txid"
+                  ]
+                }
+              }
+            }
+          },
           "400": {
             "description": "Bad Request",
             "content": {

package.json

@@ -14,6 +14,7 @@
     "test:watch": "mocha --require ts-node/register --watch 'src/**/__tests__/**/*.test.ts'",
     "test:coverage": "nyc mocha --require ts-node/register 'src/**/__tests__/**/*.test.ts'",
     "lint": "eslint --quiet .",
+    "lint:fix": "eslint --quiet . --fix",
     "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:masterExpress": "npx @api-ts/openapi-generator --name @bitgo/master-bitgo-express ./src/api/master/routers/index.ts > masterBitgoExpress.json",
     "container:build": "podman build -t bitgo-onprem-express ."

src/__tests__/api/master/consolidateUnspents.test.ts

@@ -129,7 +129,8 @@ describe('POST /api/:coin/wallet/:walletId/consolidateunspents', () => {
     const mockError = {
       error: 'Internal Server Error',
       name: 'ApiResponseError',
-      details: 'There are too few unspents that meet the given parameters to consolidate (1 available).',
+      details:
+        'There are too few unspents that meet the given parameters to consolidate (1 available).',
     };
 
     const consolidateUnspentsStub = sinon
@@ -188,4 +189,4 @@ describe('POST /api/:coin/wallet/:walletId/consolidateunspents', () => {
     walletGetNock.done();
     keychainGetNock.done();
   });
-});
+});

src/api/master/handlerUtils.ts

@@ -0,0 +1,67 @@
+import { BitGo, RequestTracer } from 'bitgo';
+import { EnclavedExpressClient } from './clients/enclavedExpressClient';
+
+/**
+ * Fetch wallet and signing keychain, with validation for source and pubkey.
+ * Throws with a clear error if not found or mismatched.
+ */
+
+export async function getWalletAndSigningKeychain({
+  bitgo,
+  coin,
+  walletId,
+  params,
+  reqId,
+  KeyIndices,
+}: {
+  bitgo: BitGo;
+  coin: string;
+  walletId: string;
+  params: { source: 'user' | 'backup'; pubkey?: string };
+  reqId: RequestTracer;
+  KeyIndices: { USER: number; BACKUP: number; BITGO: number };
+}) {
+  const baseCoin = bitgo.coin(coin);
+
+  const wallet = await baseCoin.wallets().get({ id: walletId, reqId });
+
+  if (!wallet) {
+    throw new Error(`Wallet ${walletId} not found`);
+  }
+
+  const keyIdIndex = params.source === 'user' ? KeyIndices.USER : KeyIndices.BACKUP;
+  const signingKeychain = await baseCoin.keychains().get({
+    id: wallet.keyIds()[keyIdIndex],
+  });
+
+  if (!signingKeychain || !signingKeychain.pub) {
+    throw new Error(`Signing keychain for ${params.source} not found`);
+  }
+
+  if (params.pubkey && params.pubkey !== signingKeychain.pub) {
+    throw new Error(`Pub provided does not match the keychain on wallet for ${params.source}`);
+  }
+
+  return { baseCoin, wallet, signingKeychain };
+}
+/**
+ * Create a custom signing function that delegates to enclavedExpressClient.signMultisig.
+ */
+
+export function makeCustomSigningFunction({
+  enclavedExpressClient,
+  source,
+  pub,
+}: {
+  enclavedExpressClient: EnclavedExpressClient;
+  source: 'user' | 'backup';
+  pub: string;
+}) {
+  return async function customSigningFunction(signParams: any) {
+    return enclavedExpressClient.signMultisig({
+      txPrebuild: signParams.txPrebuild,
+      source,
+      pub,
+    });
+  };
+}

src/api/master/handlers/handleAccelerate.ts

@@ -1,7 +1,7 @@
 import { RequestTracer, KeyIndices } from '@bitgo/sdk-core';
 import logger from '../../../logger';
 import { MasterApiSpecRouteRequest } from '../routers/masterApiSpec';
-import { getWalletAndSigningKeychain, makeCustomSigningFunction } from '../../../shared/coinUtils';
+import { getWalletAndSigningKeychain, makeCustomSigningFunction } from '../handlerUtils';
 
 export async function handleAccelerate(
   req: MasterApiSpecRouteRequest<'v1.wallet.accelerate', 'post'>,

src/api/master/handlers/handleConsolidateUnspents.ts

@@ -1,46 +1,34 @@
 import { RequestTracer, KeyIndices } from '@bitgo/sdk-core';
 import logger from '../../../logger';
 import { MasterApiSpecRouteRequest } from '../routers/masterApiSpec';
+import { getWalletAndSigningKeychain, makeCustomSigningFunction } from '../handlerUtils';
 
 export async function handleConsolidateUnspents(
-  req: MasterApiSpecRouteRequest<'v1.wallet.consolidateUnspents', 'post'>,
+  req: MasterApiSpecRouteRequest<'v1.wallet.consolidateunspents', 'post'>,
 ) {
   const enclavedExpressClient = req.enclavedExpressClient;
   const reqId = new RequestTracer();
   const bitgo = req.bitgo;
-  const baseCoin = bitgo.coin((req as any).params.coin);
-  const params = (req as any).decoded;
-  const walletId = (req as any).params.walletId;
-  const wallet = await baseCoin.wallets().get({ id: walletId, reqId });
-
-  if (!wallet) {
-    throw new Error(`Wallet ${walletId} not found`);
-  }
-
-  // Get the signing keychain based on source
-  const keyIdIndex = params.source === 'user' ? KeyIndices.USER : KeyIndices.BACKUP;
-  const signingKeychain = await baseCoin.keychains().get({
-    id: wallet.keyIds()[keyIdIndex],
+  const params = req.decoded;
+  const walletId = req.params.walletId;
+  const coin = req.params.coin;
+
+  const { wallet, signingKeychain } = await getWalletAndSigningKeychain({
+    bitgo,
+    coin,
+    walletId,
+    params,
+    reqId,
+    KeyIndices,
   });
 
-  if (!signingKeychain || !signingKeychain.pub) {
-    throw new Error(`Signing keychain for ${params.source} not found`);
-  }
-
-  if (params.pubkey && params.pubkey !== signingKeychain.pub) {
-    throw new Error(`Pub provided does not match the keychain on wallet for ${params.source}`);
-  }
-
   try {
     // Create custom signing function that delegates to EBE
-    const customSigningFunction = async (signParams: any) => {
-      const signedTx = await enclavedExpressClient.signMultisig({
-        txPrebuild: signParams.txPrebuild,
-        source: params.source,
-        pub: signingKeychain.pub!,
-      });
-      return signedTx;
-    };
+    const customSigningFunction = makeCustomSigningFunction({
+      enclavedExpressClient,
+      source: params.source,
+      pub: signingKeychain.pub!,
+    });
 
     // Prepare consolidation parameters
     const consolidationParams = {
@@ -57,4 +45,4 @@ export async function handleConsolidateUnspents(
     logger.error('Failed to consolidate unspents: %s', err.message);
     throw err;
   }
-} 
+}