xrpl 4.3.0 → 4.4.0-smartescrow.0

package/src/sugar/autofill.ts

@@ -19,6 +19,8 @@ const LEDGER_OFFSET = 20
 const RESTRICTED_NETWORKS = 1024
 const REQUIRED_NETWORKID_VERSION = '1.11.0'
 
+const MICRO_DROPS_PER_DROP = 1_000_000
+
 /**
  * Determines whether the source rippled version is not later than the target rippled version.
  * Example usage: isNotLaterRippledVersion('1.10.0', '1.11.0') returns true.
@@ -258,6 +260,17 @@ async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
   return new BigNumber(fee)
 }
 
+async function fetchGasPrice(client: Client): Promise<BigNumber> {
+  const response = await client.request({ command: 'server_state' })
+  const gasPrice = response.result.state.validated_ledger?.gas_price
+
+  if (gasPrice == null) {
+    return Promise.reject(new Error('Could not fetch Owner Reserve.'))
+  }
+
+  return new BigNumber(gasPrice)
+}
+
 /**
  * Calculates the fee per transaction type.
  *
@@ -266,30 +279,40 @@ async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
  * @param [signersCount=0] - The number of signers (default is 0). Only used for multisigning.
  * @returns A promise that returns the fee.
  */
-
+// eslint-disable-next-line max-lines-per-function -- needed here due to the complexity of the fee calculation
 async function calculateFeePerTransactionType(
   client: Client,
   tx: Transaction,
   signersCount = 0,
 ): Promise<BigNumber> {
   const netFeeXRP = await getFeeXrp(client)
-  const netFeeDrops = xrpToDrops(netFeeXRP)
-  let baseFee = new BigNumber(netFeeDrops)
+  const netFeeDrops = new BigNumber(xrpToDrops(netFeeXRP))
+  let baseFee = netFeeDrops
 
   const isSpecialTxCost = ['AccountDelete', 'AMMCreate'].includes(
     tx.TransactionType,
   )
 
-  // EscrowFinish Transaction with Fulfillment
-  if (tx.TransactionType === 'EscrowFinish' && tx.Fulfillment != null) {
-    const fulfillmentBytesSize: number = Math.ceil(tx.Fulfillment.length / 2)
-    // BaseFee × (33 + (Fulfillment size in bytes / 16))
-    baseFee = new BigNumber(
-      // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- expected use of magic numbers
-      scaleValue(netFeeDrops, 33 + fulfillmentBytesSize / 16),
-    )
-  } else if (isSpecialTxCost) {
-    baseFee = await fetchOwnerReserveFee(client)
+  // EscrowCreate transaction with FinishFunction
+  if (tx.TransactionType === 'EscrowCreate' && tx.FinishFunction != null) {
+    baseFee = baseFee.plus(1000)
+  } else if (tx.TransactionType === 'EscrowFinish') {
+    // EscrowFinish Transaction with Fulfillment/ComputationAllowance
+    if (tx.Fulfillment != null) {
+      const fulfillmentBytesSize: number = Math.ceil(tx.Fulfillment.length / 2)
+      // BaseFee × (33 + (Fulfillment size in bytes / 16))
+      baseFee = netFeeDrops.multipliedBy(
+        // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- expected use of magic numbers
+        33 + fulfillmentBytesSize / 16,
+      )
+    }
+    if (tx.ComputationAllowance != null) {
+      const gasPrice = await fetchGasPrice(client)
+      const extraFee: BigNumber = gasPrice
+        .multipliedBy(tx.ComputationAllowance)
+        .dividedBy(MICRO_DROPS_PER_DROP)
+      baseFee = baseFee.plus(extraFee)
+    }
   } else if (tx.TransactionType === 'Batch') {
     const rawTxFees = await tx.RawTransactions.reduce(async (acc, rawTxn) => {
       const resolvedAcc = await acc
@@ -300,6 +323,8 @@ async function calculateFeePerTransactionType(
       return BigNumber.sum(resolvedAcc, fee)
     }, Promise.resolve(new BigNumber(0)))
     baseFee = BigNumber.sum(baseFee.times(2), rawTxFees)
+  } else if (isSpecialTxCost) {
+    baseFee = await fetchOwnerReserveFee(client)
   }
 
   /*
@@ -307,7 +332,7 @@ async function calculateFeePerTransactionType(
    * BaseFee × (1 + Number of Signatures Provided)
    */
   if (signersCount > 0) {
-    baseFee = BigNumber.sum(baseFee, scaleValue(netFeeDrops, signersCount))
+    baseFee = BigNumber.sum(baseFee, netFeeDrops.multipliedBy(signersCount))
   }
 
   const maxFeeDrops = xrpToDrops(client.maxFeeXRP)
@@ -337,17 +362,6 @@ export async function getTransactionFee(
   tx.Fee = fee.toString(10)
 }
 
-/**
- * Scales the given value by multiplying it with the provided multiplier.
- *
- * @param value - The value to be scaled.
- * @param multiplier - The multiplier to scale the value.
- * @returns The scaled value as a string.
- */
-function scaleValue(value, multiplier): string {
-  return new BigNumber(value).times(multiplier).toString()
-}
-
 /**
  * Sets the latest validated ledger sequence for the transaction.
  *
@@ -394,6 +408,7 @@ export async function checkAccountDeleteBlockers(
     resolve()
   })
 }
+
 /**
  * Replaces Amount with DeliverMax if needed.
  *
@@ -405,8 +420,6 @@ export function handleDeliverMax(tx: Payment): void {
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed here
     if (tx.Amount == null) {
       // If only DeliverMax is provided, use it to populate the Amount field
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
-      // @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
       // eslint-disable-next-line no-param-reassign -- known RPC-level property
       tx.Amount = tx.DeliverMax
     }
@@ -459,28 +472,28 @@ export async function autofillBatchTxn(
 
     if (txn.Fee == null) {
       txn.Fee = '0'
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     } else if (txn.Fee !== '0') {
       throw new XrplError('Must have `Fee of "0" in inner Batch transaction.')
     }
 
     if (txn.SigningPubKey == null) {
       txn.SigningPubKey = ''
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     } else if (txn.SigningPubKey !== '') {
       throw new XrplError(
         'Must have `SigningPubKey` of "" in inner Batch transaction.',
       )
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     if (txn.TxnSignature != null) {
       throw new XrplError(
         'Must not have `TxnSignature` in inner Batch transaction.',
       )
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     if (txn.Signers != null) {
       throw new XrplError('Must not have `Signers` in inner Batch transaction.')
     }