Merge pull request #7115 from BitGo/WP-5411-express-migrate-api-pendingapprovals-id-construct-tx-to-typed-routes

feat(express): migrate constrctTx to typed routes

Author: lokesh-bitgo

modules/express/src/clientRoutes.ts

@@ -257,7 +257,7 @@ function handleApproveTransaction(req: ExpressApiRouteRequest<'express.v1.pendin
  * @deprecated
  * @param req
  */
-function handleConstructApprovalTx(req: express.Request) {
+function handleConstructApprovalTx(req: ExpressApiRouteRequest<'express.v1.pendingapproval.constructTx', 'put'>) {
   const params = req.body || {};
   return req.bitgo
     .pendingApprovals()
@@ -1593,12 +1593,10 @@ export function setupAPIRoutes(app: express.Application, config: Config): void {
 
   router.put('express.v1.pendingapprovals', [prepareBitGo(config), typedPromiseWrapper(handleApproveTransaction)]);
 
-  app.put(
-    '/api/v1/pendingapprovals/:id/constructTx',
-    parseBody,
+  router.put('express.v1.pendingapproval.constructTx', [
     prepareBitGo(config),
-    promiseWrapper(handleConstructApprovalTx)
-  );
+    typedPromiseWrapper(handleConstructApprovalTx),
+  ]);
 
   app.put(
     '/api/v1/wallet/:id/consolidateunspents',

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

@@ -20,6 +20,7 @@ import { PostUnlockLightningWallet } from './v2/unlockWallet';
 import { PostVerifyCoinAddress } from './v2/verifyAddress';
 import { PostDeriveLocalKeyChain } from './v1/deriveLocalKeyChain';
 import { PostCreateLocalKeyChain } from './v1/createLocalKeyChain';
+import { PutConstructPendingApprovalTx } from './v1/constructPendingApprovalTx';
 
 export const ExpressApi = apiSpec({
   'express.ping': {
@@ -76,6 +77,9 @@ export const ExpressApi = apiSpec({
   'express.v1.keychain.local': {
     post: PostCreateLocalKeyChain,
   },
+  'express.v1.pendingapproval.constructTx': {
+    put: PutConstructPendingApprovalTx,
+  },
 });
 
 export type ExpressApi = typeof ExpressApi;

modules/express/src/typedRoutes/api/v1/constructPendingApprovalTx.ts

@@ -0,0 +1,77 @@
+import * as t from 'io-ts';
+import { httpRoute, httpRequest, optional } from '@api-ts/io-ts-http';
+import { BitgoExpressError } from '../../schemas/error';
+
+/**
+ * Request parameters for constructing a pending approval transaction
+ */
+export const ConstructPendingApprovalTxRequestParams = {
+  /** The ID of the pending approval */
+  id: t.string,
+};
+
+/**
+ * Request body for constructing a pending approval transaction
+ */
+export const ConstructPendingApprovalTxRequestBody = {
+  /** The wallet passphrase to decrypt the user key (either walletPassphrase or xprv must be provided for transactionRequest type) */
+  walletPassphrase: optional(t.string),
+  /** The extended private key (alternative to walletPassphrase) */
+  xprv: optional(t.string),
+  /** Whether to use the original fee from the transaction request (cannot be used with fee, feeRate, or feeTxConfirmTarget) */
+  useOriginalFee: optional(t.boolean),
+  /** Custom fee amount in satoshis (cannot be used with useOriginalFee) */
+  fee: optional(t.number),
+  /** Custom fee rate in satoshis per kilobyte (cannot be used with useOriginalFee) */
+  feeRate: optional(t.number),
+  /** Custom fee confirmation target in blocks (cannot be used with useOriginalFee) */
+  feeTxConfirmTarget: optional(t.number),
+};
+
+/**
+ * Response for constructing a pending approval transaction
+ */
+export const ConstructPendingApprovalTxResponse = t.type({
+  /** The signed transaction hex */
+  tx: t.string,
+  /** The fee amount in satoshis */
+  fee: optional(t.number),
+  /** The fee rate in satoshis per kilobyte */
+  feeRate: optional(t.number),
+  /** Whether the transaction is instant */
+  instant: optional(t.boolean),
+  /** The BitGo fee amount */
+  bitgoFee: optional(t.unknown),
+  /** Travel information */
+  travelInfos: optional(t.unknown),
+  /** Estimated transaction size in bytes */
+  estimatedSize: optional(t.number),
+  /** Unspent transaction outputs used */
+  unspents: optional(t.array(t.unknown)),
+});
+
+/**
+ * Construct a pending approval transaction
+ *
+ * This endpoint constructs and signs a transaction for a pending approval, returning the transaction hex
+ * but not sending it to the network. This is useful for reviewing the transaction before approving it.
+ *
+ * For transaction request type approvals, either a wallet passphrase or xprv must be provided to sign the transaction.
+ * You can optionally specify fee-related parameters to customize the transaction fee.
+ *
+ * @operationId express.v1.pendingapproval.constructTx
+ */
+export const PutConstructPendingApprovalTx = httpRoute({
+  path: '/api/v1/pendingapprovals/:id/constructTx',
+  method: 'PUT',
+  request: httpRequest({
+    params: ConstructPendingApprovalTxRequestParams,
+    body: ConstructPendingApprovalTxRequestBody,
+  }),
+  response: {
+    /** Successfully constructed transaction */
+    200: ConstructPendingApprovalTxResponse,
+    /** Invalid request or construction fails */
+    400: BitgoExpressError,
+  },
+});