xrpl 2.12.0-beta.0 → 2.13.0

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
 }

package/src/models/ledger/XChainOwnedClaimID.ts

@@ -1,6 +1,8 @@
+import { Amount } from 'ripple-binary-codec/dist/types'
+
 import { XChainBridge } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * An XChainOwnedClaimID object represents one cross-chain transfer of value
@@ -9,7 +11,9 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  *
  * @category Ledger Entries
  */
-export default interface XChainOwnedClaimID extends BaseLedgerEntry {
+export default interface XChainOwnedClaimID
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
   LedgerEntryType: 'XChainOwnedClaimID'
 
   /** The account that checked out this unique claim ID value. */
@@ -35,14 +39,28 @@ export default interface XChainOwnedClaimID extends BaseLedgerEntry {
    */
   OtherChainSource: string
 
-  // TODO: type this better
   /**
    * Attestations collected from the witness servers. This includes the parameters
    * needed to recreate the message that was signed, including the amount, which
    * chain (locking or issuing), optional destination, and reward account for that
    * signature.
    */
-  XChainClaimAttestations: object[]
+  XChainClaimAttestations: Array<{
+    // TODO: add docs
+    XChainClaimProofSig: {
+      Amount: Amount
+
+      AttestationRewardAccount: string
+
+      AttestationSignerAccount: string
+
+      Destination?: string
+
+      PublicKey: string
+
+      WasLockingChainSend: 0 | 1
+    }
+  }>
 
   /**
    * The total amount to pay the witness servers for their signatures. It must be at
@@ -60,14 +78,4 @@ export default interface XChainOwnedClaimID 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/XChainOwnedCreateAccountClaimID.ts

@@ -1,6 +1,6 @@
 import { XChainBridge } from '../common'
 
-import BaseLedgerEntry from './BaseLedgerEntry'
+import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 /**
  * The XChainOwnedCreateAccountClaimID ledger object is used to collect attestations
@@ -9,7 +9,8 @@ import BaseLedgerEntry from './BaseLedgerEntry'
  * @category Ledger Entries
  */
 export default interface XChainOwnedCreateAccountClaimID
-  extends BaseLedgerEntry {
+  extends BaseLedgerEntry,
+    HasPreviousTxnID {
   LedgerEntryType: 'XChainOwnedCreateAccountClaimID'
 
   /** The account that owns this object. */
@@ -27,7 +28,6 @@ export default interface XChainOwnedCreateAccountClaimID
    */
   XChainAccountCreateCount: number
 
-  // TODO: type this better
   /**
    * Attestations collected from the witness servers. This includes the parameters
    * needed to recreate the message that was signed, including the amount, destination,
@@ -35,7 +35,22 @@ export default interface XChainOwnedCreateAccountClaimID
    * exception of the reward account, all signatures must sign the message created with
    * common parameters.
    */
-  XChainCreateAccountAttestations: object[]
+  XChainCreateAccountAttestations: Array<{
+    // TODO: add docs
+    XChainCreateAccountProofSig: {
+      Amount: string
+
+      AttestationRewardAccount: string
+
+      AttestationSignerAccount: string
+
+      Destination: string
+
+      PublicKey: string
+
+      WasLockingChainSend: 0 | 1
+    }
+  }>
 
   /**
    * A bit-map of boolean flags. No flags are defined for,
@@ -47,14 +62,4 @@ export default interface XChainOwnedCreateAccountClaimID
    * 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/index.ts

@@ -3,6 +3,7 @@ import AccountRoot, {
   AccountRootFlagsInterface,
 } from './AccountRoot'
 import Amendments, { Majority, AMENDMENTS_ID } from './Amendments'
+import AMM, { VoteSlot } from './AMM'
 import Bridge from './Bridge'
 import Check from './Check'
 import DepositPreauth from './DepositPreauth'
@@ -14,7 +15,7 @@ import FeeSettings, {
   FEE_SETTINGS_ID,
 } from './FeeSettings'
 import Ledger from './Ledger'
-import LedgerEntry from './LedgerEntry'
+import { LedgerEntry, LedgerEntryFilter } from './LedgerEntry'
 import LedgerHashes from './LedgerHashes'
 import NegativeUNL, { NEGATIVE_UNL_ID } from './NegativeUNL'
 import { NFTokenOffer } from './NFTokenOffer'
@@ -33,6 +34,7 @@ export {
   AccountRootFlagsInterface,
   AMENDMENTS_ID,
   Amendments,
+  AMM,
   Bridge,
   Check,
   DepositPreauth,
@@ -43,6 +45,7 @@ export {
   FeeSettingsPreAmendmentFields,
   FeeSettingsPostAmendmentFields,
   Ledger,
+  LedgerEntryFilter,
   LedgerEntry,
   LedgerHashes,
   Majority,
@@ -61,4 +64,5 @@ export {
   Ticket,
   XChainOwnedClaimID,
   XChainOwnedCreateAccountClaimID,
+  VoteSlot,
 }

package/src/models/methods/accountObjects.ts

@@ -1,33 +1,12 @@
-import {
-  Bridge,
-  Check,
-  DepositPreauth,
-  Escrow,
-  Offer,
-  PayChannel,
-  RippleState,
-  SignerList,
-  Ticket,
-  XChainOwnedClaimID,
-  XChainOwnedCreateAccountClaimID,
-} from '../ledger'
+import { Amendments, FeeSettings, LedgerHashes } from '../ledger'
+import { LedgerEntry, LedgerEntryFilter } from '../ledger/LedgerEntry'
 
 import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
 
-export type AccountObjectType =
-  | 'bridge'
-  | 'check'
-  | 'deposit_preauth'
-  | 'escrow'
-  | 'nft_offer'
-  | 'offer'
-  | 'payment_channel'
-  | 'signer_list'
-  | 'state'
-  | 'ticket'
-  | 'xchain_owned_create_account_claim_id'
-  | 'xchain_owned_claim_id'
-
+export type AccountObjectType = Exclude<
+  LedgerEntryFilter,
+  'amendments' | 'fee' | 'hashes'
+>
 /**
  * The account_objects command returns the raw ledger format for all objects
  * owned by an account. For a higher-level view of an account's trust lines and
@@ -44,8 +23,6 @@ export interface AccountObjectsRequest
   account: string
   /**
    * If included, filter results to include only this type of ledger object.
-   * The valid types are: Check , DepositPreauth, Escrow, Offer, PayChannel,
-   * SignerList, Ticket, and RippleState (trust line).
    */
   type?: AccountObjectType
   /**
@@ -69,18 +46,10 @@ export interface AccountObjectsRequest
  * Account Objects can be a Check, a DepositPreauth, an Escrow, an Offer, a
  * PayChannel, a SignerList, a Ticket, or a RippleState.
  */
-export type AccountObject =
-  | Bridge
-  | Check
-  | DepositPreauth
-  | Escrow
-  | Offer
-  | PayChannel
-  | SignerList
-  | RippleState
-  | Ticket
-  | XChainOwnedClaimID
-  | XChainOwnedCreateAccountClaimID
+export type AccountObject = Exclude<
+  LedgerEntry,
+  Amendments | FeeSettings | LedgerHashes
+>
 
 /**
  * Response expected from an {@link AccountObjectsRequest}.

package/src/models/methods/ammInfo.ts

@@ -11,15 +11,20 @@ import { BaseRequest, BaseResponse } from './baseMethod'
 export interface AMMInfoRequest extends BaseRequest {
   command: 'amm_info'
 
+  /**
+   * The address of the AMM Account to look up.
+   */
+  amm_account?: string
+
   /**
    * One of the assets of the AMM pool to look up.
    */
-  asset: Currency
+  asset?: Currency
 
   /**
    * The other asset of the AMM pool.
    */
-  asset2: Currency
+  asset2?: Currency
 }
 
 /**
@@ -93,7 +98,7 @@ export interface AMMInfoResponse extends BaseResponse {
          * The amount, in LP Tokens, that the auction slot holder paid to win the auction slot.
          * This affects the price to outbid the current slot holder.
          */
-        price: Amount
+        price: IssuedCurrencyAmount
 
         /**
          * The current 72-minute time interval this auction slot is in, from 0 to 19.

package/src/models/methods/ledger.ts

@@ -1,4 +1,5 @@
 import { Ledger } from '../ledger'
+import { LedgerEntryFilter } from '../ledger/LedgerEntry'
 import { Transaction, TransactionAndMetadata } from '../transactions'
 import { TransactionMetadata } from '../transactions/metadata'
 
@@ -65,6 +66,10 @@ export interface LedgerRequest extends BaseRequest, LookupByLedgerRequest {
    * array of queued transactions in the results.
    */
   queue?: boolean
+  /**
+   * If included, filter results to include only this type of ledger object.
+   */
+  type?: LedgerEntryFilter
 }
 
 /**

package/src/models/methods/ledgerData.ts

@@ -1,4 +1,4 @@
-import { LedgerEntry } from '../ledger'
+import { LedgerEntry, LedgerEntryFilter } from '../ledger'
 
 import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
 
@@ -37,6 +37,10 @@ export interface LedgerDataRequest extends BaseRequest, LookupByLedgerRequest {
    * that response left off.
    */
   marker?: unknown
+  /**
+   * If included, filter results to include only this type of ledger object.
+   */
+  type?: LedgerEntryFilter
 }
 
 export type LedgerDataLabeledLedgerEntry = {

package/src/models/methods/ledgerEntry.ts

@@ -158,23 +158,23 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
 
   bridge?: XChainBridge
 
-  xchain_claim_id?:
+  xchain_owned_claim_id?:
     | {
         locking_chain_door: string
         locking_chain_issue: Currency
         issuing_chain_door: string
         issuing_chain_issue: Currency
-        xchain_claim_id: string | number
+        xchain_owned_claim_id: string | number
       }
     | string
 
-  xchain_create_account_claim_id?:
+  xchain_owned_create_account_claim_id?:
     | {
         locking_chain_door: string
         locking_chain_issue: Currency
         issuing_chain_door: string
         issuing_chain_issue: Currency
-        xchain_create_account_claim_id: string | number
+        xchain_owned_create_account_claim_id: string | number
       }
     | string
 }
@@ -184,7 +184,7 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
  *
  * @category Responses
  */
-export interface LedgerEntryResponse extends BaseResponse {
+export interface LedgerEntryResponse<T = LedgerEntry> extends BaseResponse {
   result: {
     /** The unique ID of this ledger object. */
     index: string
@@ -194,7 +194,7 @@ export interface LedgerEntryResponse extends BaseResponse {
      * Object containing the data of this ledger object, according to the
      * ledger format.
      */
-    node?: LedgerEntry
+    node?: T
     /** The binary representation of the ledger object, as hexadecimal. */
     node_binary?: string
     validated?: boolean

package/src/models/methods/serverInfo.ts

@@ -33,6 +33,22 @@ export interface JobType {
   in_progress?: number
 }
 
+export type protocol =
+  | 'http'
+  | 'https'
+  | 'grpc'
+  | 'peer'
+  | 'ws'
+  | 'ws2'
+  | 'wss'
+  | 'wss2'
+
+export interface ServerPort {
+  port: string
+  /** The values in protocol are sorted in alphabetical order */
+  protocol: protocol[]
+}
+
 // The states for validating and proposing do not exist in the field state_accounting
 // See https://github.com/XRPLF/rippled/blob/develop/src/ripple/app/misc/NetworkOPs.cpp#L4545
 // https://github.com/XRPLF/rippled/blob/develop/src/ripple/app/misc/NetworkOPs.h#L66
@@ -181,6 +197,11 @@ export interface ServerInfoResponse extends BaseResponse {
       network_ledger?: 'waiting'
       /** How many other rippled servers this one is currently connected to. */
       peers: number
+      /**
+       * What Websocket/RPC ports rippled is listening on. This allows crawlers to build a richer topology without needing to
+       * port-scan nodes. For non-admin users (including peers), info about admin ports is excluded.
+       */
+      ports: ServerPort[]
       /**
        * Public key used to verify this server for peer-to-peer communications.
        * This node key pair is automatically generated by the server the first

package/src/models/methods/tx.ts

@@ -1,5 +1,6 @@
 import { Transaction, TransactionMetadata } from '../transactions'
 import { BaseTransaction } from '../transactions/common'
+import { PseudoTransaction } from '../transactions/transaction'
 
 import { BaseRequest, BaseResponse } from './baseMethod'
 
@@ -39,8 +40,9 @@ export interface TxRequest extends BaseRequest {
  *
  * @category Responses
  */
-export interface TxResponse<T extends BaseTransaction = Transaction>
-  extends BaseResponse {
+export interface TxResponse<
+  T extends BaseTransaction = Transaction | PseudoTransaction,
+> extends BaseResponse {
   result: {
     /** The SHA-512 hash of the transaction. */
     hash: string

package/src/models/transactions/AMMBid.ts

@@ -1,6 +1,5 @@
-/* eslint-disable complexity -- required for validateAMMBid */
 import { ValidationError } from '../../errors'
-import { Amount, AuthAccount, Currency } from '../common'
+import { AuthAccount, Currency, IssuedCurrencyAmount } from '../common'
 
 import {
   BaseTransaction,
@@ -33,18 +32,18 @@ export interface AMMBid extends BaseTransaction {
   Asset2: Currency
 
   /**
-   * Pay at least this amount for the slot.
+   * Pay at least this LPToken amount for the slot.
    * Setting this value higher makes it harder for others to outbid you.
    * If omitted, pay the minimum necessary to win the bid.
    */
-  BidMin?: Amount
+  BidMin?: IssuedCurrencyAmount
 
   /**
-   * Pay at most this amount for the slot.
+   * Pay at most this LPToken amount for the slot.
    * If the cost to win the bid is higher than this amount, the transaction fails.
    * If omitted, pay as much as necessary to win the bid.
    */
-  BidMax?: Amount
+  BidMax?: IssuedCurrencyAmount
 
   /**
    * A list of up to 4 additional accounts that you allow to trade at the discounted fee.

package/src/models/transactions/AMMDeposit.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- required for validateAMMDeposit */
 import { ValidationError } from '../../errors'
 import { Amount, Currency, IssuedCurrencyAmount } from '../common'
 

package/src/models/transactions/AMMWithdraw.ts

@@ -1,4 +1,3 @@
-/* eslint-disable complexity -- required for validateAMMWithdraw */
 import { ValidationError } from '../../errors'
 import { Amount, Currency, IssuedCurrencyAmount } from '../common'