Merge branch 'rippled-2.4.0' into add_dynamic_nfts

Author: oeggert

blog/2025/rippled-2.4.0.md

@@ -1,6 +1,6 @@
 ---
 category: 2025
-date: 2025-03-03
+date: 2025-03-05
 seo:
     title: Introducing XRP Ledger version 2.4.0
     description: rippled version 2.4.0 is now available. This version introduces new features and stability fixes.
@@ -12,20 +12,40 @@ markdown:
 ---
 # Introducing XRP Ledger version 2.4.0
 
-Version 2.4.0 of `rippled`, the reference server implementation of the XRP Ledger protocol, is now available. This release includes 8 new amendments, including Multi-Purpose Tokens (MPTs), Credentials, Clawback support for AMMs, and the ability to make offers as part of minting NFTs. Additionally, this release includes important fixes for stability, so server operators are encouraged to upgrade as soon as possible.
+Version 2.4.0 of `rippled`, the reference server implementation of the XRP Ledger protocol, is now available. This release adds new features and bug fixes, and introduces these amendments:
 
-## Additional Announcement
+- `PermissionedDomains`
+- `DeepFreeze`
+- `DynamicNFT`
+- `fixFrozenLPTokenTransfer`
+- `fixInvalidTxFlags`
+
+
+## Notable Updates: New Public Key Provided by the new XRPL Foundation
+
+Following the recent announcement regarding the [move to the new XRPL Foundation](./move-to-the-new-xrpl-foundation-commences.md), the XRPL Foundation members have been working diligently to facilitate a smooth transition of the Unique Node List (UNL) from the old XRPL Foundation to the new XRPL Foundation.
+
+There are two key goals driving this transition:
+- Ensure continued network participation and avoid potential downtime.
+- Allow for a staged migration with minimal impact on validators and node operators.
+
+Keeping these goals in mind, a new subdomain, **unl.xrplf.org**, has been introduced alongside the existing https://vl.xrplf.org/. This approach allows for a staged migration without modifying the key for the current UNL list. Eventually, vl.xrplf.org will be fully deprecated and replaced by unl.xrplf.org.
+
+In `rippled` release 2.4.0, the validators-example.txt has been updated to include the new public key published by the new XRPL Foundation.
+
+Further information on the transition will be shared by the XRPL Foundation in the near future.
 
-New UNL pub keys will be published on ...
 
 ## Action Required
 
-If you run an XRP Ledger server, upgrade to version 2.3.0 as soon as possible to ensure service continuity.
+If you run an XRP Ledger server, upgrade to version 2.4.0 as soon as possible to ensure service continuity.
 
 Additionally, new amendments are now open for voting according to the XRP Ledger's [amendment process](../../docs/concepts/networks-and-servers/amendments.md), which enables protocol changes following two weeks of >80% support from trusted validators. The exact time that protocol changes take effect depends on the voting decisions of the decentralized network.
 
 ## Install / Upgrade
 
+**TODO: Update package and SHA-256**
+
 On supported platforms, see the [instructions on installing or updating `rippled`](../../docs/infrastructure/installation/index.md).
 
 | Package | SHA-256 |
@@ -52,20 +72,21 @@ Date:   Mon Nov 25 12:27:17 2024 -0800
 The following amendments are open for voting with this release:
 
 
