Merge pull request #7071 from BitGo/WP-5400-express-migrate-api-calculateminerfeeinfo-to-typed-routes

feat(express): migrate calculateminerfeeinfo to typed routes

Author: lokesh-bitgo

modules/express/src/clientRoutes.ts

@@ -297,7 +297,7 @@ function handleFanOutUnspents(req: express.Request) {
  * @deprecated
  * @param req
  */
-function handleCalculateMinerFeeInfo(req: express.Request) {
+function handleCalculateMinerFeeInfo(req: ExpressApiRouteRequest<'express.calculateminerfeeinfo', 'post'>) {
   return req.bitgo.calculateMinerFeeInfo({
     bitgo: req.bitgo,
     feeRate: req.body.feeRate,
@@ -1560,12 +1560,10 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
   router.post('express.encrypt', [prepareBitGo(config), typedPromiseWrapper(handleEncrypt)]);
   router.post('express.verifyaddress', [prepareBitGo(config), typedPromiseWrapper(handleVerifyAddress)]);
   router.post('express.lightning.initWallet', [prepareBitGo(config), typedPromiseWrapper(handleInitLightningWallet)]);
-  app.post(
-    '/api/v[12]/calculateminerfeeinfo',
-    parseBody,
+  router.post('express.calculateminerfeeinfo', [
     prepareBitGo(config),
-    promiseWrapper(handleCalculateMinerFeeInfo)
-  );
+    typedPromiseWrapper(handleCalculateMinerFeeInfo),
+  ]);
 
   app.post('/api/v1/keychain/local', parseBody, prepareBitGo(config), promiseWrapper(handleCreateLocalKeyChain));
   app.post('/api/v1/keychain/derive', parseBody, prepareBitGo(config), promiseWrapper(handleDeriveLocalKeyChain));

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

@@ -0,0 +1,54 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+export const CalculateMinerFeeInfoRequestBody = {
+  /** fee rate in satoshis per kilobyte, if not provided a fallback fee rate will be used */
+  feeRate: optional(t.number),
+  /** number of P2SH (multisig) inputs in the transaction */
+  nP2shInputs: t.number,
+  /** number of P2PKH (single sig) inputs in the transaction */
+  nP2pkhInputs: t.number,
+  /** number of P2SH-P2WSH (segwit) inputs in the transaction */
+  nP2shP2wshInputs: t.number,
+  /** number of outputs in the transaction */
+  nOutputs: t.number,
+  /** whether the transaction contains uncompressed public keys (affects size calculation) */
+  containsUncompressedPublicKeys: optional(t.boolean),
+};
+
+export const CalculateMinerFeeInfoResponse = t.type({
+  /** estimated size of the transaction in bytes */
+  size: t.number,
+  /** estimated fee in satoshis for the transaction */
+  fee: t.number,
+  /** fee rate that was used to estimate the fee (in satoshis per kilobyte) */
+  feeRate: t.number,
+});
+
+/**
+ * Calculate miner fee info
+ *
+ * Calculates the estimated size and fee for a transaction based on the number and types of inputs and outputs.
+ * This is useful for estimating the fee before creating a transaction.
+ *
+ * The calculation takes into account:
+ * 1. The number and types of inputs (P2SH, P2PKH, P2SH-P2WSH)
+ * 2. The number of outputs
+ * 3. Whether the transaction contains uncompressed public keys
+ * 4. The fee rate (in satoshis per kilobyte)
+ *
+ * @operationId express.calculateminerfeeinfo
+ */
+export const PostCalculateMinerFeeInfo = httpRoute({
+  path: '/api/v[12]/calculateminerfeeinfo',
+  method: 'POST',
+  request: httpRequest({
+    body: CalculateMinerFeeInfoRequestBody,
+  }),
+  response: {
+    200: CalculateMinerFeeInfoResponse,
+    400: BitgoExpressError,
+    404: BitgoExpressError,
+  },
+});

modules/express/src/typedRoutes/api/index.ts

@@ -8,6 +8,7 @@ import { PostLogin } from './common/login';
 import { PostDecrypt } from './common/decrypt';
 import { PostEncrypt } from './common/encrypt';
 import { PostVerifyAddress } from './common/verifyAddress';
+import { PostCalculateMinerFeeInfo } from './common/calculateMinerFeeInfo';
 import { PostAcceptShare } from './v1/acceptShare';
 import { PostSimpleCreate } from './v1/simpleCreate';
 import { PutPendingApproval } from './v1/pendingApproval';
@@ -52,6 +53,9 @@ export const ExpressApi = apiSpec({
   'express.verifycoinaddress': {
     post: PostVerifyCoinAddress,
   },
+  'express.calculateminerfeeinfo': {
+    post: PostCalculateMinerFeeInfo,
+  },
 });
 
 export type ExpressApi = typeof ExpressApi;