ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-16 01:35:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add DepositPreauth information to known amendments and depositauth pages

Browse Source
This commit is contained in:
mDuo13
2018-07-18 15:32:08 -07:00
parent 22fbc74e36
commit 693f7e6493
3 changed files with 59 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
content/_snippets/depositauth-semantics-table.html
View File

@@ -10,17 +10,17 @@
<th>Transaction Type</th>
<th>Sent by Destination</th><th>Sent by Others</th>
<th class="depauth-spacer">&nbsp;</th>
<th>Sent by Destination</th><th>Sent by Others</th>
<th>Sent by Destination</th><th>Sent by Others</th><th>Sent by Preauthorized Others</th>
</tr>
</thead>
<tbody>
<tr>
<td class="depauth-txtype">AccountSet</td>
<td colspan="5" class="depauth-na">(This transaction type never sends money.)</td>
<td colspan="6" class="depauth-na">(This transaction type never sends money.)</td>
</tr>
<tr>
<td class="depauth-txtype">CheckCancel</td>
<td colspan="5" class="depauth-na">(This transaction type never sends money.)</td>
<td colspan="6" class="depauth-na">(This transaction type never sends money.)</td>
</tr>
<tr>
<td class="depauth-txtype">CheckCash</td>
@@ -29,18 +29,19 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-ok">OK</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-no">No Permission</td>
</tr>
<tr>
<td class="depauth-txtype">CheckCreate</td>
<td colspan="5" class="depauth-na">(This transaction type never sends money.)</td>
<td colspan="6" class="depauth-na">(This transaction type never sends money.)</td>
</tr>
<tr>
<td class="depauth-txtype">EscrowCancel</td>
<td class="depauth-maybe" colspan="5">Can return XRP from an expired escrow</td>
<td class="depauth-maybe" colspan="6">Can return XRP from an expired escrow</td>
</tr>
<tr>
<td class="depauth-txtype">EscrowCreate</td>
<td colspan="5" class="depauth-na">(This transaction type can only debit XRP, not credit it.)</td>
<td colspan="6" class="depauth-na">(This transaction type can only debit XRP, not credit it.)</td>
</tr>
<tr>
<td class="depauth-txtype">EscrowFinish</td>
@@ -49,10 +50,11 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-ok">OK</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-ok">OK</td>
</tr>
<tr>
<td class="depauth-txtype">OfferCancel</td>
<td colspan="5" class="depauth-na">This transaction type never sends money.</td>
<td colspan="6" class="depauth-na">This transaction type never sends money.</td>
</tr>
<tr>
<td class="depauth-txtype">OfferCreate</td>
@@ -61,6 +63,7 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-ok">OK</td>
<td class="depauth-maybe">Only if account previously created a matching offer</td>
<td class="depauth-maybe">Only if account previously created a matching offer</td>
</tr>
<tr>
<td class="depauth-txtype">Payment <div class="depauth-subtype">(If account has more than the minimum XRP reserve, enables NoRipple on all trust lines, and places no offers)</div></td>
@@ -69,6 +72,7 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-ok">OK</td>
</tr>
<tr>
<td class="depauth-txtype">Payment <div class="depauth-subtype">(If account XRP balance is below the minimum XRP reserve)</div></td>
@@ -77,6 +81,7 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-maybe">XRP payments up to the minimum reserve</td>
<td class="depauth-ok">OK</td>
</tr>
<tr>
<td class="depauth-txtype">Payment <div class="depauth-subtype">(If account has any trust lines with NoRipple disabled)</div></td>
@@ -85,6 +90,7 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-maybe">Balance changes from rippling</td>
<td class="depauth-ok">OK</td>
</tr>
<tr>
<td class="depauth-txtype">Payment <div class="depauth-subtype">(If account has placed offers)</div></td>
@@ -93,6 +99,7 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-maybe">Balance changes from executing offers</td>
<td class="depauth-ok">OK</td>
</tr>
<tr>
<td class="depauth-txtype">PaymentChannelClaim</td>
@@ -101,26 +108,27 @@
<td class="depauth-spacer">&nbsp;</td>
<td class="depauth-ok">OK</td>
<td class="depauth-no">No Permission</td>
<td class="depauth-ok">OK</td>
</tr>
<tr>
<td class="depauth-txtype">PaymentChannelCreate</td>
<td colspan="5" class="depauth-na">(This transaction type can only debit XRP, not credit it.)</td>
<td colspan="6" class="depauth-na">(This transaction type can only debit XRP, not credit it.)</td>
</tr>
<tr>
<td class="depauth-txtype">PaymentChannelFund</td>
<td class="depauth-maybe" colspan="5">Can return XRP when closing a channel created by self</td>
<td class="depauth-maybe" colspan="6">Can return XRP when closing a channel created by self</td>
</tr>
<tr>
<td class="depauth-txtype">SetRegularKey</td>
<td colspan="5" class="depauth-na">(This transaction type never sends money.)</td>
<td colspan="6" class="depauth-na">(This transaction type never sends money.)</td>
</tr>
<tr>
<td class="depauth-txtype">SignerListSet</td>
<td colspan="5" class="depauth-na">(This transaction type never sends money.)</td>
<td colspan="6" class="depauth-na">(This transaction type never sends money.)</td>
</tr>
<tr>
<td class="depauth-txtype">TrustSet</td>
<td colspan="5" class="depauth-na">(This transaction type never sends money.)</td>
<td colspan="6" class="depauth-na">(This transaction type never sends money.)</td>
</tr>
</table>

