xrpl 4.3.0-smartescrow.0 → 4.3.0-smartescrow.2

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/methods/subscribe.ts

@@ -275,13 +275,17 @@ interface TransactionStreamBase<
    * The approximate time this ledger was closed, in date time string format.
    * Always uses the UTC time zone.
    */
-  close_time_iso: string
+  close_time_iso: Version extends typeof RIPPLED_API_V2 ? string : never
   /** String Transaction result code. */
   engine_result: string
   /** Numeric transaction response code, if applicable. */
   engine_result_code: number
   /** Human-readable explanation for the transaction response. */
   engine_result_message: string
+  /**
+   * The unique hash identifier of the transaction.
+   */
+  hash?: Version extends typeof RIPPLED_API_V2 ? string : never
   /**
    * The ledger index of the current in-progress ledger version for which this
    * transaction is currently proposed.

package/src/models/transactions/NFTokenMint.ts

@@ -1,4 +1,5 @@
 import { ValidationError } from '../../errors'
+import { Amount } from '../common'
 import { isHex } from '../utils'
 
 import {
@@ -6,6 +7,8 @@ import {
   BaseTransaction,
   GlobalFlags,
   isAccount,
+  isAmount,
+  isNumber,
   validateBaseTransaction,
   validateOptionalField,
 } from './common'
@@ -104,12 +107,34 @@ export interface NFTokenMint extends BaseTransaction {
    * set to `undefined` value if you do not use it.
    */
   URI?: string | null
+  /**
+   * Indicates the amount expected for the Token.
+   *
+   * The amount can be zero. This would indicate that the account is giving
+   * the token away free, either to anyone at all, or to the account identified
+   * by the Destination field.
+   */
+  Amount?: Amount
+  /**
+   * Indicates the time after which the offer will no longer
+   * be valid. The value is the number of seconds since the
+   * Ripple Epoch.
+   */
+  Expiration?: number
+  /**
+   * If present, indicates that this offer may only be
+   * accepted by the specified account. Attempts by other
+   * accounts to accept this offer MUST fail.
+   */
+  Destination?: Account
   Flags?: number | NFTokenMintFlagsInterface
 }
 
 export interface NFTokenMintMetadata extends TransactionMetadataBase {
   // rippled 1.11.0 or later
   nftoken_id?: string
+  // if Amount is present
+  offer_id?: string
 }
 
 /**
@@ -140,4 +165,16 @@ export function validateNFTokenMint(tx: Record<string, unknown>): void {
   if (tx.NFTokenTaxon == null) {
     throw new ValidationError('NFTokenMint: missing field NFTokenTaxon')
   }
+
+  if (tx.Amount == null) {
+    if (tx.Expiration != null || tx.Destination != null) {
+      throw new ValidationError(
+        'NFTokenMint: Amount is required when Expiration or Destination is present',
+      )
+    }
+  }
+
+  validateOptionalField(tx, 'Amount', isAmount)
+  validateOptionalField(tx, 'Expiration', isNumber)
+  validateOptionalField(tx, 'Destination', isAccount)
 }

package/src/models/transactions/escrowFinish.ts

@@ -38,6 +38,8 @@ export interface EscrowFinish extends BaseTransaction {
    * The credentials included must not be expired.
    */
   CredentialIDs?: string[]
+
+  ComputationAllowance?: number
 }
 
 /**

package/src/sugar/autofill.ts

@@ -18,6 +18,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.
@@ -230,13 +232,13 @@ export async function setNextValidSequenceNumber(
 }
 
 /**
- * Fetches the account deletion fee from the server state using the provided client.
+ * Fetches the owner reserve fee from the server state using the provided client.
  *
  * @param client - The client object used to make the request.
- * @returns A Promise that resolves to the account deletion fee as a BigNumber.
- * @throws {Error} Throws an error if the account deletion fee cannot be fetched.
+ * @returns A Promise that resolves to the owner reserve fee as a BigNumber.
+ * @throws {Error} Throws an error if the owner reserve fee cannot be fetched.
  */
