xrpl 2.14.1 → 2.14.2

package/src/models/methods/index.ts

@@ -1,4 +1,7 @@
+/* eslint-disable no-inline-comments -- Necessary for important note */
 /* eslint-disable max-lines -- There is a lot to export */
+import type { APIVersion, DEFAULT_API_VERSION } from '../common'
+
 import {
   AccountChannelsRequest,
   AccountChannelsResponse,
@@ -12,6 +15,8 @@ import {
   AccountInfoAccountFlags,
   AccountInfoRequest,
   AccountInfoResponse,
+  AccountInfoV1Response,
+  AccountInfoVersionResponseMap,
   AccountQueueData,
   AccountQueueTransaction,
 } from './accountInfo'
@@ -39,6 +44,8 @@ import {
 import {
   AccountTxRequest,
   AccountTxResponse,
+  AccountTxV1Response,
+  AccountTxVersionResponseMap,
   AccountTxTransaction,
 } from './accountTx'
 import { AMMInfoRequest, AMMInfoResponse } from './ammInfo'
@@ -59,18 +66,37 @@ import {
   DepositAuthorizedRequest,
   DepositAuthorizedResponse,
 } from './depositAuthorized'
+import {
+  FeatureAllRequest,
+  FeatureAllResponse,
+  FeatureOneRequest,
+  FeatureOneResponse,
+  FeatureRequest,
+  FeatureResponse,
+} from './feature'
 import { FeeRequest, FeeResponse } from './fee'
 import {
   GatewayBalance,
   GatewayBalancesRequest,
   GatewayBalancesResponse,
 } from './gatewayBalances'
+import {
+  GetAggregatePriceRequest,
+  GetAggregatePriceResponse,
+} from './getAggregatePrice'
 import {
   LedgerBinary,
   LedgerModifiedOfferCreateTransaction,
   LedgerQueueData,
   LedgerRequest,
   LedgerResponse,
+  LedgerV1Response,
+  LedgerRequestExpandedTransactionsOnly,
+  LedgerResponseExpanded,
+  LedgerRequestExpandedAccountsAndTransactions,
+  LedgerRequestExpandedAccountsOnly,
+  LedgerRequestExpandedTransactionsBinary,
+  LedgerVersionResponseMap,
 } from './ledger'
 import { LedgerClosedRequest, LedgerClosedResponse } from './ledgerClosed'
 import { LedgerCurrentRequest, LedgerCurrentResponse } from './ledgerCurrent'
@@ -90,6 +116,7 @@ import {
   NFTHistoryTransaction,
 } from './nftHistory'
 import { NFTInfoRequest, NFTInfoResponse } from './nftInfo'
+import { NFTsByIssuerRequest, NFTsByIssuerResponse } from './nftsByIssuer'
 import { NFTSellOffersRequest, NFTSellOffersResponse } from './nftSellOffers'
 import { NoRippleCheckRequest, NoRippleCheckResponse } from './norippleCheck'
 import {
@@ -121,10 +148,20 @@ import {
   StateAccountingFinal,
 } from './serverInfo'
 import { ServerStateRequest, ServerStateResponse } from './serverState'
+import {
+  SimulateBinaryRequest,
+  SimulateBinaryResponse,
+  SimulateJsonRequest,
+  SimulateJsonResponse,
+  SimulateRequest,
+  SimulateResponse,
+} from './simulate'
 import { SubmitRequest, SubmitResponse } from './submit'
 import {
   SubmitMultisignedRequest,
   SubmitMultisignedResponse,
+  SubmitMultisignedV1Response,
+  SubmitMultisignedVersionResponseMap,
 } from './submitMultisigned'
 import {
   BooksSnapshot,
@@ -139,13 +176,14 @@ import {
   SubscribeRequest,
   SubscribeResponse,
   TransactionStream,
+  TransactionV1Stream,
   ValidationStream,
 } from './subscribe'
 import {
   TransactionEntryRequest,
   TransactionEntryResponse,
 } from './transactionEntry'
-import { TxRequest, TxResponse } from './tx'
+import { TxRequest, TxResponse, TxV1Response, TxVersionResponseMap } from './tx'
 import {
   UnsubscribeBook,
   UnsubscribeRequest,
@@ -173,6 +211,7 @@ type Request =
   | LedgerDataRequest
   | LedgerEntryRequest
   // transaction methods
+  | SimulateRequest
   | SubmitRequest
   | SubmitMultisignedRequest
   | TransactionEntryRequest
@@ -193,6 +232,7 @@ type Request =
   | ServerDefinitionsRequest
   | ServerInfoRequest
   | ServerStateRequest
+  | FeatureRequest
   // utility methods
   | PingRequest
   | RandomRequest
@@ -202,33 +242,37 @@ type Request =
   // clio only methods
   | NFTInfoRequest
   | NFTHistoryRequest
+  | NFTsByIssuerRequest
   // AMM methods
   | AMMInfoRequest
+  // Price Oracle methods
+  | GetAggregatePriceRequest
 
 /**
  * @category Responses
  */
-type Response =
+type Response<Version extends APIVersion = typeof DEFAULT_API_VERSION> =
   // account methods
   | AccountChannelsResponse
   | AccountCurrenciesResponse
-  | AccountInfoResponse
+  | AccountInfoVersionResponseMap<Version>
   | AccountLinesResponse
   | AccountNFTsResponse
   | AccountObjectsResponse
   | AccountOffersResponse
-  | AccountTxResponse
+  | AccountTxVersionResponseMap<Version>
   | GatewayBalancesResponse
   | NoRippleCheckResponse
   // ledger methods
-  | LedgerResponse
+  | LedgerVersionResponseMap<Version>
   | LedgerClosedResponse
   | LedgerCurrentResponse
   | LedgerDataResponse
   | LedgerEntryResponse
   // transaction methods
+  | SimulateResponse
   | SubmitResponse
-  | SubmitMultisignedResponse
+  | SubmitMultisignedVersionResponseMap<Version>
   | TransactionEntryResponse
   | TxResponse
   // path and order book methods
@@ -247,6 +291,7 @@ type Response =
   | ServerDefinitionsResponse
   | ServerInfoResponse
   | ServerStateResponse
+  | FeatureResponse
   // utility methods
   | PingResponse
   | RandomResponse
@@ -256,8 +301,202 @@ type Response =
   // clio only methods
   | NFTInfoResponse
   | NFTHistoryResponse
+  | NFTsByIssuerResponse
   // AMM methods
   | AMMInfoResponse
+  // Price Oracle methods
+  | GetAggregatePriceResponse
+
+export type RequestResponseMap<
+  T,
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = T extends AccountChannelsRequest
+  ? AccountChannelsResponse
+  : T extends AccountCurrenciesRequest
+  ? AccountCurrenciesResponse
+  : T extends AccountInfoRequest
+  ? AccountInfoVersionResponseMap<Version>
+  : T extends AccountLinesRequest
+  ? AccountLinesResponse
+  : T extends AccountNFTsRequest
+  ? AccountNFTsResponse
+  : T extends AccountObjectsRequest
+  ? AccountObjectsResponse
+  : T extends AccountOffersRequest
+  ? AccountOffersResponse
+  : T extends AccountTxRequest
+  ? AccountTxVersionResponseMap<Version>
+  : T extends AMMInfoRequest
+  ? AMMInfoResponse
+  : T extends GatewayBalancesRequest
+  ? GatewayBalancesResponse
+  : T extends GetAggregatePriceRequest
+  ? GetAggregatePriceResponse
+  : T extends NoRippleCheckRequest
+  ? NoRippleCheckResponse
+  : // NOTE: The order of these LedgerRequest types is important
+  // to get the proper type matching overrides based on parameters set
+  // in the request. For example LedgerRequestExpandedTransactionsBinary
+  // should match LedgerRequestExpandedTransactionsOnly, but not
+  // LedgerRequestExpandedAccountsOnly. This is because the
+  // LedgerRequestExpandedTransactionsBinary type is a superset of
+  // LedgerRequestExpandedTransactionsOnly, but not of the other.
+  // This is why LedgerRequestExpandedTransactionsBinary is listed
+  // first in the type list.
+  //
+  // Here is an example using real data:
+  // LedgerRequestExpandedTransactionsBinary = {
+  //   command: 'ledger',
+  //   ledger_index: 'validated',
+  //   expand: true,
+  //   transactions: true,
+  //   binary: true,
+  // }
+  // LedgerRequestExpandedTransactionsOnly = {
+  //   command: 'ledger',
+  //   ledger_index: 'validated',
+  //   expand: true,
+  //   transactions: true,
+  // }
+  // LedgerRequestExpandedAccountsOnly = {
+  //   command: 'ledger',
+  //   ledger_index: 'validated',
+  //   accounts: true,
+  //   expand: true,
+  // }
+  // LedgerRequest = {
+  //   command: 'ledger',
+  //   ledger_index: 'validated',
+  // }
+  //
+  // The type with the most parameters set should be listed first. In this
+  // case LedgerRequestExpandedTransactionsBinary has the most parameters (`expand`, `transactions`, and `binary`)
+  // set, so it is listed first. When TypeScript tries to match the type of
+  // a request to a response, it will try to match the request type to the
+  // response type in the order they are listed. So, if we have a request
+  // with the following parameters:
+  // {
+  //   command: 'ledger',
+  //   ledger_index: 'validated',
+  //   expand: true,
+  //   transactions: true,
+  //   binary: true,
+  // }
+  // TypeScript will first try to match the request type to
+  // LedgerRequestExpandedTransactionsBinary, which will succeed. It will
+  // then try to match the response type to LedgerResponseExpanded, which
+  // will also succeed. If we had listed LedgerRequestExpandedTransactionsOnly
+  // first, TypeScript would have tried to match the request type to
+  // LedgerRequestExpandedTransactionsOnly, which would have succeeded, but
+  // then we'd get the wrong response type, LedgerResponse, instead of
+  // LedgerResponseExpanded.
+  T extends LedgerRequestExpandedTransactionsBinary
+  ? LedgerVersionResponseMap<Version>
+  : T extends LedgerRequestExpandedAccountsAndTransactions
+  ? LedgerResponseExpanded<Version>
+  : T extends LedgerRequestExpandedTransactionsOnly
+  ? LedgerResponseExpanded<Version>
+  : T extends LedgerRequestExpandedAccountsOnly
+  ? LedgerResponseExpanded<Version>
+  : T extends LedgerRequest
+  ? LedgerVersionResponseMap<Version>
+  : T extends LedgerClosedRequest
+  ? LedgerClosedResponse
+  : T extends LedgerCurrentRequest
+  ? LedgerCurrentResponse
+  : T extends LedgerDataRequest
+  ? LedgerDataResponse
+  : T extends LedgerEntryRequest
+  ? LedgerEntryResponse
+  : T extends SimulateBinaryRequest
+  ? SimulateBinaryResponse
+  : T extends SimulateJsonRequest
+  ? SimulateJsonResponse
+  : T extends SimulateRequest
+  ? SimulateJsonResponse
+  : T extends SubmitRequest
+  ? SubmitResponse
+  : T extends SubmitMultisignedRequest
+  ? SubmitMultisignedVersionResponseMap<Version>
+  : T extends TransactionEntryRequest
+  ? TransactionEntryResponse
+  : T extends TxRequest
+  ? TxVersionResponseMap<Version>
+  : T extends BookOffersRequest
+  ? BookOffersResponse
+  : T extends DepositAuthorizedRequest
+  ? DepositAuthorizedResponse
+  : T extends PathFindRequest
+  ? PathFindResponse
+  : T extends RipplePathFindRequest
+  ? RipplePathFindResponse
+  : T extends ChannelVerifyRequest
+  ? ChannelVerifyResponse
+  : T extends SubscribeRequest
+  ? SubscribeResponse
+  : T extends UnsubscribeRequest
+  ? UnsubscribeResponse
+  : T extends FeeRequest
+  ? FeeResponse
+  : T extends ManifestRequest
+  ? ManifestResponse
+  : T extends ServerInfoRequest
+  ? ServerInfoResponse
+  : T extends ServerStateRequest
+  ? ServerStateResponse
+  : T extends ServerDefinitionsRequest
+  ? ServerDefinitionsResponse
+  : T extends FeatureAllRequest
+  ? FeatureAllResponse
+  : T extends FeatureOneRequest
+  ? FeatureOneResponse
+  : T extends PingRequest
+  ? PingResponse
+  : T extends RandomRequest
+  ? RandomResponse
+  : T extends NFTBuyOffersRequest
+  ? NFTBuyOffersResponse
+  : T extends NFTSellOffersRequest
+  ? NFTSellOffersResponse
+  : T extends NFTInfoRequest
+  ? NFTInfoResponse
+  : T extends NFTsByIssuerRequest
+  ? NFTsByIssuerResponse
+  : T extends NFTHistoryRequest
+  ? NFTHistoryResponse
+  : Response<Version>
+
+export type MarkerRequest = Request & {
+  limit?: number
+  marker?: unknown
+}
+
+export type MarkerResponse<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = Response<Version> & {
+  result: {
+    marker?: unknown
+  }
+}
+
+export type RequestAllResponseMap<
+  T,
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = T extends AccountChannelsRequest
+  ? AccountChannelsResponse
+  : T extends AccountLinesRequest
+  ? AccountLinesResponse
+  : T extends AccountObjectsRequest
+  ? AccountObjectsResponse
+  : T extends AccountOffersRequest
+  ? AccountOffersResponse
+  : T extends AccountTxRequest
+  ? AccountTxVersionResponseMap<Version>
+  : T extends LedgerDataRequest
+  ? LedgerDataResponse
+  : T extends BookOffersRequest
+  ? BookOffersResponse
+  : MarkerResponse<Version>
 
 export {
   // Allow users to define their own requests and responses.  This is useful for releasing experimental versions
@@ -275,6 +514,7 @@ export {
   AccountInfoAccountFlags,
   AccountInfoRequest,
   AccountInfoResponse,
+  AccountInfoV1Response,
   AccountQueueData,
   AccountQueueTransaction,
   AccountLinesRequest,
@@ -292,15 +532,19 @@ export {
   AccountOffersResponse,
   AccountTxRequest,
   AccountTxResponse,
+  AccountTxV1Response,
   AccountTxTransaction,
   GatewayBalance,
   GatewayBalancesRequest,
   GatewayBalancesResponse,
+  GetAggregatePriceRequest,
+  GetAggregatePriceResponse,
   NoRippleCheckRequest,
   NoRippleCheckResponse,
   // ledger methods
   LedgerRequest,
   LedgerResponse,
+  LedgerV1Response,
   LedgerQueueData,
   LedgerBinary,
   LedgerModifiedOfferCreateTransaction,
@@ -316,14 +560,18 @@ export {
   LedgerEntryRequest,
   LedgerEntryResponse,
   // transaction methods with types
+  SimulateRequest,
+  SimulateResponse,
   SubmitRequest,
   SubmitResponse,
   SubmitMultisignedRequest,
   SubmitMultisignedResponse,
+  SubmitMultisignedV1Response,
   TransactionEntryRequest,
   TransactionEntryResponse,
   TxRequest,
   TxResponse,
+  TxV1Response,
   // path and order book methods with types
   BookOffersRequest,
   BookOffer,
@@ -354,6 +602,7 @@ export {
   LedgerStreamResponse,
   ValidationStream,
   TransactionStream,
+  TransactionV1Stream,
   PathFindStream,
   PeerStatusStream,
   OrderBookStream,
@@ -376,6 +625,8 @@ export {
   ServerState,
   StateAccountingFinal,
   StateAccounting,
+  FeatureRequest,
+  FeatureResponse,
   // utility methods
   PingRequest,
   PingResponse,
@@ -393,6 +644,8 @@ export {
   NFTHistoryRequest,
   NFTHistoryResponse,
   NFTHistoryTransaction,
+  NFTsByIssuerRequest,
+  NFTsByIssuerResponse,
   // AMM methods
   AMMInfoRequest,
   AMMInfoResponse,

package/src/models/methods/ledger.ts

@@ -1,4 +1,5 @@
-import { Ledger } from '../ledger'
+import { APIVersion, DEFAULT_API_VERSION, RIPPLED_API_V1 } from '../common'
+import { Ledger, LedgerV1, LedgerVersionMap } from '../ledger/Ledger'
 import { LedgerEntryFilter } from '../ledger/LedgerEntry'
 import { Transaction, TransactionAndMetadata } from '../transactions'
 import { TransactionMetadata } from '../transactions/metadata'
@@ -72,6 +73,112 @@ export interface LedgerRequest extends BaseRequest, LookupByLedgerRequest {
   type?: LedgerEntryFilter
 }
 
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponseExpanded}. Will return full JSON-formatted transaction data instead of string hashes.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": false,
+ *  "transactions": false,
+ *  "expand": true,
+ *  "owner_funds": false
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedTransactionsOnly extends LedgerRequest {
+  expand: true
+  transactions: true
+}
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponseExpanded}. Will return full JSON-formatted `accountState` data instead of string hashes.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": true,
+ *  "transactions": false,
+ *  "expand": true,
+ *  "owner_funds": false
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedAccountsOnly extends LedgerRequest {
+  expand: true
+  accounts: true
+}
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponseExpanded}. Will return full JSON-formatted `accountState` and `transactions`
+ * data instead of string hashes.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": true,
+ *  "transactions": true,
+ *  "expand": true,
+ *  "owner_funds": false
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedAccountsAndTransactions
+  extends LedgerRequest {
+  expand: true
+  accounts: true
+  transactions: true
+}
+
+/**
+ * Retrieve information about the public ledger. Expects a response in the form
+ * of a {@link LedgerResponse}. Will return binary (hexadecimal string) format
+ * instead of JSON or string hashes for `transactions` data.
+ *
+ * @example
+ * ```ts
+ * const ledger: LedgerRequest = {
+ *  "id": 14,
+ *  "command": "ledger",
+ *  "ledger_index": "validated",
+ *  "full": false,
+ *  "accounts": true,
+ *  "transactions": true,
+ *  "expand": true,
+ *  "owner_funds": false,
+ *  "binary": true
+ * }
+ * ```
+ *
+ * @category Requests
+ */
+export interface LedgerRequestExpandedTransactionsBinary extends LedgerRequest {
+  expand: true
+  transactions: true
+  binary: true
+}
+
 /**
  * Special case transaction definition when the request contains `owner_funds: true`.
  */
@@ -96,35 +203,93 @@ export interface LedgerQueueData {
 }
 
 export interface LedgerBinary
-  extends Omit<Omit<Ledger, 'transactions'>, 'accountState'> {
+  extends Omit<Ledger, 'transactions' | 'accountState'> {
   accountState?: string[]
   transactions?: string[]
 }
 
+export interface LedgerBinaryV1
+  extends Omit<LedgerV1, 'transactions' | 'accountState'> {
+  accountState?: string[]
+  transactions?: string[]
+}
+
+interface LedgerResponseBase {
+  /** Unique identifying hash of the entire ledger. */
+  ledger_hash: string
+  /** The Ledger Index of this ledger. */
+  ledger_index: number
+  /**
+   * If true, this is a validated ledger version. If omitted or set to false,
+   * this ledger's data is not final.
+   */
+  queue_data?: Array<LedgerQueueData | string>
+  /**
+   * Array of objects describing queued transactions, in the same order as
+   * the queue. If the request specified expand as true, members contain full
+   * representations of the transactions, in either JSON or binary depending
+   * on whether the request specified binary as true.
+   */
+  validated?: boolean
+}
+
+interface LedgerResponseResult extends LedgerResponseBase {
+  /** The complete header data of this {@link Ledger}. */
+  ledger: LedgerBinary
+}
+
+interface LedgerV1ResponseResult extends LedgerResponseBase {
+  /** The complete header data of this {@link Ledger}. */
+  ledger: LedgerBinaryV1
+}
+
 /**
  * Response expected from a {@link LedgerRequest}.
+ * This is the default request response, triggered when `expand` and `binary` are both false.
  *
  * @category Responses
  */
 export interface LedgerResponse extends BaseResponse {
-  result: {
-    /** The complete header data of this {@link Ledger}. */
-    ledger: Ledger | LedgerBinary
-    /** Unique identifying hash of the entire ledger. */
-    ledger_hash: string
-    /** The Ledger Index of this ledger. */
-    ledger_index: number
-    /**
-     * If true, this is a validated ledger version. If omitted or set to false,
-     * this ledger's data is not final.
-     */
-    queue_data?: Array<LedgerQueueData | string>
-    /**
-     * Array of objects describing queued transactions, in the same order as
-     * the queue. If the request specified expand as true, members contain full
-     * representations of the transactions, in either JSON or binary depending
-     * on whether the request specified binary as true.
-     */
-    validated?: boolean
-  }
+  result: LedgerResponseResult
+}
+
+/**
+ * Response expected from a {@link LedgerRequest}.
+ * This is the default request response, triggered when `expand` and `binary` are both false.
+ * This is the response for API version 1.
+ *
+ * @category ResponsesV1
+ */
+export interface LedgerV1Response extends BaseResponse {
+  result: LedgerV1ResponseResult
+}
+
+/**
+ * Type to map between the API version and the response type.
+ *
+ * @category Responses
+ */
+export type LedgerVersionResponseMap<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = Version extends typeof RIPPLED_API_V1 ? LedgerV1Response : LedgerResponse
+
+interface LedgerResponseExpandedResult<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> extends LedgerResponseBase {
+  /** The complete header data of this {@link Ledger}. */
+  ledger: LedgerVersionMap<Version>
+}
+
+/**
+ * Response expected from a {@link LedgerRequest} when the request contains `expanded` is true. See {@link LedgerRequestExpanded}.
+ * This response will contain full JSON-formatted data instead of string hashes.
+ * The response will contain either `accounts` or `transactions` or both.
+ * `binary` will be missing altogether.
+ *
+ * @category Responses
+ */
+export interface LedgerResponseExpanded<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> extends BaseResponse {
+  result: LedgerResponseExpandedResult<Version>
 }