View.h

#pragma once
 
#include <xrpl/basics/base_uint.h>
#include <xrpl/basics/chrono.h>
#include <xrpl/beast/utility/Journal.h>
#include <xrpl/ledger/ApplyView.h>
#include <xrpl/ledger/ReadView.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Asset.h>
#include <xrpl/protocol/Keylet.h>
#include <xrpl/protocol/LedgerFormats.h>
#include <xrpl/protocol/MPTIssue.h>
#include <xrpl/protocol/Protocol.h>
#include <xrpl/protocol/SField.h>
#include <xrpl/protocol/STAmount.h>
#include <xrpl/protocol/STLedgerEntry.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/XRPAmount.h>
 
#include <cstdint>
#include <functional>
#include <map>
#include <optional>
#include <set>
#include <utility>
#include <vector>
 
namespace xrpl {
 
enum class SkipEntry : bool { No = false, Yes };
 
//------------------------------------------------------------------------------
//
// Observers
//
//------------------------------------------------------------------------------

enum class ExpiryComparison { Inclusive, Exclusive };

[[nodiscard]] bool
hasExpired(
    ReadView const& view,
    std::optional<std::uint32_t> const& exp,
    ExpiryComparison comparison = ExpiryComparison::Inclusive);
 
// Note, depth parameter is used to limit the recursion depth
[[nodiscard]] bool
isVaultPseudoAccountFrozen(
    ReadView const& view,
    AccountID const& account,
    MPTIssue const& mptShare,
    std::uint8_t depth);
 
[[nodiscard]] bool
isVaultPseudoAccountFrozen(
    ReadView const& view,
    AccountID const& account,
    SLE const& issuanceSle,
    std::uint8_t depth);
 
[[nodiscard]] bool
isLPTokenFrozen(
    ReadView const& view,
    AccountID const& account,
    Asset const& asset,
    Asset const& asset2);

[[nodiscard]] TER
canTransferLPToken(
    ReadView const& view,
    AccountID const& from,
    AccountID const& to,
    AccountID const& lpTokenIssuer);
 
// Return the list of enabled amendments
[[nodiscard]] std::set<UInt256>
getEnabledAmendments(ReadView const& view);
 
// Return a map of amendments that have achieved majority
using MajorityAmendmentsT = std::map<UInt256, NetClock::time_point>;
[[nodiscard]] MajorityAmendmentsT
getMajorityAmendments(ReadView const& view);

[[nodiscard]] std::optional<UInt256>
hashOfSeq(ReadView const& ledger, LedgerIndex seq, beast::Journal journal);

inline LedgerIndex
getCandidateLedger(LedgerIndex requested)
{
    return (requested + 255) & (~255);
}

[[nodiscard]] bool
areCompatible(
    ReadView const& validLedger,
    ReadView const& testLedger,
    beast::Journal::Stream& s,
    char const* reason);
 
[[nodiscard]] bool
areCompatible(
    UInt256 const& validHash,
    LedgerIndex validIndex,
    ReadView const& testLedger,
    beast::Journal::Stream& s,
    char const* reason);
 
//------------------------------------------------------------------------------
//
// Modifiers
//
//------------------------------------------------------------------------------
 
[[nodiscard]] TER
dirLink(
    ApplyView& view,
    AccountID const& owner,
    SLE::pointer& object,
    SF_UINT64 const& node = sfOwnerNode);

[[nodiscard]] TER
canWithdraw(
    ReadView const& view,
    AccountID const& from,
    AccountID const& to,
    SLE::ConstRef toSle,
    STAmount const& amount,
    bool hasDestinationTag,
    std::optional<std::vector<UInt256>> const& credentialIDs = std::nullopt);

[[nodiscard]] TER
canWithdraw(
    ReadView const& view,
    AccountID const& from,
    AccountID const& to,
    STAmount const& amount,
    bool hasDestinationTag,
    std::optional<std::vector<UInt256>> const& credentialIDs = std::nullopt);

[[nodiscard]] TER
canWithdraw(ReadView const& view, STTx const& tx);
 
[[nodiscard]] TER
doWithdraw(
    ApplyViewContext ctx,
    AccountID const& senderAcct,
    AccountID const& dstAcct,
    AccountID const& sourceAcct,
    XRPAmount priorBalance,
    STAmount const& amount,
    beast::Journal j);

using EntryDeleter =
    std::function<std::pair<TER, SkipEntry>(LedgerEntryType, UInt256 const&, SLE::pointer&)>;
[[nodiscard]] TER
cleanupOnAccountDelete(
    ApplyView& view,
    Keylet const& ownerDirKeylet,
    EntryDeleter const& deleter,
    beast::Journal j,
    std::optional<std::uint16_t> maxNodesToDelete = std::nullopt);

bool
after(NetClock::time_point now, std::uint32_t mark);
 
}  // namespace xrpl