xrpl 4.3.0 → 4.4.0

package/src/models/ledger/AccountRoot.ts

@@ -73,7 +73,7 @@ export default interface AccountRoot extends BaseLedgerEntry, HasPreviousTxnID {
   /** Total NFTokens this account's issued that have been burned. This number is always equal or less than MintedNFTokens. */
   BurnedNFTokens?: number
   /** The sequence that the account first minted an NFToken */
-  FirstNFTSequence: number
+  FirstNFTokenSequence?: number
   /** Total NFTokens have been minted by and on behalf of this account. */
   MintedNFTokens?: number
   /** Another account that can mint NFTokens on behalf of this account. */
@@ -146,6 +146,11 @@ export interface AccountRootFlagsInterface {
    * This address can claw back issued IOUs. Once enabled, cannot be disabled.
    */
   lsfAllowTrustLineClawback?: boolean
+
+  /**
+   * Allow IOUs to be used as escrow amounts for an issuer
+   */
+  lsfAllowTrustLineLocking?: boolean
 }
 
 export enum AccountRootFlags {
@@ -210,4 +215,9 @@ export enum AccountRootFlags {
    * This address can claw back issued IOUs. Once enabled, cannot be disabled.
    */
   lsfAllowTrustLineClawback = 0x80000000,
+  /**
+   * If the issuer's account does not have the lsfAllowTrustLineLocking flag set,
+   * then Escrow ledger-objects cannot be created with such IOUs.
+   */
+  lsfAllowTrustLineLocking = 0x40000000,
 }

package/src/models/ledger/DirectoryNode.ts

@@ -45,4 +45,7 @@ export default interface DirectoryNode
   TakerGetsCurrency?: string
   /** The issuer of the TakerGets amount from the offers in this directory. */
   TakerGetsIssuer?: string
+
+  /** The domain that the offer directory is a part of. */
+  DomainID?: string
 }

package/src/models/ledger/Escrow.ts

@@ -19,7 +19,8 @@ export default interface Escrow extends BaseLedgerEntry, HasPreviousTxnID {
    * successful.
    */
   Destination: string
-  /** The amount of XRP, in drops, to be delivered by the held payment. */
+  /** The amount to be delivered by the held payment. Can represent XRP, an IOU token, or an MPT.
+   * Must always be a positive value. */
   Amount: string
   /**
    * A PREIMAGE-SHA-256 crypto-condition, as hexadecimal. If present, the
@@ -61,4 +62,16 @@ export default interface Escrow extends BaseLedgerEntry, HasPreviousTxnID {
    * this object, in case the directory consists of multiple pages.
    */
   DestinationNode?: string
+
+  /**
+   * The transfer rate or fee at which the funds are escrowed, stored at creation
+   *  and used during settlement. Applicable to both IOUs and MPTs.
+   */
+  TransferRate?: number
+
+  /**
+   * The ledger index of the issuer's directory node associated with the Escrow.
+   * Used when the issuer is neither the source nor destination account.
+   */
+  IssuerNode?: number
 }

package/src/models/ledger/LedgerEntry.ts

@@ -18,6 +18,7 @@ import PermissionedDomain from './PermissionedDomain'
 import RippleState from './RippleState'
 import SignerList from './SignerList'
 import Ticket from './Ticket'
+import Vault from './Vault'
 import XChainOwnedClaimID from './XChainOwnedClaimID'
 import XChainOwnedCreateAccountClaimID from './XChainOwnedCreateAccountClaimID'
 
@@ -42,6 +43,7 @@ type LedgerEntry =
   | RippleState
   | SignerList
   | Ticket
+  | Vault
   | XChainOwnedClaimID
   | XChainOwnedCreateAccountClaimID
 
@@ -70,6 +72,7 @@ type LedgerEntryFilter =
   | 'signer_list'
   | 'state'
   | 'ticket'
+  | 'vault'
   | 'xchain_owned_create_account_claim_id'
   | 'xchain_owned_claim_id'
 

package/src/models/ledger/MPToken.ts

@@ -8,4 +8,5 @@ export interface MPToken extends BaseLedgerEntry, HasPreviousTxnID {
   MPTAmount?: MPTAmount
   Flags: number
   OwnerNode?: string
+  LockedAmount?: string
 }

package/src/models/ledger/MPTokenIssuance.ts

@@ -10,4 +10,5 @@ export interface MPTokenIssuance extends BaseLedgerEntry, HasPreviousTxnID {
   TransferFee?: number
   MPTokenMetadata?: string
   OwnerNode?: string
+  LockedAmount?: string
 }

package/src/models/ledger/Offer.ts

@@ -2,6 +2,19 @@ import { Amount } from '../common'
 
 import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
+export interface Book {
+  Book: {
+    /** The ID of the offer directory that links to this offer. */
+    BookDirectory: string
+
+    /**
+     * A hint indicating which page of the offer directory links to this entry,
+     * in case the directory consists of multiple pages.
+     */
+    BookNode: string
+  }
+}
+
 export default interface Offer extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Offer'
   /** A bit-map of boolean flags enabled for this Offer. */
@@ -34,9 +47,17 @@ export default interface Offer extends BaseLedgerEntry, HasPreviousTxnID {
   OwnerNode: string
   /** The time this Offer expires, in seconds since the Ripple Epoch. */
   Expiration?: number
+  /** The domain that the offer must be a part of. */
+  DomainID?: string
+  /**
+   * An additional list of order book directories that this offer belongs to.
+   * Currently this field only applicable to hybrid offers.
+   */
+  AdditionalBooks?: Book[]
 }
 
 export enum OfferFlags {
   lsfPassive = 0x00010000,
   lsfSell = 0x00020000,
+  lsfHybrid = 0x00040000,
 }

package/src/models/ledger/Vault.ts

@@ -0,0 +1,83 @@
+import { Currency } from '../common'
+import { Account } from '../transactions/common'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * The Vault object type represents a Single Asset Vault instance.
+ *
+ * @category Ledger Entries
+ */
+export default interface Vault extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'Vault'
+
+  /**
+   * Ledger object identifier.
+   */
+  LedgerIndex: string
+
+  /**
+   * A bit-map of boolean flags.
+   */
+  Flags: 0
+
+  /**
+   * The transaction sequence number that created the vault.
+   */
+  Sequence: number
+
+  /**
+   * Identifies the page where this item is referenced in the owner's directory.
+   */
+  OwnerNode: string
+
+  /**
+   * The account address of the Vault Owner.
+   */
+  Owner: string
+
+  /**
+   * The address of the Vaults pseudo-account.
+   */
+  Account: Account
+
+  /**
+   * The asset of the vault. The vault supports XRP, IOU and MPT.
+   */
+  Asset: Currency
+
+  /**
+   * The total value of the vault.
+   */
+  AssetsTotal: string
+
+  /**
+   * The asset amount that is available in the vault.
+   */
+  AssetsAvailable: string
+
+  /**
+   * The potential loss amount that is not yet realized expressed as the vaults asset.
+   */
+  LossUnrealized: string
+
+  /**
+   * The identifier of the share MPTokenIssuance object.
+   */
+  MPTokenIssuanceID: string
+
+  /**
+   * Indicates the withdrawal strategy used by the Vault.
+   */
+  WithdrawalPolicy: number
+
+  /**
+   * The maximum asset amount that can be held in the vault. Zero value 0 indicates there is no cap.
+   */
+  AssetsMaximum?: string
+
+  /**
+   * Arbitrary metadata about the Vault. Limited to 256 bytes.
+   */
+  Data?: string
+}

