xrpl 2.12.0 → 2.14.0

package/src/models/transactions/accountDelete.ts

@@ -1,6 +1,12 @@
-import { ValidationError } from '../../errors'
-
-import { BaseTransaction, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isNumber,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
 
 /**
  * An AccountDelete transaction deletes an account and any objects it owns in
@@ -16,7 +22,7 @@ export interface AccountDelete extends BaseTransaction {
    * sending account. Must be a funded account in the ledger, and must not be.
    * the sending account.
    */
-  Destination: string
+  Destination: Account
   /**
    * Arbitrary destination tag that identifies a hosted recipient or other.
    * information for the recipient of the deleted account's leftover XRP.
@@ -33,18 +39,6 @@ export interface AccountDelete extends BaseTransaction {
 export function validateAccountDelete(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.Destination === undefined) {
-    throw new ValidationError('AccountDelete: missing field Destination')
-  }
-
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError('AccountDelete: invalid Destination')
-  }
-
-  if (
-    tx.DestinationTag !== undefined &&
-    typeof tx.DestinationTag !== 'number'
-  ) {
-    throw new ValidationError('AccountDelete: invalid DestinationTag')
-  }
+  validateRequiredField(tx, 'Destination', isAccount)
+  validateOptionalField(tx, 'DestinationTag', isNumber)
 }

package/src/models/transactions/accountSet.ts

@@ -1,8 +1,12 @@
-import { isValidClassicAddress } from 'ripple-address-codec'
-
 import { ValidationError } from '../../errors'
 
-import { BaseTransaction, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  validateBaseTransaction,
+  validateOptionalField,
+} from './common'
 
 /**
  * Enum for AccountSet Flags.
@@ -155,7 +159,7 @@ export interface AccountSet extends BaseTransaction {
    * Sets an alternate account that is allowed to mint NFTokens on this
    * account's behalf using NFTokenMint's `Issuer` field.
    */
-  NFTokenMinter?: string
+  NFTokenMinter?: Account
 }
 
 const MIN_TICK_SIZE = 3
@@ -167,16 +171,11 @@ const MAX_TICK_SIZE = 15
  * @param tx - An AccountSet Transaction.
  * @throws When the AccountSet is Malformed.
  */
