Add apiVersion option to Client constructor

packages/xrpl/HISTORY.md

@@ -10,6 +10,9 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 ### Changed
 * Deprecated `setTransactionFlagsToNumber`. Start using convertTxFlagsToNumber instead
 
+### Fixed
+* `Client` supports `apiVersion` option on constructor
+
 ## 4.1.0 (2024-12-23)
 
 ### Added

packages/xrpl/src/client/index.ts

@@ -28,7 +28,6 @@ import {
   AccountOffersRequest,
   AccountOffersResponse,
   AccountTxRequest,
-  AccountTxResponse,
   // ledger methods
   LedgerDataRequest,
   LedgerDataResponse,
@@ -40,7 +39,9 @@ import type {
   MarkerRequest,
   MarkerResponse,
   SubmitResponse,
+  BaseRequest,
 } from '../models/methods'
+import { AccountTxResponseBase } from '../models/methods/accountTx'
 import type { BookOffer, BookOfferCurrency } from '../models/methods/bookOffers'
 import type {
   EventTypes,
@@ -92,7 +93,9 @@ import {
   handleStreamPartialPayment,
 } from './partialPayment'
 
-export interface ClientOptions extends ConnectionUserOptions {
+export interface ClientOptions<
+  ClientAPIVersion extends APIVersion = typeof DEFAULT_API_VERSION,
+> extends ConnectionUserOptions {
   /**
    * Multiplication factor to multiply estimated fee by to provide a cushion in case the
    * required fee rises during submission of a transaction. Defaults to 1.2.
@@ -111,6 +114,12 @@ export interface ClientOptions extends ConnectionUserOptions {
    * Duration to wait for a request to timeout.
    */
   timeout?: number
+  /**
+   * API Version to use for requests.
+   *
+   * @default DEFAULT_API_VERSION
+   */
+  apiVersion?: ClientAPIVersion
 }
 
 // Make sure to update both this and `RequestNextPageReturnMap` at the same time
@@ -122,7 +131,10 @@ type RequestNextPageType =
   | AccountTxRequest
   | LedgerDataRequest
 
-type RequestNextPageReturnMap<T> = T extends AccountChannelsRequest
+type RequestNextPageReturnMap<
+  T extends BaseRequest,
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+> = T extends AccountChannelsRequest
   ? AccountChannelsResponse
   : T extends AccountLinesRequest
   ? AccountLinesResponse
@@ -131,7 +143,7 @@ type RequestNextPageReturnMap<T> = T extends AccountChannelsRequest
   : T extends AccountOffersRequest
   ? AccountOffersResponse
   : T extends AccountTxRequest
-  ? AccountTxResponse
+  ? AccountTxResponseBase<V>
   : T extends LedgerDataRequest
   ? LedgerDataResponse
   : never
@@ -184,7 +196,9 @@ const NORMAL_DISCONNECT_CODE = 1000
  *
  * @category Clients
  */
-class Client extends EventEmitter<EventTypes> {
+class Client<
+  ClientAPIVersion extends APIVersion = typeof DEFAULT_API_VERSION,
+> extends EventEmitter<EventTypes> {
   /*
    * Underlying connection to rippled.
    */
@@ -222,7 +236,7 @@ class Client extends EventEmitter<EventTypes> {
    * API Version used by the server this client is connected to
    *
    */
-  public apiVersion: APIVersion = DEFAULT_API_VERSION
+  public apiVersion: APIVersion
 
   /**
    * Creates a new Client with a websocket connection to a rippled server.
@@ -238,7 +252,10 @@ class Client extends EventEmitter<EventTypes> {
    * ```
    */
   /* eslint-disable max-lines-per-function -- the constructor requires more lines to implement the logic */
-  public constructor(server: string, options: ClientOptions = {}) {
+  public constructor(
+    server: string,
+    options: ClientOptions<ClientAPIVersion> = {},
+  ) {
     super()
     if (typeof server !== 'string' || !/wss?(?:\+unix)?:\/\//u.exec(server)) {
       throw new ValidationError(
@@ -249,6 +266,8 @@ class Client extends EventEmitter<EventTypes> {
     this.feeCushion = options.feeCushion ?? DEFAULT_FEE_CUSHION
     this.maxFeeXRP = options.maxFeeXRP ?? DEFAULT_MAX_FEE_XRP
 
+    this.apiVersion = options.apiVersion ?? DEFAULT_API_VERSION
+
     this.connection = new Connection(server, options)
 
     this.connection.on('error', (errorCode, errorMessage, data) => {
@@ -332,7 +351,7 @@ class Client extends EventEmitter<EventTypes> {
    */
   public async request<
     R extends Request,
-    V extends APIVersion = typeof DEFAULT_API_VERSION,
+    V extends APIVersion = ClientAPIVersion,
     T = RequestResponseMap<R, V>,
   >(req: R): Promise<T> {
     const request = {
@@ -377,8 +396,8 @@ class Client extends EventEmitter<EventTypes> {
    */
   public async requestNextPage<
     T extends RequestNextPageType,
-    U extends RequestNextPageReturnMap<T>,
-  >(req: T, resp: U): Promise<RequestNextPageReturnMap<T>> {
+    U extends RequestNextPageReturnMap<T, ClientAPIVersion>,
+  >(req: T, resp: U): Promise<U> {
     if (!resp.result.marker) {
       return Promise.reject(
         new NotFoundError('response does not have a next page'),
@@ -417,7 +436,10 @@ class Client extends EventEmitter<EventTypes> {
   public on<
     T extends EventTypes,
     // eslint-disable-next-line @typescript-eslint/no-explicit-any -- needs to be any for overload
-    U extends (...args: any[]) => void = OnEventToListenerMap<T>,
+    U extends (...args: any[]) => void = OnEventToListenerMap<
+      T,
+      ClientAPIVersion
+    >,
   >(eventName: T, listener: U): this {
     return super.on(eventName, listener)
   }
@@ -455,7 +477,7 @@ class Client extends EventEmitter<EventTypes> {
 
   public async requestAll<
     T extends MarkerRequest,
-    U = RequestAllResponseMap<T, APIVersion>,
+    U = RequestAllResponseMap<T, ClientAPIVersion>,
   >(request: T, collect?: string): Promise<U[]> {
     /*
      * The data under collection is keyed based on the command. Fail if command
@@ -483,7 +505,8 @@ class Client extends EventEmitter<EventTypes> {
       // eslint-disable-next-line no-await-in-loop -- Necessary for this, it really has to wait
       const singleResponse = await this.connection.request(repeatProps)
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- Should be true
-      const singleResult = (singleResponse as MarkerResponse<APIVersion>).result
+      const singleResult = (singleResponse as MarkerResponse<ClientAPIVersion>)
+        .result
       if (!(collectKey in singleResult)) {
         throw new XrplError(`${collectKey} not in result`)
       }
@@ -833,7 +856,7 @@ class Client extends EventEmitter<EventTypes> {
       // A wallet to sign a transaction. It must be provided when submitting an unsigned transaction.
       wallet?: Wallet
     },
-  ): Promise<TxResponse<T>> {
+  ): Promise<TxResponse<T, ClientAPIVersion>> {
     const signedTx = await getSignedTx(this, transaction, opts)
 
     const lastLedger = getLastLedgerSequence(signedTx)

packages/xrpl/src/models/methods/accountTx.ts

@@ -87,7 +87,7 @@ export interface AccountTxTransaction<
 /**
  * Base interface for account transaction responses.
  */
-interface AccountTxResponseBase<
+export interface AccountTxResponseBase<
   Version extends APIVersion = typeof DEFAULT_API_VERSION,
 > extends BaseResponse {
   result: {

packages/xrpl/src/models/methods/subscribe.ts

@@ -478,7 +478,10 @@ export type EventTypes =
   | 'path_find'
   | 'error'
 
-export type OnEventToListenerMap<T extends EventTypes> = T extends 'connected'
+export type OnEventToListenerMap<
+  T extends EventTypes,
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+> = T extends 'connected'
   ? () => void
   : T extends 'disconnected'
   ? (code: number) => void
@@ -487,7 +490,7 @@ export type OnEventToListenerMap<T extends EventTypes> = T extends 'connected'
   : T extends 'validationReceived'
   ? (validation: ValidationStream) => void
   : T extends 'transaction'
-  ? (transaction: TransactionStream) => void
+  ? (transaction: TransactionStreamBase<V>) => void
   : T extends 'peerStatusChange'
   ? (peerStatus: PeerStatusStream) => void
   : T extends 'consensusPhase'

packages/xrpl/src/models/methods/tx.ts

@@ -93,9 +93,11 @@ interface BaseTxResult<
  *
  * @category Responses
  */
-export interface TxResponse<T extends BaseTransaction = Transaction>
-  extends BaseResponse {
-  result: BaseTxResult<typeof RIPPLED_API_V2, T> & { tx_json: T }
+export interface TxResponse<
+  T extends BaseTransaction = Transaction,
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+> extends BaseResponse {
+  result: BaseTxResult<V, T> & { tx_json: T }
   /**
    * If true, the server was able to search all of the specified ledger
    * versions, and the transaction was in none of them. If false, the server did

packages/xrpl/src/sugar/autofill.ts

@@ -3,6 +3,7 @@ import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
 
 import { type Client } from '..'
 import { ValidationError, XrplError } from '../errors'
+import { APIVersion, DEFAULT_API_VERSION } from '../models/common'
 import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
 import { Transaction } from '../models/transactions'
 import { xrpToDrops } from '../utils'
@@ -91,7 +92,9 @@ function isNotLaterRippledVersion(source: string, target: string): boolean {
  * @param client -- The connected client.
  * @returns True if required networkID, false otherwise.
  */
-export function txNeedsNetworkID(client: Client): boolean {
+export function txNeedsNetworkID<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>): boolean {
   if (
     client.networkID !== undefined &&
     client.networkID > RESTRICTED_NETWORKS
@@ -215,10 +218,9 @@ function convertToClassicAddress(tx: Transaction, fieldName: string): void {
  * @returns A Promise that resolves when the sequence number is set.
  * @throws {Error} If there is an error retrieving the account information.
  */
-export async function setNextValidSequenceNumber(
-  client: Client,
-  tx: Transaction,
-): Promise<void> {
+export async function setNextValidSequenceNumber<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>, tx: Transaction): Promise<void> {
   const request: AccountInfoRequest = {
     command: 'account_info',
     account: tx.Account,
@@ -236,7 +238,9 @@ export async function setNextValidSequenceNumber(
  * @returns A Promise that resolves to the account deletion fee as a BigNumber.
  * @throws {Error} Throws an error if the account deletion fee cannot be fetched.
  */
-async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
+async function fetchAccountDeleteFee<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>): Promise<BigNumber> {
   const response = await client.request({ command: 'server_state' })
   const fee = response.result.state.validated_ledger?.reserve_inc
 
@@ -255,11 +259,9 @@ async function fetchAccountDeleteFee(client: Client): Promise<BigNumber> {
  * @param [signersCount=0] - The number of signers (default is 0). Only used for multisigning.
  * @returns A promise that resolves with void. Modifies the `tx` parameter to give it the calculated fee.
  */
-export async function calculateFeePerTransactionType(
-  client: Client,
-  tx: Transaction,
-  signersCount = 0,
-): Promise<void> {
+export async function calculateFeePerTransactionType<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>, tx: Transaction, signersCount = 0): Promise<void> {
   // netFee is usually 0.00001 XRP (10 drops)
   const netFeeXRP = await getFeeXrp(client)
   const netFeeDrops = xrpToDrops(netFeeXRP)
@@ -320,10 +322,9 @@ function scaleValue(value, multiplier): string {
  * @param tx - The transaction object.
  * @returns A promise that resolves with void. Modifies the `tx` parameter setting `LastLedgerSequence`.
  */
-export async function setLatestValidatedLedgerSequence(
-  client: Client,
-  tx: Transaction,
-): Promise<void> {
+export async function setLatestValidatedLedgerSequence<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>, tx: Transaction): Promise<void> {
   const ledgerSequence = await client.getLedgerIndex()
   // eslint-disable-next-line no-param-reassign -- param reassign is safe
   tx.LastLedgerSequence = ledgerSequence + LEDGER_OFFSET
@@ -336,10 +337,9 @@ export async function setLatestValidatedLedgerSequence(
  * @param tx - The transaction object.
  * @returns A promise that resolves with void if there are no blockers, or rejects with an XrplError if there are blockers.
  */
-export async function checkAccountDeleteBlockers(
-  client: Client,
-  tx: Transaction,
-): Promise<void> {
+export async function checkAccountDeleteBlockers<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>, tx: Transaction): Promise<void> {
   const request: AccountObjectsRequest = {
     command: 'account_objects',
     account: tx.Account,

packages/xrpl/src/sugar/getFeeXrp.ts

@@ -2,6 +2,7 @@ import BigNumber from 'bignumber.js'
 
 import { type Client } from '..'
 import { XrplError } from '../errors'
+import { APIVersion, DEFAULT_API_VERSION } from '../models/common'
 
 const NUM_DECIMAL_PLACES = 6
 const BASE_10 = 10
@@ -14,10 +15,9 @@ const BASE_10 = 10
  * @param cushion - The fee cushion to use.
  * @returns The transaction fee.
  */
-export default async function getFeeXrp(
-  client: Client,
-  cushion?: number,
-): Promise<string> {
+export default async function getFeeXrp<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>, cushion?: number): Promise<string> {
   const feeCushion = cushion ?? client.feeCushion
 
   const serverInfo = (

packages/xrpl/src/sugar/getOrderbook.ts

@@ -2,7 +2,7 @@ import BigNumber from 'bignumber.js'
 
 import type { Client } from '../client'
 import { ValidationError } from '../errors'
-import { LedgerIndex } from '../models/common'
+import { APIVersion, DEFAULT_API_VERSION, LedgerIndex } from '../models/common'
 import { OfferFlags } from '../models/ledger/Offer'
 import {
   BookOffer,
@@ -142,10 +142,9 @@ type BookOfferResult = BookOffer[]
  * @param request - The request object.
  * @returns The array of book offer results.
  */
-export async function requestAllOffers(
-  client: Client,
-  request: BookOffersRequest,
-): Promise<BookOfferResult[]> {
+export async function requestAllOffers<
+  V extends APIVersion = typeof DEFAULT_API_VERSION,
+>(client: Client<V>, request: BookOffersRequest): Promise<BookOfferResult[]> {
   const results = await client.requestAll(request)
   return results.map((result) => result.result.offers)
 }