package/src/models/ledger/index.ts

@@ -31,6 +31,7 @@ import PayChannel from './PayChannel'
 import RippleState, { RippleStateFlags } from './RippleState'
 import SignerList, { SignerListFlags } from './SignerList'
 import Ticket from './Ticket'
+import Vault from './Vault'
 import XChainOwnedClaimID from './XChainOwnedClaimID'
 import XChainOwnedCreateAccountClaimID from './XChainOwnedCreateAccountClaimID'
 
@@ -75,7 +76,8 @@ export {
   SignerList,
   SignerListFlags,
   Ticket,
+  Vault,
+  VoteSlot,
   XChainOwnedClaimID,
   XChainOwnedCreateAccountClaimID,
-  VoteSlot,
 }

package/src/models/methods/bookOffers.ts

@@ -39,6 +39,13 @@ export interface BookOffersRequest extends BaseRequest, LookupByLedgerRequest {
    * currency amounts.
    */
   taker_pays: BookOfferCurrency
+  /**
+   * The object ID of a PermissionedDomain object. If this field is provided,
+   * the response will include only valid domain offers associated with that
+   * specific domain. If omitted, the response will include only hybrid and open
+   * offers for the trading pair, excluding all domain-specific offers.
+   */
+  domain?: string
 }
 
 export interface BookOffer extends Offer {

package/src/models/methods/index.ts

@@ -189,6 +189,7 @@ import {
   UnsubscribeRequest,
   UnsubscribeResponse,
 } from './unsubscribe'
+import { VaultInfoRequest, VaultInfoResponse } from './vaultInfo'
 /**
  * @category Requests
  */
@@ -247,6 +248,8 @@ type Request =
   | AMMInfoRequest
   // Price Oracle methods
   | GetAggregatePriceRequest
+  // Vault methods
+  | VaultInfoRequest
 
 /**
  * @category Responses
@@ -306,6 +309,8 @@ type Response<Version extends APIVersion = typeof DEFAULT_API_VERSION> =
   | AMMInfoResponse
   // Price Oracle methods
   | GetAggregatePriceResponse
+  // Vault methods
+  | VaultInfoResponse
 
 export type RequestResponseMap<
   T,
@@ -464,6 +469,8 @@ export type RequestResponseMap<
   ? NFTsByIssuerResponse
   : T extends NFTHistoryRequest
   ? NFTHistoryResponse
+  : T extends VaultInfoRequest
+  ? VaultInfoResponse
   : Response<Version>
 
 export type MarkerRequest = Request & {
@@ -649,4 +656,7 @@ export {
   // AMM methods
   AMMInfoRequest,
   AMMInfoResponse,
+  // Vault methods
+  VaultInfoRequest,
+  VaultInfoResponse,
 }

package/src/models/methods/pathFind.ts

@@ -30,6 +30,11 @@ export interface PathFindCreateRequest extends BasePathFindRequest {
    * about, or to check the overall cost to make a payment along a certain path.
    */
   paths?: Path[]
+  /**
+   * The object ID of a PermissionedDomain object. If this field is included,
+   * then only valid paths for this domain will be returned.
+   */
+  domain?: string
 }
 
 /** Stop sending pathfinding information. */
