Skip to content

Commit a5da13c

Browse files
committed
update deep freeze docs
1 parent 43b53b8 commit a5da13c

File tree

4 files changed

+25
-1
lines changed

4 files changed

+25
-1
lines changed

docs/_snippets/common-links.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@
9696
[DID entry]: /docs/references/protocol/ledger-data/ledger-entry-types/did.md
9797
[DIDエントリ]: /docs/references/protocol/ledger-data/ledger-entry-types/did.md
9898
[DeletableAccounts amendment]: /resources/known-amendments.md#deletableaccounts
99+
[DeepFreeze amendment]: /resources/known-amendments.md#deepfreeze
99100
[DepositAuth amendment]: /resources/known-amendments.md#depositauth
100101
[DepositPreauth amendment]: /resources/known-amendments.md#depositpreauth
101102
[DepositPreauth entry]: /docs/references/protocol/transactions/types/depositpreauth.md

docs/concepts/tokens/fungible-tokens/deep-freeze.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Deep Freeze lets token issuers on the XRP Ledger prevent token misuse by frozen
1111

1212
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.
1313

14+
_(Requires the [DeepFreeze amendment][] {% not-enabled /%})_
15+
1416
## Deep Freeze Mechanism
1517

1618
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.

resources/known-amendments.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This list is updated manually. For a live view of amendment voting, see the Amen
1717

1818
| Name | Introduced | Status |
1919
|:----------------------------------|:-----------|:------------------------------|
20+
| [DeepFreeze][] | v2.4.0 | {% badge href="https://xrpl.org/blog/2025/rippled-2.4.0" %}Open for Voting: 2025-03-05{% /badge %} |
2021
| [PermissionedDomains][] | v2.4.0 | {% badge href="https://xrpl.org/blog/2025/rippled-2.4.0" %}Open for Voting: 2025-03-05{% /badge %} |
2122
| [fixFrozenLPTokenTransfer][] | v2.4.0 | {% badge href="https://xrpl.org/blog/2025/rippled-2.4.0" %}Open for Voting: 2025-03-05{% /badge %} |
2223
| [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
301302
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.
302303

303304

305+
### DeepFreeze
306+
[DeepFreeze]: #deepfreeze
307+
308+
| Amendment | DeletableAccounts |
309+
|:-------------|:------------------|
310+
| Amendment ID | DAF3A6EB04FA5DC51E8E4F23E9B7022B693EFA636F23F22664746C77B5786B23 |
311+
| Status | Enabled |
312+
| Default Vote (Latest stable release) | No |
313+
| Pre-amendment functionality retired? | No |
314+
315+
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:
316+
317+
- `RippleState` flags:
318+
- `lsfLowDeepFreeze`
319+
- `lsfHighDeepFreeze`
320+
- `TrustSet` flags:
321+
- `tfSetDeepFreeze`
322+
- `tfClearDeepFreeze`
323+
324+
304325
### DeletableAccounts
305326
[DeletableAccounts]: #deletableaccounts
306327

sidebars.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,9 @@
115115
- page: docs/concepts/tokens/fungible-tokens/multi-purpose-tokens.md
116116
- page: docs/concepts/tokens/fungible-tokens/clawing-back-tokens.md
117117
- page: docs/concepts/tokens/fungible-tokens/freezes.md
118-
- page: docs/concepts/tokens/fungible-tokens/deep-freeze.md
119118
expanded: false
120119
items:
120+
- page: docs/concepts/tokens/fungible-tokens/deep-freeze.md
121121
- page: docs/concepts/tokens/fungible-tokens/common-misconceptions-about-freezes.md
122122
- page: docs/concepts/tokens/fungible-tokens/paths.md
123123
- page: docs/concepts/tokens/fungible-tokens/rippling.md

0 commit comments

Comments
 (0)