-- **XLS-46 DynamicNFT** - Adds the ability to update the URI of `NFToken` objects. ([#5048](https://github.com/XRPLF/rippled/pull/5048)) **TODO: doc update `NFToken` object**
-- **XLS-80 Permissioned Domains** - Adds Permissioned Domains, which act as part of broader systems on the XRP Ledger to restrict access to satisfy compliance rules. ([#5161](https://github.com/XRPLF/rippled/pull/5161)) **TODO: move docs from opensource**
-- **XLS-77 Deep Freeze** - Adds the ability to deep freeze trust lines, enabling token issuers to block the transfer of assets for holders who have been deep frozen. ([#5187](https://github.com/XRPLF/rippled/pull/5187)) **TODO: move docs from opensource**
+- **XLS-46 DynamicNFT** - Adds the ability to update the URI of `NFToken` objects. ([#5048](https://github.com/XRPLF/rippled/pull/5048))
+- **XLS-80 Permissioned Domains** - Adds Permissioned Domains, which act as part of broader systems on the XRP Ledger to restrict access to satisfy compliance rules. ([#5161](https://github.com/XRPLF/rippled/pull/5161))
+- **XLS-77 Deep Freeze** - Adds the ability to deep freeze trust lines, enabling token issuers to block the transfer of assets for holders who have been deep frozen. ([#5187](https://github.com/XRPLF/rippled/pull/5187))
 - **fixFrozenLPTokenTransfer** - Prohibits the transfer of LP tokens when the associated liquidity pool contains at least one frozen asset. ([#5227](https://github.com/XRPLF/rippled/pull/5227))
 - **fixInvalidTxFlags** - Adds transaction flag checking for `CredentialCreate`, `CredentialAccept`, and `CredentialDelete` transactions. ([#5250](https://github.com/XRPLF/rippled/pull/5250))
 
 
 ### New Features
 
+- Added a new `simulate` API method to execute dry runs of transactions and see the simulated metadata. ([#5069](https://github.com/XRPLF/rippled/pull/5069), [#5265](https://github.com/XRPLF/rippled/pull/5265))
 - Added the ability to specify MPTs when defining assets in transactions. ([#5200](https://github.com/XRPLF/rippled/pull/5200))
 - Refactored `LedgerEntry.cpp` to make it easier to read. Also added a `state` alias for `ripple_state` in the `ledger_entry` API method. ([#5199](https://github.com/XRPLF/rippled/pull/5199))
 - Improved UNL security by enabling validators to set a minimum number of UNL publishers to agree on validators. ([#5112](https://github.com/XRPLF/rippled/pull/5112))
-- Added a new `simulate` API method to execute dry runs of transactions and see the simulated metadata. ([#5069](https://github.com/XRPLF/rippled/pull/5069), [#5265](https://github.com/XRPLF/rippled/pull/5265))
 - Updated the XRPL Foundation UNL keys. ([#5289](https://github.com/XRPLF/rippled/pull/5289))
+- Added a new XRPL Foundation subdomain to enable a staged migration without modifying the key for the current UNL list. ([#5326](https://github.com/XRPLF/rippled/pull/5326))
 - Added support to filter ledger entry types by their canonical names in the `ledger`, `ledger_data`, and `account_objects` API methods. ([#5271](https://github.com/XRPLF/rippled/pull/5271))
 - Added detailed logging for each validation and proposal received from the network. ([#5291](https://github.com/XRPLF/rippled/pull/5291))
 - Improved git commit hash lookups when checking the version of a `rippled` debug build. Also added git commit hash info when using the `server_info` API method on an admin connection. ([#5225](https://github.com/XRPLF/rippled/pull/5225))
@@ -82,8 +103,11 @@ The following amendments are open for voting with this release:
 - Fixed the levelization script to ignore single-line comments during dependency analysis. ([#5194](https://github.com/XRPLF/rippled/pull/5194))
 - Fixed the assert name used in `PermissionedDomainDelete`. ([#5245](https://github.com/XRPLF/rippled/pull/5245))
 - Fixed MacOS unit tests. ([#5196](https://github.com/XRPLF/rippled/pull/5196))
-- Fixed an issue with validators not accurately reflecting amendment votes. Also added debug logging of amendment votes. ([#5173](https://github.com/XRPLF/rippled/pull/5173))
+- Fixed an issue with validators not accurately reflecting amendment votes. Also added debug logging of amendment votes. ([#5173](https://github.com/XRPLF/rippled/pull/5173), [#5312](https://github.com/XRPLF/rippled/pull/5312))
 - Fixed a potential issue with double-charging fees. ([#5269](https://github.com/XRPLF/rippled/pull/5269))
+- Removed the `new parent hash` assert and replaced it with a log message. ([#5313](https://github.com/XRPLF/rippled/pull/5313))
+- Fixed an issue that prevented previously-failed inbound ledgers to not be acquired if a new trusted proposal arrived. ([#5318](https://github.com/XRPLF/rippled/pull/5318))
+
 
 ### Other Improvements
 
@@ -98,25 +122,46 @@ The following amendments are open for voting with this release:
 - Improved logs readability. ([#5251](https://github.com/XRPLF/rippled/pull/5251))
 - Updated Visual Studio CI to VS 2022, and added VS Debug builds. ([#5240](https://github.com/XRPLF/rippled/pull/5240))
 - Updated the `secp256k1` library to version 0.6.0. ([#5254](https://github.com/XRPLF/rippled/pull/5254))
-- Changed the `[port_peer]` parameter in `rippled` example config back to `51235`; also added the recommendation to use the default port of `2459` for new deployments. ([#5299](https://github.com/XRPLF/rippled/pull/5299))
+- Changed the `[port_peer]` parameter in `rippled` example config back to `51235`; also added the recommendation to use the default port of `2459` for new deployments. ([#5290](https://github.com/XRPLF/rippled/pull/5290), [#5299](https://github.com/XRPLF/rippled/pull/5299))
 - Improved CI management. ([#5268](https://github.com/XRPLF/rippled/pull/5268))
 - Updated the git commit message rules for contributors. ([#5283](https://github.com/XRPLF/rippled/pull/5283))
 - Fixed unnecessary `setCurrentThreadName` calls. ([#5280](https://github.com/XRPLF/rippled/pull/5280))
 - Added a check to prevent permissioned domains from being created in the event the Permissioned Domains amendement is enabled before the Credentials amendement. ([#5275](https://github.com/XRPLF/rippled/pull/5275))
 - Updated Conan dependencies. ([#5256](https://github.com/XRPLF/rippled/pull/5256))
+- Fixed minor typos in code comments. ([#5279](https://github.com/XRPLF/rippled/pull/5279))
+- Fixed incorrect build instructions. ([#5274](https://github.com/XRPLF/rippled/pull/5274))
+- Refactored `rotateWithLock()` to not hold a lock during callbacks. ([#5276](https://github.com/XRPLF/rippled/pull/5276))
+- Cleaned up debug logging by combining multiple data points into a single message. ([#5302](https://github.com/XRPLF/rippled/pull/5302))
+- Updated build flags to fix performance regressions. ([#5325](https://github.com/XRPLF/rippled/pull/5325))
 
 
 ## Credits
 
 The following people contributed directly to this release:
 
+- Aanchal Malhotra <amalhotra@ripple.com>
+- Bart Thomee <11445373+bthomee@users.noreply.github.com>
+- Bronek Kozicki <brok@incorrekt.com>
+- code0xff <ian.jungyong.um@gmail.com>
+- Darius Tumas <tokeiito@tokeiito.eu>
+- David Fuelling <fuelling@ripple.com>
+- Donovan Hide <donovanhide@gmail.com>
 - Ed Hennis <ed@ripple.com>
-- JoelKatz <DavidJoelSchwartz@GMail.com>
-- Sophia Xie <106177003+sophiax851@users.noreply.github.com>
-- Valentin Balaschenko <13349202+vlntb@users.noreply.github.com>
-
-@rrmanukyan made their first contribution in #5233
-@kuznetsss made their first contribution in #5252
+- Elliot Lee <github.public@intelliot.com>
+- Javier Romero <jromero@ripple.com>
+- Kenny Lei <klei@ripple.com>
+- Mark Travis <7728157+mtrippled@users.noreply.github.com>
+- Mayukha Vadari <mvadari@gmail.com>
+- Michael Legleux <mlegleux@ripple.com>
+- Oleksandr <115580134+oleks-rip@users.noreply.github.com>
+- Qi Zhao <qzhao@ripple.com>
+- Ramkumar Srirengaram Gunasegharan <rgunasegharan@ripple.com>
+- Shae Wang <swang@ripple.com>
+- Shawn Xie <shawnxie920@gmail.com>
+- Sophia Xie <sxie@ripple.com>
+- Vijay Khanna Raviraj <vraviraj@ripple.com>
+- Vladislav Vysokikh <vvysokikh@gmail.com>
+- Xun Zhao <xzhao@ripple.com>
 
 
 ## Bug Bounties and Responsible Disclosures

docs/_snippets/common-links.md

@@ -71,6 +71,7 @@
 [Clawback transaction]: /docs/references/protocol/transactions/types/clawback.md
 [Clawback transactions]: /docs/references/protocol/transactions/types/clawback.md
 [Clawbackトランザクション]: /docs/references/protocol/transactions/types/clawback.md
+[credentials]: /docs/concepts/decentralized-storage/credentials.md
 [Credentials amendment]: /resources/known-amendments.md#credentials
 [CredentialCreate transaction]: /docs/references/protocol/transactions/types/credentialcreate.md
 [CredentialCreate transactions]: /docs/references/protocol/transactions/types/credentialcreate.md
@@ -241,6 +242,8 @@
 [PaymentChannelFundトランザクション]: /docs/references/protocol/transactions/types/paymentchannelfund.md
 [Payment]: /docs/references/protocol/transactions/types/payment.md
 [Paymentトランザクション]: /docs/references/protocol/transactions/types/payment.md
+[PermissionedDomains amendment]: /resources/known-amendments.md#permissioneddomains
+[permissioned domain]: /docs/concepts/tokens/decentralized-exchange/permissioned-domains.md
 [PriceOracle amendment]: /resources/known-amendments.md#priceoracle
 [RFC-1751]: https://tools.ietf.org/html/rfc1751
 [Reporting Mode]: /docs/concepts/networks-and-servers/rippled-server-modes.md#reporting-mode

docs/concepts/tokens/decentralized-exchange/permissioned-domains.md

@@ -0,0 +1,39 @@
+---
+seo:
+    description: The definition and details of a Permissioned Domain instance.
+labels:
+  - Compliance
+  - Permissioned Domains
+---
+# Permissioned Domains
+
+Permissioned domains are controlled environments within the broader ecosystem of the XRP Ledger blockchain. Domains do nothing on their own, but features such as Permissioned DEXes and Lending Protocols can use domains to restrict access, so that traditional financial institutions can offer services on chain while complying with various compliance rules.
+
+The only configurable rule for a domain is the set of accepted [credentials][]. Future amendments may add new and different types of rules to encompass any limits that a financial institution may need to follow to maintain compliance with the laws of the jurisdictions where they do business.
+
+Anyone can define a permissioned domain in the ledger. That person becomes the owner of that domain, and can update its settings or delete it. The only limit to the number of domains that can exist in the ledger is the reserve requirement: each Domain counts as one item toward its owner's reserve requirement.
+
+_(Requires the [PermissionedDomains amendment][] {% not-enabled /%})_
+
+{% admonition type="info" name="Note" %}
+The [Credentials amendment][] is also required. If the [PermissionedDomains amendment][] is enabled without Credentials, PermissionedDomainSet transactions are considered invalid.
+{% /admonition %}
+
+## Accepted Credentials
+
+A permissioned domain has a set of _accepted credentials_, a list of 1 to 10 credentials that grant access. Each item in the list describes a credential by its issuer and credential type. Any account that holds _at least one_ matching credential automatically gains access to the domain.
+
+A domain serves as an abstraction layer between credentials and a resource being resricted, because the owner of the domain can update the list of required credentials without changing the restricted resource itself.
+
+[{% inline-svg file="../../../img/permissioned-domain.svg" /%}](../../../img/permissioned-domain.svg "Diagram: a permissioned DEX points to a permissioned domain by ID. The domain's Accepted Credentials describes 3 possible credentials to get access")
+
+Users do not need to apply to join or leave a domain. When a transaction requires access to a resource that is restricted by a domain, the transaction automatically checks if the account holds a credential matching that domain's accepted credentials, and fails if they have none. The user's credential must be accepted and not expired.
+
+## Uses for Domains
+
+Currently, there are no available XRP Ledger features that use permissioned domains. However, amendments that are in development and use domains include:
+
+- Single Asset Vault and Lending Protocol
+- Permissioned DEXes
+
+{% raw-partial file="/docs/_snippets/common-links.md" /%}