xrpl 2.12.0-beta.0 → 2.13.0

package/src/models/transactions/NFTokenBurn.ts

@@ -1,6 +1,12 @@
-import { ValidationError } from '../../errors'
-
-import { BaseTransaction, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  isAccount,
+  isString,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+} from './common'
 
 /**
  * The NFTokenBurn transaction is used to remove an NFToken object from the
@@ -20,7 +26,7 @@ export interface NFTokenBurn extends BaseTransaction {
    * in the NFToken, either the issuer account or an account authorized by the
    * issuer, i.e. MintAccount.
    */
-  Account: string
+  Account: Account
   /**
    * Identifies the NFToken object to be removed by the transaction.
    */
@@ -30,7 +36,7 @@ export interface NFTokenBurn extends BaseTransaction {
    * Account. Only used to burn tokens which have the lsfBurnable flag enabled
    * and are not owned by the signing account.
    */
-  Owner?: string
+  Owner?: Account
 }
 
 /**
@@ -41,8 +47,6 @@ export interface NFTokenBurn extends BaseTransaction {
  */
 export function validateNFTokenBurn(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
-
-  if (tx.NFTokenID == null) {
-    throw new ValidationError('NFTokenBurn: missing field NFTokenID')
-  }
+  validateRequiredField(tx, 'NFTokenID', isString)
+  validateOptionalField(tx, 'Owner', isAccount)
 }

package/src/models/transactions/NFTokenCreateOffer.ts

@@ -8,6 +8,9 @@ import {
   validateBaseTransaction,
   isAmount,
   parseAmountValue,
+  isAccount,
+  validateOptionalField,
+  Account,
 } from './common'
 
 /**
@@ -67,7 +70,7 @@ export interface NFTokenCreateOffer extends BaseTransaction {
    * (since an offer to sell a token one doesn't already hold
    * is meaningless).
    */
-  Owner?: string
+  Owner?: Account
   /**
    * Indicates the time after which the offer will no longer
    * be valid. The value is the number of seconds since the
@@ -79,7 +82,7 @@ export interface NFTokenCreateOffer extends BaseTransaction {
    * accepted by the specified account. Attempts by other
    * accounts to accept this offer MUST fail.
    */
-  Destination?: string
+  Destination?: Account
   Flags?: number | NFTokenCreateOfferFlagsInterface
 }
 
@@ -126,6 +129,9 @@ export function validateNFTokenCreateOffer(tx: Record<string, unknown>): void {
     )
   }
 
+  validateOptionalField(tx, 'Destination', isAccount)
+  validateOptionalField(tx, 'Owner', isAccount)
+
   if (tx.NFTokenID == null) {
     throw new ValidationError('NFTokenCreateOffer: missing field NFTokenID')
   }

package/src/models/transactions/NFTokenMint.ts

@@ -1,7 +1,14 @@
 import { ValidationError } from '../../errors'
 import { isHex } from '../utils'
 
-import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  GlobalFlags,
+  isAccount,
+  validateBaseTransaction,
+  validateOptionalField,
+} from './common'
 
 /**
  * Transaction Flags for an NFTokenMint Transaction.
@@ -68,7 +75,7 @@ export interface NFTokenMint extends BaseTransaction {
    * present, the `MintAccount` field in the `AccountRoot` of the `Issuer`
    * field must match the `Account`, otherwise the transaction will fail.
    */
-  Issuer?: string
+  Issuer?: Account
   /**
    * Specifies the fee charged by the issuer for secondary sales of the Token,
    * if such sales are allowed. Valid values for this field are between 0 and
@@ -109,6 +116,8 @@ export function validateNFTokenMint(tx: Record<string, unknown>): void {
     )
   }
 
+  validateOptionalField(tx, 'Issuer', isAccount)
+
   if (typeof tx.URI === 'string' && tx.URI === '') {
     throw new ValidationError('NFTokenMint: URI must not be empty string')
   }

package/src/models/transactions/UNLModify.ts

@@ -1,9 +1,11 @@
+import { BaseTransaction } from './common'
+
 /**
  * Mark a change to the Negative UNL.
  *
  * @category Pseudo Transaction Models
  */
