XLS 85d: Token Escrow

.ci-config/rippled.cfg

@@ -190,6 +190,7 @@ fixInvalidTxFlags
 # 2.5.0 Amendments
 PermissionDelegation
 Batch
+TokenEscrow
 
 # This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
 [voting]

packages/ripple-binary-codec/src/types/uint-64.ts

@@ -12,7 +12,8 @@ function useBase10(fieldName: string): boolean {
   return (
     fieldName === 'MaximumAmount' ||
     fieldName === 'OutstandingAmount' ||
-    fieldName === 'MPTAmount'
+    fieldName === 'MPTAmount' ||
+    fieldName === 'LockedAmount'
   )
 }
 

packages/xrpl/HISTORY.md

@@ -7,6 +7,9 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 ### Fixed
 * Fix `AccountRoot` ledger object to correctly parse `FirstNFTokenSequence` field.
 
+### Added
+* Implement support for XLS-85d Token Escrow amendment.
+
 ## 4.3.0 (2025-6-09)
 
 ### Added

packages/xrpl/src/models/ledger/AccountRoot.ts

@@ -146,6 +146,12 @@ export interface AccountRootFlagsInterface {
    * This address can claw back issued IOUs. Once enabled, cannot be disabled.
    */
   lsfAllowTrustLineClawback?: boolean
+
+  /**
+   * If the issuer's account does not have the lsfAllowTrustLineLocking flag set,
+   * then Escrow ledger-objects cannot be created with such IOUs.
+   */
+  lsfAllowTrustLineLocking?: boolean
 }
 
 export enum AccountRootFlags {
@@ -210,4 +216,9 @@ export enum AccountRootFlags {
    * This address can claw back issued IOUs. Once enabled, cannot be disabled.
    */
   lsfAllowTrustLineClawback = 0x80000000,
+  /**
+   * If the issuer's account does not have the lsfAllowTrustLineLocking flag set,
+   * then Escrow ledger-objects cannot be created with such IOUs.
+   */
+  lsfAllowTrustLineLocking = 0x40000000,
 }

packages/xrpl/src/models/ledger/Escrow.ts

@@ -19,7 +19,8 @@ export default interface Escrow extends BaseLedgerEntry, HasPreviousTxnID {
    * successful.
    */
   Destination: string
-  /** The amount of XRP, in drops, to be delivered by the held payment. */
+  /** The amount to be delivered by the held payment. Can represent XRP, an IOU token, or an MPT.
+   * Must always be a positive value. */
   Amount: string
   /**
    * A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
@@ -61,4 +62,16 @@ export default interface Escrow extends BaseLedgerEntry, HasPreviousTxnID {
    * this object, in case the directory consists of multiple pages.
    */
   DestinationNode?: string
+
+  /**
+   * The transfer rate or fee at which the funds are escrowed, stored at creation
+   *  and used during settlement. Applicable to both IOUs and MPTs.
+   */
+  TransferRate?: number
+
+  /**
+   * (Optional) The ledger index of the issuer's directory node associated with
+   * the Escrow. Used when the issuer is neither the source nor destination account.
+   */
+  IssuerNode?: number
 }

packages/xrpl/src/models/ledger/MPToken.ts

@@ -8,4 +8,7 @@ export interface MPToken extends BaseLedgerEntry, HasPreviousTxnID {
   MPTAmount?: MPTAmount
   Flags: number
   OwnerNode?: string
+
+  // (Optional) The total of all outstanding escrows for this issuance.
+  LockedAmount?: string
 }

packages/xrpl/src/models/ledger/MPTokenIssuance.ts

@@ -10,4 +10,7 @@ export interface MPTokenIssuance extends BaseLedgerEntry, HasPreviousTxnID {
   TransferFee?: number
   MPTokenMetadata?: string
   OwnerNode?: string
+
+  // (Optional) The total of all outstanding escrows for this issuance.
+  LockedAmount?: string
 }

packages/xrpl/src/models/transactions/accountSet.ts

@@ -61,6 +61,8 @@ export enum AccountSetAsfFlags {
   asfDisallowIncomingTrustline = 15,
   /** Permanently gain the ability to claw back issued IOUs */
   asfAllowTrustLineClawback = 16,
+  /** Issuers allow their IOUs to be used as escrow amounts */
+  asfAllowTrustLineLocking = 17,
 }
 
 /**

packages/xrpl/src/models/transactions/escrowCreate.ts

@@ -1,4 +1,5 @@
 import { ValidationError } from '../../errors'
+import { Amount, MPTAmount } from '../common'
 
 import {
   Account,
@@ -18,11 +19,12 @@ import {
 export interface EscrowCreate extends BaseTransaction {
   TransactionType: 'EscrowCreate'
   /**
-   * Amount of XRP, in drops, to deduct from the sender's balance and escrow.
-   * Once escrowed, the XRP can either go to the Destination address (after the.
-   * FinishAfter time) or returned to the sender (after the CancelAfter time).
+   * The amount to deduct from the sender's balance and and set aside in escrow.
+   * Once escrowed, this amount can either go to the Destination address (after any Finish times/conditions)
+   * or returned to the sender (after any cancellation times/conditions). Can represent XRP, in drops,
+   * an IOU token, or an MPT. Must always be a positive value.
    */
-  Amount: string
+  Amount: Amount | MPTAmount
   /** Address to receive escrowed XRP. */
   Destination: Account
   /**
@@ -62,8 +64,10 @@ export function validateEscrowCreate(tx: Record<string, unknown>): void {
     throw new ValidationError('EscrowCreate: missing field Amount')
   }
 
-  if (typeof tx.Amount !== 'string') {
-    throw new ValidationError('EscrowCreate: Amount must be a string')
+  if (typeof tx.Amount !== 'string' && typeof tx.Amount !== 'object') {
+    throw new ValidationError(
+      'EscrowCreate: Amount must be a string (XRP) or object (IOU or MPT)',
+    )
   }
 
   validateRequiredField(tx, 'Destination', isAccount)