xrpl 4.3.0-smartescrow.3 → 4.4.0-smartescrow.0

package/src/client/index.ts

@@ -63,10 +63,12 @@ import {
 import {
   setValidAddresses,
   setNextValidSequenceNumber,
-  calculateFeePerTransactionType,
   setLatestValidatedLedgerSequence,
   checkAccountDeleteBlockers,
   txNeedsNetworkID,
+  autofillBatchTxn,
+  handleDeliverMax,
+  getTransactionFee,
 } from '../sugar/autofill'
 import { formatBalances } from '../sugar/balances'
 import {
@@ -661,8 +663,6 @@ class Client extends EventEmitter<EventTypes> {
    * @returns The autofilled transaction.
    * @throws ValidationError If Amount and DeliverMax fields are not identical in a Payment Transaction
    */
-
-  // eslint-disable-next-line complexity -- handling Payment transaction API v2 requires more logic
   public async autofill<T extends SubmittableTransaction>(
     transaction: T,
     signersCount?: number,
@@ -680,7 +680,7 @@ class Client extends EventEmitter<EventTypes> {
       promises.push(setNextValidSequenceNumber(this, tx))
     }
     if (tx.Fee == null) {
-      promises.push(calculateFeePerTransactionType(this, tx, signersCount))
+      promises.push(getTransactionFee(this, tx, signersCount))
     }
     if (tx.LastLedgerSequence == null) {
       promises.push(setLatestValidatedLedgerSequence(this, tx))
@@ -688,38 +688,51 @@ class Client extends EventEmitter<EventTypes> {
     if (tx.TransactionType === 'AccountDelete') {
       promises.push(checkAccountDeleteBlockers(this, tx))
     }
-
-    // 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
+    if (tx.TransactionType === 'Batch') {
+      promises.push(autofillBatchTxn(this, tx))
+    }
     if (tx.TransactionType === 'Payment' && tx.DeliverMax != null) {
-      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- This is a valid null check for Amount
-      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 @typescript-eslint/no-unsafe-assignment -- DeliverMax is a known RPC-level property
-        tx.Amount = tx.DeliverMax
-      }
-
-      // 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 @typescript-eslint/no-unnecessary-condition -- This is a valid null check for Amount
-      if (tx.Amount != null && tx.Amount !== tx.DeliverMax) {
-        return Promise.reject(
-          new ValidationError(
-            'PaymentTransaction: Amount and DeliverMax fields must be identical when both are provided',
-          ),
-        )
-      }
-
-      // 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
-      delete tx.DeliverMax
+      handleDeliverMax(tx)
     }
 
     return Promise.all(promises).then(() => tx)
   }
 
+  /**
+   * Simulates an unsigned transaction.
+   * Steps performed on a transaction:
+   *    1. Autofill.
+   *    2. Sign & Encode.
+   *    3. Submit.
+   *
+   * @category Core
+   *
+   * @param transaction - A transaction to autofill, sign & encode, and submit.
+   * @param opts - (Optional) Options used to sign and submit a transaction.
+   * @param opts.binary - If true, return the metadata in a binary encoding.
+   *
+   * @returns A promise that contains SimulateResponse.
+   * @throws RippledError if the simulate request fails.
+   */
+
+  public async simulate<Binary extends boolean = false>(
+    transaction: SubmittableTransaction | string,
+    opts?: {
+      // If true, return the binary-encoded representation of the results.
+      binary?: Binary
+    },
+  ): Promise<
+    Binary extends true ? SimulateBinaryResponse : SimulateJsonResponse
+  > {
+    // send request
+    const binary = opts?.binary ?? false
+    const request: SimulateRequest =
+      typeof transaction === 'string'
+        ? { command: 'simulate', tx_blob: transaction, binary }
+        : { command: 'simulate', tx_json: transaction, binary }
+    return this.request(request)
+  }
+
   /**
    * Submits a signed/unsigned transaction.
    * Steps performed on a transaction:
@@ -769,41 +782,6 @@ class Client extends EventEmitter<EventTypes> {
     return submitRequest(this, signedTx, opts?.failHard)
   }
 
-  /**
-   * Simulates an unsigned transaction.
-   * Steps performed on a transaction:
-   *    1. Autofill.
-   *    2. Sign & Encode.
-   *    3. Submit.
-   *
-   * @category Core
-   *
-   * @param transaction - A transaction to autofill, sign & encode, and submit.
-   * @param opts - (Optional) Options used to sign and submit a transaction.
-   * @param opts.binary - If true, return the metadata in a binary encoding.
-   *
-   * @returns A promise that contains SimulateResponse.
-   * @throws RippledError if the simulate request fails.
-   */
-
-  public async simulate<Binary extends boolean = false>(
-    transaction: SubmittableTransaction | string,
-    opts?: {
-      // If true, return the binary-encoded representation of the results.
-      binary?: Binary
-    },
-  ): Promise<
-    Binary extends true ? SimulateBinaryResponse : SimulateJsonResponse
-  > {
-    // send request
-    const binary = opts?.binary ?? false
-    const request: SimulateRequest =
-      typeof transaction === 'string'
-        ? { command: 'simulate', tx_blob: transaction, binary }
-        : { command: 'simulate', tx_json: transaction, binary }
-    return this.request(request)
-  }
-
   /**
    * Asynchronously submits a transaction and verifies that it has been included in a
    * validated ledger (or has errored/will not be included for some reason).
@@ -844,7 +822,7 @@ class Client extends EventEmitter<EventTypes> {
    * Under the hood, `submit` will call `client.autofill` by default, and because we've passed in a `Wallet` it
    * Will also sign the transaction for us before submitting the signed transaction binary blob to the ledger.
    *
-   * This is similar to `submitAndWait` which does all of the above, but also waits to see if the transaction has been validated.
+   * This is similar to `submit`, which does all of the above, but also waits to see if the transaction has been validated.
    * @param transaction - A transaction to autofill, sign & encode, and submit.
    * @param opts - (Optional) Options used to sign and submit a transaction.
    * @param opts.autofill - If true, autofill a transaction.
@@ -885,6 +863,12 @@ class Client extends EventEmitter<EventTypes> {
 
     const response = await submitRequest(this, signedTx, opts?.failHard)
 
+    if (response.result.engine_result.startsWith('tem')) {
+      throw new XrplError(
+        `Transaction failed, ${response.result.engine_result}: ${response.result.engine_result_message}`,
+      )
+    }
+
     const txHash = hashes.hashSignedTx(signedTx)
     return waitForFinalTransactionOutcome(
       this,

package/src/client/partialPayment.ts

@@ -96,10 +96,8 @@ function isPartialPayment(
   }
 
   const delivered = meta.delivered_amount
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- DeliverMax is a valid field on Payment response
-  // @ts-expect-error -- DeliverMax is a valid field on Payment response
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- DeliverMax is a valid field on Payment response
-  const amount = tx.DeliverMax
+
+  const amount = tx.DeliverMax ?? tx.Amount
 
   if (delivered === undefined) {
     return false

package/src/models/common/index.ts

@@ -31,6 +31,8 @@ export interface MPTAmount {
 
 export type Amount = IssuedCurrencyAmount | string
 
+export type ClawbackAmount = IssuedCurrencyAmount | MPTAmount
+
 export interface Balance {
   currency: string
   issuer?: string

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. */

package/src/models/ledger/Credential.ts

@@ -1,8 +1,8 @@
-import { GlobalFlags } from '../transactions/common'
+import { GlobalFlagsInterface } from '../transactions/common'
 
 import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
-export interface CredentialFlags extends GlobalFlags {
+export interface CredentialFlags extends GlobalFlagsInterface {
   lsfAccepted?: boolean
 }
 

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/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/XChainOwnedClaimID.ts

@@ -1,6 +1,4 @@
-import { Amount } from 'ripple-binary-codec/dist/types'
-
-import { XChainBridge } from '../common'
+import { Amount, XChainBridge } from '../common'
 
 import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 

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/baseMethod.ts

@@ -53,6 +53,7 @@ export interface ErrorResponse {
   error: string
   error_code?: string
   error_message?: string
+  error_exception?: string
   request: Request
   api_version?: number
 }

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/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,38 +98,27 @@ export function validateAMMBid(tx: Record<string, unknown>): void {
         `AMMBid: AuthAccounts length must not be greater than ${MAX_AUTH_ACCOUNTS}`,
       )
     }
-    validateAuthAccounts(
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Only used by JS
-      tx.Account as string,
-      // 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`,