From a2861de1d2db8ac279d1f136e000f2b3353f807a Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Wed, 24 Apr 2019 16:34:28 -0700 Subject: [PATCH] Tx Metadata: Edits per peer reviews --- content/_snippets/tx-metadata-field-table.md | 6 +++--- .../rippled-api/transaction-formats/transaction-metadata.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/_snippets/tx-metadata-field-table.md b/content/_snippets/tx-metadata-field-table.md index 831a4e3412..f66f44492f 100644 --- a/content/_snippets/tx-metadata-field-table.md +++ b/content/_snippets/tx-metadata-field-table.md @@ -1,7 +1,7 @@ | Field | Value | Description | |:----------------------------------------|:--------------------|:-------------| | `AffectedNodes` | Array | List of [ledger objects](ledger-object-types.html) that were created, deleted, or modified by this transaction, and specific changes to each. | -| `DeliveredAmount` | [Currency Amount][] | _(May be omitted)_ For a [partial payment](partial-payments.html), this field records the amount of currency actually delivered to the destination. For more convenient processing, instead use the `delivered_amount` field, which is provided for all Payment transactions, partial or not. | -| `TransactionIndex` | Unsigned Integer | The transaction's position within the ledger that included it. This is zero-indexed. (For example, the value `2` means it was the 3nd transaction in that ledger.) | +| `DeliveredAmount` | [Currency Amount][] | _(May be omitted)_ For a [partial payment](partial-payments.html), this field records the amount of currency actually delivered to the destination. To avoid errors when reading transactions, instead use the `delivered_amount` field, which is provided for all Payment transactions, partial or not. | +| `TransactionIndex` | Unsigned Integer | The transaction's position within the ledger that included it. This is zero-indexed. (For example, the value `2` means it was the 3rd transaction in that ledger.) | | `TransactionResult` | String | A [result code](transaction-results.html) indicating whether the transaction succeeded or how it failed. | -| [`delivered_amount`](#delivered-amount) | [Currency Amount][] | The [Currency Amount][] actually received by the `Destination` account. Use this field to determine how much was delivered, regardless of whether the transaction is a [partial payment](partial-payments.html). See below for details. [New in: rippled 0.27.0][] | +| [`delivered_amount`](#delivered-amount) | [Currency Amount][] | _(Omitted for non-Payment transactions)_ The [Currency Amount][] actually received by the `Destination` account. Use this field to determine how much was delivered, regardless of whether the transaction is a [partial payment](partial-payments.html). See [this description](transaction-metadata.html#delivered-amount) for details. [New in: rippled 0.27.0][] | diff --git a/content/references/rippled-api/transaction-formats/transaction-metadata.md b/content/references/rippled-api/transaction-formats/transaction-metadata.md index 650c1e8cdf..f68e174aae 100644 --- a/content/references/rippled-api/transaction-formats/transaction-metadata.md +++ b/content/references/rippled-api/transaction-formats/transaction-metadata.md @@ -24,7 +24,7 @@ The `AffectedNodes` array contains a complete list of the [objects in the ledger - `DeletedNode` indicates that the transaction removed an object from the ledger. - `ModifiedNode` indicates that the transaction modified an existing object in the ledger. -The value of each of these fields is an object describing the changes made to the object. +The value of each of these fields is a JSON object describing the changes made to the ledger object. ### CreatedNode Fields