refactor: Modularise ledger (#5493)

This change moves the ledger code to libxrpl.
2025-11-20 11:05:54 +00:00 · 2025-09-18 16:12:24 +01:00
parent 617a895af5
commit dc8b37a524
161 changed files with 244 additions and 272 deletions
--- a/include/xrpl/ledger/ApplyViewImpl.h
+++ b/include/xrpl/ledger/ApplyViewImpl.h
@@ -0,0 +1,99 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of rippled: https://github.com/ripple/rippled
+    Copyright (c) 2012, 2013 Ripple Labs Inc.
+
+    Permission to use, copy, modify, and/or distribute this software for any
+    purpose  with  or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#ifndef RIPPLE_LEDGER_APPLYVIEWIMPL_H_INCLUDED
+#define RIPPLE_LEDGER_APPLYVIEWIMPL_H_INCLUDED
+
+#include <xrpl/ledger/OpenView.h>
+#include <xrpl/ledger/detail/ApplyViewBase.h>
+#include <xrpl/protocol/STAmount.h>
+#include <xrpl/protocol/TER.h>
+
+namespace ripple {
+
+/** Editable, discardable view that can build metadata for one tx.
+
+    Iteration of the tx map is delegated to the base.
+
+    @note Presented as ApplyView to clients.
+*/
+class ApplyViewImpl final : public detail::ApplyViewBase
+{
+public:
+    ApplyViewImpl() = delete;
+    ApplyViewImpl(ApplyViewImpl const&) = delete;
+    ApplyViewImpl&
+    operator=(ApplyViewImpl&&) = delete;
+    ApplyViewImpl&
+    operator=(ApplyViewImpl const&) = delete;
+
+    ApplyViewImpl(ApplyViewImpl&&) = default;
+    ApplyViewImpl(ReadView const* base, ApplyFlags flags);
+
+    /** Apply the transaction.
+
+        After a call to `apply`, the only valid
+        operation on this object is to call the
+        destructor.
+    */
+    std::optional<TxMeta>
+    apply(
+        OpenView& to,
+        STTx const& tx,
+        TER ter,
+        std::optional<uint256> parentBatchId,
+        bool isDryRun,
+        beast::Journal j);
+
+    /** Set the amount of currency delivered.
+
+        This value is used when generating metadata
+        for payments, to set the DeliveredAmount field.
+        If the amount is not specified, the field is
+        excluded from the resulting metadata.
+    */
+    void
+    deliver(STAmount const& amount)
+    {
+        deliver_ = amount;
+    }
+
+    /** Get the number of modified entries
+     */
+    std::size_t
+    size();
+
+    /** Visit modified entries
+     */
+    void
+    visit(
+        OpenView& target,
+        std::function<void(
+            uint256 const& key,
+            bool isDelete,
+            std::shared_ptr<SLE const> const& before,
+            std::shared_ptr<SLE const> const& after)> const& func);
+
+private:
+    std::optional<STAmount> deliver_;
+};
+
+}  // namespace ripple
+
+#endif