xrpl 2.12.0-beta.0 → 2.13.0

package/src/models/transactions/XChainClaim.ts

@@ -1,11 +1,16 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
+  isNumber,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -35,7 +40,7 @@ export interface XChainClaim extends BaseTransaction {
    * sequence number and collected signatures won't be destroyed, and the
    * transaction can be rerun with a different destination.
    */
-  Destination: string
+  Destination: Account
 
   /**
    * An integer destination tag.
@@ -50,54 +55,25 @@ export interface XChainClaim extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainClaim at runtime.
+ * Verify the form and type of an XChainClaim at runtime.
  *
- * @param tx - A XChainClaim Transaction.
+ * @param tx - An XChainClaim Transaction.
  * @throws When the XChainClaim is malformed.
  */
-// eslint-disable-next-line complexity -- okay for this function, lots of things to check
 export function validateXChainClaim(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.XChainBridge == null) {
-    throw new ValidationError('XChainClaim: missing field XChainBridge')
-  }
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError('XChainClaim: invalid field XChainBridge')
-  }
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
 
-  if (tx.XChainClaimID == null) {
-    throw new ValidationError('XChainClaim: missing field XChainClaimID')
-  }
+  validateRequiredField(tx, 'Destination', isAccount)
 
-  if (
-    typeof tx.XChainClaimID !== 'number' &&
-    typeof tx.XChainClaimID !== 'string'
-  ) {
-    throw new ValidationError('XChainClaim: invalid field XChainClaimID')
-  }
+  validateOptionalField(tx, 'DestinationTag', isNumber)
 
-  if (tx.Destination == null) {
-    throw new ValidationError('XChainClaim: missing field Destination')
-  }
-
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError('XChainClaim: invalid field Destination')
-  }
-
-  if (
-    tx.DestinationTag !== undefined &&
-    typeof tx.DestinationTag !== 'number'
-  ) {
-    throw new ValidationError('XChainClaim: invalid field DestinationTag')
-  }
-
-  if (tx.Amount == null) {
-    throw new ValidationError('XChainClaim: missing field Amount')
-  }
-
-  if (!isAmount(tx.Amount)) {
-    throw new ValidationError('XChainClaim: invalid field Amount')
-  }
+  validateRequiredField(tx, 'Amount', isAmount)
 }

package/src/models/transactions/XChainCommit.ts

@@ -1,11 +1,16 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
+  isNumber,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -38,7 +43,7 @@ export interface XChainCommit extends BaseTransaction {
    * destination chain will need to submit a {@link XChainClaim} transaction to
    * claim the funds.
    */
-  OtherChainDestination?: string
+  OtherChainDestination?: Account
 
   /**
    * The asset to commit, and the quantity. This must match the door account's
@@ -49,47 +54,23 @@ export interface XChainCommit extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainCommit at runtime.
+ * Verify the form and type of an XChainCommit at runtime.
  *
- * @param tx - A XChainCommit Transaction.
+ * @param tx - An XChainCommit Transaction.
  * @throws When the XChainCommit is malformed.
  */
 export function validateXChainCommit(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.XChainBridge == null) {
-    throw new ValidationError('XChainCommit: missing field XChainBridge')
-  }
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError('XChainCommit: invalid field XChainBridge')
-  }
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
 
-  if (tx.XChainClaimID == null) {
-    throw new ValidationError('XChainCommit: missing field XChainClaimID')
-  }
+  validateOptionalField(tx, 'OtherChainDestination', isAccount)
 
-  if (
-    typeof tx.XChainClaimID !== 'number' &&
-    typeof tx.XChainClaimID !== 'string'
-  ) {
-    throw new ValidationError('XChainCommit: invalid field XChainClaimID')
-  }
-
-  if (
-    tx.OtherChainDestination !== undefined &&
-    typeof tx.OtherChainDestination !== 'string'
-  ) {
-    throw new ValidationError(
-      'XChainCommit: invalid field OtherChainDestination',
-    )
-  }
-
-  if (tx.Amount == null) {
-    throw new ValidationError('XChainCommit: missing field Amount')
-  }
-
-  if (!isAmount(tx.Amount)) {
-    throw new ValidationError('XChainCommit: invalid field Amount')
-  }
+  validateRequiredField(tx, 'Amount', isAmount)
 }

package/src/models/transactions/XChainCreateBridge.ts

@@ -1,4 +1,3 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
@@ -6,6 +5,8 @@ import {
   isAmount,
   isXChainBridge,
   validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -39,40 +40,17 @@ export interface XChainCreateBridge extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainCreateBridge at runtime.
+ * Verify the form and type of an XChainCreateBridge at runtime.
  *
- * @param tx - A XChainCreateBridge Transaction.
+ * @param tx - An XChainCreateBridge Transaction.
  * @throws When the XChainCreateBridge is malformed.
  */
 export function validateXChainCreateBridge(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.XChainBridge == null) {
-    throw new ValidationError('XChainCreateBridge: missing field XChainBridge')
-  }
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError('XChainCreateBridge: invalid field XChainBridge')
-  }
+  validateRequiredField(tx, 'SignatureReward', isAmount)
 
