xrpl 4.3.0 → 4.4.0

package/src/models/transactions/vaultDeposit.ts

@@ -0,0 +1,42 @@
+import { Amount, MPTAmount } from '../common'
+
+import {
+  BaseTransaction,
+  validateBaseTransaction,
+  validateRequiredField,
+  isString,
+  isAmount,
+} from './common'
+
+/**
+ * The VaultDeposit transaction adds liqudity in exchange for vault shares.
+ *
+ * @category Transaction Models
+ */
+export interface VaultDeposit extends BaseTransaction {
+  TransactionType: 'VaultDeposit'
+
+  /**
+   * The ID of the vault to which the assets are deposited.
+   */
+  VaultID: string
+
+  /**
+   * Asset amount to deposit.
+   */
+  // TODO: remove MPTAmount when MPTv2 is released
+  Amount: Amount | MPTAmount
+}
+
+/**
+ * Verify the form and type of a {@link VaultDeposit} at runtime.
+ *
+ * @param tx - A {@link VaultDeposit} Transaction.
+ * @throws When the {@link VaultDeposit} is malformed.
+ */
+export function validateVaultDeposit(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'VaultID', isString)
+  validateRequiredField(tx, 'Amount', isAmount)
+}

package/src/models/transactions/vaultSet.ts

@@ -0,0 +1,71 @@
+import { ValidationError } from '../../errors'
+import { isHex } from '../utils'
+
+import {
+  BaseTransaction,
+  validateBaseTransaction,
+  validateOptionalField,
+  validateRequiredField,
+  isString,
+  VAULT_DATA_MAX_BYTE_LENGTH,
+  XRPLNumber,
+  isXRPLNumber,
+} from './common'
+
+/**
+ * The VaultSet transaction modifies mutable fields on an existing Vault object.
+ *
+ * @category Transaction Models
+ */
+export interface VaultSet extends BaseTransaction {
+  TransactionType: 'VaultSet'
+
+  /**
+   * The ID of the Vault to be modified. Must be included when updating the Vault.
+   */
+  VaultID: string
+
+  /**
+   * Arbitrary Vault metadata, limited to 256 bytes.
+   */
+  Data?: string
+
+  /**
+   * The maximum asset amount that can be held in a vault. The value cannot be lower than the
+   * current AssetsTotal unless the value is 0.
+   */
+  AssetsMaximum?: XRPLNumber
+
+  /**
+   * The PermissionedDomain object ID associated with the shares of this Vault.
+   */
+  DomainID?: string
+}
+
+/**
+ * Verify the form and type of a {@link VaultSet} at runtime.
+ *
+ * @param tx - A {@link VaultSet} Transaction.
+ * @throws When the {@link VaultSet} is malformed.
+ */
+export function validateVaultSet(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'VaultID', isString)
+  validateOptionalField(tx, 'Data', isString)
+  validateOptionalField(tx, 'AssetsMaximum', isXRPLNumber)
+  validateOptionalField(tx, 'DomainID', isString)
+
+  if (tx.Data !== undefined) {
+    const dataHex = tx.Data
+    if (!isHex(dataHex)) {
+      throw new ValidationError('VaultSet: Data must be a valid hex string')
+    }
+    const dataByteLength = dataHex.length / 2
+    if (dataByteLength > VAULT_DATA_MAX_BYTE_LENGTH) {
+      throw new ValidationError(
+        `VaultSet: Data exceeds ${VAULT_DATA_MAX_BYTE_LENGTH} bytes (actual: ${dataByteLength})`,
+      )
+    }
+  }
+}

package/src/models/transactions/vaultWithdraw.ts

@@ -0,0 +1,51 @@
+import { Amount, MPTAmount } from '../common'
+
+import {
+  BaseTransaction,
+  validateBaseTransaction,
+  validateRequiredField,
+  isString,
+  isAmount,
+  Account,
+  validateOptionalField,
+  isAccount,
+} from './common'
+
+/**
+ * The VaultWithdraw transaction withdraws assets in exchange for the vault's shares.
+ *
+ * @category Transaction Models
+ */
+export interface VaultWithdraw extends BaseTransaction {
+  TransactionType: 'VaultWithdraw'
+
+  /**
+   * The ID of the vault from which assets are withdrawn.
+   */
+  VaultID: string
+
+  /**
+   * The exact amount of Vault asset to withdraw.
+   */
+  // TODO: remove MPTAmount when MPTv2 is released
+  Amount: Amount | MPTAmount
+
+  /**
+   * An account to receive the assets. It must be able to receive the asset.
+   */
+  Destination?: Account
+}
+
+/**
+ * Verify the form and type of a {@link VaultWithdraw} at runtime.
+ *
+ * @param tx - A {@link VaultWithdraw} Transaction.
+ * @throws When the {@link VaultWithdraw} is malformed.
+ */
+export function validateVaultWithdraw(tx: Record<string, unknown>): void {
+  validateBaseTransaction(tx)
+
+  validateRequiredField(tx, 'VaultID', isString)
+  validateRequiredField(tx, 'Amount', isAmount)
+  validateOptionalField(tx, 'Destination', isAccount)
+}

package/src/models/utils/flags.ts

@@ -20,6 +20,7 @@ import { PaymentFlags } from '../transactions/payment'
 import { PaymentChannelClaimFlags } from '../transactions/paymentChannelClaim'
 import type { Transaction } from '../transactions/transaction'
 import { TrustSetFlags } from '../transactions/trustSet'
+import { VaultCreateFlags } from '../transactions/vaultCreate'
 import { XChainModifyBridgeFlags } from '../transactions/XChainModifyBridge'
 
 import { isFlagEnabled } from '.'
@@ -63,6 +64,7 @@ const txToFlag = {
   PaymentChannelClaim: PaymentChannelClaimFlags,
   Payment: PaymentFlags,
   TrustSet: TrustSetFlags,
+  VaultCreate: VaultCreateFlags,
   XChainModifyBridge: XChainModifyBridgeFlags,
 }
 

package/src/sugar/autofill.ts

@@ -394,6 +394,7 @@ export async function checkAccountDeleteBlockers(
     resolve()
   })
 }
+
 /**
  * Replaces Amount with DeliverMax if needed.
  *
@@ -405,8 +406,6 @@ export function handleDeliverMax(tx: Payment): void {
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed here
     if (tx.Amount == null) {
       // If only DeliverMax is provided, use it to populate the Amount field
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- ignore type-assertions on the DeliverMax property
-      // @ts-expect-error -- DeliverMax property exists only at the RPC level, not at the protocol level
       // eslint-disable-next-line no-param-reassign -- known RPC-level property
       tx.Amount = tx.DeliverMax
     }
@@ -459,28 +458,28 @@ export async function autofillBatchTxn(
 
     if (txn.Fee == null) {
       txn.Fee = '0'
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     } else if (txn.Fee !== '0') {
       throw new XrplError('Must have `Fee of "0" in inner Batch transaction.')
     }
 
     if (txn.SigningPubKey == null) {
       txn.SigningPubKey = ''
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     } else if (txn.SigningPubKey !== '') {
       throw new XrplError(
         'Must have `SigningPubKey` of "" in inner Batch transaction.',
       )
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     if (txn.TxnSignature != null) {
       throw new XrplError(
         'Must not have `TxnSignature` in inner Batch transaction.',
       )
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- for JS purposes
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- needed for JS checks
     if (txn.Signers != null) {
       throw new XrplError('Must not have `Signers` in inner Batch transaction.')
     }