diff --git a/docs/_snippets/common-links.md b/docs/_snippets/common-links.md index 9e9072a767..76d10b515a 100644 --- a/docs/_snippets/common-links.md +++ b/docs/_snippets/common-links.md @@ -96,6 +96,7 @@ [DID entry]: /docs/references/protocol/ledger-data/ledger-entry-types/did.md [DIDエントリ]: /docs/references/protocol/ledger-data/ledger-entry-types/did.md [DeletableAccounts amendment]: /resources/known-amendments.md#deletableaccounts +[DeepFreeze amendment]: /resources/known-amendments.md#deepfreeze [DepositAuth amendment]: /resources/known-amendments.md#depositauth [DepositPreauth amendment]: /resources/known-amendments.md#depositpreauth [DepositPreauth entry]: /docs/references/protocol/transactions/types/depositpreauth.md diff --git a/docs/concepts/tokens/fungible-tokens/deep-freeze.md b/docs/concepts/tokens/fungible-tokens/deep-freeze.md index 7b06db2a7c..7f5dc2ea18 100644 --- a/docs/concepts/tokens/fungible-tokens/deep-freeze.md +++ b/docs/concepts/tokens/fungible-tokens/deep-freeze.md @@ -11,6 +11,8 @@ Deep Freeze lets token issuers on the XRP Ledger prevent token misuse by frozen Deep Freeze impacts trust lines that interact with payments, offers, DEX, and AMM. Issuers can block sending and receiving of funds for holders in deep freeze. +_(Requires the [DeepFreeze amendment][] {% not-enabled /%})_ + ## Deep Freeze Mechanism Deep Freeze is a setting on a trust line. It requires that the issuer implement a standard freeze on the trust line before enacting a deep freeze. The issuer cannot enact a deep freeze if they have enabled `No Freeze` on their account. diff --git a/resources/known-amendments.md b/resources/known-amendments.md index 1de9169fee..f08956e138 100644 --- a/resources/known-amendments.md +++ b/resources/known-amendments.md @@ -17,6 +17,7 @@ This list is updated manually. For a live view of amendment voting, see the Amen | Name | Introduced | Status | |:----------------------------------|:-----------|:------------------------------| +| [DeepFreeze][] | v2.4.0 | {% badge href="https://xrpl.org/blog/2025/rippled-2.4.0" %}Open for Voting: 2025-03-05{% /badge %} | | [PermissionedDomains][] | v2.4.0 | {% badge href="https://xrpl.org/blog/2025/rippled-2.4.0" %}Open for Voting: 2025-03-05{% /badge %} | | [fixFrozenLPTokenTransfer][] | v2.4.0 | {% badge href="https://xrpl.org/blog/2025/rippled-2.4.0" %}Open for Voting: 2025-03-05{% /badge %} | | [fixInvalidTxFlags][] | v2.4.0 | {% badge href="https://xrpl.org/blog/2025/rippled-2.4.0" %}Open for Voting: 2025-03-05{% /badge %} | @@ -301,6 +302,26 @@ This amendment was intended to add support for several types of crypto-condition However, the amendment was added to `rippled` v0.60.0 before implementation was complete. As a result, this amendment ID refers to incomplete code which does almost nothing. Modifying the existing amendment to add support for other crypto-conditions would cause a conflict with old versions of the amendment already in released software. If a future release adds support for additional crypto-conditions, it must use a new and different amendment ID. +### DeepFreeze +[DeepFreeze]: #deepfreeze + +| Amendment | DeletableAccounts | +|:-------------|:------------------| +| Amendment ID | DAF3A6EB04FA5DC51E8E4F23E9B7022B693EFA636F23F22664746C77B5786B23 | +| Status | Enabled | +| Default Vote (Latest stable release) | No | +| Pre-amendment functionality retired? | No | + +This amendment enables issuers to deep freeze trustlines from interacting with payments, offers, AMMs, and the DEX. This prevents deep frozen accounts from sending and receiving frozen assets. With this amendment, four new flags are introduced: + +- `RippleState` flags: + - `lsfLowDeepFreeze` + - `lsfHighDeepFreeze` +- `TrustSet` flags: + - `tfSetDeepFreeze` + - `tfClearDeepFreeze` + + ### DeletableAccounts [DeletableAccounts]: #deletableaccounts diff --git a/sidebars.yaml b/sidebars.yaml index 74393eefad..223b87f61a 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -115,9 +115,9 @@ - page: docs/concepts/tokens/fungible-tokens/multi-purpose-tokens.md - page: docs/concepts/tokens/fungible-tokens/clawing-back-tokens.md - page: docs/concepts/tokens/fungible-tokens/freezes.md - - page: docs/concepts/tokens/fungible-tokens/deep-freeze.md expanded: false items: + - page: docs/concepts/tokens/fungible-tokens/deep-freeze.md - page: docs/concepts/tokens/fungible-tokens/common-misconceptions-about-freezes.md - page: docs/concepts/tokens/fungible-tokens/paths.md - page: docs/concepts/tokens/fungible-tokens/rippling.md