Class TransactionSummary

Inheritance

object

BaseMethodResult

TransactionSummary

Implements

IAccountTransaction

Inherited Members

BaseMethodResult.UnknownFields

Namespace: Xrpl.Models.Methods

Assembly: Xrpl.dll

Syntax

public class TransactionSummary : BaseMethodResult, IAccountTransaction

Properties

CloseTimeIso

The ledger close time represented in ISO 8601 time format.

Declaration

[JsonPropertyName("close_time_iso")]
[JsonConverter(typeof(FromStringDateTimeConverter))]
public DateTime? CloseTimeIso { get; set; }

Property Value

Type	Description
Nullable

Remarks

API v2 only — API v1 does not report the close time on account_tx entries.

Ctid

The compact transaction identifier, when rippled reports one.

Declaration

[JsonPropertyName("ctid")]
public string? Ctid { get; set; }

Property Value

Type	Description
string

Remarks

Covers the singular tx method, where ctid sits beside tx_json — this property reads it from there. account_tx instead nests ctid inside tx_json itself, which lands on Ctid on the deserialized transaction, not here.

Hash

Unique hashed String representing the transaction.

Declaration

[JsonPropertyName("hash")]
public string Hash { get; set; }

Property Value

Type	Description
string

Remarks

API v1 reports the hash inside the transaction envelope instead of at the top level, so it falls back to the deserialized transaction.

LedgerHash

A hex string of the ledger version that included this transaction.

Declaration

[JsonPropertyName("ledger_hash")]
public string LedgerHash { get; set; }

Property Value

Type	Description
string

Remarks

API v2 only — API v1 does not report the ledger hash on account_tx entries.

LedgerIndex

The ledger index of the ledger version that included this transaction.

Declaration

[JsonPropertyName("ledger_index")]
public ulong? LedgerIndex { get; set; }

Property Value

Type	Description
ulong?

Remarks

API v1 reports this inside the transaction envelope instead of at the top level, so it falls back to the deserialized transaction.

Meta

If binary is True, then this is a hex string of the transaction metadata.
Otherwise, the transaction metadata is included in JSON format.

Declaration

[JsonPropertyName("meta")]
[JsonConverter(typeof(MetaBinaryConverter))]
public Meta Meta { get; set; }

Property Value

Type	Description
Meta

MetaBlob

If binary is True, then this is a hex string of the transaction metadata.

Declaration

[JsonPropertyName("meta_blob")]
public string? MetaBlob { get; set; }

Property Value

Type	Description
string

Remarks

API v2 with binary: true. rippled sends this as a top-level sibling of tx_blob instead of the usual meta field, and the meta field is absent entirely — so MetaBinaryConverter's string branch, which handles API v1's "meta": "<hex>", never runs for this shape. API v1 binary mode puts the same hex string in MetaBlob instead, reached through Meta below.

Transaction

JSON object defining the transaction.

Declaration

[JsonPropertyName("tx_json")]
public TransactionResponse Transaction { get; set; }

Property Value

Type	Description
TransactionResponse

Remarks

rippled wraps the transaction in tx_json under API v2 and in tx under API v1; both envelopes populate this property.

Match on the I-interface, not on the request type. What arrives here is a TransactionResponse - an NFTokenCreateOfferResponse, say - and never the request type of the same name. So:

if (summary.Transaction is NFTokenCreateOffer request)  // never matches
if (summary.Transaction is INFTokenCreateOffer offer)   // this is the one

The first line compiles, warns about nothing and quietly finds nothing, which looks exactly like the response having failed to parse - so the search starts in the wrong place. Request and response types come in pairs that share an I-interface; use those to read history, and the request types only to send. Every pair has one, with no exceptions, and a unit test holds the SDK to that.

TxBlob

If binary is True, then this is a hex string of the transaction itself.

Declaration

[JsonPropertyName("tx_blob")]
public string? TxBlob { get; set; }

Property Value

Type	Description
string

Remarks

API v2 with binary: true. rippled sends this as a top-level sibling of meta_blob instead of the usual tx_json field, and tx_json is absent entirely — so Transaction below is null for this shape.

Validated

Whether or not the transaction is included in a validated ledger.
Any transaction not yet in a validated ledger is subject to change.

Declaration

[JsonPropertyName("validated")]
public bool Validated { get; set; }

Property Value

Type	Description
bool

Implements

IAccountTransaction