xrpl 4.3.0-smartescrow.2 → 4.3.0

package/src/Wallet/utils.ts

@@ -0,0 +1,58 @@
+import { bytesToHex } from '@xrplf/isomorphic/utils'
+import BigNumber from 'bignumber.js'
+import { decodeAccountID } from 'ripple-address-codec'
+import { decode, encode } from 'ripple-binary-codec'
+
+import { Transaction } from '../models'
+
+/**
+ * If presented in binary form, the Signers array must be sorted based on
+ * the numeric value of the signer addresses, with the lowest value first.
+ * (If submitted as JSON, the submit_multisigned method handles this automatically.)
+ * https://xrpl.org/multi-signing.html.
+ *
+ * @param left - A Signer to compare with.
+ * @param right - A second Signer to compare with.
+ * @returns 1 if left \> right, 0 if left = right, -1 if left \< right, and null if left or right are NaN.
+ */
+export function compareSigners<T extends { Account: string }>(
+  left: T,
+  right: T,
+): number {
+  return addressToBigNumber(left.Account).comparedTo(
+    addressToBigNumber(right.Account),
+  )
+}
+
+export const NUM_BITS_IN_HEX = 16
+
+/**
+ * Converts an address to a BigNumber.
+ *
+ * @param address - The address to convert.
+ * @returns A BigNumber representing the address.
+ */
+export function addressToBigNumber(address: string): BigNumber {
+  const hex = bytesToHex(decodeAccountID(address))
+  return new BigNumber(hex, NUM_BITS_IN_HEX)
+}
+
+/**
+ * Decodes a transaction or transaction blob into a Transaction object.
+ *
+ * @param txOrBlob - A Transaction object or a hex string representing a transaction blob.
+ * @returns A Transaction object.
+ * @throws If the input is not a valid Transaction or transaction blob.
+ */
+export function getDecodedTransaction(
+  txOrBlob: Transaction | string,
+): Transaction {
+  if (typeof txOrBlob === 'object') {
+    // We need this to handle X-addresses in multisigning
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are casting here to get strong typing
+    return decode(encode(txOrBlob)) as unknown as Transaction
+  }
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are casting here to get strong typing
+  return decode(txOrBlob) as unknown as Transaction
+}

package/src/client/RequestManager.ts

