explanatory comment to indicate the rounding down of LPTokens and amo…

…unts
ckeshava · Apr 9, 2024 · 5302b30 · 5302b30
1 parent 31b8971
commit 5302b30
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/ripple/app/misc/impl/AMMHelpers.cpp b/src/ripple/app/misc/impl/AMMHelpers.cpp
@@ -153,6 +153,11 @@ adjustAmountsByLPTokens(
     std::uint16_t tfee,
     bool isDeposit)
 {
+    // If lpTokens contains a fractional part and at least 16 significant
+    // digits, it is possible that lpTokensActual is rounded down. This is to
+    // ensure that we don't create/burn more LPTokens (depending on
+    // whether it's AMMDeposit or AMMWithdraw transaction) than what the trader
+    // asked for.
     auto const lpTokensActual =
         adjustLPTokens(lptAMMBalance, lpTokens, isDeposit);