From 0736841ea715d51fda7b2bd2285cbd3a093667c9 Mon Sep 17 00:00:00 2001 From: Rome Reginelli Date: Mon, 9 Oct 2023 10:22:45 -0700 Subject: [PATCH 1/2] Clarify issuer note The Clawback page had some "in this specification" language that was copied from the XLS spec, and was confusing in the new location. This rewrite should clarify. --- .../transactions/transaction-types/clawback.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/references/protocol-reference/transactions/transaction-types/clawback.md b/content/references/protocol-reference/transactions/transaction-types/clawback.md index 72c99e3193..7983dd2570 100644 --- a/content/references/protocol-reference/transactions/transaction-types/clawback.md +++ b/content/references/protocol-reference/transactions/transaction-types/clawback.md @@ -13,7 +13,7 @@ labels: Claw back tokens issued by your account. -Clawback is disabled by default. To use clawback, you must send an [AccountSet transaction][] to enable the **Allow Trust Line Clawback** setting. An issuer with any existing tokens cannot enable Clawback. You can only enable **Allow Trust Line Clawback** if you have a completely empty owner directory, meaning you must do so before you set up any trust lines, offers, escrows, payment channels, checks, or signer lists. After you enable Clawback, it cannot reverted: the account permanently gains the ability to claw back issued assets on trust lines. +Clawback is disabled by default. To use clawback, you must send an [AccountSet transaction][] to enable the **Allow Trust Line Clawback** setting. An issuer with any existing tokens cannot enable Clawback. You can only enable **Allow Trust Line Clawback** if you have a completely empty owner directory, meaning you must do so before you set up any trust lines, offers, escrows, payment channels, checks, or signer lists. After you enable Clawback, it cannot reverted: the account permanently gains the ability to claw back issued assets on trust lines. ## Example {{currentpage.name}} JSON @@ -35,7 +35,7 @@ Clawback is disabled by default. To use clawback, you must send an [AccountSet t |:-------------------|:----------|:------------------|:------------------| | `Amount` | [Currency Amount][] | Amount |Indicates the amount being clawed back, as well as the counterparty from which the amount is being clawed back. The quantity to claw back, in the `value` sub-field, must not be zero. If this is more than the current balance, the transaction claws back the entire balance. The sub-field `issuer` within `Amount` represents the token holder's account ID, rather than the issuer's.| -The account executing this transaction must be the issuer of the asset being clawed back. Note that in the XRP Ledger, trust lines are bidirectional and, under some configurations, both sides can be seen as the *issuer* of an asset. In this specification, the term *issuer* is used to mean the side of the trust line that has an outstanding balance (that is, 'owes' the issued asset) that it wants to claw back. +**Note:** The XRP Ledger, the party that created a token is called the _issuer_, but trust lines are bidirectional and, under some configurations, both sides can be seen as the issuer. In this transaction, the token issuer's address is in the `Account` field, and the token holder's address is in the `Amount` field's `issuer` sub-field. ## Error Cases From 8d214553b41eee157839f6149c762c5d427e4aae Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Mon, 9 Oct 2023 15:41:54 -0700 Subject: [PATCH 2/2] Clawback note: fix typo --- .../transactions/transaction-types/clawback.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/references/protocol-reference/transactions/transaction-types/clawback.md b/content/references/protocol-reference/transactions/transaction-types/clawback.md index 7983dd2570..65a2a385a4 100644 --- a/content/references/protocol-reference/transactions/transaction-types/clawback.md +++ b/content/references/protocol-reference/transactions/transaction-types/clawback.md @@ -13,7 +13,7 @@ labels: Claw back tokens issued by your account. -Clawback is disabled by default. To use clawback, you must send an [AccountSet transaction][] to enable the **Allow Trust Line Clawback** setting. An issuer with any existing tokens cannot enable Clawback. You can only enable **Allow Trust Line Clawback** if you have a completely empty owner directory, meaning you must do so before you set up any trust lines, offers, escrows, payment channels, checks, or signer lists. After you enable Clawback, it cannot reverted: the account permanently gains the ability to claw back issued assets on trust lines. +Clawback is disabled by default. To use clawback, you must send an [AccountSet transaction][] to enable the **Allow Trust Line Clawback** setting. An issuer with any existing tokens cannot enable Clawback. You can only enable **Allow Trust Line Clawback** if you have a completely empty owner directory, meaning you must do so before you set up any trust lines, offers, escrows, payment channels, checks, or signer lists. After you enable Clawback, it cannot reverted: the account permanently gains the ability to claw back issued assets on trust lines. ## Example {{currentpage.name}} JSON @@ -35,7 +35,7 @@ Clawback is disabled by default. To use clawback, you must send an [AccountSet t |:-------------------|:----------|:------------------|:------------------| | `Amount` | [Currency Amount][] | Amount |Indicates the amount being clawed back, as well as the counterparty from which the amount is being clawed back. The quantity to claw back, in the `value` sub-field, must not be zero. If this is more than the current balance, the transaction claws back the entire balance. The sub-field `issuer` within `Amount` represents the token holder's account ID, rather than the issuer's.| -**Note:** The XRP Ledger, the party that created a token is called the _issuer_, but trust lines are bidirectional and, under some configurations, both sides can be seen as the issuer. In this transaction, the token issuer's address is in the `Account` field, and the token holder's address is in the `Amount` field's `issuer` sub-field. +**Note:** In the XRP Ledger, the party that created a token is called the _issuer_, but trust lines are bidirectional and, under some configurations, both sides can be seen as the issuer. In this transaction, the token issuer's address is in the `Account` field, and the token holder's address is in the `Amount` field's `issuer` sub-field. ## Error Cases