31
content/concepts/payment-system-basics/accounts/depositauth.md
View File

@@ -24,12 +24,17 @@ To get the full effect of Deposit Authorization, Ripple recommends also doing th
## Precise Semantics
An account with Deposit Authorization enabled:x
An account with Deposit Authorization enabled:
- **Cannot** be the destination of [Payment transactions][], with **one exception**:
- **Cannot** be the destination of [Payment transactions][], with **the following exceptions**:
- If the account's XRP balance is equal to or below the minimum account [reserve requirement](reserves.html), it can be the destination of an XRP Payment whose `Amount` is equal or less than the minimum account reserve (currently 20 XRP). This is to prevent an account from becoming "stuck" by being unable to send transactions but also unable to receive XRP. The account's owner reserve does not matter for this case.
- Can receive XRP from [PaymentChannelClaim transactions][] **only if** the sender of the PaymentChannelClaim transaction is the destination of the payment channel.
- Can receive XRP from [EscrowFinish transactions][] **only if** the sender of the EscrowFinish transaction is the destination of the escrow.
- If the destination has [preauthorized](#preauthorization) the sender of the Payment. _(Requires the [DepositPreauth amendment][])_
- Can receive XRP from [PaymentChannelClaim transactions][] **only in the following cases**:
- The sender of the PaymentChannelClaim transaction is the destination of the payment channel.
- The destination of the PaymentChannelClaim transaction has [preauthorized](#preauthorization) the sender of the PaymentChannelClaim. _(Requires the [DepositPreauth amendment][])_
- Can receive XRP from [EscrowFinish transactions][] **only in the following cases**:
- The sender of the EscrowFinish transaction is the destination of the escrow.
- The destination of the EscrowFinish transaction has [preauthorized](#preauthorization) the sender of the EscrowFinish. _(Requires the [DepositPreauth amendment][])_
- **Can** receive XRP or issued currencies by sending a [CheckCash][] transaction. _(Requires the [Checks amendment](known-amendments.html#checks).)_
- **Can** receive XRP or issued currencies by sending [OfferCreate transactions][].
- If the account sends an OfferCreate transaction that is not fully executed immediately, it **can** receive the remainder of the ordered XRP or issued currency later when the offer is consumed by other accounts' [Payment][] and [OfferCreate][] transactions.
@@ -55,6 +60,23 @@ To see whether an account has Deposit Authorization enabled, use the [account_in
If the result of the `Flags` value bitwise-AND the `lsfDepositAuth` flag value (0x01000000) is nonzero, then the account has DepositAuth enabled. If the result is zero, then the account has DepositAuth disabled.
## Preauthorization
_(Requires the [DepositPreauth amendment][])_
Accounts with DepositAuth enabled can _preauthorize_ certain senders, to allow payments from those senders to succeed even with DepositAuth enabled. This allows specific senders to send funds directly without the receiver taking action on each transaction individually. Preauthorization is not required to use DepositAuth, but can make certain operations more convenient.
To preauthorize a particular sender, send a DepositPreauth transaction <!--{# TODO: link when the transaction reference is updated #}--> with the address of another account to preauthorize in the `Authorize` field. To revoke preauthorization, provide the other account's address in the `Unauthorize` field instead. Specify your own address in the `Account` field as usual. You can preauthorize or unauthorize accounts even if you do not currently have DepositAuth enabled; the preauthorization status you set for other accounts is saved, but has no effect unless you enable DepositAuth. An account cannot preauthorize itself.
Preauthorizing another account adds an object to the ledger, which increases the [owner reserve](reserves.html#owner-reserves) of the account providing the authorization. If the account revokes this preauthorization, doing so removes the object and the reserve decreases accordingly.
After the DepositPreauth transaction has been processed, the authorized account can send funds to your account, even if you have DepositAuth enabled, using any of the following transaction types:
- [Payment][]
- [EscrowFinish][]
- [PaymentChannelClaim][]
## See Also
- The [Authorized Trust Lines](authorized-trust-lines.html) feature (`RequireAuth` flag) limits which counterparties can hold non-XRP currencies issued by an account.
@@ -63,6 +85,7 @@ If the result of the `Flags` value bitwise-AND the `lsfDepositAuth` flag value (
- [Partial Payments](partial-payments.html) provide a way for accounts to return unwanted payments while subtracting [transfer fees](transfer-fees.html) and exchange rates from the amount delivered instead of adding them to the amount sent.
<!--{# common link defs #}-->
[DepositPreauth amendment]: known-amendments.html#depositpreauth
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

13
content/news/known-amendments.md
View File

@@ -5,6 +5,7 @@ The following is a comprehensive list of all known amendments and their status o
| Name | Introduced | Status |
|:--------------------------|:-----------|:------------------------------------|
| [DepositPreauth][] | v1.1.0 | [Planned: TBD]( "BADGE_LIGHTGREY") |
| [Checks][] | v0.90.0 | [Planned: TBD]( "BADGE_LIGHTGREY") |
| [FlowCross][] | v0.70.0 | [Planned: TBD]( "BADGE_LIGHTGREY") |
| [CryptoConditionsSuite][] | TBD | [Planned: TBD]( "BADGE_LIGHTGREY") |
@@ -90,7 +91,17 @@ As an exception, accounts with `DepositAuth` enabled can receive Payment transac
Also fixes a bug in the EscrowCreate and PaymentChannelCreate transactions where they mistakenly enforced the DisallowXRP flag, which is meant to be a non-binding advisory flag. (By not enforcing DisallowXRP in the ledger itself an account can still receive the necessary XRP to meet its [account reserve](reserves.html) and pay [transaction costs](transaction-cost.html).)
**Caution:** This amendment is [in development](https://github.com/ripple/rippled/pull/2239) and is expected for `rippled` v0.90.0.
## DepositPreauth
[DepositPreauth]: #depositpreauth
| Amendment ID | Status |
|:-----------------------------------------------------------------|:----------|
| 3CBC5C4E630A1B82380295CDA84B32B49DD066602E74E39B85EF64137FA65194 | In Development |
Provides users of [deposit authorization](depositauth.html) with a way to preauthorize specific senders so those senders are allowed to send payments directly.
Adds a new transaction type, DepositPreauth for adding or removing preauthorization, and a DepositPreauth ledger object type for tracking preauthorizations from one account to another. Adds a JSON-RPC command, `deposit_authorized`, to query whether an account is authorized to send payments directly to another.
## EnforceInvariants