xrpl 4.3.0 → 4.4.0-smartescrow.0

package/src/models/methods/vaultInfo.ts

@@ -0,0 +1,193 @@
+import { Currency } from '../common'
+
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+/**
+ * The `vault_info` method gets information about a Vault instance.
+ * Returns an {@link VaultInfoResponse}.
+ *
+ * @category Requests
+ */
+export interface VaultInfoRequest extends BaseRequest {
+  command: 'vault_info'
+
+  /**
+   * The object ID of the Vault to be returned.
+   */
+  vault_id?: string
+
+  /**
+   * ID of the Vault Owner account.
+   */
+  owner?: string
+
+  /**
+   * Sequence number of the vault entry.
+   */
+  seq?: number
+}
+
+/**
+ * Response expected from an {@link VaultInfoRequest}.
+ *
+ * @category Responses
+ */
+export interface VaultInfoResponse extends BaseResponse {
+  result: {
+    vault: {
+      /**
+       * The pseudo-account ID of the vault.
+       */
+      Account: string
+
+      /**
+       * Object representing the asset held in the vault.
+       */
+      Asset: Currency
+
+      /**
+       * Amount of assets currently available for withdrawal.
+       */
+      AssetsAvailable: string
+
+      /**
+       * Total amount of assets in the vault.
+       */
+      AssetsTotal: string
+
+      /**
+       * Ledger entry type, always "Vault".
+       */
+      LedgerEntryType: 'Vault'
+
+      /**
+       * ID of the Vault Owner account.
+       */
+      Owner: string
+
+      /**
+       * Transaction ID of the last modification to this vault.
+       */
+      PreviousTxnID: string
+
+      /**
+       * Ledger sequence number of the last transaction modifying this vault.
+       */
+      PreviousTxnLgrSeq: number
+
+      /**
+       * Sequence number of the vault entry.
+       */
+      Sequence: number
+
+      /**
+       * Unique index of the vault ledger entry.
+       */
+      index: string
+
+      /**
+       * Object containing details about issued shares.
+       */
+      shares: {
+        /**
+         * The ID of the Issuer of the Share. It will always be the pseudo-account ID.
+         */
+        Issuer: string
+
+        /**
+         * Ledger entry type, always "MPTokenIssuance".
+         */
+        LedgerEntryType: string
+
+        /**
+         * Total outstanding shares issued.
+         */
+        OutstandingAmount: string
+
+        /**
+         * Transaction ID of the last modification to the shares issuance.
+         */
+        PreviousTxnID: string
+
+        /**
+         * Ledger sequence number of the last transaction modifying the shares issuance.
+         */
+        PreviousTxnLgrSeq: number
+
+        /**
+         * Sequence number of the shares issuance entry.
+         */
+        Sequence: number
+
+        /**
+         * Unique index of the shares ledger entry.
+         */
+        index: string
+
+        /**
+         * Identifier for the owner node of the shares.
+         */
+        OwnerNode?: string
+
+        /**
+         * The ID of the MPTokenIssuance object. It will always be equal to vault.ShareMPTID.
+         */
+        mpt_issuance_id?: string
+
+        /**
+         * The PermissionedDomain object ID associated with the shares of this Vault.
+         */
+        DomainID?: string
+
+        /**
+         * Bit-field flags associated with the shares issuance.
+         */
+        Flags?: number
+      }
+
+      /**
+       * Unrealized loss associated with the vault.
+       */
+      LossUnrealized?: string
+
+      /**
+       * Identifier for the owner node in the ledger tree.
+       */
+      OwnerNode?: string
+
+      /**
+       * Multi-purpose token ID associated with this vault.
+       */
+      ShareMPTID?: string
+
+      /**
+       * Policy defining withdrawal conditions.
+       */
+      WithdrawalPolicy?: number
+
+      /**
+       * Flags
+       */
+      Flags?: number
+    }
+
+    /**
+     * The identifying hash of the ledger that was used to generate this
+     * response.
+     */
+    ledger_hash?: string
+
+    /**
+     * The ledger index of the ledger version that was used to generate this
+     * response.
+     */
+    ledger_index?: number
+
+    /**
+     * If included and set to true, the information in this response comes from
+     * a validated ledger version. Otherwise, the information is subject to
+     * change.
+     */
+    validated?: boolean
+  }
+}

