tx format: Clarify no-op tfImmediateOrCancel/tfFillOrKill OfferCreates

This commit is contained in:
mDuo13
2017-08-31 17:53:21 -07:00
parent 401491ea1e
commit 5f311cc65a
2 changed files with 3 additions and 0 deletions

View File

@@ -738,6 +738,8 @@ The following invalid flag combination prompts a `temINVALID_FLAG` error:
* tfImmediateOrCancel and tfFillOrKill
**Note:** When an OfferCreate uses tfImmediateOrCancel or tfFillOrKill and the offer cannot be executed when placed, the transaction may conclude "successfully" without trading any currency or having any effect on the order books. In this case, the transaction has the [result code](#result-categories) `tesSUCCESS`, it pays the [transaction cost](concept-transaction-cost.html) and uses up a `Sequence` number, but has no other effect.
## Payment ##

View File

@@ -1220,6 +1220,7 @@
<ul>
<li>tfImmediateOrCancel and tfFillOrKill</li>
</ul>
<p class="devportal-callout note"><strong>Note:</strong> When an OfferCreate uses tfImmediateOrCancel or tfFillOrKill and the offer cannot be executed when placed, the transaction may conclude "successfully" without trading any currency or having any effect on the order books. In this case, the transaction has the <a href="#result-categories">result code</a> <code>tesSUCCESS</code>, it pays the <a href="concept-transaction-cost.html">transaction cost</a> and uses up a <code>Sequence</code> number, but has no other effect.</p>
<h2 id="payment">Payment</h2>
<p><a href="https://github.com/ripple/rippled/blob/5425a90f160711e46b2c1f1c93d68e5941e4bfb6/src/ripple/app/transactors/Payment.cpp" title="Source">[Source]<br/></a></p>
<p>A Payment transaction represents a transfer of value from one account to another. (Depending on the path taken, this can involve additional exchanges of value, which occur atomically.)</p>