xrpl 3.1.0 → 4.0.0

package/src/models/methods/tx.ts

@@ -1,3 +1,9 @@
+import {
+  APIVersion,
+  DEFAULT_API_VERSION,
+  RIPPLED_API_V1,
+  RIPPLED_API_V2,
+} from '../common'
 import { Transaction, TransactionMetadata } from '../transactions'
 import { BaseTransaction } from '../transactions/common'
 
@@ -41,6 +47,47 @@ export interface TxRequest extends BaseRequest {
   max_ledger?: number
 }
 
+/**
+ * Common properties of transaction responses.
+ *
+ * @category Responses
+ */
+interface BaseTxResult<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+  T extends BaseTransaction = Transaction,
+> {
+  /** The SHA-512 hash of the transaction. */
+  hash: string
+  /**
+   * The Concise Transaction Identifier of the transaction (16-byte hex string)
+   */
+  ctid?: string
+  /** The ledger index of the ledger that includes this transaction. */
+  ledger_index?: number
+  /** Unique hashed string Transaction metadata blob, which describes the results of the transaction.
+   *  Can be undefined if a transaction has not been validated yet. This field is omitted if binary
+   *  binary format is not requested. */
+  meta_blob?: Version extends typeof RIPPLED_API_V2
+    ? TransactionMetadata<T> | string
+    : never
+  /** Transaction metadata, which describes the results of the transaction.
+   *  Can be undefined if a transaction has not been validated yet. */
+  meta?: TransactionMetadata<T> | string
+  /**
+   * If true, this data comes from a validated ledger version; if omitted or.
+   * Set to false, this data is not final.
+   */
+  validated?: boolean
+  /**
+   * The time the transaction was closed, in seconds since the Ripple Epoch.
+   */
+  close_time_iso?: string
+  /**
+   * This number measures the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC)
+   */
+  date?: number
+}
+
 /**
  * Response expected from a {@link TxRequest}.
  *
@@ -48,28 +95,7 @@ export interface TxRequest extends BaseRequest {
  */
 export interface TxResponse<T extends BaseTransaction = Transaction>
   extends BaseResponse {
-  result: {
-    /** The SHA-512 hash of the transaction. */
-    hash: string
-    /**
-     * The Concise Transaction Identifier of the transaction (16-byte hex string)
-     */
-    ctid?: string
-    /** The ledger index of the ledger that includes this transaction. */
-    ledger_index?: number
-    /** Transaction metadata, which describes the results of the transaction.
-     *  Can be undefined if a transaction has not been validated yet. */
-    meta?: TransactionMetadata<T> | string
-    /**
-     * If true, this data comes from a validated ledger version; if omitted or.
-     * Set to false, this data is not final.
-     */
-    validated?: boolean
-    /**
-     * This number measures the number of seconds since the "Ripple Epoch" of January 1, 2000 (00:00 UTC)
-     */
-    date?: number
-  } & T
+  result: BaseTxResult<typeof RIPPLED_API_V2, 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
@@ -78,3 +104,29 @@ export interface TxResponse<T extends BaseTransaction = Transaction>
    */
   searched_all?: boolean
 }
+
+/**
+ * Response expected from a {@link TxRequest} using API version 1.
+ *
+ * @category ResponsesV1
+ */
+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
+   * versions, and the transaction was in none of them. If false, the server did
+   * not have all of the specified ledger versions available, so it is not sure.
+   * If one of them might contain the transaction.
+   */
+  searched_all?: boolean
+}
+
+/**
+ * Type to map between the API version and the response type.
+ *
+ * @category Responses
+ */
+export type TxVersionResponseMap<
+  Version extends APIVersion = typeof DEFAULT_API_VERSION,
+> = Version extends typeof RIPPLED_API_V1 ? TxV1Response : TxResponse

package/src/sugar/autofill.ts

@@ -1,7 +1,7 @@
 import BigNumber from 'bignumber.js'
 import { xAddressToClassicAddress, isValidXAddress } from 'ripple-address-codec'
 
-import type { Client } from '..'
+import { type Client } from '..'
 import { ValidationError, XrplError } from '../errors'
 import { AccountInfoRequest, AccountObjectsRequest } from '../models/methods'
 import { Transaction } from '../models/transactions'
@@ -17,7 +17,6 @@ const LEDGER_OFFSET = 20
 // Mainnet and testnet are exceptions. More context: https://github.com/XRPLF/rippled/pull/4370
 const RESTRICTED_NETWORKS = 1024
 const REQUIRED_NETWORKID_VERSION = '1.11.0'