-async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
+async function fetchOwnerReserveFee(client: Client): Promise<BigNumber> {
   const response = await client.request({ command: 'server_state' })
   const fee = response.result.state.validated_ledger?.reserve_inc
 
@@ -247,6 +249,17 @@ async function fetchAccountDeleteFee(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.
  *
@@ -255,68 +268,65 @@ async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
  * @param [signersCount=0] - The number of signers (default is 0). Only used for multisigning.
  * @returns A promise that resolves with void. Modifies the `tx` parameter to give it the calculated fee.
  */
+// eslint-disable-next-line max-lines-per-function -- okay here
 export async function calculateFeePerTransactionType(
   client: Client,
   tx: Transaction,
   signersCount = 0,
 ): Promise<void> {
-  // netFee is usually 0.00001 XRP (10 drops)
   const netFeeXRP = await getFeeXrp(client)
-  const netFeeDrops = xrpToDrops(netFeeXRP)
-  let baseFee = new BigNumber(netFeeDrops)
-
-  // EscrowFinish Transaction with Fulfillment
-  if (tx.TransactionType === 'EscrowFinish' && tx.Fulfillment != null) {
-    const fulfillmentBytesSize: number = Math.ceil(tx.Fulfillment.length / 2)
-    // 10 drops × (33 + (Fulfillment size in bytes / 16))
-    const product = new BigNumber(
-      // eslint-disable-next-line @typescript-eslint/no-magic-numbers -- expected use of magic numbers
-      scaleValue(netFeeDrops, 33 + fulfillmentBytesSize / 16),
-    )
-    baseFee = product.dp(0, BigNumber.ROUND_CEIL)
+  const netFeeDrops = new BigNumber(xrpToDrops(netFeeXRP))
+  let baseFee = netFeeDrops
+
+  // EscrowFinish Transaction with Fulfillment/ComputationAllowance
+  if (tx.TransactionType === 'EscrowFinish') {
+    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)
+    }
   }
   // EscrowCreate transaction with FinishFunction
   if (tx.TransactionType === 'EscrowCreate' && tx.FinishFunction != null) {
-    baseFee = BigNumber.sum(baseFee, 1000)
+    baseFee = baseFee.plus(1000)
   }
 
-  if (
-    tx.TransactionType === 'AccountDelete' ||
-    tx.TransactionType === 'AMMCreate'
-  ) {
-    baseFee = await fetchAccountDeleteFee(client)
+  const isSpecialTxCost = ['AccountDelete', 'AMMCreate'].includes(
+    tx.TransactionType,
+  )
+
+  if (isSpecialTxCost) {
+    baseFee = await fetchOwnerReserveFee(client)
   }
 
   /*
    * Multi-signed Transaction
-   * 10 drops × (1 + Number of Signatures Provided)
+   * BaseFee × (1 + Number of Signatures Provided)
    */
   if (signersCount > 0) {
-    baseFee = BigNumber.sum(baseFee, scaleValue(netFeeDrops, 1 + signersCount))
+    baseFee = BigNumber.sum(baseFee, netFeeDrops.multipliedBy(1 + signersCount))
   }
 
   const maxFeeDrops = xrpToDrops(client.maxFeeXRP)
-  const totalFee =
-    tx.TransactionType === 'AccountDelete'
-      ? baseFee
-      : BigNumber.min(baseFee, maxFeeDrops)
+  const totalFee = isSpecialTxCost
+    ? baseFee
+    : BigNumber.min(baseFee, maxFeeDrops)
 
   // Round up baseFee and return it as a string
-  // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-magic-numbers -- param reassign is safe, base 10 magic num
+  // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-magic-numbers, require-atomic-updates -- safe reassignment.
   tx.Fee = totalFee.dp(0, BigNumber.ROUND_CEIL).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.
  *