Transaction.h

#pragma once
 
#include <xrpl/basics/RangeSet.h>
#include <xrpl/beast/utility/Journal.h>
#include <xrpl/protocol/ErrorCodes.h>
#include <xrpl/protocol/Protocol.h>
#include <xrpl/protocol/STBase.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/TxMeta.h>
#include <xrpl/protocol/TxSearched.h>
 
#include <optional>
#include <variant>
 
namespace xrpl {
 
//
// Transactions should be constructed in JSON with. Use STObject::parseJson to
// obtain a binary version.
//
 
class Application;
class Rules;
 
enum class TransStatus {
    NEW = 0,         // just received / generated
    INVALID = 1,     // no valid signature, insufficient funds
    INCLUDED = 2,    // added to the current ledger
    CONFLICTED = 3,  // losing to a conflicting transaction
    COMMITTED = 4,   // known to be in a ledger
    HELD = 5,        // not valid now, maybe later
    REMOVED = 6,     // taken out of a ledger
    OBSOLETE = 7,    // a compatible transaction has taken precedence
    INCOMPLETE = 8   // needs more signatures
};
 
// This class is for constructing and examining transactions.
// Transactions are static so manipulation functions are unnecessary.
class Transaction : public std::enable_shared_from_this<Transaction>,
                    public CountedObject<Transaction>
{
public:
    using pointer = std::shared_ptr<Transaction>;
    using ref = pointer const&;
 
    Transaction(std::shared_ptr<STTx const> const&, std::string&, Application&) noexcept;
 
    // The two boost::optional parameters are because SOCI requires
    // boost::optional (not std::optional) parameters.
    static Transaction::pointer
    transactionFromSQL(
        boost::optional<std::uint64_t> const& ledgerSeq,
        boost::optional<std::string> const& status,
        Blob const& rawTxn,
        Application& app);
 
    // The boost::optional parameter is because SOCI requires
    // boost::optional (not std::optional) parameters.
    static TransStatus
    sqlTransactionStatus(boost::optional<std::string> const& status);
 
    std::shared_ptr<STTx const> const&
    getSTransaction()
    {
        return transaction_;
    }
 
    uint256 const&
    getID() const
    {
        return transactionID_;
    }
 
    LedgerIndex
    getLedger() const
    {
        return ledgerIndex_;
    }
 
    bool
    isValidated() const
    {
        return ledgerIndex_ != 0;
    }
 
    TransStatus
    getStatus() const
    {
        return status_;
    }
 
    TER
    getResult()
    {
        return result_;
    }
 
    void
    setResult(TER terResult)
    {
        result_ = terResult;
    }
 
    void
    setStatus(
        TransStatus status,
        std::uint32_t ledgerSeq,
        std::optional<uint32_t> transactionSeq = std::nullopt,
        std::optional<uint32_t> networkID = std::nullopt);
 
    void
    setStatus(TransStatus status)
    {
        status_ = status;
    }
 
    void
    setLedger(LedgerIndex ledger)
    {
        ledgerIndex_ = ledger;
    }

    void
    setApplying()
    {
        // Note that all access to applying_ are made by NetworkOPsImp, and must
        // be done under that class's lock.
        applying_ = true;
    }

    bool
    getApplying() const
    {
        // Note that all access to applying_ are made by NetworkOPsImp, and must
        // be done under that class's lock.
        return applying_;
    }

    void
    clearApplying()
    {
        // Note that all access to applying_ are made by NetworkOPsImp, and must
        // be done under that class's lock.
        applying_ = false;
    }
 
    struct SubmitResult
    {
        void
        clear()
        {
            applied = false;
            broadcast = false;
            queued = false;
            kept = false;
        }

        [[nodiscard]] bool
        any() const
        {
            return applied || broadcast || queued || kept;
        }
 
        bool applied = false;
        bool broadcast = false;
        bool queued = false;
        bool kept = false;
    };

    SubmitResult
    getSubmitResult() const
    {
        return submitResult_;
    }

    void
    clearSubmitResult()
    {
        submitResult_.clear();
    }

    void
    setApplied()
    {
        submitResult_.applied = true;
    }

    void
    setQueued()
    {
        submitResult_.queued = true;
    }

    void
    setBroadcast()
    {
        submitResult_.broadcast = true;
    }

    void
    setKept()
    {
        submitResult_.kept = true;
    }
 
    struct CurrentLedgerState
    {
        CurrentLedgerState() = delete;
 
        CurrentLedgerState(
            LedgerIndex li,
            XRPAmount fee,
            std::uint32_t accSeqNext,
            std::uint32_t accSeqAvail)
            : validatedLedger{li}
            , minFeeRequired{fee}
            , accountSeqNext{accSeqNext}
            , accountSeqAvail{accSeqAvail}
        {
        }
 
        LedgerIndex validatedLedger;
        XRPAmount minFeeRequired;
        std::uint32_t accountSeqNext;
        std::uint32_t accountSeqAvail;
    };

    std::optional<CurrentLedgerState>
    getCurrentLedgerState() const
    {
        return currentLedgerState_;
    }

    void
    setCurrentLedgerState(
        LedgerIndex validatedLedger,
        XRPAmount fee,
        std::uint32_t accountSeq,
        std::uint32_t availableSeq)
    {
        currentLedgerState_.emplace(validatedLedger, fee, accountSeq, availableSeq);
    }
 
    json::Value
    getJson(JsonOptions options, bool binary = false) const;
 
    // Information used to locate a transaction.
    // Contains a nodestore hash and ledger sequence pair if the transaction was
    // found. Otherwise, contains the range of ledgers present in the database
    // at the time of search.
    struct Locator
    {
        std::variant<std::pair<uint256, uint32_t>, ClosedInterval<uint32_t>> locator;
 
        // @return true if transaction was found, false otherwise
        //
        // Call this function first to determine the type of the contained info.
        // Calling the wrong getter function will throw an exception.
        // See documentation for the getter functions for more details
        [[nodiscard]] bool
        isFound() const
        {
            return std::holds_alternative<std::pair<uint256, uint32_t>>(locator);
        }
 
        // @return key used to find transaction in nodestore
        //
        // Throws if isFound() returns false
        uint256 const&
        getNodestoreHash()
        {
            return std::get<std::pair<uint256, uint32_t>>(locator).first;
        }
 
        // @return sequence of ledger containing the transaction
        //
        // Throws is isFound() returns false
        uint32_t
        getLedgerSequence()
        {
            return std::get<std::pair<uint256, uint32_t>>(locator).second;
        }
 
        // @return range of ledgers searched
        //
        // Throws if isFound() returns true
        ClosedInterval<uint32_t> const&
        getLedgerRangeSearched()
        {
            return std::get<ClosedInterval<uint32_t>>(locator);
        }
    };
 
    static Locator
    locate(uint256 const& id, Application& app);
 
    static std::
        variant<std::pair<std::shared_ptr<Transaction>, std::shared_ptr<TxMeta>>, TxSearched>
        load(uint256 const& id, Application& app, ErrorCodeI& ec);
 
    static std::
        variant<std::pair<std::shared_ptr<Transaction>, std::shared_ptr<TxMeta>>, TxSearched>
        load(
            uint256 const& id,
            Application& app,
            ClosedInterval<uint32_t> const& range,
            ErrorCodeI& ec);
 
private:
    static std::
        variant<std::pair<std::shared_ptr<Transaction>, std::shared_ptr<TxMeta>>, TxSearched>
        load(
            uint256 const& id,
            Application& app,
            std::optional<ClosedInterval<uint32_t>> const& range,
            ErrorCodeI& ec);
 
    uint256 transactionID_;
 
    LedgerIndex ledgerIndex_ = 0;
    std::optional<uint32_t> txnSeq_;
    std::optional<uint32_t> networkID_;
    TransStatus status_ = TransStatus::INVALID;
    TER result_ = temUNCERTAIN;
    /* Note that all access to applying_ are made by NetworkOPsImp,
        and must be done under that class's lock. This avoids the overhead of
        taking a separate lock, and the consequences of a race condition are
        nearly-zero.
 
        1. If there is a race condition, and getApplying returns false when it
            should be true, the transaction will be processed again. Not that
            big a deal if it's a rare one-off. Most of the time, it'll get
            tefALREADY or tefPAST_SEQ.
        2. On the flip side, if it returns true, when it should be false, then
            the transaction must have been attempted recently, so no big deal if
            it doesn't immediately get tried right away.
        3. If there's a race between setApplying and clearApplying, and the
            flag ends up set, then a batch is about to try to process the
            transaction and will call clearApplying later. If it ends up
            cleared, then it might get attempted again later as is the case with
            item 1.
    */
    bool applying_ = false;

    SubmitResult submitResult_;
 
    std::optional<CurrentLedgerState> currentLedgerState_;
 
    std::shared_ptr<STTx const> transaction_;
    Application& app_;
    beast::Journal j_;
};
 
}  // namespace xrpl