feat: Add optional CTID field to Tx (#2477)

* Add optional CTID field to Tx * Update HISTORY.md * Update TxRequest * Update comment to remove incorrect statement --------- Co-authored-by: Caleb Kniffen <[email protected]>
XRPLF · Nov 30, 2023 · 98abafb · 98abafb
1 parent 9a85aaa
commit 98abafb
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/packages/xrpl/HISTORY.md b/packages/xrpl/HISTORY.md
@@ -12,7 +12,11 @@ Subscribe to [the **xrpl-announce** mailing list](https://groups.google.com/g/xr
 ### Added
 * Support for `server_definitions` RPC
 
+### Added
+* Add support for Concise Transaction Identifier (ctid) as defined in [XLS-37](https://github.com/XRPLF/XRPL-Standards/discussions/91)
+
 ### Fixed
+* Allow flag maps when submitting `NFTokenMint` and `NFTokenCreateOffer` transactions like others with flags
 * Fix parseNFTokenID to return the correct taxon if large serial and (or) taxon were used
 
 ## 2.13.0 (2023-10-18)

diff --git a/packages/xrpl/src/models/methods/tx.ts b/packages/xrpl/src/models/methods/tx.ts
@@ -12,7 +12,14 @@ import { BaseRequest, BaseResponse } from './baseMethod'
  */
 export interface TxRequest extends BaseRequest {
   command: 'tx'
-  transaction: string
+  /**
+   * The transaction hash to look up. Exactly one of `transaction` or `ctid` must be specified for a TxRequest.
+   */
+  transaction?: string
+  /**
+   * The Concise Transaction ID to look up. Exactly one of `transaction` or `ctid` must be specified for a TxRequest.
+   */
+  ctid?: string
   /**
    * If true, return transaction data and metadata as binary serialized to
    * hexadecimal strings. If false, return transaction data and metadata as.
@@ -46,6 +53,10 @@ export interface TxResponse<
   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.