xrpl 2.12.0 → 3.0.0-beta.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/NFTokenCancelOffer.ts

@@ -1,6 +1,7 @@
 import { ValidationError } from '../../errors'
 
 import { BaseTransaction, validateBaseTransaction } from './common'
+import type { TransactionMetadataBase } from './metadata'
 
 /**
  * The NFTokenCancelOffer transaction deletes existing NFTokenOffer objects.
@@ -26,6 +27,11 @@ export interface NFTokenCancelOffer extends BaseTransaction {
   NFTokenOffers: string[]
 }
 
+export interface NFTokenCancelOfferMetadata extends TransactionMetadataBase {
+  // rippled 1.11.0  or  later
+  nftoken_ids?: string[]
+}
+
 /**
  * Verify the form and type of an NFTokenCancelOffer at runtime.
  *

package/src/models/transactions/NFTokenCreateOffer.ts

@@ -8,7 +8,11 @@ import {
   validateBaseTransaction,
   isAmount,
   parseAmountValue,
+  isAccount,
+  validateOptionalField,
+  Account,
 } from './common'
+import type { TransactionMetadataBase } from './metadata'
 
 /**
  * Transaction Flags for an NFTokenCreateOffer Transaction.
@@ -67,7 +71,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,10 +83,15 @@ 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
 }
 
+export interface NFTokenCreateOfferMetadata extends TransactionMetadataBase {
+  // rippled 1.11.0 or later
+  offer_id?: string
+}
+
 function validateNFTokenSellOfferCases(tx: Record<string, unknown>): void {
   if (tx.Owner != null) {
     throw new ValidationError(
@@ -126,6 +135,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,15 @@
 import { ValidationError } from '../../errors'
 import { isHex } from '../utils'
 
-import { BaseTransaction, GlobalFlags, validateBaseTransaction } from './common'
+import {
+  Account,
+  BaseTransaction,
+  GlobalFlags,
+  isAccount,
+  validateBaseTransaction,
+  validateOptionalField,
+} from './common'
+import type { TransactionMetadataBase } from './metadata'
 
 /**
  * Transaction Flags for an NFTokenMint Transaction.
@@ -68,7 +76,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
@@ -94,6 +102,11 @@ export interface NFTokenMint extends BaseTransaction {
   Flags?: number | NFTokenMintFlagsInterface
 }
 
+export interface NFTokenMintMetadata extends TransactionMetadataBase {
+  // rippled 1.11.0 or later
+  nftoken_id?: string
+}
+
 /**
  * Verify the form and type of an NFTokenMint at runtime.
  *
@@ -109,6 +122,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,5 +1,3 @@
-import { isString } from 'lodash'
-
 import { Amount, XChainBridge } from '../common'
 
 import {
@@ -8,6 +6,8 @@ import {
   isXChainBridge,
   validateBaseTransaction,
   validateRequiredField,
+  isAccount,
+  Account,
 } from './common'
 
 /**
@@ -39,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
@@ -63,7 +63,7 @@ export function validateXChainAccountCreateCommit(
 
   validateRequiredField(tx, 'SignatureReward', isAmount)
 
-  validateRequiredField(tx, 'Destination', isString)
+  validateRequiredField(tx, 'Destination', isAccount)
 
   validateRequiredField(tx, 'Amount', isAmount)
 }

package/src/models/transactions/XChainAddAccountCreateAttestation.ts

@@ -1,7 +1,9 @@
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
   isNumber,
   isString,
@@ -29,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.
@@ -91,13 +93,13 @@ export function validateXChainAddAccountCreateAttestation(
 
   validateRequiredField(tx, 'Amount', isAmount)
 
-  validateRequiredField(tx, 'AttestationRewardAccount', isString)
+  validateRequiredField(tx, 'AttestationRewardAccount', isAccount)
 
-  validateRequiredField(tx, 'AttestationSignerAccount', isString)
+  validateRequiredField(tx, 'AttestationSignerAccount', isAccount)
 
-  validateRequiredField(tx, 'Destination', isString)
+  validateRequiredField(tx, 'Destination', isAccount)
 
-  validateRequiredField(tx, 'OtherChainSource', isString)
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
 
   validateRequiredField(tx, 'PublicKey', isString)
 

package/src/models/transactions/XChainAddClaimAttestation.ts

@@ -1,7 +1,9 @@
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
   isNumber,
   isString,
@@ -28,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.
@@ -87,13 +89,13 @@ export function validateXChainAddClaimAttestation(
 
   validateRequiredField(tx, 'Amount', isAmount)
 
-  validateRequiredField(tx, 'AttestationRewardAccount', isString)
+  validateRequiredField(tx, 'AttestationRewardAccount', isAccount)
 
-  validateRequiredField(tx, 'AttestationSignerAccount', isString)
+  validateRequiredField(tx, 'AttestationSignerAccount', isAccount)
 
-  validateOptionalField(tx, 'Destination', isString)
+  validateOptionalField(tx, 'Destination', isAccount)
 
-  validateRequiredField(tx, 'OtherChainSource', isString)
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
 
   validateRequiredField(tx, 'PublicKey', isString)
 

package/src/models/transactions/XChainClaim.ts

@@ -1,7 +1,9 @@
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
   isNumber,
   isString,
@@ -38,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.
@@ -69,7 +71,7 @@ export function validateXChainClaim(tx: Record<string, unknown>): void {
     (inp) => isNumber(inp) || isString(inp),
   )
 
-  validateRequiredField(tx, 'Destination', isString)
+  validateRequiredField(tx, 'Destination', isAccount)
 
   validateOptionalField(tx, 'DestinationTag', isNumber)
 

package/src/models/transactions/XChainCommit.ts

@@ -1,7 +1,9 @@
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
   isNumber,
   isString,
@@ -41,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
@@ -68,7 +70,7 @@ export function validateXChainCommit(tx: Record<string, unknown>): void {
     (inp) => isNumber(inp) || isString(inp),
   )
 
-  validateOptionalField(tx, 'OtherChainDestination', isString)
+  validateOptionalField(tx, 'OtherChainDestination', isAccount)
 
   validateRequiredField(tx, 'Amount', isAmount)
 }

package/src/models/transactions/XChainCreateClaimID.ts

@@ -1,9 +1,10 @@
 import { Amount, XChainBridge } from '../common'
 
 import {
+  Account,
   BaseTransaction,
+  isAccount,
   isAmount,
-  isString,
   isXChainBridge,
   validateBaseTransaction,
   validateRequiredField,
@@ -33,7 +34,7 @@ export interface XChainCreateClaimID extends BaseTransaction {
   /**
    * The account that must send the {@link XChainCommit} transaction on the source chain.
    */
-  OtherChainSource: string
+  OtherChainSource: Account
 }
 
 /**
@@ -49,5 +50,5 @@ export function validateXChainCreateClaimID(tx: Record<string, unknown>): void {
 
   validateRequiredField(tx, 'SignatureReward', isAmount)
 
-  validateRequiredField(tx, 'OtherChainSource', isString)
+  validateRequiredField(tx, 'OtherChainSource', isAccount)
 }

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')
-  }
 }