feat: update bitgo-api-docs

This commit updates the BitGo API.

Author: dev-portal-updater-unprotected[bot]

api.yaml

@@ -35774,27 +35774,37 @@ components:
         numBlocks:
           type: integer
           description: |
-            (BTC only) Used to estimate the fee rate by targeting confirmation within the given number of blocks. If neither 'feeRate' nor 'numBlocks' is specified, a block target of 2 is used by default. Can be limited with 'maxFeeRate'.
+            (BTC only) The number of blocks required to confirm a transaction. You can use 'numBlocks' to estimate the fee rate by targeting confirmation within a given number of blocks. If both 'feeRate' and 'numBlocks' are absent, the transaction defaults to 2 blocks for confirmation.
+
+            Note: The 'maxFeeRate' limits the fee rate generated by 'numBlocks'.
           minimum: 2
           maximum: 1000
         feeRate:
           allOf:
             - $ref: '#/components/schemas/IntegerOrString'
             - example: 10000
           description: |
-            Custom minimum fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. For xrp, it refers to the open ledger fee in drops (1 XRP = 1000000 drops) and the actual fee used is usually 4.5 times the open ledger fee. 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 , a flat 1000 microAlgos or a flat 10 drops of xrp).
+            Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
+
+            If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
         maxFeeRate:
           allOf:
             - $ref: '#/components/schemas/IntegerOrIntegerString'
             - example: 20000
           description: |
