xrpl 4.6.0 → 5.0.0

package/src/models/ledger/PermissionedDomain.ts

@@ -3,8 +3,7 @@ import { AuthorizeCredential } from '../common'
 import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
 
 export default interface PermissionedDomain
-  extends BaseLedgerEntry,
-    HasPreviousTxnID {
+  extends BaseLedgerEntry, HasPreviousTxnID {
   /* The ledger object's type (PermissionedDomain). */
   LedgerEntryType: 'PermissionedDomain'
 

package/src/models/ledger/XChainOwnedClaimID.ts

@@ -10,8 +10,7 @@ import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
  * @category Ledger Entries
  */
 export default interface XChainOwnedClaimID
-  extends BaseLedgerEntry,
-    HasPreviousTxnID {
+  extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'XChainOwnedClaimID'
 
   /** The account that checked out this unique claim ID value. */

package/src/models/ledger/XChainOwnedCreateAccountClaimID.ts

@@ -9,8 +9,7 @@ import { BaseLedgerEntry, HasPreviousTxnID } from './BaseLedgerEntry'
  * @category Ledger Entries
  */
 export default interface XChainOwnedCreateAccountClaimID
-  extends BaseLedgerEntry,
-    HasPreviousTxnID {
+  extends BaseLedgerEntry, HasPreviousTxnID {
   LedgerEntryType: 'XChainOwnedCreateAccountClaimID'
 
   /** The account that owns this object. */

package/src/models/methods/accountChannels.ts

@@ -88,8 +88,7 @@ export interface Channel {
  * @category Requests
  */
 export interface AccountChannelsRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'account_channels'
   /**
    * The unique identifier of an account, typically the account's address. The

package/src/models/methods/accountCurrencies.ts

@@ -8,8 +8,7 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface AccountCurrenciesRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'account_currencies'
   /** A unique identifier for the account, most commonly the account's address. */
   account: string

package/src/models/methods/accountLines.ts

@@ -73,8 +73,7 @@ export interface AccountLinesTrustline {
  * @category Requests
  */
 export interface AccountLinesRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'account_lines'
   /** A unique identifier for the account, most commonly the account's Address. */
   account: string
@@ -83,6 +82,11 @@ export interface AccountLinesRequest
    * connecting the two accounts.
    */
   peer?: string
+  /**
+   * If true, filter out trust lines with balances at their default values.
+   * The default is false.
+   */
+  ignore_default?: boolean
   /**
    * Limit the number of trust lines to retrieve. The server is not required to
    * honor this value. Must be within the inclusive range 10 to 400.
@@ -133,5 +137,11 @@ export interface AccountLinesResponse extends BaseResponse {
      * No additional pages after this one.
      */
     marker?: unknown
+    /**
+     * The maximum number of trust lines retrieved. The server may return fewer
+     * than the specified limit, even if more results are available. If no limit
+     * was specified in the request, use a default limit of 200.
+     */
+    limit?: number
   }
 }

package/src/models/methods/accountNFTs.ts

@@ -57,9 +57,19 @@ export interface AccountNFTsResponse extends BaseResponse {
      * The ledger index of the current open ledger, which was used when
      * retrieving this information.
      */
-    ledger_current_index: number
-    /** If true, this data comes from a validated ledger. */
-    validated: boolean
+    ledger_current_index?: number
+    /**
+     * The identifying hash of the ledger that was used to generate this response.
+     */
+    ledger_hash?: string
+    /**
+     * The ledger index of the ledger that was used to generate this response.
+     */
+    ledger_index?: number
+    /**
+     * If true, this data comes from a validated ledger.
+     */
+    validated?: boolean
     /**
      * Server-defined value indicating the response is paginated. Pass this to
      * the next call to resume where this call left off. Omitted when there are

package/src/models/methods/accountObjects.ts

@@ -16,8 +16,7 @@ export type AccountObjectType = Exclude<
  * @category Requests
  */
 export interface AccountObjectsRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'account_objects'
   /** A unique identifier for the account, most commonly the account's address. */
   account: string

package/src/models/methods/accountOffers.ts

@@ -10,8 +10,7 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface AccountOffersRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'account_offers'
   /** A unique identifier for the account, most commonly the account's Address. */
   account: string

package/src/models/methods/ammInfo.ts

@@ -25,6 +25,11 @@ export interface AMMInfoRequest extends BaseRequest {
    * The other asset of the AMM pool.
    */
   asset2?: Currency
+
+  /**
+   * Show only LP Tokens held by this liquidity provider.
+   */
+  account?: string
 }
 
 /**

package/src/models/methods/depositAuthorized.ts

@@ -8,8 +8,7 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface DepositAuthorizedRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'deposit_authorized'
   /** The sender of a possible payment. */
   source_account: string

package/src/models/methods/gatewayBalances.ts

@@ -20,8 +20,7 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface GatewayBalancesRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'gateway_balances'
   /** The Address to check. This should be the issuing address. */
   account: string

package/src/models/methods/index.ts

@@ -108,7 +108,14 @@ import {
   LedgerDataRequest,
   LedgerDataResponse,
 } from './ledgerData'
-import { LedgerEntryRequest, LedgerEntryResponse } from './ledgerEntry'
+import {
+  LedgerEntryBinaryRequest,
+  LedgerEntryJsonRequest,
+  LedgerEntryRequest,
+  LedgerEntryBinaryResponse,
+  LedgerEntryJsonResponse,
+  LedgerEntryResponse,
+} from './ledgerEntry'
 import { ManifestRequest, ManifestResponse } from './manifest'
 import { NFTBuyOffersRequest, NFTBuyOffersResponse } from './nftBuyOffers'
 import {
@@ -412,8 +419,12 @@ export type RequestResponseMap<
   ? LedgerCurrentResponse
   : T extends LedgerDataRequest
   ? LedgerDataResponse
+  : T extends LedgerEntryBinaryRequest
+  ? LedgerEntryBinaryResponse
+  : T extends LedgerEntryJsonRequest
+  ? LedgerEntryJsonResponse
   : T extends LedgerEntryRequest
-  ? LedgerEntryResponse
+  ? LedgerEntryJsonResponse
   : T extends SimulateBinaryRequest
   ? SimulateBinaryResponse
   : T extends SimulateJsonRequest
@@ -565,7 +576,11 @@ export {
   LedgerDataBinaryLedgerEntry,
   LedgerDataResponse,
   LedgerDataLedgerState,
+  LedgerEntryBinaryRequest,
+  LedgerEntryJsonRequest,
   LedgerEntryRequest,
+  LedgerEntryBinaryResponse,
+  LedgerEntryJsonResponse,
   LedgerEntryResponse,
   // transaction methods with types
   SimulateRequest,

package/src/models/methods/ledger.ts

@@ -144,8 +144,8 @@ export interface LedgerRequestExpandedAccountsOnly extends LedgerRequest {
  *
  * @category Requests
  */
-export interface LedgerRequestExpandedAccountsAndTransactions
-  extends LedgerRequest {
+// eslint-disable-next-line max-len -- Disable for interface declaration.
+export interface LedgerRequestExpandedAccountsAndTransactions extends LedgerRequest {
   expand: true
   accounts: true
   transactions: true
@@ -202,14 +202,18 @@ export interface LedgerQueueData {
   max_spend_drops?: string
 }
 
-export interface LedgerBinary
-  extends Omit<Ledger, 'transactions' | 'accountState'> {
+export interface LedgerBinary extends Omit<
+  Ledger,
+  'transactions' | 'accountState'
+> {
   accountState?: string[]
   transactions?: string[]
 }
 
-export interface LedgerBinaryV1
-  extends Omit<LedgerV1, 'transactions' | 'accountState'> {
+export interface LedgerBinaryV1 extends Omit<
+  LedgerV1,
+  'transactions' | 'accountState'
+> {
   accountState?: string[]
   transactions?: string[]
 }

package/src/models/methods/ledgerEntry.ts

@@ -230,17 +230,60 @@ export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
   }
 }
 
+export type LedgerEntryBinaryRequest = LedgerEntryRequest & {
+  binary: true
+}
+
+export type LedgerEntryJsonRequest = LedgerEntryRequest & {
+  binary?: false
+}
+
+interface LedgerEntryResponseResultBase {
+  /** The unique ID of this ledger object. */
+  index: string
+  /** The ledger index of the ledger that was used when retrieving this data. */
+  ledger_current_index: number
+  validated?: boolean
+  /**
+   * (Optional) Indicates the ledger index at which the object was deleted.
+   */
+  deleted_ledger_index?: number
+}
+
+/**
+ * Response expected from a {@link LedgerEntryRequest} with binary: true.
+ *
+ * @category Responses
+ */
+export interface LedgerEntryBinaryResponse extends BaseResponse {
+  result: LedgerEntryResponseResultBase & {
+    /** The binary representation of the ledger object, as hexadecimal. */
+    node_binary: string
+  }
+}
+
+/**
+ * Response expected from a {@link LedgerEntryRequest} with binary: false or omitted.
+ *
+ * @category Responses
+ */
+export interface LedgerEntryJsonResponse<T = LedgerEntry> extends BaseResponse {
+  result: LedgerEntryResponseResultBase & {
+    /**
+     * Object containing the data of this ledger object, according to the
+     * ledger format.
+     */
+    node: T
+  }
+}
+
 /**
  * Response expected from a {@link LedgerEntryRequest}.
  *
  * @category Responses
  */
 export interface LedgerEntryResponse<T = LedgerEntry> extends BaseResponse {
-  result: {
-    /** The unique ID of this ledger object. */
-    index: string
-    /** The ledger index of the ledger that was used when retrieving this data. */
-    ledger_current_index: number
+  result: LedgerEntryResponseResultBase & {
     /**
      * Object containing the data of this ledger object, according to the
      * ledger format.
@@ -248,10 +291,5 @@ export interface LedgerEntryResponse<T = LedgerEntry> extends BaseResponse {
     node?: T
     /** The binary representation of the ledger object, as hexadecimal. */
     node_binary?: string
-    validated?: boolean
-    /**
-     * (Optional) Indicates the ledger index at which the object was deleted.
-     */
-    deleted_ledger_index?: number
   }
 }

package/src/models/methods/nftBuyOffers.ts

@@ -9,13 +9,22 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface NFTBuyOffersRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'nft_buy_offers'
   /**
    * The unique identifier of an NFToken. The request returns buy offers for this NFToken.
    */
   nft_id: string
+  /**
+   * Limit the number of NFT buy offers to retrieve. The server may return
+   * fewer results. Valid values are within 50-500. The default is 250.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
 }
 
 /**
@@ -33,5 +42,14 @@ export interface NFTBuyOffersResponse extends BaseResponse {
      * The token ID of the NFToken to which these offers pertain.
      */
     nft_id: string
+    /**
+     * The limit value used in the request.
+     */
+    limit?: number
+    /**
+     * Server-defined value indicating the response is paginated. Pass this to
+     * the next call to resume where this call left off.
+     */
+    marker?: unknown
   }
 }

package/src/models/methods/nftSellOffers.ts

@@ -9,13 +9,22 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface NFTSellOffersRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'nft_sell_offers'
   /**
    * The unique identifier of an NFToken. The request returns sell offers for this NFToken.
    */
   nft_id: string
+  /**
+   * Limit the number of NFT sell offers to retrieve. The server may return
+   * fewer results. Valid values are within 50-500. The default is 250.
+   */
+  limit?: number
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off.
+   */
+  marker?: unknown
 }
 
 /**
@@ -33,5 +42,14 @@ export interface NFTSellOffersResponse extends BaseResponse {
      * The token ID of the NFToken to which these offers pertain.
      */
     nft_id: string
+    /**
+     * The limit value used in the request.
+     */
+    limit?: number
+    /**
+     * Server-defined value indicating the response is paginated. Pass this to
+     * the next call to resume where this call left off.
+     */
+    marker?: unknown
   }
 }

package/src/models/methods/nftsByIssuer.ts

@@ -11,8 +11,7 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface NFTsByIssuerRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'nfts_by_issuer'
   /**
    * A unique identifier for the account, most commonly the account's address

package/src/models/methods/ripplePathFind.ts

@@ -15,8 +15,7 @@ export interface SourceCurrencyAmount {
  * @category Requests
  */
 export interface RipplePathFindRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'ripple_path_find'
   /** Unique address of the account that would send funds in a transaction. */
   source_account: string

package/src/models/methods/serverDefinitions.ts

@@ -45,6 +45,33 @@ export interface ServerDefinitionsResponse extends BaseResponse {
         TRANSACTION_TYPES: Record<string, number>
 
         TYPES: Record<string, number>
+
+        /** Maps AccountSet flag names (asf flags) to their numeric values. */
+        ACCOUNT_SET_FLAGS: Record<string, number>
+
+        /** Maps ledger entry type names to their flags and flag values. */
+        LEDGER_ENTRY_FLAGS: Record<string, Record<string, number>>
+
+        /**
+         * Describes the fields and their optionality for each ledger entry type,
+         * including common fields shared across all ledger entries.
+         */
+        LEDGER_ENTRY_FORMATS: Record<
+          string,
+          Array<{ name: string; optionality: number }>
+        >
+
+        /** Maps transaction type names to their supported flags and flag values. */
+        TRANSACTION_FLAGS: Record<string, Record<string, number>>
+
+        /**
+         * Describes the fields and their optionality for each transaction type,
+         * including common fields shared across all transactions.
+         */
+        TRANSACTION_FORMATS: Record<
+          string,
+          Array<{ name: string; optionality: number }>
+        >
       }
     | {
         FIELDS?: never
@@ -56,6 +83,16 @@ export interface ServerDefinitionsResponse extends BaseResponse {
         TRANSACTION_TYPES?: never
 
         TYPES?: never
+
+        ACCOUNT_SET_FLAGS?: never
+
+        LEDGER_ENTRY_FLAGS?: never
+
+        LEDGER_ENTRY_FORMATS?: never
+
+        TRANSACTION_FLAGS?: never
+
+        TRANSACTION_FORMATS?: never
       }
   )
 }

package/src/models/methods/simulate.ts

@@ -64,8 +64,9 @@ export interface SimulateBinaryResponse extends BaseResponse {
   }
 }
 
-export interface SimulateJsonResponse<T extends BaseTransaction = Transaction>
-  extends BaseResponse {
+export interface SimulateJsonResponse<
+  T extends BaseTransaction = Transaction,
+> extends BaseResponse {
   result: {
     applied: false
 

package/src/models/methods/transactionEntry.ts

@@ -11,8 +11,7 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  * @category Requests
  */
 export interface TransactionEntryRequest
-  extends BaseRequest,
-    LookupByLedgerRequest {
+  extends BaseRequest, LookupByLedgerRequest {
   command: 'transaction_entry'
 
   /** Unique hash of the transaction you are looking up. */

package/src/models/methods/tx.ts

@@ -93,8 +93,9 @@ interface BaseTxResult<
  *
  * @category Responses
  */
-export interface TxResponse<T extends BaseTransaction = Transaction>
-  extends BaseResponse {
+export interface TxResponse<
+  T extends BaseTransaction = Transaction,
+> extends BaseResponse {
   result: BaseTxResult<typeof RIPPLED_API_V2, T> & { tx_json: T }
   /**
    * If true, the server was able to search all of the specified ledger
@@ -110,8 +111,9 @@ export interface TxResponse<T extends BaseTransaction = Transaction>
  *
  * @category ResponsesV1
  */
-export interface TxV1Response<T extends BaseTransaction = Transaction>
-  extends BaseResponse {
+export interface TxV1Response<
+  T extends BaseTransaction = Transaction,
+> extends BaseResponse {
   result: BaseTxResult<typeof RIPPLED_API_V1, T> & T
   /**
    * If true, the server was able to search all of the specified ledger

package/src/models/methods/vaultInfo.ts

@@ -199,6 +199,12 @@ export interface VaultInfoResponse extends BaseResponse {
      */
     ledger_index?: number
 
+    /**
+     * The ledger index of the current in-progress ledger, which was used when
+     * retrieving this information. May be omitted.
+     */
+    ledger_current_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

package/src/models/transactions/MPTokenIssuanceCreate.ts

@@ -63,8 +63,8 @@ export enum MPTokenIssuanceCreateFlags {
  *
  * @category Transaction Flags
  */
-export interface MPTokenIssuanceCreateFlagsInterface
-  extends GlobalFlagsInterface {
+// eslint-disable-next-line max-len -- Disable for interface declaration.
+export interface MPTokenIssuanceCreateFlagsInterface extends GlobalFlagsInterface {
   tfMPTCanLock?: boolean
   tfMPTRequireAuth?: boolean
   tfMPTCanEscrow?: boolean

package/src/models/transactions/paymentChannelClaim.ts

@@ -73,8 +73,8 @@ export enum PaymentChannelClaimFlags {
  * // }
  * ```
  */
-export interface PaymentChannelClaimFlagsInterface
-  extends GlobalFlagsInterface {
+// eslint-disable-next-line max-len -- Disable for interface declaration.
+export interface PaymentChannelClaimFlagsInterface extends GlobalFlagsInterface {
   /**
    * Clear the channel's Expiration time. (Expiration is different from the
    * channel's immutable CancelAfter time.) Only the source address of the

package/src/utils/quality.ts

@@ -17,7 +17,11 @@ function percentToDecimal(percent: string): string {
     throw new ValidationError(`Value ${percent} contains too many % signs`)
   }
 
-  return new BigNumber(split[0]).dividedBy('100').toString(BASE_TEN)
+  try {
+    return new BigNumber(split[0]).dividedBy('100').toString(BASE_TEN)
+  } catch (_err) {
+    throw new ValidationError(`Value is not a number`)
+  }
 }
 
 /**
@@ -30,7 +34,12 @@ function percentToDecimal(percent: string): string {
  * @category Utilities
  */
 export function decimalToTransferRate(decimal: string): number {
-  const rate = new BigNumber(decimal).times(ONE_BILLION).plus(ONE_BILLION)
+  let rate: BigNumber
+  try {
+    rate = new BigNumber(decimal).times(ONE_BILLION).plus(ONE_BILLION)
+  } catch (_err) {
+    throw new ValidationError(`Value is not a number`)
+  }
 
   if (rate.isLessThan(ONE_BILLION) || rate.isGreaterThan(TWO_BILLION)) {
     throw new ValidationError(`Decimal value must be between 0 and 1.00.`)
@@ -42,10 +51,6 @@ export function decimalToTransferRate(decimal: string): number {
     return 0
   }
 
-  if (billionths === 'NaN') {
-    throw new ValidationError(`Value is not a number`)
-  }
-
   if (billionths.includes('.')) {
     throw new ValidationError(`Decimal exceeds maximum precision.`)
   }
@@ -77,14 +82,15 @@ export function percentToTransferRate(percent: string): number {
  * @category Utilities
  */
 export function decimalToQuality(decimal: string): number {
-  const rate = new BigNumber(decimal).times(ONE_BILLION)
-
-  const billionths = rate.toString(BASE_TEN)
-
-  if (billionths === 'NaN') {
+  let rate: BigNumber
+  try {
+    rate = new BigNumber(decimal).times(ONE_BILLION)
+  } catch (_err) {
     throw new ValidationError(`Value is not a number`)
   }
 
+  const billionths = rate.toString(BASE_TEN)
+
   if (billionths.includes('-')) {
     throw new ValidationError('Cannot have negative Quality')
   }

package/src/utils/xrpConversion.ts

@@ -21,12 +21,12 @@ export function dropsToXrp(dropsToConvert: BigNumber.Value): number {
    * decimal point followed by zeros, e.g. '1.00'.
    * Important: specify base BASE_10 to avoid exponential notation, e.g. '1e-7'.
    */
-  const drops = new BigNumber(dropsToConvert).toString(BASE_TEN)
-
-  // check that the value is valid and actually a number
-  if (typeof dropsToConvert === 'string' && drops === 'NaN') {
+  let drops: string
+  try {
+    drops = new BigNumber(dropsToConvert).toString(BASE_TEN)
+  } catch (_err) {
     throw new ValidationError(
-      `dropsToXrp: invalid value '${dropsToConvert}', should be a BigNumber or string-encoded number.`,
+      `dropsToXrp: invalid value '${typeof dropsToConvert === 'string' ? dropsToConvert : JSON.stringify(dropsToConvert)}', should be a BigNumber or string-encoded number.`,
     )
   }
 
@@ -63,12 +63,12 @@ export function dropsToXrp(dropsToConvert: BigNumber.Value): number {
  */
 export function xrpToDrops(xrpToConvert: BigNumber.Value): string {
   // Important: specify base BASE_TEN to avoid exponential notation, e.g. '1e-7'.
-  const xrp = new BigNumber(xrpToConvert).toString(BASE_TEN)
-
-  // check that the value is valid and actually a number
-  if (typeof xrpToConvert === 'string' && xrp === 'NaN') {
+  let xrp: string
+  try {
+    xrp = new BigNumber(xrpToConvert).toString(BASE_TEN)
+  } catch (_err) {
     throw new ValidationError(
-      `xrpToDrops: invalid value '${xrpToConvert}', should be a BigNumber or string-encoded number.`,
+      `xrpToDrops: invalid value '${typeof xrpToConvert === 'string' ? xrpToConvert : JSON.stringify(xrpToConvert)}', should be a BigNumber or string-encoded number.`,
     )
   }