-  if (tx.SignatureReward == null) {
-    throw new ValidationError(
-      'XChainCreateBridge: missing field SignatureReward',
-    )
-  }
-
-  if (!isAmount(tx.SignatureReward)) {
-    throw new ValidationError(
-      'XChainCreateBridge: invalid field SignatureReward',
-    )
-  }
-
-  if (
-    tx.MinAccountCreateAmount !== undefined &&
-    !isAmount(tx.MinAccountCreateAmount)
-  ) {
-    throw new ValidationError(
-      'XChainCreateBridge: invalid field MinAccountCreateAmount',
-    )
-  }
+  validateOptionalField(tx, 'MinAccountCreateAmount', isAmount)
 }

package/src/models/transactions/XChainCreateClaimID.ts

@@ -1,11 +1,13 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
   isXChainBridge,
   validateBaseTransaction,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -32,47 +34,21 @@ export interface XChainCreateClaimID extends BaseTransaction {
   /**
    * The account that must send the {@link XChainCommit} transaction on the source chain.
    */
-  OtherChainSource: string
+  OtherChainSource: Account
 }
 
 /**
- * Verify the form and type of a XChainCreateClaimID at runtime.
+ * Verify the form and type of an XChainCreateClaimID at runtime.
  *
- * @param tx - A XChainCreateClaimID Transaction.
+ * @param tx - An XChainCreateClaimID Transaction.
  * @throws When the XChainCreateClaimID is malformed.
  */
 export function validateXChainCreateClaimID(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.XChainBridge == null) {
-    throw new ValidationError('XChainCreateClaimID: missing field XChainBridge')
-  }
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError('XChainCreateClaimID: invalid field XChainBridge')
-  }
+  validateRequiredField(tx, 'SignatureReward', isAmount)
 
-  if (tx.SignatureReward == null) {
-    throw new ValidationError(
-      'XChainCreateClaimID: missing field SignatureReward',
-    )
-  }
-
-  if (!isAmount(tx.SignatureReward)) {
-    throw new ValidationError(
-      'XChainCreateClaimID: invalid field SignatureReward',
-    )
-  }
-
-  if (tx.OtherChainSource == null) {
-    throw new ValidationError(
-      'XChainCreateClaimID: missing field OtherChainSource',
-    )
-  }
-
-  if (typeof tx.OtherChainSource !== 'string') {
-    throw new ValidationError(
-      'XChainCreateClaimID: invalid field OtherChainSource',
-    )
-  }
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
 }

package/src/models/transactions/XChainModifyBridge.ts

@@ -1,4 +1,3 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
@@ -7,6 +6,8 @@ import {
   isAmount,
   isXChainBridge,
   validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -60,34 +61,17 @@ export interface XChainModifyBridge extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainModifyBridge at runtime.
+ * Verify the form and type of an XChainModifyBridge at runtime.
  *
- * @param tx - A XChainModifyBridge Transaction.
+ * @param tx - An XChainModifyBridge Transaction.
  * @throws When the XChainModifyBridge is malformed.
  */
 export function validateXChainModifyBridge(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (tx.XChainBridge == null) {
-    throw new ValidationError('XChainModifyBridge: missing field XChainBridge')
-  }
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError('XChainModifyBridge: invalid field XChainBridge')
-  }
+  validateOptionalField(tx, 'SignatureReward', isAmount)
 
-  if (tx.SignatureReward !== undefined && !isAmount(tx.SignatureReward)) {
-    throw new ValidationError(
-      'XChainModifyBridge: invalid field SignatureReward',
-    )
-  }
-
-  if (
-    tx.MinAccountCreateAmount !== undefined &&
-    !isAmount(tx.MinAccountCreateAmount)
-  ) {
-    throw new ValidationError(
-      'XChainModifyBridge: invalid field MinAccountCreateAmount',
-    )
-  }
+  validateOptionalField(tx, 'MinAccountCreateAmount', isAmount)
 }

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,10 +1,12 @@
-/* eslint-disable complexity -- Necessary for validateAccountSet */
-
-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.
@@ -157,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
@@ -169,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/checkCash.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- Necessary for validateCheckCash */
 import { ValidationError } from '../../errors'
 import { Amount } from '../common'
 

package/src/models/transactions/checkCreate.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- Necessary for validateCheckCreate */
 import { ValidationError } from '../../errors'
 import { Amount } from '../common'
 
@@ -6,6 +5,11 @@ import {
   BaseTransaction,
   validateBaseTransaction,
   isIssuedCurrency,
+  isAccount,
+  validateRequiredField,
+  validateOptionalField,
+  isNumber,
+  Account,
 } from './common'
 
 /**
@@ -18,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
@@ -57,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' &&
@@ -69,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')
   }