refactor: Modularize shamap and nodestore (#5668)

This change moves the shamap and nodestore from `xrpld` to `libxrpl`.
2025-11-20 02:55:50 +00:00 · 2025-10-31 22:25:16 +00:00
parent 50fc93f742
commit 8eb233c2ea
100 changed files with 282 additions and 262 deletions
--- a/include/xrpl/shamap/SHAMapAddNode.h
+++ b/include/xrpl/shamap/SHAMapAddNode.h
@@ -0,0 +1,185 @@
+//------------------------------------------------------------------------------
+/*
+    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_SHAMAP_SHAMAPADDNODE_H_INCLUDED
+#define RIPPLE_SHAMAP_SHAMAPADDNODE_H_INCLUDED
+
+#include <string>
+
+namespace ripple {
+
+// results of adding nodes
+class SHAMapAddNode
+{
+private:
+    int mGood;
+    int mBad;
+    int mDuplicate;
+
+public:
+    SHAMapAddNode();
+    void
+    incInvalid();
+    void
+    incUseful();
+    void
+    incDuplicate();
+    void
+    reset();
+    int
+    getGood() const;
+    bool
+    isGood() const;
+    bool
+    isInvalid() const;
+    bool
+    isUseful() const;
+    std::string
+    get() const;
+
+    SHAMapAddNode&
+    operator+=(SHAMapAddNode const& n);
+
+    static SHAMapAddNode
+    duplicate();
+    static SHAMapAddNode
+    useful();
+    static SHAMapAddNode
+    invalid();
+
+private:
+    SHAMapAddNode(int good, int bad, int duplicate);
+};
+
+inline SHAMapAddNode::SHAMapAddNode() : mGood(0), mBad(0), mDuplicate(0)
+{
+}
+
+inline SHAMapAddNode::SHAMapAddNode(int good, int bad, int duplicate)
+    : mGood(good), mBad(bad), mDuplicate(duplicate)
+{
+}
+
+inline void
+SHAMapAddNode::incInvalid()
+{
+    ++mBad;
+}
+
+inline void
+SHAMapAddNode::incUseful()
+{
+    ++mGood;
+}
+
+inline void
+SHAMapAddNode::incDuplicate()
+{
+    ++mDuplicate;
+}
+
+inline void
+SHAMapAddNode::reset()
+{
+    mGood = mBad = mDuplicate = 0;
+}
+
+inline int
+SHAMapAddNode::getGood() const
+{
+    return mGood;
+}
+
+inline bool
+SHAMapAddNode::isInvalid() const
+{
+    return mBad > 0;
+}
+
+inline bool
+SHAMapAddNode::isUseful() const
+{
+    return mGood > 0;
+}
+
+inline SHAMapAddNode&
+SHAMapAddNode::operator+=(SHAMapAddNode const& n)
+{
+    mGood += n.mGood;
+    mBad += n.mBad;
+    mDuplicate += n.mDuplicate;
+
+    return *this;
+}
+
+inline bool
+SHAMapAddNode::isGood() const
+{
+    return (mGood + mDuplicate) > mBad;
+}
+
+inline SHAMapAddNode
+SHAMapAddNode::duplicate()
+{
+    return SHAMapAddNode(0, 0, 1);
+}
+
+inline SHAMapAddNode
+SHAMapAddNode::useful()
+{
+    return SHAMapAddNode(1, 0, 0);
+}
+
+inline SHAMapAddNode
+SHAMapAddNode::invalid()
+{
+    return SHAMapAddNode(0, 1, 0);
+}
+
+inline std::string
+SHAMapAddNode::get() const
+{
+    std::string ret;
+    if (mGood > 0)
+    {
+        ret.append("good:");
+        ret.append(std::to_string(mGood));
+    }
+    if (mBad > 0)
+    {
+        if (!ret.empty())
+            ret.append(" ");
+        ret.append("bad:");
+        ret.append(std::to_string(mBad));
+    }
+    if (mDuplicate > 0)
+    {
+        if (!ret.empty())
+            ret.append(" ");
+        ret.append("dupe:");
+        ret.append(std::to_string(mDuplicate));
+    }
+    if (ret.empty())
+        ret = "no nodes processed";
+    return ret;
+}
+
+}  // namespace ripple
+
+#endif