-export interface UNLModify {
+export interface UNLModify extends BaseTransaction {
   TransactionType: 'UNLModify'
   /**
    * The ledger index where this pseudo-transaction appears.

package/src/models/transactions/XChainAccountCreateCommit.ts

@@ -1,4 +1,3 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
@@ -6,6 +5,9 @@ import {
   isAmount,
   isXChainBridge,
   validateBaseTransaction,
+  validateRequiredField,
+  isAccount,
+  Account,
 } from './common'
 
 /**
@@ -37,7 +39,7 @@ export interface XChainAccountCreateCommit extends BaseTransaction {
   /**
    * The destination account on the destination chain.
    */
-  Destination: string
+  Destination: Account
 
   /**
    * The amount, in XRP, to use for account creation. This must be greater than or
@@ -47,61 +49,21 @@ export interface XChainAccountCreateCommit extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainAccountCreateCommit at runtime.
+ * Verify the form and type of an XChainAccountCreateCommit at runtime.
  *
- * @param tx - A XChainAccountCreateCommit Transaction.
+ * @param tx - An XChainAccountCreateCommit Transaction.
  * @throws When the XChainAccountCreateCommit is malformed.
  */
-// eslint-disable-next-line max-lines-per-function --  okay for this function, there's a lot of things to check
 export function validateXChainAccountCreateCommit(
   tx: Record<string, unknown>,
 ): void {
   validateBaseTransaction(tx)
 
-  if (tx.XChainBridge == null) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: missing field XChainBridge',
-    )
-  }
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: invalid field XChainBridge',
-    )
-  }
+  validateRequiredField(tx, 'SignatureReward', isAmount)
 
-  if (tx.SignatureReward == null) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: missing field SignatureReward',
-    )
-  }
+  validateRequiredField(tx, 'Destination', isAccount)
 
-  if (
-    typeof tx.SignatureReward !== 'number' &&
-    typeof tx.SignatureReward !== 'string'
-  ) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: invalid field SignatureReward',
-    )
-  }
-
-  if (tx.Destination == null) {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: missing field Destination',
-    )
-  }
-
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError(
-      'XChainAccountCreateCommit: invalid field Destination',
-    )
-  }
-
-  if (tx.Amount == null) {
-    throw new ValidationError('XChainAccountCreateCommit: missing field Amount')
-  }
-
-  if (!isAmount(tx.Amount)) {
-    throw new ValidationError('XChainAccountCreateCommit: invalid field Amount')
-  }
+  validateRequiredField(tx, 'Amount', isAmount)
 }

package/src/models/transactions/XChainAddAccountCreateAttestation.ts

