Skip to content

Commit 02c83f2

Browse files
committed
Change disclaimer to amendment link
1 parent 196ba7a commit 02c83f2

File tree

13 files changed

+38
-19
lines changed

13 files changed

+38
-19
lines changed

docs/_snippets/common-links.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@
187187
[LedgerHashesエントリ]: /docs/references/protocol/ledger-data/ledger-entry-types/ledgerhashes.md
188188
[LedgerHashesオブジェクト]: /docs/references/protocol/ledger-data/ledger-entry-types/ledgerhashes.md
189189
[Marker]: /docs/references/http-websocket-apis/api-conventions/markers-and-pagination.md
190+
[MPToken amendment]: /resources/known-amendments.md#mptokensv1
190191
[MultiSign amendment]: /resources/known-amendments.md#multisign
191192
[MultiSignReserve amendment]: /resources/known-amendments.md#multisignreserve
192193
[MultiSignReserveの修正]: /resources/known-amendments.md#multisignreserve

docs/concepts/tokens/fungible-tokens/multi-purpose-tokens.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ status: not_enabled
88
---
99
# Multi-purpose Tokens
1010

11-
{% partial file="/docs/_snippets/mpts-disclaimer.md" /%}
11+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
1212

1313
Multi-purpose tokens (MPTs) are a more compact and flexible type of fungible token.
1414

@@ -62,3 +62,5 @@ MPTs are intended to be complementary to IOUs. While there might be use cases w
6262
- [MPTokenIssuanceCreate](../../../references/protocol/transactions/types/mptokenissuancecreate.md)
6363
- [MPTokenIssuanceDestroy](../../../references/protocol/transactions/types/mptokenissuancedestroy.md)
6464
- [MPTokenIssuanceSet](../../../references/protocol/transactions/types/mptokenissuanceset.md)
65+
66+
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/http-websocket-apis/public-api-methods/clio-methods/mpt_holders.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ labels:
77

88
# mpt_holders
99

10-
{% partial file="/docs/_snippets/mpts-disclaimer.md" /%}
10+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
1111

1212
For a given `MPTokenIssuanceID` and ledger sequence, `mpt_holders` returns all holders of that MPT and their balance. This method likely returns very large data sets, so you should expect to implement paging via the `marker` field. This API is only available using Clio, not rippled.
1313

