Merge branch 'develop' into feature/validator_list_threshold

API-CHANGELOG.md

@@ -26,7 +26,15 @@ In `api_version: 2`, the `signer_lists` field [will be moved](#modifications-to-
 
 The `network_id` field was added in the `server_info` response in version 1.5.0 (2019), but it is not returned in [reporting mode](https://xrpl.org/rippled-server-modes.html#reporting-mode).
 
-## XRP Ledger server version 2.0.0
+### Breaking change in 2.3
+
+- `book_changes`: If the requested ledger version is not available on this node, a `ledgerNotFound` error is returned and the node does not attempt to acquire the ledger from the p2p network (as with other non-admin RPCs).
+
+Admins can still attempt to retrieve old ledgers with the `ledger_request` RPC.
+
+### Addition in 2.3
+
+- `book_changes`: Returns a `validated` field in its response, which was missing in prior versions.
 
 ### Additions in 2.2
 

cfg/rippled-example.cfg

@@ -1106,6 +1106,20 @@
 #                           This setting may not be combined with the
 #                           "safety_level" setting.
 #
+#       page_size           Valid values: integer (MUST be power of 2 between 512 and 65536)
+#                           The default is 4096 bytes. This setting determines
+#                           the size of a page in the transaction.db file.
+#                           See https://www.sqlite.org/pragma.html#pragma_page_size 
+#                           for more details about the available options.
+#
+#       journal_size_limit  Valid values: integer
+#                           The default is 1582080. This setting limits
+#                           the size of the journal for transaction.db file. When the limit is
+#                           reached, older entries will be deleted.
+#                           See https://www.sqlite.org/pragma.html#pragma_journal_size_limit
+#                           for more details about the available options.
+#
+#
 #-------------------------------------------------------------------------------
 #
 # 7. Diagnostics

src/libxrpl/protocol/BuildInfo.cpp

@@ -33,7 +33,7 @@ namespace BuildInfo {
 //  and follow the format described at http://semver.org/
 //------------------------------------------------------------------------------
 // clang-format off
-char const* const versionString = "2.3.0-b3"
+char const* const versionString = "2.3.0-b4"
 // clang-format on
 
 #if defined(DEBUG) || defined(SANITIZER)

src/test/nodestore/Database_test.cpp

@@ -439,6 +439,115 @@ class Database_test : public TestBase
                 BEAST_EXPECT(found);
             }
         }
+        {
+            // N/A: Default values
+            Env env(*this);
+            auto const s = setup_DatabaseCon(env.app().config());
+            if (BEAST_EXPECT(s.txPragma.size() == 4))
+            {
+                BEAST_EXPECT(s.txPragma.at(0) == "PRAGMA page_size=4096;");
+                BEAST_EXPECT(
+                    s.txPragma.at(1) == "PRAGMA journal_size_limit=1582080;");
+                BEAST_EXPECT(
+                    s.txPragma.at(2) == "PRAGMA max_page_count=4294967294;");
+                BEAST_EXPECT(
+                    s.txPragma.at(3) == "PRAGMA mmap_size=17179869184;");
+            }
+        }
+        {
+            // Success: Valid values
+            Env env = [&]() {
+                auto p = test::jtx::envconfig();
+                {
+                    auto& section = p->section("sqlite");
+                    section.set("page_size", "512");
+                    section.set("journal_size_limit", "2582080");
+                }
+                return Env(*this, std::move(p));
+            }();
+            auto const s = setup_DatabaseCon(env.app().config());
+            if (BEAST_EXPECT(s.txPragma.size() == 4))
+            {
+                BEAST_EXPECT(s.txPragma.at(0) == "PRAGMA page_size=512;");
+                BEAST_EXPECT(
+                    s.txPragma.at(1) == "PRAGMA journal_size_limit=2582080;");
+                BEAST_EXPECT(
+                    s.txPragma.at(2) == "PRAGMA max_page_count=4294967294;");
+                BEAST_EXPECT(
+                    s.txPragma.at(3) == "PRAGMA mmap_size=17179869184;");
+            }
+        }
+        {
+            // Error: Invalid values
+            auto const expected =
+                "Invalid page_size. Must be between 512 and 65536.";
+            bool found = false;
+            auto p = test::jtx::envconfig();
+            {
+                auto& section = p->section("sqlite");
+                section.set("page_size", "256");
+            }
+            try
+            {
+                Env env(
+                    *this,
+                    std::move(p),
+                    std::make_unique<CheckMessageLogs>(expected, &found),
+                    beast::severities::kWarning);
+                fail();
+            }
+            catch (...)
+            {
+                BEAST_EXPECT(found);
+            }
+        }
+        {
+            // Error: Invalid values
+            auto const expected =
+                "Invalid page_size. Must be between 512 and 65536.";
+            bool found = false;
+            auto p = test::jtx::envconfig();
+            {
+                auto& section = p->section("sqlite");
+                section.set("page_size", "131072");
+            }
+            try
+            {
+                Env env(
+                    *this,
+                    std::move(p),
+                    std::make_unique<CheckMessageLogs>(expected, &found),
+                    beast::severities::kWarning);
+                fail();
+            }
+            catch (...)
+            {
+                BEAST_EXPECT(found);
+            }
+        }
+        {
+            // Error: Invalid values
+            auto const expected = "Invalid page_size. Must be a power of 2.";
+            bool found = false;
+            auto p = test::jtx::envconfig();
+            {
+                auto& section = p->section("sqlite");
+                section.set("page_size", "513");
+            }
+            try
+            {
+                Env env(
+                    *this,
+                    std::move(p),
+                    std::make_unique<CheckMessageLogs>(expected, &found),
+                    beast::severities::kWarning);
+                fail();
+            }
+            catch (...)
+            {
+                BEAST_EXPECT(found);
+            }
+        }
     }
 
     //--------------------------------------------------------------------------