package/src/models/transactions/AMMBid.ts

@@ -4,7 +4,9 @@ import { AuthAccount, Currency, IssuedCurrencyAmount } from '../common'
 import {
   BaseTransaction,
   isAmount,
-  isCurrency,
+  isArray,
+  isIssuedCurrency,
+  isRecord,
   validateBaseTransaction,
 } from './common'
 
@@ -65,7 +67,7 @@ export function validateAMMBid(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMBid: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMBid: Asset must be a Currency')
   }
 
@@ -73,7 +75,7 @@ export function validateAMMBid(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMBid: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMBid: Asset2 must be a Currency')
   }
 
@@ -86,7 +88,7 @@ export function validateAMMBid(tx: Record<string, unknown>): void {
   }
 
   if (tx.AuthAccounts != null) {
-    if (!Array.isArray(tx.AuthAccounts)) {
+    if (!isArray(tx.AuthAccounts)) {
       throw new ValidationError(
         `AMMBid: AuthAccounts must be an AuthAccount array`,
       )
@@ -96,37 +98,27 @@ export function validateAMMBid(tx: Record<string, unknown>): void {
         `AMMBid: AuthAccounts length must not be greater than ${MAX_AUTH_ACCOUNTS}`,
       )
     }
-    validateAuthAccounts(
-      tx.Account,
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Only used by JS
-      tx.AuthAccounts as Array<Record<string, unknown>>,
-    )
+    validateAuthAccounts(tx.Account, tx.AuthAccounts)
   }
 }
 
 function validateAuthAccounts(
   senderAddress: string,
-  authAccounts: Array<Record<string, unknown>>,
+  authAccounts: unknown[],
 ): boolean {
   for (const authAccount of authAccounts) {
-    if (
-      authAccount.AuthAccount == null ||
-      typeof authAccount.AuthAccount !== 'object'
-    ) {
+    if (!isRecord(authAccount)) {
+      throw new ValidationError(`AMMBid: invalid AuthAccounts`)
+    }
+    if (!isRecord(authAccount.AuthAccount)) {
       throw new ValidationError(`AMMBid: invalid AuthAccounts`)
     }
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- used for null check
-    // @ts-expect-error -- used for null check
     if (authAccount.AuthAccount.Account == null) {
       throw new ValidationError(`AMMBid: invalid AuthAccounts`)
     }
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- used for null check
-    // @ts-expect-error -- used for null check
     if (typeof authAccount.AuthAccount.Account !== 'string') {
       throw new ValidationError(`AMMBid: invalid AuthAccounts`)
     }
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- used for null check
-    // @ts-expect-error -- used for null check
     if (authAccount.AuthAccount.Account === senderAddress) {
       throw new ValidationError(
         `AMMBid: AuthAccounts must not include sender's address`,

package/src/models/transactions/AMMClawback.ts

@@ -6,8 +6,8 @@ import {
   BaseTransaction,
   GlobalFlagsInterface,
   isAccount,
-  isAmount,
-  isCurrency,
+  isIssuedCurrency,
+  isIssuedCurrencyAmount,
   validateBaseTransaction,
   validateOptionalField,
   validateRequiredField,
@@ -81,12 +81,9 @@ export function validateAMMClawback(tx: Record<string, unknown>): void {
 
   validateRequiredField(tx, 'Holder', isAccount)
 
-  validateRequiredField(tx, 'Asset', isCurrency)
+  validateRequiredField(tx, 'Asset', isIssuedCurrency)
 
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- required
-  const asset = tx.Asset as IssuedCurrency
-  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- required
-  const amount = tx.Amount as IssuedCurrencyAmount
+  const asset = tx.Asset
 
   if (tx.Holder === asset.issuer) {
     throw new ValidationError(
@@ -100,18 +97,18 @@ export function validateAMMClawback(tx: Record<string, unknown>): void {
     )
   }
 
-  validateRequiredField(tx, 'Asset2', isCurrency)
+  validateRequiredField(tx, 'Asset2', isIssuedCurrency)
 
-  validateOptionalField(tx, 'Amount', isAmount)
+  validateOptionalField(tx, 'Amount', isIssuedCurrencyAmount)
 
   if (tx.Amount != null) {
-    if (amount.currency !== asset.currency) {
+    if (tx.Amount.currency !== asset.currency) {
       throw new ValidationError(
         'AMMClawback: Amount.currency must match Asset.currency',
       )
     }
 
-    if (amount.issuer !== asset.issuer) {
+    if (tx.Amount.issuer !== asset.issuer) {
       throw new ValidationError(
         'AMMClawback: Amount.issuer must match Amount.issuer',
       )

package/src/models/transactions/AMMDelete.ts

@@ -1,7 +1,11 @@
 import { ValidationError } from '../../errors'
 import { Currency } from '../common'
 
-import { BaseTransaction, isCurrency, validateBaseTransaction } from './common'
+import {
+  BaseTransaction,
+  isIssuedCurrency,
+  validateBaseTransaction,
+} from './common'
 
 /**
  * Delete an empty Automated Market Maker (AMM) instance that could not be fully deleted automatically.
@@ -41,7 +45,7 @@ export function validateAMMDelete(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDelete: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMDelete: Asset must be a Currency')
   }
 
@@ -49,7 +53,7 @@ export function validateAMMDelete(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDelete: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMDelete: Asset2 must be a Currency')
   }
 }

package/src/models/transactions/AMMDeposit.ts

@@ -5,8 +5,8 @@ import {
   BaseTransaction,
   GlobalFlagsInterface,
   isAmount,
-  isCurrency,
   isIssuedCurrency,
+  isIssuedCurrencyAmount,
   validateBaseTransaction,
 } from './common'
 
@@ -89,7 +89,7 @@ export function validateAMMDeposit(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDeposit: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMDeposit: Asset must be a Currency')
   }
 
@@ -97,7 +97,7 @@ export function validateAMMDeposit(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMDeposit: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMDeposit: Asset2 must be a Currency')
   }
 
@@ -111,7 +111,7 @@ export function validateAMMDeposit(tx: Record<string, unknown>): void {
     )
   }
 
-  if (tx.LPTokenOut != null && !isIssuedCurrency(tx.LPTokenOut)) {
+  if (tx.LPTokenOut != null && !isIssuedCurrencyAmount(tx.LPTokenOut)) {
     throw new ValidationError(
       'AMMDeposit: LPTokenOut must be an IssuedCurrencyAmount',
     )

package/src/models/transactions/AMMVote.ts

@@ -2,7 +2,11 @@ import { ValidationError } from '../../errors'
 import { Currency } from '../common'
 
 import { AMM_MAX_TRADING_FEE } from './AMMCreate'
-import { BaseTransaction, isCurrency, validateBaseTransaction } from './common'
+import {
+  BaseTransaction,
+  isIssuedCurrency,
+  validateBaseTransaction,
+} from './common'
 
 /**
  * Vote on the trading fee for an Automated Market Maker (AMM) instance.
@@ -43,7 +47,7 @@ export function validateAMMVote(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMVote: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMVote: Asset must be a Currency')
   }
 
@@ -51,7 +55,7 @@ export function validateAMMVote(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMVote: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMVote: Asset2 must be a Currency')
   }
 

package/src/models/transactions/AMMWithdraw.ts

@@ -5,8 +5,8 @@ import {
   BaseTransaction,
   GlobalFlagsInterface,
   isAmount,
-  isCurrency,
   isIssuedCurrency,
+  isIssuedCurrencyAmount,
   validateBaseTransaction,
 } from './common'
 
@@ -87,7 +87,7 @@ export function validateAMMWithdraw(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMWithdraw: missing field Asset')
   }
 
-  if (!isCurrency(tx.Asset)) {
+  if (!isIssuedCurrency(tx.Asset)) {
     throw new ValidationError('AMMWithdraw: Asset must be a Currency')
   }
 
@@ -95,7 +95,7 @@ export function validateAMMWithdraw(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMWithdraw: missing field Asset2')
   }
 
-  if (!isCurrency(tx.Asset2)) {
+  if (!isIssuedCurrency(tx.Asset2)) {
     throw new ValidationError('AMMWithdraw: Asset2 must be a Currency')
   }
 
@@ -105,7 +105,7 @@ export function validateAMMWithdraw(tx: Record<string, unknown>): void {
     throw new ValidationError('AMMWithdraw: must set Amount with EPrice')
   }
 
-  if (tx.LPTokenIn != null && !isIssuedCurrency(tx.LPTokenIn)) {
+  if (tx.LPTokenIn != null && !isIssuedCurrencyAmount(tx.LPTokenIn)) {
     throw new ValidationError(
       'AMMWithdraw: LPTokenIn must be an IssuedCurrencyAmount',
     )

package/src/models/transactions/MPTokenIssuanceCreate.ts

@@ -158,7 +158,9 @@ export function validateMPTokenIssuanceCreate(
 
   if (typeof tx.TransferFee === 'number') {
     // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Not necessary
-    const flags = tx.Flags as number | MPTokenIssuanceCreateFlagsInterface
+    const flags = (tx.Flags ?? 0) as
+      | number
+      | MPTokenIssuanceCreateFlagsInterface
     const isTfMPTCanTransfer =
       typeof flags === 'number'
         ? isFlagEnabled(flags, MPTokenIssuanceCreateFlags.tfMPTCanTransfer)

package/src/models/transactions/MPTokenIssuanceSet.ts

@@ -69,7 +69,7 @@ export function validateMPTokenIssuanceSet(tx: Record<string, unknown>): void {
   validateOptionalField(tx, 'Holder', isAccount)
 
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Not necessary
-  const flags = tx.Flags as number | MPTokenIssuanceSetFlagsInterface
+  const flags = (tx.Flags ?? 0) as number | MPTokenIssuanceSetFlagsInterface
   const isTfMPTLock =
     typeof flags === 'number'
       ? isFlagEnabled(flags, MPTokenIssuanceSetFlags.tfMPTLock)

package/src/models/transactions/NFTokenCancelOffer.ts

@@ -1,6 +1,6 @@
 import { ValidationError } from '../../errors'
 
-import { BaseTransaction, validateBaseTransaction } from './common'
+import { BaseTransaction, isArray, validateBaseTransaction } from './common'
 import type { TransactionMetadataBase } from './metadata'
 
 /**
@@ -41,7 +41,7 @@ export interface NFTokenCancelOfferMetadata extends TransactionMetadataBase {
 export function validateNFTokenCancelOffer(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
 
-  if (!Array.isArray(tx.NFTokenOffers)) {
+  if (!isArray(tx.NFTokenOffers)) {
     throw new ValidationError('NFTokenCancelOffer: missing field NFTokenOffers')
   }
 

package/src/models/transactions/NFTokenCreateOffer.ts

@@ -146,10 +146,14 @@ export function validateNFTokenCreateOffer(tx: Record<string, unknown>): void {
     throw new ValidationError('NFTokenCreateOffer: invalid Amount')
   }
 
-  if (
-    typeof tx.Flags === 'number' &&
-    isFlagEnabled(tx.Flags, NFTokenCreateOfferFlags.tfSellNFToken)
-  ) {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- checked in BaseTransaction
+  const flags = (tx.Flags ?? 0) as number | NFTokenCreateOfferFlagsInterface
+  const isTfSellNFToken =
+    typeof flags === 'number'
+      ? isFlagEnabled(flags, NFTokenCreateOfferFlags.tfSellNFToken)
+      : flags.tfSellNFToken ?? false
+
+  if (isTfSellNFToken) {
     validateNFTokenSellOfferCases(tx)
   } else {
     validateNFTokenBuyOfferCases(tx)

package/src/models/transactions/checkCreate.ts

@@ -4,7 +4,7 @@ import { Amount } from '../common'
 import {
   BaseTransaction,
   validateBaseTransaction,
-  isIssuedCurrency,
+  isIssuedCurrencyAmount,
   isAccount,
   validateRequiredField,
   validateOptionalField,
@@ -64,11 +64,7 @@ export function validateCheckCreate(tx: Record<string, unknown>): void {
   validateRequiredField(tx, 'Destination', isAccount)
   validateOptionalField(tx, 'DestinationTag', isNumber)
 
-  if (
-    typeof tx.SendMax !== 'string' &&
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Only used by JS
-    !isIssuedCurrency(tx.SendMax as Record<string, unknown>)
-  ) {
+  if (typeof tx.SendMax !== 'string' && !isIssuedCurrencyAmount(tx.SendMax)) {
     throw new ValidationError('CheckCreate: invalid SendMax')
   }
 

package/src/models/transactions/clawback.ts

@@ -1,13 +1,15 @@
 import { ValidationError } from '../../errors'
-import { IssuedCurrencyAmount, MPTAmount } from '../common'
+import { ClawbackAmount } from '../common'
 
 import {
   BaseTransaction,
   validateBaseTransaction,
-  isIssuedCurrency,
+  isIssuedCurrencyAmount,
   isMPTAmount,
   isAccount,
   validateOptionalField,
+  isClawbackAmount,
+  validateRequiredField,
 } from './common'
 
 /**
@@ -26,7 +28,7 @@ export interface Clawback extends BaseTransaction {
    * names MUST be lower-case. If the amount is IOU, the `issuer` field MUST be the holder's address,
    * whom to be clawed back.
    */
-  Amount: IssuedCurrencyAmount | MPTAmount
+  Amount: ClawbackAmount
   /**
    * Indicates the AccountID that the issuer wants to clawback. This field is only valid for clawing back
    * MPTs.
@@ -42,17 +44,14 @@ export interface Clawback extends BaseTransaction {
  */
 export function validateClawback(tx: Record<string, unknown>): void {
   validateBaseTransaction(tx)
+  validateRequiredField(tx, 'Amount', isClawbackAmount)
   validateOptionalField(tx, 'Holder', isAccount)
 
-  if (tx.Amount == null) {
-    throw new ValidationError('Clawback: missing field Amount')
-  }
-
-  if (!isIssuedCurrency(tx.Amount) && !isMPTAmount(tx.Amount)) {
+  if (!isIssuedCurrencyAmount(tx.Amount) && !isMPTAmount(tx.Amount)) {
     throw new ValidationError('Clawback: invalid Amount')
   }
 
-  if (isIssuedCurrency(tx.Amount) && tx.Account === tx.Amount.issuer) {
+  if (isIssuedCurrencyAmount(tx.Amount) && tx.Account === tx.Amount.issuer) {
     throw new ValidationError('Clawback: invalid holder Account')
   }
 
@@ -60,7 +59,7 @@ export function validateClawback(tx: Record<string, unknown>): void {
     throw new ValidationError('Clawback: invalid holder Account')
   }
 
-  if (isIssuedCurrency(tx.Amount) && tx.Holder) {
+  if (isIssuedCurrencyAmount(tx.Amount) && tx.Holder) {
     throw new ValidationError('Clawback: cannot have Holder for currency')
   }