@@ -154,3 +154,5 @@ Example of an `account_objects` response:
154154
}
155155
}
156156
```
157+
158+
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -923,7 +923,9 @@ An example of a successful response:
923923

924924
{% /tabs %}
925925

926-
### Get MPT Issuance Object
926+
### Get MPT Issuance Object
927+
928+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
927929

928930
Return an `MPTokenIssuance` object.
929931

@@ -963,7 +965,9 @@ rippled json ledger_entry '{ "mpt_issuance": "000004C463C52827307480341125DA0577
963965

964966
[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-mpt_issuance)
965967

966-
### Get MPToken Object
968+
### Get MPToken Object
969+
970+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
967971

968972
Return an `MPToken` object.
969973

docs/references/protocol/ledger-data/ledger-entry-types/mptoken.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels:
55
---
66
# MPToken
77

8-
{% partial file="/docs/_snippets/mpts-disclaimer.md" /%}
8+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
99

1010
The `MPToken` object represents a number of tokens held by an account that is not the token issuer. MPTs are acquired via ordinary payment or DEX transactions, and can optionally be redeemed or exchanged using these same types of transactions. The object key of the MPToken is derived from hashing the space key, the holder's address, and the `MPTokenIssuanceID`.
1111

@@ -58,7 +58,7 @@ Flags are properties or other options associated with the `MPToken` object.
5858
| `lsfMPTAuthorized` | `0x00000002` | (Only applicable for allow-listing) If set, indicates that the issuer has authorized the holder for the MPT. This flag can be set using a `MPTokenAuthorize` transaction; it can also be "un-set" using a `MPTokenAuthorize` transaction specifying the `tfMPTUnauthorize` flag. |
5959

6060
<!--{# common link defs #}-->
61-
<!-- Uncomment for xrpl.org
6261
{% include '_snippets/rippled-api-links.md' %}
6362
{% include '_snippets/tx-type-links.md' %}
64-
{% include '_snippets/rippled_versions.md' %} -->
63+
{% include '_snippets/rippled_versions.md' %}
64+
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/protocol/ledger-data/ledger-entry-types/mptokenissuance.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ labels:
55
---
66
# MPTokenIssuance
77

8-
{% partial file="/docs/_snippets/mpts-disclaimer.md" /%}
8+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
99

1010
The `MPTokenIssuance` object represents a single MPT issuance and holds data associated with the issuance itself. Token issuances are created using the `MPTokenIssuanceCreate` transaction and can be destroyed by the `MPTokenIssuanceDestroy` transaction.
1111

@@ -90,9 +90,7 @@ Flags are properties or other options associated with the `MPToken` object. Exce
9090
| `lsfMPTCanTransfer` | `0x00000020` | If set, indicates that tokens held by non-issuers can be transferred to other accounts. If not set, indicates that tokens held by non-issuers cannot be transferred except back to the issuer; this enables use cases such as store credit. |
9191
| `lsfMPTCanClawback` | `0x00000040` | If set, indicates that the issuer may use the `Clawback` transaction to claw back value from individual holders. |
9292

93-
94-
<!--{# common link defs #}-->
95-
<!-- uncomment for xrpl.org
9693
{% include '_snippets/rippled-api-links.md' %}
9794
{% include '_snippets/tx-type-links.md' %}
98-
{% include '_snippets/rippled_versions.md' %} -->
95+
{% include '_snippets/rippled_versions.md' %}
96+
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/protocol/transactions/metadata.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,8 @@ Transactions (`tx` and `account_tx`) involving NFTs can contain the following fi
256256
| `offer_id` | String | Shows the `OfferID`of a new `NFTokenOffer` in a response from a `NFTokenCreateOffer` transaction. |
257257
## MPT Fields
258258

259+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
260+
259261
### Synthetic mpt_issuance_id field
260262
`MPTokenIssuanceID` is an identifier that allows you to specify an `MPTokenIssuance` in RPCs. The server adds a synthetically parsed `mpt_issuance_id` field to API responses to avoid the need for client-side parsing of the `MPTokenIssuanceID`.
261263

docs/references/protocol/transactions/types/clawback.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,14 @@ Clawback is disabled by default. To use clawback, you must send an [AccountSet t
3535
| Field | JSON Type | [Internal Type][] | Description |
3636
|:-------------------|:----------|:------------------|:------------------|
3737
| `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.|
38-
| `Holder` | string | AccountID | (Optional) Specifies the holder's address from which to claw back. The holder must already own an `MPToken` object with a non-zero balance. |
38+
| `Holder` | string | AccountID | (Optional) Specifies the holder's address from which to claw back. The holder must already own an `MPToken` object with a non-zero balance. _(Requires the [MPToken amendment][] {% not-enabled /%})_ |
3939

4040
{% admonition type="info" name="Note" %}For an IOU (trust line) 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.{% /admonition %}
4141

4242
{% admonition type="info" name="Note" %}To claw back funds from an MPT holder, the issuer must have specified that the MPT allows clawback by setting the `tfMPTCanClawback` flag when creating the MPT using the `MPTokenIssuanceCreate` transaction. Assuming an MPT was created with this flag set, clawbacks are allowed using the `Clawback` transaction.{% /admonition %}
4343

4444

45+
4546
## Error Cases
4647

