InvariantCheck.h

#pragma once
 
#include <xrpl/beast/utility/Journal.h>
#include <xrpl/ledger/ReadView.h>
#include <xrpl/protocol/STLedgerEntry.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/XRPAmount.h>
#include <xrpl/tx/invariants/AMMInvariant.h>
#include <xrpl/tx/invariants/DirectoryInvariant.h>
#include <xrpl/tx/invariants/FreezeInvariant.h>
#include <xrpl/tx/invariants/LoanBrokerInvariant.h>
#include <xrpl/tx/invariants/LoanInvariant.h>
#include <xrpl/tx/invariants/MPTInvariant.h>
#include <xrpl/tx/invariants/NFTInvariant.h>
#include <xrpl/tx/invariants/PermissionedDEXInvariant.h>
#include <xrpl/tx/invariants/PermissionedDomainInvariant.h>
#include <xrpl/tx/invariants/SponsorshipInvariant.h>
#include <xrpl/tx/invariants/VaultInvariant.h>
 
#include <cstdint>
#include <set>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
namespace xrpl {
 
#if GENERATING_DOCS
class InvariantChecker_PROTOTYPE
{
public:
    explicit InvariantChecker_PROTOTYPE() = default;

    void
    visitEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after);

    bool
    finalize(
        STTx const& tx,
        TER const tec,
        XRPAmount const fee,
        ReadView const& view,
        beast::Journal const& j);
};
#endif

class TransactionFeeCheck
{
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    static bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&);
};

class XRPNotCreated
{
    std::int64_t drops_ = 0;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class AccountRootsNotDeleted
{
    std::uint32_t accountsDeleted_ = 0;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class AccountRootsDeletedClean
{
    // Pair is <before, after>. Before is used for most of the checks, so that
    // if, for example, an object ID field is cleared, but the object is not
    // deleted, it can still be found. After is used specifically for any checks
    // that are expected as part of the deletion, such as zeroing out the
    // balance.
    std::vector<std::pair<SLE::const_pointer, SLE::const_pointer>> accountsDeleted_;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&);
};

class XRPBalanceChecks
{
    bool bad_ = false;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class LedgerEntryTypesMatch
{
    bool typeMismatch_ = false;
    bool invalidTypeAdded_ = false;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class NoXRPTrustLines
{
    bool xrpTrustLine_ = false;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class NoDeepFreezeTrustLinesWithoutFreeze
{
    bool deepFreezeWithoutFreeze_ = false;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class NoBadOffers
{
    bool bad_ = false;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class NoZeroEscrow
{
    bool bad_ = false;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class ValidNewAccountRoot
{
    std::uint32_t accountsCreated_ = 0;
    std::uint32_t accountSeq_ = 0;
    bool pseudoAccount_ = false;
    std::uint32_t flags_ = 0;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class ValidClawback
{
    struct EntryChange
    {
        SLE::const_pointer before;
        SLE::const_pointer after;
    };
 
    std::uint32_t trustlinesChanged_ = 0;
    std::uint32_t mptokensChanged_ = 0;
    EntryChange iou_;
    EntryChange mpt_;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};

class ValidPseudoAccounts
{
    std::vector<std::string> errors_;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&);
};

class NoModifiedUnmodifiableFields
{
    // Pair is <before, after>.
    std::set<std::pair<SLE::const_pointer, SLE::const_pointer>> changedEntries_;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&);
};

class ValidAmounts
{
    std::vector<SLE::const_pointer> afterEntries_;
 
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
};
 
/*
 * Verify that when an object with an associated pseudo-account is deleted,
 * its pseudo-account is also deleted.
 *
 * The reverse (pseudo-account deleted → object deleted) is enforced by
 * AccountRootsDeletedClean via getPseudoAccountFields().
 */
class ObjectHasPseudoAccount
{
public:
    void
    visitEntry(bool, SLE::const_ref, SLE::const_ref);
 
    [[nodiscard]] bool
    finalize(STTx const&, TER const, XRPAmount const, ReadView const&, beast::Journal const&) const;
 
private:
    std::vector<SLE::const_pointer> deletedObjSles_;
};
// additional invariant checks can be declared above and then added to this
// tuple
using InvariantChecks = std::tuple<
    TransactionFeeCheck,
    AccountRootsNotDeleted,
    AccountRootsDeletedClean,
    LedgerEntryTypesMatch,
    XRPBalanceChecks,
    XRPNotCreated,
    NoXRPTrustLines,
    NoDeepFreezeTrustLinesWithoutFreeze,
    TransfersNotFrozen,
    NoBadOffers,
    NoZeroEscrow,
    ValidNewAccountRoot,
    ValidNFTokenPage,
    NFTokenCountTracking,
    ValidClawback,
    ValidMPTIssuance,
    ValidPermissionedDomain,
    ValidPermissionedDEX,
    ValidBookDirectory,
    ValidAMM,
    NoModifiedUnmodifiableFields,
    ValidPseudoAccounts,
    ValidLoanBroker,
    ValidLoan,
    ValidVault,
    ValidConfidentialMPToken,
    ValidMPTBalanceChanges,
    ValidAmounts,
    ValidMPTTransfer,
    ObjectHasPseudoAccount,
    SponsorshipOwnerCountsMatch,
    SponsorshipAccountCountMatchesField>;

inline InvariantChecks
getInvariantChecks()
{
    return InvariantChecks{};
}
 
}  // namespace xrpl