xrpl 3.1.0 → 4.0.0-mpt-beta

package/src/models/methods/feature.ts

@@ -0,0 +1,68 @@
+import { BaseRequest, BaseResponse } from './baseMethod'
+
+export interface FeatureAllRequest extends BaseRequest {
+  command: 'feature'
+
+  feature?: never
+}
+
+export interface FeatureOneRequest extends BaseRequest {
+  command: 'feature'
+
+  feature: string
+}
+
+/**
+ * The `feature` command returns information about amendments this server knows about, including whether they are enabled.
+ * Returns an {@link FeatureResponse}.
+ *
+ * @category Requests
+ */
+export type FeatureRequest = FeatureAllRequest | FeatureOneRequest
+
+export interface FeatureAllResponse extends BaseResponse {
+  result: {
+    features: Record<
+      string,
+      {
+        /*
+         * Whether this amendment is currently enabled in the latest ledger.
+         */
+        enabled: boolean
+
+        /*
+         * The human-readable name for this amendment, if known.
+         */
+        name: string
+
+        supported: boolean
+      }
+    >
+  }
+}
+
+export interface FeatureOneResponse extends BaseResponse {
+  result: Record<
+    string,
+    {
+      /*
+       * Whether this amendment is currently enabled in the latest ledger.
+       */
+      enabled: boolean
+
+      /*
+       * The human-readable name for this amendment, if known.
+       */
+      name: string
+
+      supported: boolean
+    }
+  >
+}
+
+/**
+ * Response expected from an {@link FeatureRequest}.
+ *
+ * @category Responses
+ */
+export type FeatureResponse = FeatureAllResponse | FeatureOneResponse

package/src/models/methods/index.ts

@@ -1,5 +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,
@@ -13,6 +15,8 @@ import {
   AccountInfoAccountFlags,
   AccountInfoRequest,
   AccountInfoResponse,
+  AccountInfoV1Response,
+  AccountInfoVersionResponseMap,
   AccountQueueData,
   AccountQueueTransaction,
 } from './accountInfo'
