mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-04 11:55:50 +00:00
add raw data
This commit is contained in:
Oliver Eggert
@@ -18,9 +18,78 @@ Some fields that may appear in transaction metadata include:
|
||||
|
||||
## Example Metadata
|
||||
|
||||
The following JSON object shows the metadata for [a complex cross-currency payment](https://livenet.xrpl.org/transactions/8C55AFC2A2AA42B5CE624AEECDB3ACFDD1E5379D4E5BF74A8460C5E97EF8706B):
|
||||
The following JSON object shows the metadata for an order, [trading XRP for USD](https://livenet.xrpl.org/transactions/424661CF1FD3675D11EC910CF161979553B6D135F9BD03E6F8D4611D88D27581):
|
||||
|
||||
{% code-snippet file="/_api-examples/metadata/cross-currency-payment.json" language="json" /%}
|
||||
```json
|
||||
{
|
||||
AffectedNodes: [
|
||||
0: {
|
||||
ModifiedNode: {
|
||||
FinalFields: {...}
|
||||
LedgerEntryType: "AccountRoot"
|
||||
LedgerIndex: "1ED8DDFD80F275CB1CE7F18BB9D906655DE8029805D8B95FB9020B30425821EB"
|
||||
PreviousFields: {...}
|
||||
PreviousTxnID: "3110F983CDC090750B45C9BFB74B8CE629CA80F57C35612402B2760153822BA5"
|
||||
PreviousTxnLgrSeq: 86724072
|
||||
}
|
||||
}
|
||||
1: {
|
||||
DeletedNode: {
|
||||
FinalFields: {...}
|
||||
LedgerEntryType: "Offer"
|
||||
LedgerIndex: "348AF66EBD872FBF2BD23085D3FB4A200E15509451475027C4A5EE8D8B77C623"
|
||||
PreviousFields: {...}
|
||||
}
|
||||
}
|
||||
2: {
|
||||
ModifiedNode: {
|
||||
FinalFields: {...}
|
||||
LedgerEntryType: "DirectoryNode"
|
||||
LedgerIndex: "4A68E363398C8DA470CF85237CA4A044476CD38BA7D5C9B8E8F19417A13B01C1"
|
||||
}
|
||||
}
|
||||
3: {
|
||||
ModifiedNode: {
|
||||
FinalFields: {...}
|
||||
LedgerEntryType: "RippleState"
|
||||
LedgerIndex: "7345788A2C9121EB8168D2755950887CED3887CCDBC882015BC070A61C2AD1DA"
|
||||
PreviousFields: {...}
|
||||
PreviousTxnID: "B4726FC087FAB3DB3578A34095B96F9055075A86A16CE741B406D91202685998"
|
||||
PreviousTxnLgrSeq: 86722015
|
||||
}
|
||||
}
|
||||
4: {
|
||||
ModifiedNode: {
|
||||
FinalFields: {...}
|
||||
LedgerEntryType: "RippleState"
|
||||
LedgerIndex: "8250CE37F6495903C1F7D16E072E8823ECE06FA73F011A0F8D79D5626BF581BB"
|
||||
PreviousFields: {...}
|
||||
PreviousTxnID: "B4726FC087FAB3DB3578A34095B96F9055075A86A16CE741B406D91202685998"
|
||||
PreviousTxnLgrSeq: 86722015
|
||||
}
|
||||
}
|
||||
5: {
|
||||
ModifiedNode: {
|
||||
FinalFields: {...}
|
||||
LedgerEntryType: "AccountRoot"
|
||||
LedgerIndex: "9D398F1DEA77448C78196D6B01289A13D32DFCB4F9023A2A06338F893FA85521"
|
||||
PreviousFields: {...}
|
||||
PreviousTxnID: "DCB061EC44BBF73BBC20CE0432E9D8D7C4B8B28ABA8AE5A5BA687476E7A796EF"
|
||||
PreviousTxnLgrSeq: 86724050
|
||||
}
|
||||
}
|
||||
6: {
|
||||
DeletedNode: {
|
||||
FinalFields: {...}
|
||||
LedgerEntryType: "DirectoryNode"
|
||||
LedgerIndex: "DFA3B6DDAB58C7E8E5D944E736DA4B7046C30E4F460FD9DE4E1566CBCC208000"
|
||||
}
|
||||
}
|
||||
]
|
||||
TransactionIndex: 5
|
||||
TransactionResult: "tesSUCCESS"
|
||||
}
|
||||
```
|
||||
|
||||
## AffectedNodes
|
||||
|
||||
@@ -36,34 +105,34 @@ The value of each of these fields is a JSON object describing the changes made t
|
||||
|
||||
A `CreatedNode` object contains the following fields:
|
||||
|
||||
| Field | Value | Description |
|
||||
|:------------------|:------------------|:-------------------------------------|
|
||||
| `LedgerEntryType` | String | The [type of ledger entry](../ledger-data/ledger-entry-types/index.md) that was created. |
|
||||
| Field | Value | Description |
|
||||
| :---------------- | :---------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `LedgerEntryType` | String | The [type of ledger entry](../ledger-data/ledger-entry-types/index.md) that was created. |
|
||||
| `LedgerIndex` | String - [Hash][] | The [ID of this ledger entry](../ledger-data/common-fields.md) in the ledger's [state tree](../../../concepts/ledgers/index.md). **Note:** This is **not the same** as a [ledger index](../data-types/basic-data-types.md#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. |
|
||||
| `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](../ledger-data/ledger-entry-types/index.md) that was deleted. |
|
||||
| Field | Value | Description |
|
||||
| :---------------- | :---------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `LedgerEntryType` | String | The [type of ledger entry](../ledger-data/ledger-entry-types/index.md) that was deleted. |
|
||||
| `LedgerIndex` | String - [Hash][] | The [ID of this ledger entry](../ledger-data/common-fields.md) in the ledger's [state tree](../../../concepts/ledgers/index.md). **Note:** This is **not the same** as a [ledger index](../data-types/basic-data-types.md#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. |
|
||||
| `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](../ledger-data/ledger-entry-types/index.md) that was modified. |
|
||||
| `LedgerIndex` | String - [Hash][] | The [ID of this ledger entry](../ledger-data/common-fields.md) in the ledger's [state tree](../../../concepts/ledgers/index.md). **Note:** This is **not the same** as a [ledger index](../data-types/basic-data-types.md#ledger-index), even though the field name is very similar. |
|
||||
| Field | Value | Description |
|
||||
| :------------------ | :------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `LedgerEntryType` | String | The [type of ledger entry](../ledger-data/ledger-entry-types/index.md) that was modified. |
|
||||
| `LedgerIndex` | String - [Hash][] | The [ID of this ledger entry](../ledger-data/common-fields.md) in the ledger's [state tree](../../../concepts/ledgers/index.md). **Note:** This is **not the same** as a [ledger index](../data-types/basic-data-types.md#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. |
|
||||
| `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.
|
||||
|
||||
@@ -71,11 +140,11 @@ A `ModifiedNode` object contains the following 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](../data-types/nftoken.md#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 `OfferID`of a new `NFTokenOffer` in a response from a `NFTokenCreateOffer` transaction. |
|
||||
| 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](../data-types/nftoken.md#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 `OfferID`of a new `NFTokenOffer` in a response from a `NFTokenCreateOffer` transaction. |
|
||||
|
||||
## delivered_amount
|
||||
|
||||
|
||||
Reference in New Issue
Block a user