@@ -175,6 +175,7 @@ export default class RequestManager {
    * @param response - The response to handle.
    * @throws ResponseFormatError if the response format is invalid, RippledError if rippled returns an error.
    */
+  // eslint-disable-next-line complexity -- handling a response is complex
   public handleResponse(
     response: Partial<Response<APIVersion> | ErrorResponse>,
   ): void {
@@ -195,7 +196,9 @@ export default class RequestManager {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We know this must be true
       const errorResponse = response as Partial<ErrorResponse>
       const error = new RippledError(
-        errorResponse.error_message ?? errorResponse.error,
+        errorResponse.error_message ??
+          errorResponse.error_exception ??
+          errorResponse.error,
         errorResponse,
       )
       this.reject(response.id, error)

package/src/client/connection.ts

@@ -349,7 +349,6 @@ export class Connection extends EventEmitter {
       try {
         this.requestManager.handleResponse(data)
       } catch (error) {
-        // eslint-disable-next-line max-depth -- okay here
         if (error instanceof Error) {
           this.emit('error', 'badMessage', error.message, message)
         } else {

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 {
@@ -662,7 +664,6 @@ class Client extends EventEmitter<EventTypes> {
    * @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 +681,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,33 +689,11 @@ 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 === '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
+    if (tx.TransactionType === 'Batch') {
+      promises.push(autofillBatchTxn(this, tx))
+    }
+    if (tx.TransactionType === 'Payment') {
+      handleDeliverMax(tx)
     }
 
     return Promise.all(promises).then(() => tx)

package/src/client/partialPayment.ts

@@ -96,10 +96,9 @@ 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
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- needed here
+  const amount = tx.DeliverMax as Amount | MPTAmount
 
   if (delivered === undefined) {
     return false

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

@@ -0,0 +1,39 @@
+import { Permission } from '../transactions'
+
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
+
+/**
+ * This object represents a set of permissions that an account has delegated to another account.
+ *
+ * @category Ledger Entries
+ */
+export default interface Delegate extends BaseLedgerEntry, HasPreviousTxnID {
+  LedgerEntryType: 'Delegate'
+
+  /**
+   * The account that wants to authorize another account.
+   */
+  Account: string
+
+  /**
+   * The authorized account.
+   */
+  Authorize: string
+
+  /**
+   * The transaction permissions that the account has access to.
+   */
+  Permissions: Permission[]
+
+  /**
+   * A hint indicating which page of the sender's owner directory links to this object,
+   * in case the directory consists of multiple pages.
+   */
+  OwnerNode: string
+
+  /**
+   * A bit-map of boolean flags. No flags are defined for the Delegate object
+   * type, so this value is always 0.
+   */
+  Flags: 0
+}

package/src/models/ledger/Escrow.ts

@@ -61,8 +61,4 @@ export default interface Escrow extends BaseLedgerEntry, HasPreviousTxnID {
    * this object, in case the directory consists of multiple pages.
    */
   DestinationNode?: string
-
-  FinishFunction?: string
-
-  Data?: string
 }

package/src/models/ledger/FeeSettings.ts

@@ -24,10 +24,6 @@ export interface FeeSettingsPostAmendmentFields {
   ReserveBaseDrops: string
   /** The incremental owner reserve for owning objects, as drops of XRP. */
   ReserveIncrementDrops: string
-
-  ExtensionComputeLimit: number
-
-  ExtensionSizeLimit: number
 }
 
 export interface FeeSettingsBase

package/src/models/ledger/LedgerEntry.ts

@@ -4,6 +4,7 @@ import AMM from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import Credential from './Credential'
+import Delegate from './Delegate'
 import DepositPreauth from './DepositPreauth'
 import DirectoryNode from './DirectoryNode'
 import Escrow from './Escrow'
@@ -27,6 +28,7 @@ type LedgerEntry =
   | Bridge
   | Check
   | Credential
+  | Delegate
   | DepositPreauth
   | DirectoryNode
   | Escrow
@@ -50,6 +52,7 @@ type LedgerEntryFilter =
   | 'bridge'
   | 'check'
   | 'credential'
+  | 'delegate'
   | 'deposit_preauth'
   | 'did'
   | 'directory'

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

@@ -7,6 +7,7 @@ import AMM, { VoteSlot } from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import Credential from './Credential'
+import Delegate from './Delegate'
 import DepositPreauth from './DepositPreauth'
 import DID from './DID'
 import DirectoryNode from './DirectoryNode'
@@ -43,6 +44,7 @@ export {
   Bridge,
   Check,
   Credential,
+  Delegate,
   DepositPreauth,
   DirectoryNode,
   DID,

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

@@ -223,6 +223,11 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
         xchain_owned_create_account_claim_id: string | number
       }
     | string
+
+  delegate?: {
+    account: string
+    authorize: string
+  }
 }
 
 /**

package/src/models/methods/serverInfo.ts

@@ -85,11 +85,6 @@ export interface ServerInfoResponse extends BaseResponse {
         hash: string
         reserve_base_xrp: number
         reserve_inc_xrp: number
-
-        extension_compute: number
-        extension_size: number
-        gas_price: number
-
         seq: number
       }
       /**
@@ -257,10 +252,6 @@ export interface ServerInfoResponse extends BaseResponse {
          * object an account owns in the ledger.
          */
         reserve_inc_xrp: number
-
-        extension_compute: number
-        extension_size: number
-        gas_price: number
         /** The ledger index of the latest validated ledger. */
         seq: number
       }

package/src/models/methods/serverState.ts

@@ -30,11 +30,6 @@ export interface ServerStateResponse extends BaseResponse {
         hash: string
         reserve_base: number
         reserve_inc: number
-
-        extension_compute: number
-        extension_size: number
-        gas_price: number
-
         seq: number
       }
       io_latency_ms: number
@@ -74,11 +69,6 @@ export interface ServerStateResponse extends BaseResponse {
         hash: string
         reserve_base: number
         reserve_inc: number
-
-        extension_compute: number
-        extension_size: number
-        gas_price: number
-
         seq: number
       }
       validation_quorum: number

package/src/models/transactions/AMMBid.ts

@@ -97,8 +97,7 @@ export function validateAMMBid(tx: Record<string, unknown>): void {
       )
     }
     validateAuthAccounts(
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Only used by JS
-      tx.Account as string,
+      tx.Account,
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Only used by JS
       tx.AuthAccounts as Array<Record<string, unknown>>,
     )

package/src/models/transactions/AMMClawback.ts

@@ -4,7 +4,7 @@ import { Currency, IssuedCurrency, IssuedCurrencyAmount } from '../common'
 import {
   Account,
   BaseTransaction,
-  GlobalFlags,
+  GlobalFlagsInterface,
   isAccount,
   isAmount,
   isCurrency,
@@ -28,7 +28,7 @@ export enum AMMClawbackFlags {
  *
  * @category Transaction Flags
  */
-export interface AMMClawbackFlagsInterface extends GlobalFlags {
+export interface AMMClawbackFlagsInterface extends GlobalFlagsInterface {
   tfClawTwoAssets?: boolean
 }
 

package/src/models/transactions/AMMDeposit.ts

@@ -3,7 +3,7 @@ import { Amount, Currency, IssuedCurrencyAmount } from '../common'
 
 import {
   BaseTransaction,
-  GlobalFlags,
+  GlobalFlagsInterface,
   isAmount,
   isCurrency,
   isIssuedCurrency,
@@ -24,7 +24,7 @@ export enum AMMDepositFlags {
   tfTwoAssetIfEmpty = 0x00800000,
 }
 
-export interface AMMDepositFlagsInterface extends GlobalFlags {
+export interface AMMDepositFlagsInterface extends GlobalFlagsInterface {
   tfLPToken?: boolean
   tfSingleAsset?: boolean
   tfTwoAsset?: boolean

package/src/models/transactions/AMMWithdraw.ts

@@ -3,7 +3,7 @@ import { Amount, Currency, IssuedCurrencyAmount } from '../common'
 
 import {
   BaseTransaction,
-  GlobalFlags,
+  GlobalFlagsInterface,
   isAmount,
   isCurrency,
   isIssuedCurrency,
@@ -25,7 +25,7 @@ export enum AMMWithdrawFlags {
   tfLimitLPToken = 0x00400000,
 }
 
-export interface AMMWithdrawFlagsInterface extends GlobalFlags {
+export interface AMMWithdrawFlagsInterface extends GlobalFlagsInterface {
   tfLPToken?: boolean
   tfWithdrawAll?: boolean
   tfOneAssetWithdrawAll?: boolean

package/src/models/transactions/MPTokenAuthorize.ts

@@ -6,7 +6,7 @@ import {
   Account,
   validateOptionalField,
   isAccount,
-  GlobalFlags,
+  GlobalFlagsInterface,
 } from './common'
 
 /**
@@ -32,7 +32,7 @@ export enum MPTokenAuthorizeFlags {
  *
  * @category Transaction Flags
  */
-export interface MPTokenAuthorizeFlagsInterface extends GlobalFlags {
+export interface MPTokenAuthorizeFlagsInterface extends GlobalFlagsInterface {
   tfMPTUnauthorize?: boolean
 }
 

package/src/models/transactions/MPTokenIssuanceCreate.ts

@@ -3,7 +3,7 @@ import { isHex, INTEGER_SANITY_CHECK, isFlagEnabled } from '../utils'
 
 import {
   BaseTransaction,
-  GlobalFlags,
+  GlobalFlagsInterface,
   validateBaseTransaction,
   validateOptionalField,
   isString,
@@ -58,7 +58,8 @@ export enum MPTokenIssuanceCreateFlags {
  *
  * @category Transaction Flags
  */
-export interface MPTokenIssuanceCreateFlagsInterface extends GlobalFlags {
+export interface MPTokenIssuanceCreateFlagsInterface
+  extends GlobalFlagsInterface {
   tfMPTCanLock?: boolean
   tfMPTRequireAuth?: boolean
   tfMPTCanEscrow?: boolean

package/src/models/transactions/MPTokenIssuanceSet.ts

@@ -9,7 +9,7 @@ import {
   Account,
   validateOptionalField,
   isAccount,
-  GlobalFlags,
+  GlobalFlagsInterface,
 } from './common'
 
 /**
@@ -34,7 +34,7 @@ export enum MPTokenIssuanceSetFlags {
  *
  * @category Transaction Flags
  */
-export interface MPTokenIssuanceSetFlagsInterface extends GlobalFlags {
+export interface MPTokenIssuanceSetFlagsInterface extends GlobalFlagsInterface {
   tfMPTLock?: boolean
   tfMPTUnlock?: boolean
 }

package/src/models/transactions/NFTokenCreateOffer.ts

@@ -4,7 +4,7 @@ import { isFlagEnabled } from '../utils'
 
 import {
   BaseTransaction,
-  GlobalFlags,
+  GlobalFlagsInterface,
   validateBaseTransaction,
   isAmount,
   parseAmountValue,
@@ -33,7 +33,7 @@ export enum NFTokenCreateOfferFlags {
  *
  * @category Transaction Flags
  */
-export interface NFTokenCreateOfferFlagsInterface extends GlobalFlags {
+export interface NFTokenCreateOfferFlagsInterface extends GlobalFlagsInterface {
   tfSellNFToken?: boolean
 }
 

package/src/models/transactions/NFTokenMint.ts

@@ -5,7 +5,7 @@ import { isHex } from '../utils'
 import {
   Account,
   BaseTransaction,
-  GlobalFlags,
+  GlobalFlagsInterface,
   isAccount,
   isAmount,
   isNumber,
@@ -53,7 +53,7 @@ export enum NFTokenMintFlags {
  *
  * @category Transaction Flags
  */
-export interface NFTokenMintFlagsInterface extends GlobalFlags {
+export interface NFTokenMintFlagsInterface extends GlobalFlagsInterface {
   tfBurnable?: boolean
   tfOnlyXRP?: boolean
   tfTrustLine?: boolean

package/src/models/transactions/XChainAddAccountCreateAttestation.ts

@@ -110,13 +110,13 @@ export function validateXChainAddAccountCreateAttestation(
   validateRequiredField(
     tx,
     'WasLockingChainSend',
-    (inp) => inp === 0 || inp === 1,
+    (inp: unknown): inp is 0 | 1 => inp === 0 || inp === 1,
   )
 
   validateRequiredField(
     tx,
     'XChainAccountCreateCount',
-    (inp) => isNumber(inp) || isString(inp),
+    (inp: unknown): inp is number | string => isNumber(inp) || isString(inp),
   )
 
   validateRequiredField(tx, 'XChainBridge', isXChainBridge)

package/src/models/transactions/XChainAddClaimAttestation.ts

@@ -104,7 +104,7 @@ export function validateXChainAddClaimAttestation(
   validateRequiredField(
     tx,
     'WasLockingChainSend',
-    (inp) => inp === 0 || inp === 1,
+    (inp: unknown): inp is 0 | 1 => inp === 0 || inp === 1,
   )
 
   validateRequiredField(tx, 'XChainBridge', isXChainBridge)
@@ -112,6 +112,6 @@ export function validateXChainAddClaimAttestation(
   validateRequiredField(
     tx,
     'XChainClaimID',
-    (inp) => isNumber(inp) || isString(inp),
+    (inp: unknown): inp is number | string => isNumber(inp) || isString(inp),
   )
 }

package/src/models/transactions/XChainClaim.ts

@@ -68,7 +68,7 @@ export function validateXChainClaim(tx: Record<string, unknown>): void {
   validateRequiredField(
     tx,
     'XChainClaimID',
-    (inp) => isNumber(inp) || isString(inp),
+    (inp: unknown): inp is number | string => isNumber(inp) || isString(inp),
   )
 
   validateRequiredField(tx, 'Destination', isAccount)

package/src/models/transactions/XChainCommit.ts

@@ -67,7 +67,7 @@ export function validateXChainCommit(tx: Record<string, unknown>): void {
   validateRequiredField(
     tx,
     'XChainClaimID',
-    (inp) => isNumber(inp) || isString(inp),
+    (inp: unknown): inp is number | string => isNumber(inp) || isString(inp),
   )
 
   validateOptionalField(tx, 'OtherChainDestination', isAccount)

package/src/models/transactions/XChainModifyBridge.ts

@@ -2,7 +2,7 @@ import { Amount, XChainBridge } from '../common'
 
 import {
   BaseTransaction,
-  GlobalFlags,
+  GlobalFlagsInterface,
   isAmount,
   isXChainBridge,
   validateBaseTransaction,
@@ -26,7 +26,7 @@ export enum XChainModifyBridgeFlags {
  *
  * @category Transaction Flags
  */
-export interface XChainModifyBridgeFlagsInterface extends GlobalFlags {
+export interface XChainModifyBridgeFlagsInterface extends GlobalFlagsInterface {
   /** Clears the MinAccountCreateAmount of the bridge. */
   tfClearAccountCreateAmount?: boolean
 }

package/src/models/transactions/accountDelete.ts

@@ -52,8 +52,7 @@ export function validateAccountDelete(tx: Record<string, unknown>): void {
 
   validateCredentialsList(
     tx.CredentialIDs,
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- known from base check
-    tx.TransactionType as string,
+    tx.TransactionType,
     true,
     MAX_AUTHORIZED_CREDENTIALS,
   )

package/src/models/transactions/accountSet.ts

@@ -3,6 +3,7 @@ import { ValidationError } from '../../errors'
 import {
   Account,
   BaseTransaction,
+  GlobalFlagsInterface,
   isAccount,
   validateBaseTransaction,
   validateOptionalField,
@@ -112,7 +113,7 @@ export enum AccountSetTfFlags {
  * // }
  * ```
  */
-export interface AccountSetFlagsInterface {
+export interface AccountSetFlagsInterface extends GlobalFlagsInterface {
   tfRequireDestTag?: boolean
   tfOptionalDestTag?: boolean
   tfRequireAuth?: boolean