xrpl 4.3.0 → 4.4.0

package/src/models/transactions/AMMClawback.ts

@@ -6,8 +6,8 @@ import {
   BaseTransaction,
   GlobalFlagsInterface,
   isAccount,
-  isAmount,
-  isCurrency,
+  isIssuedCurrency,
+  isIssuedCurrencyAmount,
   validateBaseTransaction,
   validateOptionalField,
   validateRequiredField,
@@ -81,12 +81,9 @@ export function validateAMMClawback(tx: Record<string, unknown>): void {
 
   validateRequiredField(tx, 'Holder', isAccount)
 
-  validateRequiredField(tx, 'Asset', isCurrency)
+  validateRequiredField(tx, 'Asset', isIssuedCurrency)
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- required
-  const asset = tx.Asset as IssuedCurrency
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- required
-  const amount = tx.Amount as IssuedCurrencyAmount
+  const asset = tx.Asset
 
   if (tx.Holder === asset.issuer) {
     throw new ValidationError(
@@ -100,18 +97,18 @@ export function validateAMMClawback(tx: Record<string, unknown>): void {
     )
   }
 
-  validateRequiredField(tx, 'Asset2', isCurrency)
+  validateRequiredField(tx, 'Asset2', isIssuedCurrency)
 
-  validateOptionalField(tx, 'Amount', isAmount)
+  validateOptionalField(tx, 'Amount', isIssuedCurrencyAmount)
 
   if (tx.Amount != null) {
-    if (amount.currency !== asset.currency) {
+    if (tx.Amount.currency !== asset.currency) {
       throw new ValidationError(
         'AMMClawback: Amount.currency must match Asset.currency',
       )
     }
 
-    if (amount.issuer !== asset.issuer) {
+    if (tx.Amount.issuer !== asset.issuer) {
       throw new ValidationError(
         'AMMClawback: Amount.issuer must match Amount.issuer',
       )

package/src/models/transactions/AMMDelete.ts

@@ -1,7 +1,11 @@
 import { ValidationError } from '../../errors'
 import { Currency } from '../common'
 
-import { BaseTransaction, isCurrency, validateBaseTransaction } from './common'
+import {
+  BaseTransaction,
+  isIssuedCurrency,
+  validateBaseTransaction,
+} from './common'
 
 /**
  * Delete an empty Automated Market Maker (AMM) instance that could not be fully deleted automatically.
@@ -41,7 +45,7 @@ export function validateAMMDelete(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDelete: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMDelete: Asset must be a Currency')
   }
 
@@ -49,7 +53,7 @@ export function validateAMMDelete(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDelete: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMDelete: Asset2 must be a Currency')
   }
 }

package/src/models/transactions/AMMDeposit.ts

@@ -5,8 +5,8 @@ import {
   BaseTransaction,
   GlobalFlagsInterface,
   isAmount,
-  isCurrency,
   isIssuedCurrency,
+  isIssuedCurrencyAmount,
   validateBaseTransaction,
 } from './common'
 
@@ -89,7 +89,7 @@ export function validateAMMDeposit(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDeposit: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMDeposit: Asset must be a Currency')
   }
 
@@ -97,7 +97,7 @@ export function validateAMMDeposit(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDeposit: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMDeposit: Asset2 must be a Currency')
   }
 
@@ -111,7 +111,7 @@ export function validateAMMDeposit(tx: Record<string, unknown>): void {
     )
   }
 
-  if (tx.LPTokenOut != null && !isIssuedCurrency(tx.LPTokenOut)) {
+  if (tx.LPTokenOut != null && !isIssuedCurrencyAmount(tx.LPTokenOut)) {
     throw new ValidationError(
       'AMMDeposit: LPTokenOut must be an IssuedCurrencyAmount',
     )

package/src/models/transactions/AMMVote.ts

@@ -2,7 +2,11 @@ import { ValidationError } from '../../errors'
 import { Currency } from '../common'
 
 import { AMM_MAX_TRADING_FEE } from './AMMCreate'
-import { BaseTransaction, isCurrency, validateBaseTransaction } from './common'
+import {
+  BaseTransaction,
+  isIssuedCurrency,
+  validateBaseTransaction,
+} from './common'
 
 /**
  * Vote on the trading fee for an Automated Market Maker (AMM) instance.
@@ -43,7 +47,7 @@ export function validateAMMVote(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMVote: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMVote: Asset must be a Currency')
   }
 
@@ -51,7 +55,7 @@ export function validateAMMVote(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMVote: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMVote: Asset2 must be a Currency')
   }
 

package/src/models/transactions/AMMWithdraw.ts

@@ -5,8 +5,8 @@ import {
   BaseTransaction,
   GlobalFlagsInterface,
   isAmount,
-  isCurrency,
   isIssuedCurrency,
+  isIssuedCurrencyAmount,
   validateBaseTransaction,
 } from './common'
 
@@ -87,7 +87,7 @@ export function validateAMMWithdraw(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMWithdraw: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMWithdraw: Asset must be a Currency')
   }
 
@@ -95,7 +95,7 @@ export function validateAMMWithdraw(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMWithdraw: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMWithdraw: Asset2 must be a Currency')
   }
 
@@ -105,7 +105,7 @@ export function validateAMMWithdraw(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMWithdraw: must set Amount with EPrice')
   }
 
-  if (tx.LPTokenIn != null && !isIssuedCurrency(tx.LPTokenIn)) {
+  if (tx.LPTokenIn != null && !isIssuedCurrencyAmount(tx.LPTokenIn)) {
     throw new ValidationError(
       'AMMWithdraw: LPTokenIn must be an IssuedCurrencyAmount',
     )

package/src/models/transactions/MPTokenIssuanceCreate.ts

@@ -8,6 +8,9 @@ import {
   validateOptionalField,
   isString,
   isNumber,
+  MAX_MPT_META_BYTE_LENGTH,
+  MPT_META_WARNING_HEADER,
+  validateMPTokenMetadata,
 } from './common'
 import type { TransactionMetadataBase } from './metadata'
 
@@ -104,10 +107,18 @@ export interface MPTokenIssuanceCreate extends BaseTransaction {
    * The field must NOT be present if the `tfMPTCanTransfer` flag is not set.
    */
   TransferFee?: number
+
   /**
-   * Arbitrary metadata about this issuance, in hex format.
+   * Optional arbitrary metadata about this issuance, encoded as a hex string and limited to 1024 bytes.
+   *
+   * The decoded value must be a UTF-8 encoded JSON object that adheres to the
+   * XLS-89d MPTokenMetadata standard.
+   *
+   * While adherence to the XLS-89d format is not mandatory, non-compliant metadata
+   * may not be discoverable by ecosystem tools such as explorers and indexers.
    */
-  MPTokenMetadata?: string | null
+  MPTokenMetadata?: string
+
   Flags?: number | MPTokenIssuanceCreateFlagsInterface
 }
 
@@ -131,15 +142,13 @@ export function validateMPTokenIssuanceCreate(
   validateOptionalField(tx, 'TransferFee', isNumber)
   validateOptionalField(tx, 'AssetScale', isNumber)
 
-  if (typeof tx.MPTokenMetadata === 'string' && tx.MPTokenMetadata === '') {
+  if (
+    typeof tx.MPTokenMetadata === 'string' &&
+    (!isHex(tx.MPTokenMetadata) ||
+      tx.MPTokenMetadata.length / 2 > MAX_MPT_META_BYTE_LENGTH)
+  ) {
     throw new ValidationError(
-      'MPTokenIssuanceCreate: MPTokenMetadata must not be empty string',
-    )
-  }
-
-  if (typeof tx.MPTokenMetadata === 'string' && !isHex(tx.MPTokenMetadata)) {
-    throw new ValidationError(
-      'MPTokenIssuanceCreate: MPTokenMetadata must be in hex format',
+      `MPTokenIssuanceCreate: MPTokenMetadata (hex format) must be non-empty and no more than ${MAX_MPT_META_BYTE_LENGTH} bytes.`,
     )
   }
 
@@ -158,7 +167,9 @@ export function validateMPTokenIssuanceCreate(
 
   if (typeof tx.TransferFee === 'number') {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Not necessary
-    const flags = tx.Flags as number | MPTokenIssuanceCreateFlagsInterface
+    const flags = (tx.Flags ?? 0) as
+      | number
+      | MPTokenIssuanceCreateFlagsInterface
     const isTfMPTCanTransfer =
       typeof flags === 'number'
         ? isFlagEnabled(flags, MPTokenIssuanceCreateFlags.tfMPTCanTransfer)
@@ -176,5 +187,19 @@ export function validateMPTokenIssuanceCreate(
       )
     }
   }
+
+  if (tx.MPTokenMetadata != null) {
+    const validationMessages = validateMPTokenMetadata(tx.MPTokenMetadata)
+
+    if (validationMessages.length > 0) {
+      const message = [
+        MPT_META_WARNING_HEADER,
+        ...validationMessages.map((msg) => `- ${msg}`),
+      ].join('\n')
+
+      // eslint-disable-next-line no-console -- Required here.
+      console.warn(message)
+    }
+  }
 }
 /* eslint-enable max-lines-per-function */

package/src/models/transactions/MPTokenIssuanceSet.ts

@@ -69,7 +69,7 @@ export function validateMPTokenIssuanceSet(tx: Record<string, unknown>): void {
   validateOptionalField(tx, 'Holder', isAccount)
 
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Not necessary
-  const flags = tx.Flags as number | MPTokenIssuanceSetFlagsInterface
+  const flags = (tx.Flags ?? 0) as number | MPTokenIssuanceSetFlagsInterface
   const isTfMPTLock =
     typeof flags === 'number'
       ? isFlagEnabled(flags, MPTokenIssuanceSetFlags.tfMPTLock)

package/src/models/transactions/NFTokenCancelOffer.ts

@@ -1,6 +1,6 @@
 import { ValidationError } from '../../errors'
 
-import { BaseTransaction, validateBaseTransaction } from './common'
+import { BaseTransaction, isArray, validateBaseTransaction } from './common'
 import type { TransactionMetadataBase } from './metadata'
 
 /**
@@ -41,7 +41,7 @@ export interface NFTokenCancelOfferMetadata extends TransactionMetadataBase {
 export function validateNFTokenCancelOffer(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (!Array.isArray(tx.NFTokenOffers)) {
+  if (!isArray(tx.NFTokenOffers)) {
     throw new ValidationError('NFTokenCancelOffer: missing field NFTokenOffers')
   }
 

package/src/models/transactions/NFTokenCreateOffer.ts

@@ -146,10 +146,14 @@ export function validateNFTokenCreateOffer(tx: Record<string, unknown>): void {
     throw new ValidationError('NFTokenCreateOffer: invalid Amount')
   }
 
-  if (
-    typeof tx.Flags === 'number' &&
-    isFlagEnabled(tx.Flags, NFTokenCreateOfferFlags.tfSellNFToken)
-  ) {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- checked in BaseTransaction
+  const flags = (tx.Flags ?? 0) as number | NFTokenCreateOfferFlagsInterface
+  const isTfSellNFToken =
+    typeof flags === 'number'
+      ? isFlagEnabled(flags, NFTokenCreateOfferFlags.tfSellNFToken)
+      : flags.tfSellNFToken ?? false
+
+  if (isTfSellNFToken) {
     validateNFTokenSellOfferCases(tx)
   } else {
     validateNFTokenBuyOfferCases(tx)

package/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,
 }
 
 /**

package/src/models/transactions/checkCreate.ts

@@ -4,7 +4,7 @@ import { Amount } from '../common'
 import {
   BaseTransaction,
   validateBaseTransaction,
-  isIssuedCurrency,
+  isIssuedCurrencyAmount,
   isAccount,
   validateRequiredField,
   validateOptionalField,
@@ -64,11 +64,7 @@ export function validateCheckCreate(tx: Record<string, unknown>): void {
   validateRequiredField(tx, 'Destination', isAccount)
   validateOptionalField(tx, 'DestinationTag', isNumber)
 
-  if (
-    typeof tx.SendMax !== 'string' &&
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Only used by JS
-    !isIssuedCurrency(tx.SendMax as Record<string, unknown>)
-  ) {
+  if (typeof tx.SendMax !== 'string' && !isIssuedCurrencyAmount(tx.SendMax)) {
     throw new ValidationError('CheckCreate: invalid SendMax')
   }
 

package/src/models/transactions/clawback.ts

@@ -1,13 +1,15 @@
 import { ValidationError } from '../../errors'
-import { IssuedCurrencyAmount, MPTAmount } from '../common'
+import { ClawbackAmount } from '../common'
 
 import {
   BaseTransaction,
   validateBaseTransaction,
-  isIssuedCurrency,
+  isIssuedCurrencyAmount,
   isMPTAmount,
   isAccount,
   validateOptionalField,
+  isClawbackAmount,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -26,7 +28,7 @@ export interface Clawback extends BaseTransaction {
    * names MUST be lower-case. If the amount is IOU, the `issuer` field MUST be the holder's address,
    * whom to be clawed back.
    */
-  Amount: IssuedCurrencyAmount | MPTAmount
+  Amount: ClawbackAmount
   /**
    * Indicates the AccountID that the issuer wants to clawback. This field is only valid for clawing back
    * MPTs.
@@ -42,17 +44,14 @@ export interface Clawback extends BaseTransaction {
  */
 export function validateClawback(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
+  validateRequiredField(tx, 'Amount', isClawbackAmount)
   validateOptionalField(tx, 'Holder', isAccount)
 
-  if (tx.Amount == null) {
-    throw new ValidationError('Clawback: missing field Amount')
-  }
-
-  if (!isIssuedCurrency(tx.Amount) && !isMPTAmount(tx.Amount)) {
+  if (!isIssuedCurrencyAmount(tx.Amount) && !isMPTAmount(tx.Amount)) {
     throw new ValidationError('Clawback: invalid Amount')
   }
 
-  if (isIssuedCurrency(tx.Amount) && tx.Account === tx.Amount.issuer) {
+  if (isIssuedCurrencyAmount(tx.Amount) && tx.Account === tx.Amount.issuer) {
     throw new ValidationError('Clawback: invalid holder Account')
   }
 
@@ -60,7 +59,7 @@ export function validateClawback(tx: Record<string, unknown>): void {
     throw new ValidationError('Clawback: invalid holder Account')
   }
 
-  if (isIssuedCurrency(tx.Amount) && tx.Holder) {
+  if (isIssuedCurrencyAmount(tx.Amount) && tx.Holder) {
     throw new ValidationError('Clawback: cannot have Holder for currency')
   }