@@ -40,6 +44,8 @@ import {
 import {
   AccountTxRequest,
   AccountTxResponse,
+  AccountTxV1Response,
+  AccountTxVersionResponseMap,
   AccountTxTransaction,
 } from './accountTx'
 import { AMMInfoRequest, AMMInfoResponse } from './ammInfo'
@@ -60,6 +66,14 @@ import {
   DepositAuthorizedRequest,
   DepositAuthorizedResponse,
 } from './depositAuthorized'
+import {
+  FeatureAllRequest,
+  FeatureAllResponse,
+  FeatureOneRequest,
+  FeatureOneResponse,
+  FeatureRequest,
+  FeatureResponse,
+} from './feature'
 import { FeeRequest, FeeResponse } from './fee'
 import {
   GatewayBalance,
@@ -76,11 +90,13 @@ import {
   LedgerQueueData,
   LedgerRequest,
   LedgerResponse,
+  LedgerV1Response,
   LedgerRequestExpandedTransactionsOnly,
   LedgerResponseExpanded,
   LedgerRequestExpandedAccountsAndTransactions,
   LedgerRequestExpandedAccountsOnly,
   LedgerRequestExpandedTransactionsBinary,
+  LedgerVersionResponseMap,
 } from './ledger'
 import { LedgerClosedRequest, LedgerClosedResponse } from './ledgerClosed'
 import { LedgerCurrentRequest, LedgerCurrentResponse } from './ledgerCurrent'
@@ -100,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 {
@@ -135,6 +152,8 @@ import { SubmitRequest, SubmitResponse } from './submit'
 import {
   SubmitMultisignedRequest,
   SubmitMultisignedResponse,
+  SubmitMultisignedV1Response,
+  SubmitMultisignedVersionResponseMap,
 } from './submitMultisigned'
 import {
   BooksSnapshot,
@@ -155,7 +174,7 @@ import {
   TransactionEntryRequest,
   TransactionEntryResponse,
 } from './transactionEntry'
-import { TxRequest, TxResponse } from './tx'
+import { TxRequest, TxResponse, TxV1Response, TxVersionResponseMap } from './tx'
 import {
   UnsubscribeBook,
   UnsubscribeRequest,
@@ -203,6 +222,7 @@ type Request =
   | ServerDefinitionsRequest
   | ServerInfoRequest
   | ServerStateRequest
+  | FeatureRequest
   // utility methods
   | PingRequest
   | RandomRequest
@@ -212,6 +232,7 @@ type Request =
   // clio only methods
   | NFTInfoRequest
   | NFTHistoryRequest
+  | NFTsByIssuerRequest
   // AMM methods
   | AMMInfoRequest
   // Price Oracle methods
@@ -220,27 +241,27 @@ type Request =
 /**
  * @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
   | SubmitResponse
-  | SubmitMultisignedResponse
+  | SubmitMultisignedVersionResponseMap<Version>
   | TransactionEntryResponse
   | TxResponse
   // path and order book methods
@@ -259,6 +280,7 @@ type Response =
   | ServerDefinitionsResponse
   | ServerInfoResponse
   | ServerStateResponse
+  | FeatureResponse
   // utility methods
   | PingResponse
   | RandomResponse
@@ -268,17 +290,21 @@ type Response =
   // clio only methods
   | NFTInfoResponse
   | NFTHistoryResponse
+  | NFTsByIssuerResponse
   // AMM methods
   | AMMInfoResponse
   // Price Oracle methods
   | GetAggregatePriceResponse
 
-export type RequestResponseMap<T> = T extends AccountChannelsRequest
+export type RequestResponseMap<
+  T,
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = T extends AccountChannelsRequest
   ? AccountChannelsResponse
   : T extends AccountCurrenciesRequest
   ? AccountCurrenciesResponse
   : T extends AccountInfoRequest
-  ? AccountInfoResponse
+  ? AccountInfoVersionResponseMap<Version>
   : T extends AccountLinesRequest
   ? AccountLinesResponse
   : T extends AccountNFTsRequest
@@ -288,7 +314,7 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
   : T extends AccountOffersRequest
   ? AccountOffersResponse
   : T extends AccountTxRequest
-  ? AccountTxResponse
+  ? AccountTxVersionResponseMap<Version>
   : T extends AMMInfoRequest
   ? AMMInfoResponse
   : T extends GatewayBalancesRequest
@@ -354,15 +380,15 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
   // then we'd get the wrong response type, LedgerResponse, instead of
   // LedgerResponseExpanded.
   T extends LedgerRequestExpandedTransactionsBinary
-  ? LedgerResponse
+  ? LedgerVersionResponseMap<Version>
   : T extends LedgerRequestExpandedAccountsAndTransactions
-  ? LedgerResponseExpanded
+  ? LedgerResponseExpanded<Version>
   : T extends LedgerRequestExpandedTransactionsOnly
-  ? LedgerResponseExpanded
+  ? LedgerResponseExpanded<Version>
   : T extends LedgerRequestExpandedAccountsOnly
-  ? LedgerResponseExpanded
+  ? LedgerResponseExpanded<Version>
   : T extends LedgerRequest
-  ? LedgerResponse
+  ? LedgerVersionResponseMap<Version>
   : T extends LedgerClosedRequest
   ? LedgerClosedResponse
   : T extends LedgerCurrentRequest
@@ -374,11 +400,11 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
   : T extends SubmitRequest
   ? SubmitResponse
   : T extends SubmitMultisignedRequest
-  ? SubmitMultisignedResponse
+  ? SubmitMultisignedVersionResponseMap<Version>
   : T extends TransactionEntryRequest
   ? TransactionEntryResponse
   : T extends TxRequest
-  ? TxResponse
+  ? TxVersionResponseMap<Version>
   : T extends BookOffersRequest
   ? BookOffersResponse
   : T extends DepositAuthorizedRequest
@@ -403,6 +429,10 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
   ? ServerStateResponse
   : T extends ServerDefinitionsRequest
   ? ServerDefinitionsResponse
+  : T extends FeatureAllRequest
+  ? FeatureAllResponse
+  : T extends FeatureOneRequest
+  ? FeatureOneResponse
   : T extends PingRequest
   ? PingResponse
   : T extends RandomRequest
@@ -413,22 +443,29 @@ export type RequestResponseMap<T> = T extends AccountChannelsRequest
   ? NFTSellOffersResponse
   : T extends NFTInfoRequest
   ? NFTInfoResponse
+  : T extends NFTsByIssuerRequest
+  ? NFTsByIssuerResponse
   : T extends NFTHistoryRequest
   ? NFTHistoryResponse
-  : Response
+  : Response<Version>
 
 export type MarkerRequest = Request & {
   limit?: number
   marker?: unknown
 }
 
-export type MarkerResponse = Response & {
+export type MarkerResponse<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = Response<Version> & {
   result: {
     marker?: unknown
   }
 }
 
-export type RequestAllResponseMap<T> = T extends AccountChannelsRequest
+export type RequestAllResponseMap<
+  T,
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = T extends AccountChannelsRequest
   ? AccountChannelsResponse
   : T extends AccountLinesRequest
   ? AccountLinesResponse
@@ -437,14 +474,12 @@ export type RequestAllResponseMap<T> = T extends AccountChannelsRequest
   : T extends AccountOffersRequest
   ? AccountOffersResponse
   : T extends AccountTxRequest
-  ? AccountTxResponse
+  ? AccountTxVersionResponseMap<Version>
   : T extends LedgerDataRequest
   ? LedgerDataResponse
-  : T extends AccountTxRequest
-  ? AccountTxResponse
   : T extends BookOffersRequest
   ? BookOffersResponse
-  : MarkerResponse
+  : MarkerResponse<Version>
 
 export {
   // Allow users to define their own requests and responses.  This is useful for releasing experimental versions
@@ -462,6 +497,7 @@ export {
   AccountInfoAccountFlags,
   AccountInfoRequest,
   AccountInfoResponse,
+  AccountInfoV1Response,
   AccountQueueData,
   AccountQueueTransaction,
   AccountLinesRequest,
@@ -479,6 +515,7 @@ export {
   AccountOffersResponse,
   AccountTxRequest,
   AccountTxResponse,
+  AccountTxV1Response,
   AccountTxTransaction,
   GatewayBalance,
   GatewayBalancesRequest,
@@ -490,6 +527,7 @@ export {
   // ledger methods
   LedgerRequest,
   LedgerResponse,
+  LedgerV1Response,
   LedgerQueueData,
   LedgerBinary,
   LedgerModifiedOfferCreateTransaction,
@@ -509,10 +547,12 @@ export {
   SubmitResponse,
   SubmitMultisignedRequest,
   SubmitMultisignedResponse,
+  SubmitMultisignedV1Response,
   TransactionEntryRequest,
   TransactionEntryResponse,
   TxRequest,
   TxResponse,
+  TxV1Response,
   // path and order book methods with types
   BookOffersRequest,
   BookOffer,
@@ -565,6 +605,8 @@ export {
   ServerState,
   StateAccountingFinal,
   StateAccounting,
+  FeatureRequest,
+  FeatureResponse,
   // utility methods
   PingRequest,
   PingResponse,
@@ -582,6 +624,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'
@@ -207,6 +208,12 @@ export interface LedgerBinary
   transactions?: string[]
 }
 
+export interface LedgerBinaryV1
+  extends Omit<Omit<LedgerV1, 'transactions'>, 'accountState'> {
+  accountState?: string[]
+  transactions?: string[]
+}
+
 interface LedgerResponseBase {
   /** Unique identifying hash of the entire ledger. */
   ledger_hash: string
@@ -231,6 +238,11 @@ interface LedgerResponseResult extends LedgerResponseBase {
   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.
@@ -241,9 +253,31 @@ export interface LedgerResponse extends BaseResponse {
   result: LedgerResponseResult
 }
 
-interface LedgerResponseExpandedResult extends LedgerResponseBase {
+/**
+ * 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: Ledger
+  ledger: LedgerVersionMap<Version>
 }
 
 /**
@@ -254,6 +288,8 @@ interface LedgerResponseExpandedResult extends LedgerResponseBase {
  *
  * @category Responses
  */
-export interface LedgerResponseExpanded extends BaseResponse {
-  result: LedgerResponseExpandedResult
+export interface LedgerResponseExpanded<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> extends BaseResponse {
+  result: LedgerResponseExpandedResult<Version>
 }

package/src/models/methods/ledgerEntry.ts

@@ -21,6 +21,22 @@ import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
  */
 export interface LedgerEntryRequest extends BaseRequest, LookupByLedgerRequest {
   command: 'ledger_entry'
+
+  /**
+   * Retrieve a MPTokenIssuance object from the ledger.
+   */
+  mpt_issuance?: string
+
+  /**
+   * Retrieve a MPToken object from the ledger.
+   */
+  mptoken?:
+    | {
+        mpt_issuance_id: string
+        account: string
+      }
+    | string
+
   /**
    * Retrieve an Automated Market Maker (AMM) object from the ledger.
    * This is similar to amm_info method, but the ledger_entry version returns only the ledger entry as stored.

package/src/models/methods/nftsByIssuer.ts

@@ -0,0 +1,68 @@
+import { NFToken } from '../common'
+
+import { BaseRequest, BaseResponse, LookupByLedgerRequest } from './baseMethod'
+
+/**
+ * The nfts_by_issuer method returns a list of NFTokens issued by the account.
+ * The order of the NFTs is not associated with the date the NFTs were minted.
+ * Expects a response in the form of a {@link
+ * NFTsByIssuerResponse}.
+ *
+ * @category Requests
+ */
+export interface NFTsByIssuerRequest
+  extends BaseRequest,
+    LookupByLedgerRequest {
+  command: 'nfts_by_issuer'
+  /**
+   * A unique identifier for the account, most commonly the account's address
+   */
+  issuer: string
+  /**
+   * Value from a previous paginated response. Resume retrieving data where
+   * that response left off. This value is stable even if there is a change in
+   * the server's range of available ledgers.
+   */
+  marker?: unknown
+  /**
+   * Filter NFTs issued by this issuer that have this taxon.
+   */
+  nft_taxon?: number
+  /**
+   * Default varies. Limit the number of transactions to retrieve. The server
+   * is not required to honor this value.
+   */
+  limit?: number
+}
+
+/**
+ * Expected response from an {@link NFTsByIssuerRequest}.
+ *
+ * @category Responses
+ */
+export interface NFTsByIssuerResponse extends BaseResponse {
+  result: {
+    /**
+     * The unique identifier for the account, most commonly the account's address
+     */
+    issuer: string
+    /**
+     * A list of NFTs issued by the account.
+     * The order of the NFTs is not associated with the date the NFTs were minted.
+     */
+    nfts: NFToken[]
+    /**
+     * Server-defined value indicating the response is paginated. Pass this
+     * to the next call to resume where this call left off.
+     */
+    marker?: unknown
+    /**
+     * The limit value used in the request.
+     */
+    limit?: number
+    /**
+     * Use to filter NFTs issued by this issuer that have this taxon.
+     */
+    nft_taxon?: number
+  }
+}

package/src/models/methods/submitMultisigned.ts

@@ -1,3 +1,4 @@
+import { APIVersion, DEFAULT_API_VERSION, RIPPLED_API_V1 } from '../common'
 import { Transaction } from '../transactions'
 
 import { BaseRequest, BaseResponse } from './baseMethod'
@@ -24,28 +25,59 @@ export interface SubmitMultisignedRequest extends BaseRequest {
   fail_hard?: boolean
 }
 
+/**
+ * Common properties for multisigned transaction responses.
+ *
+ * @category Responses
+ */
+interface BaseSubmitMultisignedResult {
+  /**
+   * Code indicating the preliminary result of the transaction, for example.
+   * `tesSUCCESS`.
+   */
+  engine_result: string
+  /**
+   * Numeric code indicating the preliminary result of the transaction,
+   * directly correlated to `engine_result`.
+   */
+  engine_result_code: number
+  /** Human-readable explanation of the preliminary transaction result. */
+  engine_result_message: string
+  /** The complete transaction in hex string format. */
+  tx_blob: string
+  /** The complete transaction in JSON format. */
+  tx_json: Transaction
+}
+
 /**
  * Response expected from a {@link SubmitMultisignedRequest}.
  *
  * @category Responses
  */
 export interface SubmitMultisignedResponse extends BaseResponse {
-  result: {
-    /**
-     * Code indicating the preliminary result of the transaction, for example.
-     * `tesSUCCESS` .
-     */
-    engine_result: string
-    /**
-     * Numeric code indicating the preliminary result of the transaction,
-     * directly correlated to `engine_result`.
-     */
-    engine_result_code: number
-    /** Human-readable explanation of the preliminary transaction result. */
-    engine_result_message: string
-    /** The complete transaction in hex string format. */
-    tx_blob: string
-    /** The complete transaction in JSON format. */
+  result: BaseSubmitMultisignedResult & {
+    hash?: string
+  }
+}
+
+/**
+ * Response expected from a {@link SubmitMultisignedRequest} using api_version 1.
+ *
+ * @category ResponsesV1
+ */
+export interface SubmitMultisignedV1Response extends BaseResponse {
+  result: BaseSubmitMultisignedResult & {
     tx_json: Transaction & { hash?: string }
   }
 }
+
+/**
+ * Type to map between the API version and the response type.
+ *
+ * @category Responses
+ */
+export type SubmitMultisignedVersionResponseMap<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = Version extends typeof RIPPLED_API_V1
+  ? SubmitMultisignedV1Response
+  : SubmitMultisignedResponse