-// eslint-disable-next-line max-lines-per-function, max-statements -- okay for this method, only a little over
+// eslint-disable-next-line max-lines-per-function -- okay for this method, only a little over
 export function validateAccountSet(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (
-    tx.NFTokenMinter !== undefined &&
-    !isValidClassicAddress(String(tx.NFTokenMinter))
-  ) {
-    throw new ValidationError('AccountSet: invalid NFTokenMinter')
-  }
+  validateOptionalField(tx, 'NFTokenMinter', isAccount)
 
   if (tx.ClearFlag !== undefined) {
     if (typeof tx.ClearFlag !== 'number') {

package/src/models/transactions/checkCreate.ts

@@ -5,6 +5,11 @@ import {
   BaseTransaction,
   validateBaseTransaction,
   isIssuedCurrency,
+  isAccount,
+  validateRequiredField,
+  validateOptionalField,
+  isNumber,
+  Account,
 } from './common'
 
 /**
@@ -17,7 +22,7 @@ import {
 export interface CheckCreate extends BaseTransaction {
   TransactionType: 'CheckCreate'
   /** The unique address of the account that can cash the Check. */
-  Destination: string
+  Destination: Account
   /**
    * Maximum amount of source currency the Check is allowed to debit the
    * sender, including transfer fees on non-XRP currencies. The Check can only
@@ -56,9 +61,8 @@ export function validateCheckCreate(tx: Record<string, unknown>): void {
     throw new ValidationError('CheckCreate: missing field SendMax')
   }
 
-  if (tx.Destination === undefined) {
-    throw new ValidationError('CheckCreate: missing field Destination')
-  }
+  validateRequiredField(tx, 'Destination', isAccount)
+  validateOptionalField(tx, 'DestinationTag', isNumber)
 
   if (
     typeof tx.SendMax !== 'string' &&
@@ -68,17 +72,6 @@ export function validateCheckCreate(tx: Record<string, unknown>): void {
     throw new ValidationError('CheckCreate: invalid SendMax')
   }
 
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError('CheckCreate: invalid Destination')
-  }
-
-  if (
-    tx.DestinationTag !== undefined &&
-    typeof tx.DestinationTag !== 'number'
-  ) {
-    throw new ValidationError('CheckCreate: invalid DestinationTag')
-  }
-
   if (tx.Expiration !== undefined && typeof tx.Expiration !== 'number') {
     throw new ValidationError('CheckCreate: invalid Expiration')
   }

package/src/models/transactions/common.ts

@@ -1,3 +1,4 @@
+import { isValidClassicAddress, isValidXAddress } from 'ripple-address-codec'
 import { TRANSACTION_TYPES } from 'ripple-binary-codec'
 
 import { ValidationError } from '../../errors'
@@ -118,6 +119,24 @@ export function isIssuedCurrency(
   )
 }
 
+/**
+ * Must be a valid account address
+ */
+export type Account = string
+
+/**
+ * Verify a string is in fact a valid account address.
+ *
+ * @param account - The object to check the form and type of.
+ * @returns Whether the account is properly formed account for a transaction.
+ */
+export function isAccount(account: unknown): account is Account {
+  return (
+    typeof account === 'string' &&
+    (isValidClassicAddress(account) || isValidXAddress(account))
+  )
+}
+
 /**
  * Verify the form and type of an Amount at runtime.
  *
@@ -203,7 +222,7 @@ export interface GlobalFlags {}
  */
 export interface BaseTransaction {
   /** The unique address of the transaction sender. */
-  Account: string
+  Account: Account
   /**
    * The type of transaction. Valid types include: `Payment`, `OfferCreate`,
    * `TrustSet`, and many others.

package/src/models/transactions/escrowCancel.ts

@@ -1,6 +1,12 @@
 import { ValidationError } from '../../errors'
 
-import { BaseTransaction, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  validateBaseTransaction,
+  validateRequiredField,
+} from './common'
 
 /**
  * Return escrowed XRP to the sender.
@@ -10,7 +16,7 @@ import { BaseTransaction, validateBaseTransaction } from './common'
 export interface EscrowCancel extends BaseTransaction {
   TransactionType: 'EscrowCancel'
   /** Address of the source account that funded the escrow payment. */
-  Owner: string
+  Owner: Account
   /**
    * Transaction sequence (or Ticket  number) of EscrowCreate transaction that.
    * created the escrow to cancel.
@@ -27,13 +33,7 @@ export interface EscrowCancel extends BaseTransaction {
 export function validateEscrowCancel(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.Owner == null) {
-    throw new ValidationError('EscrowCancel: missing Owner')
-  }
-
-  if (typeof tx.Owner !== 'string') {
-    throw new ValidationError('EscrowCancel: Owner must be a string')
-  }
+  validateRequiredField(tx, 'Owner', isAccount)
 
   if (tx.OfferSequence == null) {
     throw new ValidationError('EscrowCancel: missing OfferSequence')

package/src/models/transactions/escrowCreate.ts

@@ -1,6 +1,14 @@
 import { ValidationError } from '../../errors'
 
-import { BaseTransaction, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isNumber,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
 
 /**
  * Sequester XRP until the escrow process either finishes or is canceled.
@@ -16,7 +24,7 @@ export interface EscrowCreate extends BaseTransaction {
    */
   Amount: string
   /** Address to receive escrowed XRP. */
-  Destination: string
+  Destination: Account
   /**
    * The time, in seconds since the Ripple Epoch, when this escrow expires.
    * This value is immutable; the funds can only be returned the sender after.
@@ -58,13 +66,8 @@ export function validateEscrowCreate(tx: Record<string, unknown>): void {
     throw new ValidationError('EscrowCreate: Amount must be a string')
   }
 
-  if (tx.Destination === undefined) {
-    throw new ValidationError('EscrowCreate: missing field Destination')
-  }
-
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError('EscrowCreate: Destination must be a string')
-  }
+  validateRequiredField(tx, 'Destination', isAccount)
+  validateOptionalField(tx, 'DestinationTag', isNumber)
 
   if (tx.CancelAfter === undefined && tx.FinishAfter === undefined) {
     throw new ValidationError(
@@ -89,11 +92,4 @@ export function validateEscrowCreate(tx: Record<string, unknown>): void {
   if (tx.Condition !== undefined && typeof tx.Condition !== 'string') {
     throw new ValidationError('EscrowCreate: Condition must be a string')
   }
-
-  if (
-    tx.DestinationTag !== undefined &&
-    typeof tx.DestinationTag !== 'number'
-  ) {
-    throw new ValidationError('EscrowCreate: DestinationTag must be a number')
-  }
 }

package/src/models/transactions/escrowFinish.ts

@@ -1,6 +1,12 @@
 import { ValidationError } from '../../errors'
 
-import { BaseTransaction, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  validateBaseTransaction,
+  validateRequiredField,
+} from './common'
 
 /**
  * Deliver XRP from a held payment to the recipient.
@@ -10,7 +16,7 @@ import { BaseTransaction, validateBaseTransaction } from './common'
 export interface EscrowFinish extends BaseTransaction {
   TransactionType: 'EscrowFinish'
   /** Address of the source account that funded the held payment. */
-  Owner: string
+  Owner: Account
   /**
    * Transaction sequence of EscrowCreate transaction that created the held.
    * payment to finish.
@@ -37,13 +43,7 @@ export interface EscrowFinish extends BaseTransaction {
 export function validateEscrowFinish(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.Owner == null) {
-    throw new ValidationError('EscrowFinish: missing field Owner')
-  }
-
-  if (typeof tx.Owner !== 'string') {
-    throw new ValidationError('EscrowFinish: Owner must be a string')
-  }
+  validateRequiredField(tx, 'Owner', isAccount)
 
   if (tx.OfferSequence == null) {
     throw new ValidationError('EscrowFinish: missing field OfferSequence')

package/src/models/transactions/index.ts

@@ -1,5 +1,10 @@
 export { BaseTransaction } from './common'
-export { validate, TransactionAndMetadata, Transaction } from './transaction'
+export {
+  validate,
+  PseudoTransaction,
+  TransactionAndMetadata,
+  Transaction,
+} from './transaction'
 export * from './metadata'
 export {
   AccountSetAsfFlags,
@@ -26,6 +31,8 @@ export { CheckCancel } from './checkCancel'
 export { CheckCash } from './checkCash'
 export { CheckCreate } from './checkCreate'
 export { Clawback } from './clawback'
+export { DIDDelete } from './DIDDelete'
+export { DIDSet } from './DIDSet'
 export { DepositPreauth } from './depositPreauth'
 export { EscrowCancel } from './escrowCancel'
 export { EscrowCreate } from './escrowCreate'

package/src/models/transactions/payment.ts

@@ -7,6 +7,11 @@ import {
   isAmount,
   GlobalFlags,
   validateBaseTransaction,
+  isAccount,
+  validateRequiredField,
+  validateOptionalField,
+  isNumber,
+  Account,
 } from './common'
 
 /**
@@ -112,7 +117,7 @@ export interface Payment extends BaseTransaction {
    */
   Amount: Amount
   /** The unique address of the account receiving the payment. */
-  Destination: string
+  Destination: Account
   /**
    * Arbitrary tag that identifies the reason for the payment to the
    * destination, or a hosted recipient to pay.
@@ -163,19 +168,8 @@ export function validatePayment(tx: Record<string, unknown>): void {
     throw new ValidationError('PaymentTransaction: invalid Amount')
   }
 
-  if (tx.Destination === undefined) {
-    throw new ValidationError('PaymentTransaction: missing field Destination')
-  }
-
-  if (!isAmount(tx.Destination)) {
-    throw new ValidationError('PaymentTransaction: invalid Destination')
-  }
-
-  if (tx.DestinationTag != null && typeof tx.DestinationTag !== 'number') {
-    throw new ValidationError(
-      'PaymentTransaction: DestinationTag must be a number',
-    )
-  }
+  validateRequiredField(tx, 'Destination', isAccount)
+  validateOptionalField(tx, 'DestinationTag', isNumber)
 
   if (tx.InvoiceID !== undefined && typeof tx.InvoiceID !== 'string') {
     throw new ValidationError('PaymentTransaction: InvoiceID must be a string')

package/src/models/transactions/paymentChannelCreate.ts

@@ -1,6 +1,14 @@
 import { ValidationError } from '../../errors'
 
-import { BaseTransaction, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isNumber,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
 
 /**
  * Create a unidirectional channel and fund it with XRP. The address sending
@@ -21,7 +29,7 @@ export interface PaymentChannelCreate extends BaseTransaction {
    * Address to receive XRP claims against this channel. This is also known as
    * the "destination address" for the channel.
    */
-  Destination: string
+  Destination: Account
   /**
    * Amount of time the source address must wait before closing the channel if
    * it has unclaimed XRP.
@@ -54,7 +62,6 @@ export interface PaymentChannelCreate extends BaseTransaction {
  * @param tx - An PaymentChannelCreate Transaction.
  * @throws When the PaymentChannelCreate is Malformed.
  */
-// eslint-disable-next-line max-lines-per-function -- okay for this function, there's a lot of things to check
 export function validatePaymentChannelCreate(
   tx: Record<string, unknown>,
 ): void {
@@ -68,15 +75,8 @@ export function validatePaymentChannelCreate(
     throw new ValidationError('PaymentChannelCreate: Amount must be a string')
   }
 
-  if (tx.Destination === undefined) {
-    throw new ValidationError('PaymentChannelCreate: missing Destination')
-  }
-
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError(
-      'PaymentChannelCreate: Destination must be a string',
-    )
-  }
+  validateRequiredField(tx, 'Destination', isAccount)
+  validateOptionalField(tx, 'DestinationTag', isNumber)
 
   if (tx.SettleDelay === undefined) {
     throw new ValidationError('PaymentChannelCreate: missing SettleDelay')
@@ -103,13 +103,4 @@ export function validatePaymentChannelCreate(
       'PaymentChannelCreate: CancelAfter must be a number',
     )
   }
-
-  if (
-    tx.DestinationTag !== undefined &&
-    typeof tx.DestinationTag !== 'number'
-  ) {
-    throw new ValidationError(
-      'PaymentChannelCreate: DestinationTag must be a number',
-    )
-  }
 }

package/src/models/transactions/transaction.ts

@@ -20,6 +20,9 @@ import { CheckCreate, validateCheckCreate } from './checkCreate'
 import { Clawback, validateClawback } from './clawback'
 import { isIssuedCurrency } from './common'
 import { DepositPreauth, validateDepositPreauth } from './depositPreauth'
+import { DIDDelete, validateDIDDelete } from './DIDDelete'
+import { DIDSet, validateDIDSet } from './DIDSet'
+import { EnableAmendment } from './enableAmendment'
 import { EscrowCancel, validateEscrowCancel } from './escrowCancel'
 import { EscrowCreate, validateEscrowCreate } from './escrowCreate'
 import { EscrowFinish, validateEscrowFinish } from './escrowFinish'
@@ -53,10 +56,12 @@ import {
   PaymentChannelFund,
   validatePaymentChannelFund,
 } from './paymentChannelFund'
+import { SetFee } from './setFee'
 import { SetRegularKey, validateSetRegularKey } from './setRegularKey'
 import { SignerListSet, validateSignerListSet } from './signerListSet'
 import { TicketCreate, validateTicketCreate } from './ticketCreate'
 import { TrustSet, validateTrustSet } from './trustSet'
+import { UNLModify } from './UNLModify'
 import {
   XChainAccountCreateCommit,
   validateXChainAccountCreateCommit,
@@ -88,18 +93,20 @@ import {
  * @category Transaction Models
  */
 export type Transaction =
-  | AccountDelete
-  | AccountSet
   | AMMBid
+  | AMMCreate
   | AMMDelete
   | AMMDeposit
-  | AMMCreate
   | AMMVote
   | AMMWithdraw
+  | AccountDelete
+  | AccountSet
   | CheckCancel
   | CheckCash
   | CheckCreate
   | Clawback
+  | DIDDelete
+  | DIDSet
   | DepositPreauth
   | EscrowCancel
   | EscrowCreate
@@ -119,15 +126,17 @@ export type Transaction =
   | SignerListSet
   | TicketCreate
   | TrustSet
+  | XChainAccountCreateCommit
   | XChainAddAccountCreateAttestation
   | XChainAddClaimAttestation
   | XChainClaim
   | XChainCommit
   | XChainCreateBridge
   | XChainCreateClaimID
-  | XChainAccountCreateCommit
   | XChainModifyBridge
 
+export type PseudoTransaction = EnableAmendment | SetFee | UNLModify
+
 /**
  * @category Transaction Models
  */
@@ -205,18 +214,14 @@ export function validate(transaction: Record<string, unknown>): void {
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- okay here
   setTransactionFlagsToNumber(tx as unknown as Transaction)
   switch (tx.TransactionType) {
-    case 'AccountDelete':
-      validateAccountDelete(tx)
-      break
-
-    case 'AccountSet':
-      validateAccountSet(tx)
-      break
-
     case 'AMMBid':
       validateAMMBid(tx)
       break
 
+    case 'AMMCreate':
+      validateAMMCreate(tx)
+      break
+
     case 'AMMDelete':
       validateAMMDelete(tx)
       break
@@ -225,10 +230,6 @@ export function validate(transaction: Record<string, unknown>): void {
       validateAMMDeposit(tx)
       break
 
-    case 'AMMCreate':
-      validateAMMCreate(tx)
-      break
-
     case 'AMMVote':
       validateAMMVote(tx)
       break
@@ -237,6 +238,14 @@ export function validate(transaction: Record<string, unknown>): void {
       validateAMMWithdraw(tx)
       break
 
+    case 'AccountDelete':
+      validateAccountDelete(tx)
+      break
+
+    case 'AccountSet':
+      validateAccountSet(tx)
+      break
+
     case 'CheckCancel':
       validateCheckCancel(tx)
       break
@@ -253,6 +262,14 @@ export function validate(transaction: Record<string, unknown>): void {
       validateClawback(tx)
       break
 
+    case 'DIDDelete':
+      validateDIDDelete(tx)
+      break
+
+    case 'DIDSet':
+      validateDIDSet(tx)
+      break
+
     case 'DepositPreauth':
       validateDepositPreauth(tx)
       break
@@ -329,6 +346,10 @@ export function validate(transaction: Record<string, unknown>): void {
       validateTrustSet(tx)
       break
 
+    case 'XChainAccountCreateCommit':
+      validateXChainAccountCreateCommit(tx)
+      break
+
     case 'XChainAddAccountCreateAttestation':
       validateXChainAddAccountCreateAttestation(tx)
       break
@@ -353,10 +374,6 @@ export function validate(transaction: Record<string, unknown>): void {
       validateXChainCreateClaimID(tx)
       break
 
-    case 'XChainAccountCreateCommit':
-      validateXChainAccountCreateCommit(tx)
-      break
-
     case 'XChainModifyBridge':
       validateXChainModifyBridge(tx)
       break

package/src/models/utils/flags.ts

@@ -10,6 +10,8 @@ import { AccountSetTfFlags } from '../transactions/accountSet'
 import { AMMDepositFlags } from '../transactions/AMMDeposit'
 import { AMMWithdrawFlags } from '../transactions/AMMWithdraw'
 import { GlobalFlags } from '../transactions/common'
+import { NFTokenCreateOfferFlags } from '../transactions/NFTokenCreateOffer'
+import { NFTokenMintFlags } from '../transactions/NFTokenMint'
 import { OfferCreateFlags } from '../transactions/offerCreate'
 import { PaymentFlags } from '../transactions/payment'
 import { PaymentChannelClaimFlags } from '../transactions/paymentChannelClaim'
@@ -43,6 +45,19 @@ export function parseAccountRootFlags(
   return flagsInterface
 }
 
+const txToFlag = {
+  AccountSet: AccountSetTfFlags,
+  AMMDeposit: AMMDepositFlags,
+  AMMWithdraw: AMMWithdrawFlags,
+  NFTokenCreateOffer: NFTokenCreateOfferFlags,
+  NFTokenMint: NFTokenMintFlags,
+  OfferCreate: OfferCreateFlags,
+  PaymentChannelClaim: PaymentChannelClaimFlags,
+  Payment: PaymentFlags,
+  TrustSet: TrustSetFlags,
+  XChainModifyBridge: XChainModifyBridgeFlags,
+}
+
 /**
  * Sets a transaction's flags to its numeric representation.
  *
@@ -57,34 +72,9 @@ export function setTransactionFlagsToNumber(tx: Transaction): void {
     return
   }
 
-  switch (tx.TransactionType) {
-    case 'AccountSet':
-      tx.Flags = convertFlagsToNumber(tx.Flags, AccountSetTfFlags)
-      return
-    case 'AMMDeposit':
-      tx.Flags = convertFlagsToNumber(tx.Flags, AMMDepositFlags)
-      return
-    case 'AMMWithdraw':
-      tx.Flags = convertFlagsToNumber(tx.Flags, AMMWithdrawFlags)
-      return
-    case 'OfferCreate':
-      tx.Flags = convertFlagsToNumber(tx.Flags, OfferCreateFlags)
-      return
-    case 'PaymentChannelClaim':
-      tx.Flags = convertFlagsToNumber(tx.Flags, PaymentChannelClaimFlags)
-      return
-    case 'Payment':
-      tx.Flags = convertFlagsToNumber(tx.Flags, PaymentFlags)
-      return
-    case 'TrustSet':
-      tx.Flags = convertFlagsToNumber(tx.Flags, TrustSetFlags)
-      return
-    case 'XChainModifyBridge':
-      tx.Flags = convertFlagsToNumber(tx.Flags, XChainModifyBridgeFlags)
-      return
-    default:
-      tx.Flags = 0
-  }
+  tx.Flags = txToFlag[tx.TransactionType]
+    ? convertFlagsToNumber(tx.Flags, txToFlag[tx.TransactionType])
+    : 0
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- added ValidationError check for flagEnum

package/src/utils/hashes/hashLedger.ts

@@ -10,6 +10,7 @@ import { ValidationError, XrplError } from '../../errors'
 import type { Ledger } from '../../models/ledger'
 import { LedgerEntry } from '../../models/ledger'
 import { Transaction, TransactionMetadata } from '../../models/transactions'
+import { PseudoTransaction } from '../../models/transactions/transaction'
 
 import HashPrefix from './HashPrefix'
 import sha512Half from './sha512Half'
@@ -124,7 +125,9 @@ export function hashLedgerHeader(ledgerHeader: Ledger): string {
  * @category Utilities
  */
 export function hashTxTree(
-  transactions: Array<Transaction & { metaData?: TransactionMetadata }>,
+  transactions: Array<
+    (Transaction | PseudoTransaction) & { metaData?: TransactionMetadata }
+  >,
 ): string {
   const shamap = new SHAMap()
   for (const txJSON of transactions) {