Merge pull request #8577 from BitGo/WCI-35-36

docs(express): CalculateMinerFeeV1 and V2

Author: rishikeshdadam136

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

@@ -3,37 +3,34 @@ 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 */
+  /** Custom minimum fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. If the applied `feeRate` does not meet a coin's required minimum transaction fee amount, the minimum is still applied (for example, 1000 sat/kvByte or a flat 1000 microAlgos) */
   feeRate: optional(t.number),
-  /** number of P2SH (multisig) inputs in the transaction */
+  /** Number of P2SH (multi-signature) inputs */
   nP2shInputs: t.number,
-  /** number of P2PKH (single sig) inputs in the transaction */
+  /** Number of P2PKH (single-signature) inputs */
   nP2pkhInputs: t.number,
-  /** number of P2SH-P2WSH (segwit) inputs in the transaction */
+  /** Number of P2SH_P2WSH (wrapped segwit multi-signature) inputs */
   nP2shP2wshInputs: t.number,
-  /** number of outputs in the transaction */
+  /** Number of outputs */
   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 */
+  /** Estimated size of the transaction in bytes */
   size: t.number,
-  /** estimated fee in satoshis for the transaction */
+  /** Estimated fee in base units for the transaction */
   fee: t.number,
-  /** fee rate that was used to estimate the fee (in satoshis per kilobyte) */
+  /** The fee rate in base units per kB used to estimate the fee for the transaction */
   feeRate: t.number,
 });
 
 /**
- * Calculate miner fee info (v1)
- *
- * 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.
+ * Calculate the fee and estimated size in bytes for a Bitcoin transaction
  *
  * @operationId express.v1.calculateminerfeeinfo
- * @tag express
+ * @tag Express
  */
 export const PostV1CalculateMinerFeeInfo = httpRoute({
   path: '/api/v1/calculateminerfeeinfo',

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

@@ -3,19 +3,10 @@ import { BitgoExpressError } from '../../schemas/error';
 import { CalculateMinerFeeInfoRequestBody, CalculateMinerFeeInfoResponse } from '../v1/calculateMinerFeeInfo';
 
 /**
- * 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)
+ * Calculate the fee and estimated size in bytes for a Bitcoin transaction
  *
  * @operationId express.calculateminerfeeinfo
- * @tag express
+ * @tag Express
  */
 export const PostV2CalculateMinerFeeInfo = httpRoute({
   path: '/api/v2/calculateminerfeeinfo',