-            Custom upper limit for fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. 'maxFeeRate' can be used to limit a fee rate estimate generated with 'numBlocks'.
+            (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate'.
         feeMultiplier:
           allOf:
             - $ref: '#/components/schemas/NumberOrString'
             - example: 1.5
           description: |
-            Custom multiplier for fee rate. Suggested to be used in conjunction with 'maxFeeRate' for higher priority transactions, or transactions which may not be broadcast for some time after being built. If used together with 'rbfTxIds' (RBF), it acts as an absolute fee multiplier for the transaction to be replaced. Must be greater than 0. Must be a number and greater than 1 if used for RBF.
+            (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+
+            Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
         minConfirms:
           type: integer
           description: |
@@ -36152,13 +36162,19 @@ components:
             - $ref: '#/components/schemas/IntegerOrString'
             - example: 10000
           description: |
-            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).
+            Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
+
+            If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
         maxFeeRate:
           allOf:
             - $ref: '#/components/schemas/IntegerOrIntegerString'
             - example: 20000
           description: |
-            Custom upper limit for fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. 'maxFeeRate' can be used to limit a fee rate estimate generated with 'numBlocks'.
+            (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate'.
         maxFeePercentage:
           type: integer
           description: Maximum relative portion that can be spent towards fees
@@ -36616,29 +36632,36 @@ components:
         - error
         - errorName
     EstimateTransactionFees:
-      title: General
+      title: Bitcoin
       type: object
       properties:
         feePerKb:
           type: integer
-          description: Fee per kilobyte for a transaction to be confirmed across two or more blocks. Defaults to 2 if 'numBlocks' is not provided in the request query.
+          description: (BTC only) The fee (in base units) per kilobyte (or virtual kilobyte) required to confirm a transaction on 2 or more blocks.
           example: 15902
         cpfpFeePerKb:
           type: integer
-          description: Child-Pays-For-Parent (CPFP) fee per kilobyte where the fee includes the fees for all unconfirmed transactions dependent on this transaction.
+          description: |
+            (BTC only) Child-Pays-For-Parent (CPFP) fee (in base units) per kilobyte (or virtual kilobyte). Includes the fees for all unconfirmed transactions dependent on the CPFP transaction.
         numBlocks:
           type: integer
-          description: The target block confirmation.
+          description: |
+            (BTC only) The number of blocks required to confirm a transaction. You can use 'numBlocks' to estimate the fee rate by targeting confirmation within a given number of blocks. If both 'feeRate' and 'numBlocks' are absent, the transaction defaults to 2 blocks for confirmation.
+
+            Note: The 'maxFeeRate' limits the fee rate generated by 'numBlocks'.
           example: 2
         confidence:
           type: integer
           minimum: 0
           maximum: 100
-          description: (BTC only) Confidence, as a percentage, in the accuracy of the fee estimate.
+          description: (BTC only) The confidence (as a percentage) in the accuracy of the fee estimate.
           example: 80
         feeByBlockTarget:
           type: object
-          description: (BTC only) Fee estimates are stored as a key-value pair where the key is the block target (between 1 and 1000) and the value is the corresponding fee estimate (in baseunits per kilobyte).
+          description: |
+            (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+
+            Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
           example:
             '1': 50536
             '2': 15902
@@ -36798,7 +36821,9 @@ components:
               minimum: 1
             - example: 1.5
           description: |
-            If used together with 'rbfTxIds' (RBF), it acts as an absolute fee multiplier for the transaction to be replaced - must be greater than 1.
+            (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+
+            Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
     ExpressAcceptShareRequest:
       type: object
       properties:
@@ -36926,13 +36951,19 @@ components:
             - $ref: '#/components/schemas/IntegerOrString'
             - example: 10000
           description: |
-            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).
+            Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
+
+            If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
         maxFeeRate:
           allOf:
             - $ref: '#/components/schemas/IntegerOrIntegerString'
             - example: 20000
           description: |
-            Custom upper limit for fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. 'maxFeeRate' can be used to limit a fee rate estimate generated with 'numBlocks'.
+            (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate'.
         maxFeePercentage:
           type: integer
           description: Maximum relative portion that can be spent towards fees
@@ -37023,13 +37054,19 @@ components:
             - $ref: '#/components/schemas/IntegerOrString'
             - example: 10000
           description: |
-            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).
+            Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
+
+            If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
         maxFeeRate:
           allOf:
             - $ref: '#/components/schemas/IntegerOrIntegerString'
             - example: 20000
           description: |
-            Custom upper limit for fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. 'maxFeeRate' can be used to limit a fee rate estimate generated with 'numBlocks'.
+            (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate'.
         maxFeePercentage:
           type: integer
           description: Maximum relative portion that can be spent towards fees
@@ -37445,7 +37482,11 @@ components:
                     - $ref: '#/components/schemas/IntegerOrString'
                     - example: 10000
                   description: |
-                    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).
+                    Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
+
+                    If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+
+                    Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
                 payGoFee:
                   type: integer
                   description: BitGo fee of the transaction (in base units)
@@ -37507,13 +37548,19 @@ components:
             - $ref: '#/components/schemas/IntegerOrString'
             - example: 10000
           description: |
-            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).
+            Custom fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte.
+
+            If the 'feeRate' is less than the minimum required network fee, then the minimum fee applies. For example, 1000 sat/kvByte, a flat 1000 microAlgos, or a flat 10 drops of xrp. For XRP, the actual fee is usually 4.5 times the open ledger fee.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate' and 'minFeeRate'.
         maxFeeRate:
           allOf:
             - $ref: '#/components/schemas/IntegerOrIntegerString'
             - example: 20000
           description: |
-            Custom upper limit for fee rate in a coin's base unit per kilobyte (or virtual kilobyte)--for example, satoshis per kvByte or microAlgos per kByte. 'maxFeeRate' can be used to limit a fee rate estimate generated with 'numBlocks'.
+            (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+
+            Note: The 'feeRate' overrides the 'maxFeeRate'.
         allowPartialSweep:
           type: boolean
           default: false
@@ -40459,21 +40506,27 @@ components:
           nullable: true
           example: 12000
           description: |
-            (UTXO only) Wallet-level minimum fee rate that must be greater than or equal to the default of 1000 satoshis/kvByte. Per transaction, you can override 'minFeeRate' with the 'feeRate' parameter.
+            (BTC only) The minimum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. Must be greater than or equal to the default of 1000 satoshis/kvByte. 
+
+            Note: The you can override 'minFeeRate' on a per transaction basis with the 'feeRate' parameter.
         maxFeeRate:
           type: integer
           minimum: 1000
           nullable: true
           example: 18000
           description: |
-            (UTXO only) Wallet-level maximum fee rate that must be greater than or equal to the default of 1000 satoshis/kvByte. Per transaction, you can override 'maxFeeRate' with the 'feeRate' parameter.
+            (BTC only) The maximum fee rate (in base units) per kilobyte (or virtual kilobyte). For example, satoshis per kvByte. The 'maxFeeRate' limits the fee rate generated by both 'feeMultiplier' and 'numBlocks'.
+
+            Note: The you can override 'maxFeeRate' on a per transaction basis with the 'feeRate' parameter.
         feeMultiplier:
           type: number
           minimum: 1
           nullable: true
           example: 1.2
           description: |
-            (UTXO only) Wallet-level custom multiplier for fee rate that must be greater than 1. The default multiplier is 1.2. The maximum fee rate still limits the new fee.
+            (UTXO only) Custom multiplier to the 'feeRate'. The resulting fee rate is limited by the 'maxFeeRate'. For replace-by-fee (RBF) transactions (that include 'rbfTxIds'), the 'feeMultiplier' must be greater than 1, since it's an absolute fee multiplier to the transaction being replaced.
+
+            Note: The 'maxFeeRate' limits the fee rate generated by 'feeMultiplier'.
         changeAddressType:
           $ref: '#/components/schemas/DefaultChangeAddressType'
         txFormat:
@@ -50929,7 +50982,10 @@ components:
         default: 2
         minimum: 1
         maximum: 1000
-      description: Sets the target estimated number of blocks for a confirmation
+      description: |
+        (BTC only) The number of blocks required to confirm a transaction. You can use 'numBlocks' to estimate the fee rate by targeting confirmation within a given number of blocks. If both 'feeRate' and 'numBlocks' are absent, the transaction defaults to 2 blocks for confirmation.
+
+        Note: The 'maxFeeRate' limits the fee rate generated by 'numBlocks'.
     unspentIds:
       name: unspentIds
       in: query