-const HOOKS_TESTNET_ID = 21338
 
 /**
  * Determines whether the source rippled version is not later than the target rippled version.
@@ -87,8 +86,7 @@ function isNotLaterRippledVersion(source: string, target: string): boolean {
 
 /**
  * Determine if the transaction required a networkID to be valid.
- * Transaction needs networkID if later than restricted ID and either the network is hooks testnet
- * or build version is >= 1.11.0
+ * Transaction needs networkID if later than restricted ID and build version is >= 1.11.0
  *
  * @param client -- The connected client.
  * @returns True if required networkID, false otherwise.
@@ -99,12 +97,8 @@ export function txNeedsNetworkID(client: Client): boolean {
     client.networkID > RESTRICTED_NETWORKS
   ) {
     if (
-      (client.buildVersion &&
-        isNotLaterRippledVersion(
-          REQUIRED_NETWORKID_VERSION,
-          client.buildVersion,
-        )) ||
-      client.networkID === HOOKS_TESTNET_ID
+      client.buildVersion &&
+      isNotLaterRippledVersion(REQUIRED_NETWORKID_VERSION, client.buildVersion)
     ) {
       return true
     }

package/src/sugar/getFeeXrp.ts

@@ -1,6 +1,6 @@
 import BigNumber from 'bignumber.js'
 
-import type { Client } from '..'
+import { type Client } from '..'
 import { XrplError } from '../errors'
 
 const NUM_DECIMAL_PLACES = 6
@@ -20,8 +20,11 @@ export default async function getFeeXrp(
 ): Promise<string> {
   const feeCushion = cushion ?? client.feeCushion
 
-  const serverInfo = (await client.request({ command: 'server_info' })).result
-    .info
+  const serverInfo = (
+    await client.request({
+      command: 'server_info',
+    })
+  ).result.info
 
   const baseFee = serverInfo.validated_ledger?.base_fee_xrp
 

package/src/sugar/submit.ts

@@ -10,7 +10,7 @@ import type {
 } from '..'
 import { ValidationError, XrplError } from '../errors'
 import { Signer } from '../models/common'
-import { TxRequest, TxResponse } from '../models/methods'
+import { TxResponse } from '../models/methods'
 import { BaseTransaction } from '../models/transactions/common'
 
 /** Approximate time for a ledger to close, in milliseconds */
@@ -129,7 +129,7 @@ export async function waitForFinalTransactionOutcome<
   }
 
   const txResponse = await client
-    .request<TxRequest, TxResponse<T>>({
+    .request({
       command: 'tx',
       transaction: txHash,
     })
@@ -153,7 +153,9 @@ export async function waitForFinalTransactionOutcome<
     })
 
   if (txResponse.result.validated) {
-    return txResponse
+    // TODO: resolve the type assertion below
+    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions -- we know that txResponse is of type TxResponse
+    return txResponse as TxResponse<T>
   }
 
   return waitForFinalTransactionOutcome<T>(

package/src/utils/hashes/hashLedger.ts

@@ -8,8 +8,9 @@ import BigNumber from 'bignumber.js'
 import { decode, encode } from 'ripple-binary-codec'
 
 import { ValidationError, XrplError } from '../../errors'
-import type { Ledger } from '../../models/ledger'
+import { APIVersion } from '../../models'
 import { LedgerEntry } from '../../models/ledger'
+import { LedgerVersionMap } from '../../models/ledger/Ledger'
 import { Transaction, TransactionMetadata } from '../../models/transactions'
 
 import HashPrefix from './HashPrefix'
@@ -99,7 +100,9 @@ export function hashSignedTx(tx: Transaction | string): string {
  * @returns The hash of the ledger.
  * @category Utilities
  */
-export function hashLedgerHeader(ledgerHeader: Ledger): string {
+export function hashLedgerHeader(
+  ledgerHeader: LedgerVersionMap<APIVersion>,
+): string {
   const prefix = HashPrefix.LEDGER.toString(HEX).toUpperCase()
 
   const ledger =
@@ -158,7 +161,7 @@ export function hashStateTree(entries: LedgerEntry[]): string {
 }
 
 function computeTransactionHash(
-  ledger: Ledger,
+  ledger: LedgerVersionMap<APIVersion>,
   options: HashLedgerHeaderOptions,
 ): string {
   const { transaction_hash } = ledger
@@ -188,7 +191,7 @@ function computeTransactionHash(
 }
 
 function computeStateHash(
-  ledger: Ledger,
+  ledger: LedgerVersionMap<APIVersion>,
   options: HashLedgerHeaderOptions,
 ): string {
   const { account_hash } = ledger
@@ -222,7 +225,7 @@ function computeStateHash(
  * @category Utilities
  */
 function hashLedger(
-  ledger: Ledger,
+  ledger: LedgerVersionMap<APIVersion>,
   options: {
     computeTreeHashes?: boolean
   } = {},

package/src/utils/index.ts

@@ -23,6 +23,7 @@ import {
 } from 'ripple-binary-codec'
 import { verify as verifyKeypairSignature } from 'ripple-keypairs'
 
+import type { APIVersion } from '../models'
 import { LedgerEntry } from '../models/ledger'
 import { Response } from '../models/methods'
 import { PaymentChannelClaim } from '../models/transactions/paymentChannelClaim'
@@ -157,7 +158,7 @@ function isValidAddress(address: string): boolean {
  * @returns Whether the response has more pages of data.
  * @category Utilities
  */
-function hasNextPage(response: Response): boolean {
+function hasNextPage(response: Response<APIVersion>): boolean {
   // eslint-disable-next-line @typescript-eslint/dot-notation -- only checking if it exists
   return Boolean(response.result['marker'])
 }