4748
Besides errors that can occur for all transactions, {% $frontmatter.seo.title %} transactions can result in the following [transaction result codes](../transaction-results/index.md):
@@ -51,6 +52,6 @@ Besides errors that can occur for all transactions, {% $frontmatter.seo.title %}
5152
| `temDISABLED` | Occurs if the [Clawback amendment](/resources/known-amendments.md#clawback) is not enabled. |
5253
| `temBAD_AMOUNT` | Occurs if the holder's balance is 0. It is not an error if the amount exceeds the holder's balance; in that case, the maximum available balance is clawed back. Also occurs if the counterparty listed in `Amount` is the same as the `Account` issuing this transaction. |
5354
| `tecNO_LINE` | Occurs there is no trust line with the counterparty or that trust line's balance is 0. |
54-
| `tecNO_PERMISSION` | Occurs if you attempt to set `lsfAllowTrustlineClawback` while `lsfNoFreeze` is set. Also occurs, conversely, if you try to set `lsfNoFreeze` while `lsfAllowTrustLineClawback` is set. |
55+
| `tecNO_PERMISSION` | Occurs if you attempt to set `lsfAllowTrustlineClawback` while `lsfNoFreeze` is set. Also occurs, conversely, if you try to set `lsfNoFreeze` while `lsfAllowTrustLineClawback` is set. |
5556

5657
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/protocol/transactions/types/mptokenauthorize.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ labels:
99
# MPTokenAuthorize
1010
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenAuthorize.cpp "Source")
1111

12-
{% partial file="/docs/_snippets/mpts-disclaimer.md" /%}
12+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
1313

1414
This transaction enables an account to hold an amount of a particular MPT issuance. When applied successfully, it creates a new `MPToken` object with an initial zero balance, owned by the holder account.
1515

@@ -32,4 +32,6 @@ Transactions of the MPTokenAuthorize type support additional values in the Flags
3232

3333
| Flag Name | Hex Value | Decimal Value | Description |
3434
|:-------------------|:-------------|:--------------|:------------------------------|
35-
| `tfMPTUnauthorize` | `0x00000001` | 1 | If set, and transaction is submitted by a holder, it indicates that the holder no longer wants to hold the `MPToken`, which will be deleted as a result. If the holder's `MPToken` has a non-zero balance while trying to set this flag, the transaction fails. On the other hand, if set, and transaction is submitted by an issuer, it would mean that the issuer wants to unauthorize the holder (only applicable for allow-listing), which would unset the `lsfMPTAuthorized` flag on the `MPToken`. |
35+
| `tfMPTUnauthorize` | `0x00000001` | 1 | If set, and transaction is submitted by a holder, it indicates that the holder no longer wants to hold the `MPToken`, which will be deleted as a result. If the holder's `MPToken` has a non-zero balance while trying to set this flag, the transaction fails. On the other hand, if set, and transaction is submitted by an issuer, it would mean that the issuer wants to unauthorize the holder (only applicable for allow-listing), which would unset the `lsfMPTAuthorized` flag on the `MPToken`. |
36+
37+
{% raw-partial file="/docs/_snippets/common-links.md" /%}

docs/references/protocol/transactions/types/mptokenissuancecreate.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ labels:
99
# MPTokenIssuanceCreate
1010
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/MPTokenIssuanceCreate.cpp "Source")
1111

12-
{% partial file="/docs/_snippets/mpts-disclaimer.md" /%}
12+
_(Requires the [MPToken amendment][] {% not-enabled /%})_
1313

1414
The `MPTokenIssuanceCreate` transaction creates an MPTokenIssuance <!--[MPTokenIssuance](mptokenissuance.html)--> object and adds it to the relevant directory node of the creator account. This transaction is the only opportunity an issuer has to specify any token fields that are defined as immutable (for example, MPT Flags).
1515

@@ -61,3 +61,4 @@ Transactions of the MPTokenIssuanceCreate type support additional values in the
6161
| `tfMPTCanTransfer` | `0x00000020` | `32` | If set, indicates that tokens can be transferred to other accounts that are not the issuer. |
6262
| `tfMPTCanClawback` | `0x00000040` | `64` | If set, indicates that the issuer can use the Clawback transaction to claw back value from individual holders. |
6363

64+
{% raw-partial file="/docs/_snippets/common-links.md" /%}

0 commit comments

Comments
 (0)