-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Update tec-codes.md #3078
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Update tec-codes.md #3078
Conversation
In certain cases, future `tec` codes may have other side effects on the ledger. For example, `tecWASM_REJECTED` is expected to be able to modify the value of the (new) "Data" field in the Escrow ledger entry.
|
||
{% admonition type="warning" name="Caution" %}A transaction that provisionally failed with a `tec` code may still succeed or fail with a different code after being reapplied. The result is final when it appears in a validated ledger version. For more information, see [Finality of Results](../../../../concepts/transactions/finality-of-results/index.md) and [Reliable Transaction Submission](../../../../concepts/transactions/reliable-transaction-submission.md).{% /admonition %} | ||
{% admonition type="warning" name="Caution" %}A transaction that provisionally failed with a `tec` code may still succeed or fail with a different code after being reapplied. The result is final when it appears in a fully validated ledger version. For more information, see [Finality of Results](../../../../concepts/transactions/finality-of-results/index.md) and [Reliable Transaction Submission](../../../../concepts/transactions/reliable-transaction-submission.md).{% /admonition %} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are trying not to create confusion between "validated" and "fully validated" in the docs. They are the same. (However, one server issuing a validation vote for a ledger does not make it validated.)
@@ -2,18 +2,18 @@ | |||
html: tec-codes.html | |||
parent: transaction-results.html | |||
seo: | |||
description: tec codes indicate that the transaction failed, but it was applied to a ledger to deduct the transaction cost. | |||
description: tec codes indicate that the transaction did not succeed, but it deducted the transaction cost and it was applied to a ledger. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As long as we're here, we may as well clean up the mixed singular/plural here:
description: tec codes indicate that the transaction did not succeed, but it deducted the transaction cost and it was applied to a ledger. | |
description: A tec result code indicates that the transaction did not succeed, but it deducted the transaction cost and it was applied to a ledger. |
labels: | ||
- Transaction Sending | ||
--- | ||
# tec Codes | ||
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/protocol/impl/TER.cpp "Source") | ||
|
||
These codes indicate that the transaction failed, but it was applied to a ledger to apply the [transaction cost](../../../../concepts/transactions/transaction-cost.md). They have numerical values in the range 100 to 199. It is recommended to use the text code, not the numeric value. | ||
These codes indicate that the transaction did not succeed, but it was applied to a ledger to apply the [transaction cost](../../../../concepts/transactions/transaction-cost.md) and may have had other side effects to the ledger. The `tec` codes have numerical values in the range 100 to 199. It is recommended to use the text code, not the numeric value. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it's necessary to state this here and in the following paragraph.
|
||
Transactions with `tec` codes destroy the XRP paid as a [transaction cost](../../../../concepts/transactions/transaction-cost.md), and consume a [sequence number](../../data-types/basic-data-types.md#account-sequence). For the most part, the transactions take no other action, but there are some exceptions. For example, a transaction that results in `tecOVERSIZE` still cleans up some [unfunded offers](../../../../concepts/tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer). Always look at the [transaction metadata](../metadata.md) to see precisely what a transaction did. | ||
Transactions with `tec` codes destroy the XRP paid as a [transaction cost](../../../../concepts/transactions/transaction-cost.md), and consume a [sequence number](../../data-types/basic-data-types.md#account-sequence). Although the transactions did not succeed, they sometimes have some other effect. For example, a transaction that results in `tecOVERSIZE` still cleans up some [unfunded offers](../../../../concepts/tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer). Always look at the [transaction metadata](../metadata.md) to see precisely what a transaction did. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This feels like it might be too much in the other direction—not making it clear that the default expectation for a tec
code is to make minimal, bookkeeping changes only.
Transactions with `tec` codes destroy the XRP paid as a [transaction cost](../../../../concepts/transactions/transaction-cost.md), and consume a [sequence number](../../data-types/basic-data-types.md#account-sequence). Although the transactions did not succeed, they sometimes have some other effect. For example, a transaction that results in `tecOVERSIZE` still cleans up some [unfunded offers](../../../../concepts/tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer). Always look at the [transaction metadata](../metadata.md) to see precisely what a transaction did. | |
A transaction that fails with a `tec` code destroys the XRP paid as a [transaction cost](../../../../concepts/transactions/transaction-cost.md) and consumes a [sequence number](../../data-types/basic-data-types.md#account-sequence). Although the transaction did not succeed, it may also cause some bookkeeping or cleanup work to be done. For example, a transaction that results in `tecOVERSIZE` still removes some [unfunded offers](../../../../concepts/tokens/decentralized-exchange/offers.md#lifecycle-of-an-offer). Always look at the [transaction metadata](../metadata.md) to see precisely what a transaction did. |
In certain cases, future
tec
codes may have other side effects on the ledger. For example,tecWASM_REJECTED
is expected to be able to modify the value of the (new) "Data" field in the Escrow ledger entry.