src/test/rpc/BookChanges_test.cpp

@@ -0,0 +1,100 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of rippled: https://github.com/ripple/rippled
+    Copyright (c) 2024 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.
+*/
+//==============================================================================
+
+#include <test/jtx.h>
+
+namespace ripple {
+namespace test {
+
+class BookChanges_test : public beast::unit_test::suite
+{
+public:
+    void
+    testConventionalLedgerInputStrings()
+    {
+        testcase("Specify well-known strings as ledger input");
+        jtx::Env env(*this);
+        Json::Value params, resp;
+
+        // As per convention in XRPL, ledgers can be specified with strings
+        // "closed", "validated" or "current"
+        params["ledger"] = "validated";
+        resp = env.rpc("json", "book_changes", to_string(params));
+        BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
+        BEAST_EXPECT(resp[jss::result][jss::status] == "success");
+        BEAST_EXPECT(resp[jss::result][jss::validated] == true);
+
+        params["ledger"] = "current";
+        resp = env.rpc("json", "book_changes", to_string(params));
+        BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
+        BEAST_EXPECT(resp[jss::result][jss::status] == "success");
+        BEAST_EXPECT(resp[jss::result][jss::validated] == false);
+
+        params["ledger"] = "closed";
+        resp = env.rpc("json", "book_changes", to_string(params));
+        BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
+        BEAST_EXPECT(resp[jss::result][jss::status] == "success");
+
+        // In the unit-test framework, requesting for "closed" ledgers appears
+        // to yield "validated" ledgers. This is not new behavior. It is also
+        // observed in the unit tests for the LedgerHeader class.
+        BEAST_EXPECT(resp[jss::result][jss::validated] == true);
+
+        // non-conventional ledger input should throw an error
+        params["ledger"] = "non_conventional_ledger_input";
+        resp = env.rpc("json", "book_changes", to_string(params));
+        BEAST_EXPECT(resp[jss::result].isMember(jss::error));
+        BEAST_EXPECT(resp[jss::result][jss::status] != "success");
+    }
+
+    void
+    testLedgerInputDefaultBehavior()
+    {
+        testcase(
+            "If ledger_hash or ledger_index is not specified, the behavior "
+            "must default to the `current` ledger");
+        jtx::Env env(*this);
+
+        // As per convention in XRPL, ledgers can be specified with strings
+        // "closed", "validated" or "current"
+        Json::Value const resp =
+            env.rpc("json", "book_changes", to_string(Json::Value{}));
+        BEAST_EXPECT(!resp[jss::result].isMember(jss::error));
+        BEAST_EXPECT(resp[jss::result][jss::status] == "success");
+
+        // I dislike asserting the below statement, because its dependent on the
+        // unit-test framework BEAST_EXPECT(resp[jss::result][jss::ledger_index]
+        // == 3);
+    }
+
+    void
+    run() override
+    {
+        testConventionalLedgerInputStrings();
+        testLedgerInputDefaultBehavior();
+
+        // Note: Other aspects of the book_changes rpc are fertile grounds for
+        // unit-testing purposes. It can be included in future work
+    }
+};
+
+BEAST_DEFINE_TESTSUITE(BookChanges, app, ripple);
+
+}  // namespace test
+}  // namespace ripple