@@ -1,11 +1,15 @@
-import { ValidationError } from '../../errors'
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
+  isNumber,
+  isString,
   isXChainBridge,
   validateBaseTransaction,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -27,23 +31,23 @@ export interface XChainAddAccountCreateAttestation extends BaseTransaction {
   /**
    * The account that should receive this signer's share of the SignatureReward.
    */
-  AttestationRewardAccount: string
+  AttestationRewardAccount: Account
 
   /**
    * The account on the door account's signer list that is signing the transaction.
    */
-  AttestationSignerAccount: string
+  AttestationSignerAccount: Account
 
   /**
    * The destination account for the funds on the destination chain.
    */
-  Destination: string
+  Destination: Account
 
   /**
    * The account on the source chain that submitted the {@link XChainAccountCreateCommit}
    * transaction that triggered the event associated with the attestation.
    */
-  OtherChainSource: string
+  OtherChainSource: Account
 
   /**
    * The public key used to verify the signature.
@@ -77,149 +81,43 @@ export interface XChainAddAccountCreateAttestation extends BaseTransaction {
 }
 
 /**
- * Verify the form and type of a XChainAddAccountCreateAttestation at runtime.
+ * Verify the form and type of an XChainAddAccountCreateAttestation at runtime.
  *
- * @param tx - A XChainAddAccountCreateAttestation Transaction.
+ * @param tx - An XChainAddAccountCreateAttestation Transaction.
  * @throws When the XChainAddAccountCreateAttestation is malformed.
  */
-// eslint-disable-next-line max-lines-per-function, max-statements, complexity -- okay for this function, lots of things to check
 export function validateXChainAddAccountCreateAttestation(
   tx: Record<string, unknown>,
 ): void {
   validateBaseTransaction(tx)
 
-  if (tx.Amount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field Amount',
-    )
-  }
-
-  if (!isAmount(tx.Amount)) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field Amount',
-    )
-  }
-
-  if (tx.AttestationRewardAccount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field AttestationRewardAccount',
-    )
-  }
-
-  if (typeof tx.AttestationRewardAccount !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field AttestationRewardAccount',
-    )
-  }
-
-  if (tx.AttestationSignerAccount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field AttestationSignerAccount',
-    )
-  }
-
-  if (typeof tx.AttestationSignerAccount !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field AttestationSignerAccount',
-    )
-  }
-
-  if (tx.Destination == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field Destination',
-    )
-  }
-
-  if (typeof tx.Destination !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field Destination',
-    )
-  }
-
-  if (tx.OtherChainSource == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field OtherChainSource',
-    )
-  }
-
-  if (typeof tx.OtherChainSource !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field OtherChainSource',
-    )
-  }
-
-  if (tx.PublicKey == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field PublicKey',
-    )
-  }
-
-  if (typeof tx.PublicKey !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field PublicKey',
-    )
-  }
-
-  if (tx.Signature == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field Signature',
-    )
-  }
-
-  if (typeof tx.Signature !== 'string') {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field Signature',
-    )
-  }
-
-  if (tx.SignatureReward == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field SignatureReward',
-    )
-  }
-
-  if (!isAmount(tx.SignatureReward)) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field SignatureReward',
-    )
-  }
-
-  if (tx.WasLockingChainSend == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field WasLockingChainSend',
-    )
-  }
-
-  if (tx.WasLockingChainSend !== 0 && tx.WasLockingChainSend !== 1) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field WasLockingChainSend',
-    )
-  }
-
-  if (tx.XChainAccountCreateCount == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field XChainAccountCreateCount',
-    )
-  }
-
-  if (
-    typeof tx.XChainAccountCreateCount !== 'string' &&
-    typeof tx.XChainAccountCreateCount !== 'number'
-  ) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field XChainAccountCreateCount',
-    )
-  }
-
-  if (tx.XChainBridge == null) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: missing field XChainBridge',
-    )
-  }
-
-  if (!isXChainBridge(tx.XChainBridge)) {
-    throw new ValidationError(
-      'XChainAddAccountCreateAttestation: invalid field XChainBridge',
-    )
-  }
+  validateRequiredField(tx, 'Amount', isAmount)
+
+  validateRequiredField(tx, 'AttestationRewardAccount', isAccount)
+
+  validateRequiredField(tx, 'AttestationSignerAccount', isAccount)
+
+  validateRequiredField(tx, 'Destination', isAccount)
+
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
+
+  validateRequiredField(tx, 'PublicKey', isString)
+
+  validateRequiredField(tx, 'Signature', isString)
+
+  validateRequiredField(tx, 'SignatureReward', isAmount)
+
+  validateRequiredField(
+    tx,
+    'WasLockingChainSend',
+    (inp) => inp === 0 || inp === 1,
+  )
+
+  validateRequiredField(
+    tx,
+    'XChainAccountCreateCount',
+    (inp) => isNumber(inp) || isString(inp),
+  )
+
+  validateRequiredField(tx, 'XChainBridge', isXChainBridge)
 }

package/src/models/transactions/XChainAddClaimAttestation.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'
 
 /**
@@ -25,24 +30,24 @@ export interface XChainAddClaimAttestation extends BaseTransaction {
   /**
    * The account that should receive this signer's share of the SignatureReward.
    */
-  AttestationRewardAccount: string
+  AttestationRewardAccount: Account
 
   /**
    * The account on the door account's signer list that is signing the transaction.
    */
-  AttestationSignerAccount: string
+  AttestationSignerAccount: Account
 
   /**
    * The destination account for the funds on the destination chain (taken from
    * the {@link XChainCommit} transaction).
    */
-  Destination?: string
+  Destination?: Account
 
   /**
    * The account on the source chain that submitted the {@link XChainCommit}
    * transaction that triggered the event associated with the attestation.
    */
-  OtherChainSource: string
+  OtherChainSource: Account
 
   /**
    * The public key used to verify the attestation signature.
@@ -72,127 +77,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', isAccount)
+
+  validateRequiredField(tx, 'AttestationSignerAccount', isAccount)
+
+  validateOptionalField(tx, 'Destination', isAccount)
+
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
+
+  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),
+  )
 }