Refactor the structure of RippleCalc

* Split code into multiple files * Rename and move things
2025-12-06 17:27:52 +00:00 · 2014-05-09 15:53:27 -04:00
parent 4b3e629dfd
commit 3ca9646329
22 changed files with 3242 additions and 2741 deletions
--- a/src/ripple_app/paths/CalcNode.cpp
+++ b/src/ripple_app/paths/CalcNode.cpp
@@ -0,0 +1,111 @@
+//------------------------------------------------------------------------------
+/*
+    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.
+*/
+//==============================================================================
+
+#include <tuple>
+
+#include "CalcState.h"
+#include "Calculators.h"
+#include "RippleCalc.h"
+#include "Tuning.h"
+
+namespace ripple {
+
+TER calcNodeFwd (
+    RippleCalc& rippleCalc,
+    const unsigned int nodeIndex, PathState& pathState,
+    const bool bMultiQuality)
+{
+    auto const& node = pathState.vpnNodes[nodeIndex];
+    auto const nodeIsAccount = isAccount(node);
+
+    WriteLog (lsTRACE, RippleCalc)
+        << "calcNodeFwd> nodeIndex=" << nodeIndex;
+
+    TER errorCode = nodeIsAccount
+        ? calcNodeAccountFwd (rippleCalc, nodeIndex, pathState, bMultiQuality)
+        : calcNodeOfferFwd (rippleCalc, nodeIndex, pathState, bMultiQuality);
+
+    if (errorCode == tesSUCCESS && nodeIndex + 1 != pathState.vpnNodes.size ())
+        errorCode = calcNodeFwd (rippleCalc, nodeIndex + 1, pathState, bMultiQuality);
+
+    if (errorCode == tesSUCCESS && !(pathState.saInPass && pathState.saOutPass))
+        errorCode = tecPATH_DRY;
+
+    WriteLog (lsTRACE, RippleCalc)
+        << "calcNodeFwd<"
+        << " nodeIndex:" << nodeIndex
+        << " errorCode:" << errorCode;
+
+    return errorCode;
+}
+
+// Calculate a node and its previous nodes.
+//
+// From the destination work in reverse towards the source calculating how much
+// must be asked for.
+//
+// Then work forward, figuring out how much can actually be delivered.
+// <-- errorCode: tesSUCCESS or tecPATH_DRY
+// <-> pnNodes:
+//     --> [end]saWanted.mAmount
+//     --> [all]saWanted.mCurrency
+//     --> [all]saAccount
+//     <-> [0]saWanted.mAmount : --> limit, <-- actual
+TER calcNodeRev (
+    RippleCalc& rippleCalc,
+    const unsigned int nodeIndex, PathState& pathState,
+    const bool bMultiQuality)
+{
+    PathState::Node& node = pathState.vpnNodes[nodeIndex];
+    bool const nodeIsAccount
+        = is_bit_set (node.uFlags,  STPathElement::typeAccount);
+    TER errorCode;
+
+    node.saTransferRate = STAmount::saFromRate (
+        rippleCalc.mActiveLedger.rippleTransferRate (node.uIssuerID));
+
+    WriteLog (lsTRACE, RippleCalc)
+        << "calcNodeRev>"
+        << " nodeIndex=" << nodeIndex
+        << " nodeIsAccount=" << nodeIsAccount
+        << " uIssuerID=" << RippleAddress::createHumanAccountID (node.uIssuerID)
+        << " saTransferRate=" << node.saTransferRate;
+
+    errorCode = nodeIsAccount
+            ? calcNodeAccountRev (rippleCalc, nodeIndex, pathState, bMultiQuality)
+        : calcNodeOfferRev (rippleCalc, nodeIndex, pathState, bMultiQuality);
+
+    // Do previous.
+    if (errorCode != tesSUCCESS)
+        // Error, don't continue.
+        nothing ();
+    else if (nodeIndex)
+        // Continue in reverse.  TODO(tom): remove unnecessary recursion.
+        errorCode = calcNodeRev (rippleCalc, nodeIndex - 1, pathState, bMultiQuality);
+
+    WriteLog (lsTRACE, RippleCalc)
+        << "calcNodeRev< "
+        << "nodeIndex=" << nodeIndex
+        << " errorCode=%s" << transToken (errorCode)
+        << "/" << errorCode;
+
+    return errorCode;
+}
+
+} // ripple