src/xrpld/app/main/DBInit.h

@@ -42,9 +42,6 @@ inline constexpr std::uint32_t SQLITE_TUNING_CUTOFF = 10'000'000;
 // Ledger database holds ledgers and ledger confirmations
 inline constexpr auto LgrDBName{"ledger.db"};
 
-inline constexpr std::array<char const*, 1> LgrDBPragma{
-    {"PRAGMA journal_size_limit=1582080;"}};
-
 inline constexpr std::array<char const*, 5> LgrDBInit{
     {"BEGIN TRANSACTION;",
 
@@ -72,25 +69,6 @@ inline constexpr std::array<char const*, 5> LgrDBInit{
 // Transaction database holds transactions and public keys
 inline constexpr auto TxDBName{"transaction.db"};
 
-// In C++17 omitting the explicit template parameters caused
-// a crash
-inline constexpr std::array<char const*, 4> TxDBPragma
-{
-    "PRAGMA page_size=4096;", "PRAGMA journal_size_limit=1582080;",
-        "PRAGMA max_page_count=4294967294;",
-
-#if (ULONG_MAX > UINT_MAX) && !defined(NO_SQLITE_MMAP)
-        "PRAGMA mmap_size=17179869184;"
-#else
-
-        // Provide an explicit `no-op` SQL statement
-        // in order to keep the size of the array
-        // constant regardless of the preprocessor
-        // condition evaluation
-        "PRAGMA sqlite_noop_statement;"
-#endif
-};
-
 inline constexpr std::array<char const*, 8> TxDBInit{
     {"BEGIN TRANSACTION;",
 

src/xrpld/app/rdb/backend/detail/Node.cpp

@@ -72,7 +72,7 @@ makeLedgerDBs(
 {
     // ledger database
     auto lgr{std::make_unique<DatabaseCon>(
-        setup, LgrDBName, LgrDBPragma, LgrDBInit, checkpointerSetup, j)};
+        setup, LgrDBName, setup.lgrPragma, LgrDBInit, checkpointerSetup, j)};
     lgr->getSession() << boost::str(
         boost::format("PRAGMA cache_size=-%d;") %
         kilobytes(config.getValueFor(SizedItem::lgrDBCache)));
@@ -81,7 +81,7 @@ makeLedgerDBs(
     {
         // transaction database
         auto tx{std::make_unique<DatabaseCon>(
-            setup, TxDBName, TxDBPragma, TxDBInit, checkpointerSetup, j)};
+            setup, TxDBName, setup.txPragma, TxDBInit, checkpointerSetup, j)};
         tx->getSession() << boost::str(
             boost::format("PRAGMA cache_size=-%d;") %
             kilobytes(config.getValueFor(SizedItem::txnDBCache)));

src/xrpld/app/rdb/detail/Vacuum.cpp

@@ -40,8 +40,8 @@ doVacuumDB(DatabaseCon::Setup const& setup, beast::Journal j)
         return false;
     }
 
-    auto txnDB =
-        std::make_unique<DatabaseCon>(setup, TxDBName, TxDBPragma, TxDBInit, j);
+    auto txnDB = std::make_unique<DatabaseCon>(
+        setup, TxDBName, setup.txPragma, TxDBInit, j);
     auto& session = txnDB->getSession();
     std::uint32_t pageSize;
 

src/xrpld/app/rdb/detail/Wallet.cpp

@@ -27,7 +27,7 @@ makeWalletDB(DatabaseCon::Setup const& setup, beast::Journal j)
 {
     // wallet database
     return std::make_unique<DatabaseCon>(
-        setup, WalletDBName, std::array<char const*, 0>(), WalletDBInit, j);
+        setup, WalletDBName, std::array<std::string, 0>(), WalletDBInit, j);
 }
 
 std::unique_ptr<DatabaseCon>
@@ -38,7 +38,7 @@ makeTestWalletDB(
 {
     // wallet database
     return std::make_unique<DatabaseCon>(
-        setup, dbname.data(), std::array<char const*, 0>(), WalletDBInit, j);
+        setup, dbname.data(), std::array<std::string, 0>(), WalletDBInit, j);
 }
 
 void