xrpl 4.4.0 → 4.5.0-smartescrow.0

package/src/models/methods/serverInfo.ts

@@ -85,6 +85,11 @@ export interface ServerInfoResponse extends BaseResponse {
         hash: string
         reserve_base_xrp: number
         reserve_inc_xrp: number
+
+        extension_compute: number
+        extension_size: number
+        gas_price: number
+
         seq: number
       }
       /**
@@ -252,6 +257,10 @@ export interface ServerInfoResponse extends BaseResponse {
          * object an account owns in the ledger.
          */
         reserve_inc_xrp: number
+
+        extension_compute: number
+        extension_size: number
+        gas_price: number
         /** The ledger index of the latest validated ledger. */
         seq: number
       }

package/src/models/methods/serverState.ts

@@ -30,6 +30,11 @@ export interface ServerStateResponse extends BaseResponse {
         hash: string
         reserve_base: number
         reserve_inc: number
+
+        extension_compute: number
+        extension_size: number
+        gas_price: number
+
         seq: number
       }
       io_latency_ms: number
@@ -69,6 +74,11 @@ export interface ServerStateResponse extends BaseResponse {
         hash: string
         reserve_base: number
         reserve_inc: number
+
+        extension_compute: number
+        extension_size: number
+        gas_price: number
+
         seq: number
       }
       validation_quorum: number

package/src/models/transactions/escrowCreate.ts

@@ -50,6 +50,10 @@ export interface EscrowCreate extends BaseTransaction {
    * payment, such as a hosted recipient at the destination address.
    */
   DestinationTag?: number
+
+  FinishFunction?: string
+
+  Data?: string
 }
 
 /**
@@ -71,9 +75,13 @@ export function validateEscrowCreate(tx: Record<string, unknown>): void {
     )
   }
 
-  if (tx.FinishAfter === undefined && tx.Condition === undefined) {
+  if (
+    tx.FinishAfter === undefined &&
+    tx.Condition === undefined &&
+    tx.FinishFunction === undefined
+  ) {
     throw new ValidationError(
-      'EscrowCreate: Either Condition or FinishAfter must be specified',
+      'EscrowCreate: Either FinishAfter, Condition, or FinishFunction must be specified',
     )
   }
 

package/src/models/transactions/escrowFinish.ts

@@ -9,6 +9,7 @@ import {
   validateRequiredField,
   MAX_AUTHORIZED_CREDENTIALS,
 } from './common'
+import { TransactionMetadataBase } from './metadata'
 
 /**
  * Deliver XRP from a held payment to the recipient.
@@ -38,6 +39,14 @@ export interface EscrowFinish extends BaseTransaction {
    * The credentials included must not be expired.
    */
   CredentialIDs?: string[]
+
+  ComputationAllowance?: number
+}
+
+export interface EscrowFinishMetadata extends TransactionMetadataBase {
+  // if ComputationAllowance is present and the Smart Escrow runs
+  GasUsed?: number
+  WasmReturnCode?: number
 }
 
 /**

package/src/models/transactions/metadata.ts

@@ -1,6 +1,7 @@
 import { Amount, MPTAmount } from '../common'
 
 import { BaseTransaction } from './common'
+import { EscrowFinish, EscrowFinishMetadata } from './escrowFinish'
 import {
   MPTokenIssuanceCreate,
   MPTokenIssuanceCreateMetadata,
@@ -105,4 +106,6 @@ export type TransactionMetadata<T extends BaseTransaction = Transaction> =
     ? NFTokenCancelOfferMetadata
     : T extends MPTokenIssuanceCreate
     ? MPTokenIssuanceCreateMetadata
+    : T extends EscrowFinish
+    ? EscrowFinishMetadata
     : TransactionMetadataBase

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.
  *