Merge branch 'mvadari/sponsor/apply-view-context' of https://github.com/XRPLF/rippled into mvadari/sponsor/reserve-context

include/xrpl/ledger/View.h

@@ -201,7 +201,7 @@ canWithdraw(ReadView const& view, STTx const& tx);
 
 [[nodiscard]] TER
 doWithdraw(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     AccountID const& senderAcct,
     AccountID const& dstAcct,
     AccountID const& sourceAcct,

include/xrpl/ledger/helpers/AccountRootHelpers.h

@@ -109,7 +109,7 @@ baseAccountReserve(ReadView const& view, std::int32_t ownerCount, std::int32_t a
  */
 [[nodiscard]] TER
 checkInsufficientReserve(
-    ReadView const& view,
+    ApplyView const& view,
     STTx const& tx,
     SLE::const_ref accSle,
     STAmount const& accBalance,

include/xrpl/ledger/helpers/EscrowHelpers.h

@@ -19,7 +19,7 @@ namespace xrpl {
 template <ValidIssueType T>
 TER
 escrowUnlockApplyHelper(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     Rate lockedRate,
     SLE::ref sleDest,
     STAmount const& xrpBalance,
@@ -33,7 +33,7 @@ escrowUnlockApplyHelper(
 template <>
 inline TER
 escrowUnlockApplyHelper<Issue>(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     Rate lockedRate,
     SLE::ref sleDest,
     STAmount const& xrpBalance,
@@ -168,7 +168,7 @@ escrowUnlockApplyHelper<Issue>(
 template <>
 inline TER
 escrowUnlockApplyHelper<MPTIssue>(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     Rate lockedRate,
     SLE::ref sleDest,
     STAmount const& xrpBalance,

include/xrpl/ledger/helpers/MPTokenHelpers.h

@@ -71,7 +71,7 @@ canAddHolding(ReadView const& view, MPTIssue const& mptIssue);
 
 [[nodiscard]] TER
 authorizeMPToken(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     XRPAmount const& priorBalance,
     MPTID const& mptIssuanceID,
     AccountID const& account,
@@ -102,7 +102,7 @@ requireAuth(
  */
 [[nodiscard]] TER
 enforceMPTokenAuthorization(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     MPTID const& mptIssuanceID,
     AccountID const& account,
     XRPAmount const& priorBalance,
@@ -188,7 +188,7 @@ canMPTTradeAndTransfer(
 
 [[nodiscard]] TER
 addEmptyHolding(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     AccountID const& accountID,
     XRPAmount priorBalance,
     MPTIssue const& mptIssue,
@@ -196,7 +196,7 @@ addEmptyHolding(
 
 [[nodiscard]] TER
 removeEmptyHolding(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     AccountID const& accountID,
     MPTIssue const& mptIssue,
     beast::Journal journal);

include/xrpl/ledger/helpers/OracleHelpers.h

@@ -0,0 +1,19 @@
+#pragma once
+
+#include <cstddef>
+#include <cstdint>
+
+namespace xrpl {
+
+constexpr uint32_t kMinOracleReserveCount = 1;
+constexpr uint32_t kMaxOracleReserveCount = 2;
+constexpr std::size_t kOracleReserveCountThreshold = 5;
+
+inline uint32_t
+calculateOracleReserve(std::size_t priceDataSeriesCount)
+{
+    return priceDataSeriesCount > kOracleReserveCountThreshold ? kMaxOracleReserveCount
+                                                               : kMinOracleReserveCount;
+}
+
+}  // namespace xrpl

include/xrpl/ledger/helpers/RippleStateHelpers.h

@@ -229,7 +229,7 @@ canTransfer(ReadView const& view, Issue const& issue, AccountID const& from, Acc
 /// canAddHolding() in preflight with the same View and Asset
 [[nodiscard]] TER
 addEmptyHolding(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     AccountID const& accountID,
     XRPAmount priorBalance,
     Issue const& issue,
@@ -237,7 +237,7 @@ addEmptyHolding(
 
 [[nodiscard]] TER
 removeEmptyHolding(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     AccountID const& accountID,
     Issue const& issue,
     beast::Journal journal);

include/xrpl/ledger/helpers/SponsorHelpers.h

@@ -3,6 +3,7 @@
 #include <xrpl/basics/Log.h>
 #include <xrpl/beast/utility/Journal.h>
 #include <xrpl/ledger/View.h>
+#include <xrpl/ledger/helpers/OracleHelpers.h>
 #include <xrpl/protocol/AccountID.h>
 #include <xrpl/protocol/SField.h>
 #include <xrpl/protocol/STTx.h>
@@ -107,4 +108,121 @@ removeSponsorFromLedgerEntry(SLE::ref sle, SF_ACCOUNT const& field = sfSponsor)
         sle->makeFieldAbsent(field);
 }
 
+template <typename T>
+inline std::optional<AccountID>
+getLedgerEntryOwner(ReadView const& view, T const& sle, AccountID const& account)
+{
+    switch (sle->getType())
+    {
+        case ltCHECK:
+        case ltESCROW:
+        case ltPAYCHAN:
+        case ltMPTOKEN:
+        case ltDELEGATE:
+        case ltDEPOSIT_PREAUTH:
+            return sle->getAccountID(sfAccount);
+        case ltMPTOKEN_ISSUANCE:
+            return sle->getAccountID(sfIssuer);
+        case ltSIGNER_LIST: {
+            auto const signerList = view.read(keylet::signers(account));
+            if (!signerList)
+                return std::nullopt;
+            if (signerList->key() == sle->key())
+                return account;
+            return std::nullopt;
+        }
+        case ltCREDENTIAL: {
+            if (sle->isFlag(lsfAccepted))
+                return sle->getAccountID(sfSubject);
+            return sle->getAccountID(sfIssuer);
+        }
+        case ltRIPPLE_STATE: {
+            if (sle->isFlag(lsfHighReserve))
+            {
+                auto const highAccount = sle->getFieldAmount(sfHighLimit).getIssuer();
+                if (highAccount == account)
+                    return highAccount;
+            }
+            if (sle->isFlag(lsfLowReserve))
+            {
+                auto const lowAccount = sle->getFieldAmount(sfLowLimit).getIssuer();
+                if (lowAccount == account)
+                    return lowAccount;
+            }
+            return std::nullopt;
+        }
+        default:
+            UNREACHABLE("Object is not supported by sponsorship.");
+            return std::nullopt;
+    };
+}
+
+template <typename T>
+inline bool
+isLedgerEntrySupportedBySponsorship(T const& sle)
+{
+    switch (sle->getType())
+    {
+        case ltCHECK:
+        case ltESCROW:
+        case ltPAYCHAN:
+        case ltMPTOKEN:
+        case ltDELEGATE:
+        case ltDEPOSIT_PREAUTH:
+        case ltMPTOKEN_ISSUANCE:
+        case ltSIGNER_LIST:
+        case ltCREDENTIAL:
+        case ltRIPPLE_STATE:
+            return true;
+        default:
+            return false;
+    };
+}
+
+template <typename T>
+inline std::uint32_t
+getLedgerEntryOwnerCount(T const& sle)
+{
+    switch (sle->getType())
+    {
+        case ltORACLE: {
+            return calculateOracleReserve(sle->getFieldArray(sfPriceDataSeries).size());
+        }
+        // Vaults require 2 owner counts (the vault and a pseudo-account)
+        case ltVAULT:
+            return 2;
+        default:
+            return 1;
+    }
+};
+
+template <typename T>
+inline SF_ACCOUNT const&
+getLedgerEntrySponsorField(T const& sle, AccountID const& owner)
+{
+    switch (sle->getType())
+    {
+        case ltRIPPLE_STATE: {
+            if (sle->isFlag(lsfHighReserve))
+            {
+                auto const highAccount = sle->getFieldAmount(sfHighLimit).getIssuer();
+                if (highAccount == owner)
+                    return sfHighSponsor;
+            }
+            if (sle->isFlag(lsfLowReserve))
+            {
+                auto const lowAccount = sle->getFieldAmount(sfLowLimit).getIssuer();
+                if (lowAccount == owner)
+                    return sfLowSponsor;
+            }
+            // LCOV_EXCL_START
+            UNREACHABLE("Should not happen. Owner should be checked before calling this function.");
+            return sfSponsor;
+            // LCOV_EXCL_STOP
+        }
+        default:
+            return sfSponsor;
+    }
+};
+
 }  // namespace xrpl

include/xrpl/ledger/helpers/TokenHelpers.h

@@ -230,7 +230,7 @@ canAddHolding(ReadView const& view, Asset const& asset);
 
 [[nodiscard]] TER
 addEmptyHolding(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     AccountID const& accountID,
     XRPAmount priorBalance,
     Asset const& asset,
@@ -238,7 +238,7 @@ addEmptyHolding(
 
 [[nodiscard]] TER
 removeEmptyHolding(
-    ApplyViewContext const& ctx,
+    ApplyViewContext ctx,
     AccountID const& accountID,
     Asset const& asset,
     beast::Journal journal);

include/xrpl/tx/transactors/oracle/OracleSet.h

@@ -22,12 +22,6 @@ public:
     {
     }
 
-    static uint32_t
-    calculateOracleReserve(std::size_t count)
-    {
-        return count > 5 ? 2 : 1;
-    }
-
     static NotTEC
     preflight(PreflightContext const& ctx);
 

include/xrpl/tx/transactors/token/MPTokenIssuanceCreate.h

@@ -63,7 +63,7 @@ public:
         beast::Journal const& j) override;
 
     static std::expected<MPTID, TER>
-    create(ApplyViewContext const& ctx, beast::Journal journal, MPTCreateArgs const& args);
+    create(ApplyViewContext ctx, beast::Journal journal, MPTCreateArgs const& args);
 };
 
 }  // namespace xrpl