@@ -97,6 +102,11 @@ export interface PathFindResponse extends BaseResponse {
      * Continues to send updates each time a new ledger closes.
      */
     full_reply: boolean
+    /**
+     * The object ID of a PermissionedDomain object, if the orderbook shown is
+     * for a specific domain.
+     */
+    domain?: string
     /**
      * The ID provided in the WebSocket request is included again at this
      * level.

package/src/models/methods/ripplePathFind.ts

@@ -38,6 +38,11 @@ export interface RipplePathFindRequest
    * and optional issuer field, like how currency amounts are specified.
    */
   source_currencies?: SourceCurrencyAmount[]
+  /**
+   * The object ID of a PermissionedDomain object. If this field is included,
+   * then only valid paths for this domain will be returned.
+   */
+  domain?: string
 }
 
 export interface RipplePathFindPathOption {

package/src/models/methods/subscribe.ts

@@ -39,6 +39,12 @@ export interface SubscribeBook {
   snapshot?: boolean
   /** If true, return both sides of the order book. The default is false. */
   both?: boolean
+  /**
+   * The object ID of a PermissionedDomain object. If this field is included,
+   * then the offers will be filtered to only show the valid domain offers for
+   * that domain.
+   */
+  domain?: string
 }
 
 /**
@@ -136,6 +142,11 @@ export interface LedgerStream extends BaseStream {
    * connected but has not yet obtained a ledger from the network.
    */
   validated_ledgers?: string
+
+  /**
+   * The network from which the ledger stream is received.
+   */
+  network_id?: number
 }
 
 /**
@@ -175,6 +186,11 @@ export interface LedgerStreamResponse {
    * connected but has not yet obtained a ledger from the network.
    */
   validated_ledgers?: string
+
+  /**
+   * The network from which the ledger stream is received.
+   */
+  network_id?: number
 }
 
 /**
@@ -259,6 +275,11 @@ export interface ValidationStream extends BaseStream {
    * validator is using a token, this is an ephemeral public key.
    */
   validation_public_key: string
+
+  /**
+   * The network from which the validations stream is received.
+   */
+  network_id?: number
 }
 
 /**

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`,