xrpl 2.12.0 → 3.0.0-beta.0

package/src/client/partialPayment.ts

@@ -3,14 +3,18 @@ import { decode } from 'ripple-binary-codec'
 
 import type {
   AccountTxResponse,
-  Response,
-  ResponseWarning,
   TransactionEntryResponse,
   TransactionStream,
   TxResponse,
 } from '..'
 import type { Amount } from '../models/common'
-import { PaymentFlags, Transaction } from '../models/transactions'
+import type { RequestResponseMap } from '../models/methods'
+import { BaseRequest, BaseResponse } from '../models/methods/baseMethod'
+import {
+  PaymentFlags,
+  PseudoTransaction,
+  Transaction,
+} from '../models/transactions'
 import type { TransactionMetadata } from '../models/transactions/metadata'
 import { isFlagEnabled } from '../models/utils'
 
@@ -36,7 +40,7 @@ function amountsEqual(amt1: Amount, amt2: Amount): boolean {
 }
 
 function isPartialPayment(
-  tx?: Transaction,
+  tx?: Transaction | PseudoTransaction,
   metadata?: TransactionMetadata | string,
 ): boolean {
   if (tx == null || metadata == null || tx.TransactionType !== 'Payment') {
@@ -86,7 +90,10 @@ function accountTxHasPartialPayment(response: AccountTxResponse): boolean {
   return foo
 }
 
-function hasPartialPayment(command: string, response: Response): boolean {
+function hasPartialPayment<R extends BaseRequest, T = RequestResponseMap<R>>(
+  command: string,
+  response: T,
+): boolean {
   /* eslint-disable @typescript-eslint/consistent-type-assertions -- Request type is known at runtime from command */
   switch (command) {
     case 'tx':
@@ -107,12 +114,13 @@ function hasPartialPayment(command: string, response: Response): boolean {
  * @param command - Command from the request, tells us what response to expect.
  * @param response - Response to check for a partial payment.
  */
-export function handlePartialPayment(
-  command: string,
-  response: Response,
-): void {
+export function handlePartialPayment<
+  R extends BaseRequest,
+  T = RequestResponseMap<R>,
+>(command: string, response: T): void {
   if (hasPartialPayment(command, response)) {
-    const warnings: ResponseWarning[] = response.warnings ?? []
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- We are checking dynamically and safely.
+    const warnings = (response as BaseResponse).warnings ?? []
 
     const warning = {
       id: WARN_PARTIAL_PAYMENT_CODE,
@@ -121,6 +129,8 @@ export function handlePartialPayment(
 
     warnings.push(warning)
 
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- We are checking dynamically and safely.
+    // @ts-expect-error -- We are checking dynamically and safely.
     response.warnings = warnings
   }
 }

package/src/errors.ts

@@ -1,6 +1,4 @@
 /* eslint-disable max-classes-per-file -- Errors can be defined in the same file */
-import { inspect } from 'util'
-
 /**
  * Base Error class for xrpl.js. All Errors thrown by xrpl.js should throw
  * XrplErrors.
@@ -38,7 +36,7 @@ class XrplError extends Error {
   public toString(): string {
     let result = `[${this.name}(${this.message}`
     if (this.data) {
-      result += `, ${inspect(this.data)}`
+      result += `, ${JSON.stringify(this.data)}`
     }
     result += ')]'
     return result

package/src/index.ts

@@ -1,6 +1,3 @@
-// Broadcast client is experimental
-export { BroadcastClient } from './client/BroadcastClient'
-
 export { Client, ClientOptions } from './client'
 
 export * from './models'
@@ -11,6 +8,7 @@ export { default as ECDSA } from './ECDSA'
 
 export * from './errors'
 
+export { FundingOptions } from './Wallet/fundWallet'
 export { Wallet } from './Wallet'
 
 export { walletFromSecretNumbers } from './Wallet/walletFromSecretNumbers'

package/src/models/ledger/AMM.ts

@@ -1,6 +1,6 @@
 import { AuthAccount, Currency, IssuedCurrencyAmount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 export interface VoteSlot {
   VoteEntry: {
@@ -15,7 +15,7 @@ export interface VoteSlot {
  *
  * @category Ledger Entries
  */
-export default interface AMM extends BaseLedgerEntry {
+export default interface AMM extends BaseLedgerEntry, MissingPreviousTxnID {
   LedgerEntryType: 'AMM'
   /**
    * The address of the special account that holds this AMM's assets.
@@ -75,12 +75,4 @@ export default interface AMM extends BaseLedgerEntry {
    * type, so this value is always 0.
    */
   Flags: 0
-  /**
-   * This field is missing on AMM but is present on all other account_object returned objects.
-   */
-  PreviousTxnID: never
-  /**
-   * This field is missing on AMM but is present on all other account_object returned objects.
-   */
-  PreviousTxnLgrSeq: never
 }

package/src/models/ledger/AccountRoot.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The AccountRoot object type describes a single account, its settings, and
@@ -6,7 +6,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface AccountRoot extends BaseLedgerEntry {
+export default interface AccountRoot extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'AccountRoot'
   /** The identifying (classic) address of this account. */
   Account: string
@@ -19,16 +19,6 @@ export default interface AccountRoot extends BaseLedgerEntry {
    * to its owner reserve.
    */
   OwnerCount: number
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
   /** The sequence number of the next valid transaction for this account. */
   Sequence: number
   /**

package/src/models/ledger/Amendments.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The unique id for the Amendments object https://xrpl.org/amendments-object.html#amendments-id-format
@@ -24,7 +24,9 @@ export interface Majority {
  *
  * @category Ledger Entries
  */
-export default interface Amendments extends BaseLedgerEntry {
+export default interface Amendments
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
   LedgerEntryType: 'Amendments'
   /**
    * Array of 256-bit amendment IDs for all currently-enabled amendments. If

package/src/models/ledger/BaseLedgerEntry.ts

@@ -1,3 +1,27 @@
-export default interface BaseLedgerEntry {
+export interface BaseLedgerEntry {
   index: string
 }
+
+export interface HasPreviousTxnID {
+  /**
+   * The identifying hash of the transaction that most recently modified this
+   * object.
+   */
+  PreviousTxnID: string
+  /**
+   * The index of the ledger that contains the transaction that most recently
+   * modified this object.
+   */
+  PreviousTxnLgrSeq: number
+}
+
+export interface MissingPreviousTxnID {
+  /**
+   * This field is missing on this object but is present on most other returned objects.
+   */
+  PreviousTxnID: never
+  /**
+   * This field is missing on this object but is present on most other returned objects.
+   */
+  PreviousTxnLgrSeq: never
+}

package/src/models/ledger/Bridge.ts

@@ -1,6 +1,6 @@
 import { Amount, XChainBridge } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * A Bridge objects represents a cross-chain bridge and includes information about
@@ -9,7 +9,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Bridge extends BaseLedgerEntry {
+export default interface Bridge extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Bridge'
 
   /** The door account that owns the bridge. */
@@ -69,16 +69,4 @@ export default interface Bridge extends BaseLedgerEntry {
    * object, in case the directory consists of multiple pages.
    */
   OwnerNode: string
-
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
 }

package/src/models/ledger/Check.ts

@@ -1,6 +1,6 @@
 import { Amount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * A Check object describes a check, similar to a paper personal check, which
@@ -8,7 +8,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Check extends BaseLedgerEntry {
+export default interface Check extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Check'
   /** The sender of the Check. Cashing the Check debits this address's balance. */
   Account: string

package/src/models/ledger/DepositPreauth.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * A DepositPreauth object tracks a preauthorization from one account to
@@ -6,7 +6,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface DepositPreauth extends BaseLedgerEntry {
+export default interface DepositPreauth
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
   LedgerEntryType: 'DepositPreauth'
   /** The account that granted the preauthorization. */
   Account: string
@@ -22,14 +24,4 @@ export default interface DepositPreauth extends BaseLedgerEntry {
    * object, in case the directory consists of multiple pages.
    */
   OwnerNode: string
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
 }

package/src/models/ledger/DirectoryNode.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The DirectoryNode object type provides a list of links to other objects in
@@ -6,7 +6,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface DirectoryNode extends BaseLedgerEntry {
+export default interface DirectoryNode
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
   LedgerEntryType: 'DirectoryNode'
   /**
    * A bit-map of boolean flags enabled for this directory. Currently, the

package/src/models/ledger/Escrow.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The Escrow object type represents a held payment of XRP waiting to be
@@ -6,7 +6,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Escrow extends BaseLedgerEntry {
+export default interface Escrow extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Escrow'
   /**
    * The address of the owner (sender) of this held payment. This is the
@@ -61,14 +61,4 @@ export default interface Escrow extends BaseLedgerEntry {
    * this object, in case the directory consists of multiple pages.
    */
   DestinationNode?: string
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
 }

package/src/models/ledger/FeeSettings.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The unique id for the FeeSettings object https://xrpl.org/feesettings.html#feesettings-id-format
@@ -26,7 +26,7 @@ export interface FeeSettingsPostAmendmentFields {
   ReserveIncrementDrops: string
 }
 
-export interface FeeSettingsBase extends BaseLedgerEntry {
+export interface FeeSettingsBase extends BaseLedgerEntry, MissingPreviousTxnID {
   LedgerEntryType: 'FeeSettings'
   /**
    * A bit-map of boolean flags for this object. No flags are defined for this type.

package/src/models/ledger/Ledger.ts

@@ -1,6 +1,10 @@
-import { Transaction, TransactionMetadata } from '../transactions'
+import {
+  PseudoTransaction,
+  Transaction,
+  TransactionMetadata,
+} from '../transactions'
 
-import LedgerEntry from './LedgerEntry'
+import { LedgerEntry } from './LedgerEntry'
 
 /**
  * A ledger is a block of transactions and shared state data. It has a unique
@@ -11,7 +15,7 @@ import LedgerEntry from './LedgerEntry'
 export default interface Ledger {
   /** The SHA-512Half of this ledger's state tree information. */
   account_hash: string
-  /** All the state information in this ledger. */
+  /** All the state information in this ledger. Admin only. */
   accountState?: LedgerEntry[]
   /** A bit-map of flags relating to the closing of this ledger. */
   close_flags: number
@@ -61,5 +65,7 @@ export default interface Ledger {
    * either JSON or binary depending on whether the request specified binary
    * as true.
    */
-  transactions?: Array<Transaction & { metaData?: TransactionMetadata }>
+  transactions?: Array<
+    (Transaction | PseudoTransaction) & { metaData?: TransactionMetadata }
+  >
 }

package/src/models/ledger/LedgerEntry.ts

@@ -37,4 +37,25 @@ type LedgerEntry =
   | XChainOwnedClaimID
   | XChainOwnedCreateAccountClaimID
 
-export default LedgerEntry
+type LedgerEntryFilter =
+  | 'account'
+  | 'amendments'
+  | 'amm'
+  | 'bridge'
+  | 'check'
+  | 'deposit_preauth'
+  | 'directory'
+  | 'escrow'
+  | 'fee'
+  | 'hashes'
+  | 'nft_offer'
+  | 'nft_page'
+  | 'offer'
+  | 'payment_channel'
+  | 'signer_list'
+  | 'state'
+  | 'ticket'
+  | 'xchain_owned_create_account_claim_id'
+  | 'xchain_owned_claim_id'
+
+export { LedgerEntry, LedgerEntryFilter }

package/src/models/ledger/LedgerHashes.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The LedgerHashes objects exist to make it possible to look up a previous
@@ -7,7 +7,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface LedgerHashes extends BaseLedgerEntry {
+export default interface LedgerHashes
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
   LedgerEntryType: 'LedgerHashes'
   /** The Ledger Index of the last entry in this object's Hashes array. */
   LastLedgerSequence?: number

package/src/models/ledger/NFTokenOffer.ts

@@ -1,8 +1,8 @@
 import { Amount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
-export interface NFTokenOffer extends BaseLedgerEntry {
+export interface NFTokenOffer extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'NFTokenOffer'
   Amount: Amount
   Destination?: string
@@ -11,6 +11,4 @@ export interface NFTokenOffer extends BaseLedgerEntry {
   NFTokenOfferNode?: string
   Owner: string
   OwnerNode?: string
-  PreviousTxnID: string
-  PreviousTxnLgrSeq: number
 }

package/src/models/ledger/NFTokenPage.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 export interface NFToken {
   NFToken: {
@@ -10,11 +10,9 @@ export interface NFToken {
   }
 }
 
-export interface NFTokenPage extends BaseLedgerEntry {
+export interface NFTokenPage extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'NFTokenPage'
   NextPageMin?: string
   NFTokens: NFToken[]
   PreviousPageMin?: string
-  PreviousTxnID?: string
-  PreviousTxnLgrSeq?: number
 }

package/src/models/ledger/NegativeUNL.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, MissingPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The unique id for the nUNL object https://xrpl.org/negativeunl.html#negativeunl-id-format
@@ -12,7 +12,9 @@ export const NEGATIVE_UNL_ID =
  *
  * @category Ledger Entries
  */
-export default interface NegativeUNL extends BaseLedgerEntry {
+export default interface NegativeUNL
+  extends BaseLedgerEntry,
+    MissingPreviousTxnID {
   LedgerEntryType: 'NegativeUNL'
   /**
    * A list of trusted validators that are currently disabled.

package/src/models/ledger/Offer.ts

@@ -1,8 +1,8 @@
 import { Amount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
-export default interface Offer extends BaseLedgerEntry {
+export default interface Offer extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Offer'
   /** A bit-map of boolean flags enabled for this Offer. */
   Flags: number
@@ -32,16 +32,6 @@ export default interface Offer extends BaseLedgerEntry {
    * in case the directory consists of multiple pages.
    */
   OwnerNode: string
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
   /** The time this Offer expires, in seconds since the Ripple Epoch. */
   Expiration?: number
 }

package/src/models/ledger/PayChannel.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The PayChannel object type represents a payment channel. Payment channels
@@ -9,7 +9,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface PayChannel extends BaseLedgerEntry {
+export default interface PayChannel extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'PayChannel'
   /**
    * The source address that owns this payment channel. This comes from the
@@ -60,16 +60,6 @@ export default interface PayChannel extends BaseLedgerEntry {
    * to this object, in case the directory consists of multiple pages.
    */
   OwnerNode: string
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
   /**
    * A bit-map of boolean flags enabled for this payment channel. Currently,
    * the protocol defines no flags for PayChannel objects.

package/src/models/ledger/RippleState.ts

@@ -1,13 +1,13 @@
 import { IssuedCurrencyAmount } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The RippleState object type connects two accounts in a single currency.
  *
  * @category Ledger Entries
  */
-export default interface RippleState extends BaseLedgerEntry {
+export default interface RippleState extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'RippleState'
   /** A bit-map of boolean options enabled for this object. */
   Flags: number
@@ -27,16 +27,6 @@ export default interface RippleState extends BaseLedgerEntry {
    * the address of the high account that set this limit.
    */
   HighLimit: IssuedCurrencyAmount
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
   /**
    * A hint indicating which page of the low account's owner directory links to
    * this object, in case the directory consists of multiple pages.

package/src/models/ledger/SignerList.ts

@@ -1,6 +1,6 @@
 import { SignerEntry } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The SignerList object type represents a list of parties that, as a group,
@@ -10,23 +10,13 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface SignerList extends BaseLedgerEntry {
+export default interface SignerList extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'SignerList'
   /**
    * A bit-map of Boolean flags enabled for this signer list. For more
    * information, see SignerList Flags.
    */
   Flags: number
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
   /**
    * A hint indicating which page of the owner directory links to this object,
    * in case the directory consists of multiple pages.

package/src/models/ledger/Ticket.ts

@@ -1,4 +1,4 @@
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The Ticket object type represents a Ticket, which tracks an account sequence
@@ -7,7 +7,7 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface Ticket extends BaseLedgerEntry {
+export default interface Ticket extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'Ticket'
   /** The account that owns this Ticket. */
   Account: string
@@ -21,16 +21,6 @@ export default interface Ticket extends BaseLedgerEntry {
    * in case the directory consists of multiple pages.
    */
   OwnerNode: string
-  /**
-   * The identifying hash of the transaction that most recently modified this
-   * object.
-   */
-  PreviousTxnID: string
-  /**
-   * The index of the ledger that contains the transaction that most recently
-   * modified this object.
-   */
-  PreviousTxnLgrSeq: number
   /** The Sequence Number this Ticket sets aside. */
   TicketSequence: number
 }