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 <ckniffen@ripple.com>
This commit is contained in:
Jackson Mills
2023-11-30 07:23:12 -08:00
committed by GitHub
parent 9a85aaa109
commit 98abafbf12
2 changed files with 16 additions and 1 deletions

View File

@@ -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)

View File

@@ -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.