xrpl 2.12.0-beta.0 → 2.12.0

package/src/models/transactions/XChainAddClaimAttestation.ts

@@ -1,11 +1,14 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
   BaseTransaction,
   isAmount,
+  isNumber,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -72,127 +75,41 @@ export interface XChainAddClaimAttestation extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainAddClaimAttestation at runtime.
+ * Verify the form and type of an XChainAddClaimAttestation at runtime.
  *
- * @param tx - A XChainAddClaimAttestation Transaction.
+ * @param tx - An XChainAddClaimAttestation Transaction.
  * @throws When the XChainAddClaimAttestation is malformed.
  */
-// eslint-disable-next-line max-lines-per-function, max-statements, complexity -- okay for this function, lots of things to check
 export function validateXChainAddClaimAttestation(
   tx: Record<string, unknown>,
 ): void {
   validateBaseTransaction(tx)
 
-  if (tx.Amount == null) {
-    throw new ValidationError('XChainAddClaimAttestation: missing field Amount')
-  }
-
-  if (!isAmount(tx.Amount)) {
-    throw new ValidationError('XChainAddClaimAttestation: invalid field Amount')
-  }
-
-  if (tx.AttestationRewardAccount == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field AttestationRewardAccount',
-    )
-  }
-
-  if (typeof tx.AttestationRewardAccount !== 'string') {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field AttestationRewardAccount',
-    )
-  }
-
-  if (tx.AttestationSignerAccount == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field AttestationSignerAccount',
-    )
-  }
-
-  if (typeof tx.AttestationSignerAccount !== 'string') {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field AttestationSignerAccount',
-    )
-  }
-
-  if (tx.Destination !== undefined && typeof tx.Destination !== 'string') {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field Destination',
-    )
-  }
-
-  if (tx.OtherChainSource == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field OtherChainSource',
-    )
-  }
-
-  if (typeof tx.OtherChainSource !== 'string') {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field OtherChainSource',
-    )
-  }
-
-  if (tx.PublicKey == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field PublicKey',
-    )
-  }
-
-  if (typeof tx.PublicKey !== 'string') {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field PublicKey',
-    )
-  }
-
-  if (tx.Signature == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field Signature',
-    )
-  }
-
-  if (typeof tx.Signature !== 'string') {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field Signature',
-    )
-  }
-
-  if (tx.WasLockingChainSend == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field WasLockingChainSend',
-    )
-  }
-
-  if (tx.WasLockingChainSend !== 0 && tx.WasLockingChainSend !== 1) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field WasLockingChainSend',
-    )
-  }
-
-  if (tx.XChainBridge == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field XChainBridge',
-    )
-  }
-
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field XChainBridge',
-    )
-  }
-
-  if (tx.XChainClaimID == null) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: missing field XChainClaimID',
-    )
-  }
-
-  if (
-    typeof tx.XChainClaimID !== 'string' &&
-    typeof tx.XChainClaimID !== 'number'
-  ) {
-    throw new ValidationError(
-      'XChainAddClaimAttestation: invalid field XChainClaimID',
-    )
-  }
+  validateRequiredField(tx, 'Amount', isAmount)
+
+  validateRequiredField(tx, 'AttestationRewardAccount', isString)
+
+  validateRequiredField(tx, 'AttestationSignerAccount', isString)
+
+  validateOptionalField(tx, 'Destination', isString)
+
+  validateRequiredField(tx, 'OtherChainSource', isString)
+
+  validateRequiredField(tx, 'PublicKey', isString)
+
+  validateRequiredField(tx, 'Signature', isString)
+
+  validateRequiredField(
+    tx,
+    'WasLockingChainSend',
+    (inp) => inp === 0 || inp === 1,
+  )
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
+
+  validateRequiredField(
+    tx,
+    'XChainClaimID',
+    (inp) => isNumber(inp) || isString(inp),
+  )
 }

package/src/models/transactions/XChainClaim.ts

@@ -1,11 +1,14 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
   BaseTransaction,
   isAmount,
+  isNumber,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -50,54 +53,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', isString)
 
-  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,14 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
   BaseTransaction,
   isAmount,
+  isNumber,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -49,47 +52,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', isString)
 
-  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,12 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
   BaseTransaction,
   isAmount,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -36,43 +37,17 @@ export interface XChainCreateClaimID extends BaseTransaction {
 }
 
 /**
- * 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', isString)
 }

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/accountSet.ts

@@ -1,5 +1,3 @@
-/* eslint-disable complexity -- Necessary for validateAccountSet */
-
 import { isValidClassicAddress } from 'ripple-address-codec'
 
 import { ValidationError } from '../../errors'

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'