xrpl-dev-portal/content/references/protocol-reference/transactions/transaction-metadata.md

html, parent, blurb, labels

html	parent	blurb	labels
transaction-metadata.html	transaction-formats.html	Transaction metadata describes the outcome of the transaction in detail, regardless of whether the transaction is successful.	Blockchain

Transaction Metadata

Transaction metadata is a section of data that gets added to a transaction after it is processed. Any transaction that gets included in a ledger has metadata, regardless of whether it is successful. The transaction metadata describes the outcome of the transaction in detail.

Warning: The changes described in transaction metadata are only final if the transaction is in a validated ledger version.

Some fields that may appear in transaction metadata include:

{% include '_snippets/tx-metadata-field-table.md' %}

Example Metadata

The following JSON object shows the metadata for a complex cross-currency payment:

{% include '_api-examples/metadata/cross-currency-payment.json' %}

AffectedNodes

The AffectedNodes array contains a complete list of the ledger entries that this transaction modified in some way. Each item in this array is an object with one top-level field indicating what happened:

• CreatedNode indicates that the transaction created a new ledger entry.
• DeletedNode indicates that the transaction removed a ledger entry
• ModifiedNode indicates that the transaction modified an existing ledger entry.

The value of each of these fields is a JSON object describing the changes made to the ledger entry.

CreatedNode Fields

A CreatedNode object contains the following fields:

Field	Value	Description
LedgerEntryType	String	The type of ledger entry that was created.
LedgerIndex	String - [Hash][]	The ID of this ledger entry in the ledger's state tree. Note: This is not the same as a ledger index, even though the field name is very similar.
NewFields	Object	The content fields of the newly-created ledger entry. Which fields are present depends on what type of ledger entry was created.

DeletedNode Fields

A DeletedNode object contains the following fields:

Field	Value	Description
LedgerEntryType	String	The type of ledger entry that was deleted.
LedgerIndex	String - [Hash][]	The ID of this ledger entry in the ledger's state tree. Note: This is not the same as a ledger index, even though the field name is very similar.
FinalFields	Object	The content fields of the ledger entry immediately before it was deleted. Which fields are present depends on what type of ledger entry was created.

ModifiedNode Fields

A ModifiedNode object contains the following fields:

Field	Value	Description
LedgerEntryType	String	The type of ledger entry that was deleted.
LedgerIndex	String - [Hash][]	The ID of this ledger entry in the ledger's state tree. Note: This is not the same as a ledger index, even though the field name is very similar.
FinalFields	Object	The content fields of the ledger entry after applying any changes from this transaction. Which fields are present depends on what type of ledger entry was created. This omits the PreviousTxnID and PreviousTxnLgrSeq fields, even though most types of ledger entries have them.
PreviousFields	Object	The previous values for all fields of the object that were changed as a result of this transaction. If the transaction only added fields to the object, this field is an empty object.
PreviousTxnID	String - [Hash][]	(May be omitted) The [identifying hash][] of the previous transaction to modify this ledger entry. Omitted for ledger entry types that do not have a PreviousTxnID field.
PreviousTxnLgrSeq	Number - [Ledger Index][]	(May be omitted) The [Ledger Index][] of the ledger version containing the previous transaction to modify this ledger entry. Omitted for ledger entry types that do not have a PreviousTxnLgrSeq field.

Note: If the modified ledger entry has PreviousTxnID and PreviousTxnLgrSeq fields, the transaction always updates them with the transaction's own identifying hash and the index of the ledger version that included the transaction, but these fields' new value is not listed in the FinalFields of the ModifiedNode object, and their previous values are listed at the top level of the ModifiedNode object rather than in the nested PreviousFields object.

NFT Fields

Transactions (tx and account_tx) involving NFTs can contain the following fields in the metadata. These values are added by the Clio server at request time and are not stored in the hashed binary metadata:

Field	Value	Description
nftoken_id	String	Shows the NFTokenID for the NFToken that changed on the ledger as a result of the transaction. Only present if the transaction is NFTokenMint or NFTokenAcceptOffer. See NFTokenID.
nftoken_ids	Array	Shows all the NFTokenIDs for the NFTokens that changed on the ledger as a result of the transaction. Only present if the transaction is NFTokenCancelOffer.
offer_id	String	Shows the OfferIDof a new NFTokenOffer in a response from a NFTokenCreateOffer transaction.

delivered_amount

The Amount of a [Payment transaction][] indicates the amount to deliver to the Destination, so if the transaction was successful, then the destination received that much -- except if the transaction was a partial payment. (In that case, any positive amount up to Amount might have arrived.) Rather than choosing whether or not to trust the Amount field, you should use the delivered_amount field of the metadata to see how much actually reached its destination.

The rippled server provides a delivered_amount field in JSON transaction metadata for all successful Payment transactions. This field is formatted like a normal currency amount. However, the delivered amount is not available for transactions that meet both of the following criteria:

• Is a partial payment
• Included in a validated ledger before 2014-01-20

If both conditions are true, then delivered_amount contains the string value unavailable instead of an actual amount. If this happens, you can only figure out the actual delivered amount by reading the AffectedNodes in the transaction's metadata.

Note: The delivered_amount field is generated on-demand for the request, and is not included in the binary format for transaction metadata, nor is it used when calculating the hash of the transaction metadata. In contrast, the DeliveredAmount field is included in the binary format for partial payment transactions after 2014-01-20.

See also: Partial Payments

{% include '_snippets/rippled-api-links.md' %} {% include '_snippets/tx-type-links.md' %} {% include '_snippets/rippled_versions.md' %}