AMMContext.h

#pragma once
 
#include <xrpl/protocol/AccountID.h>
 
#include <cstdint>
 
namespace xrpl {

class AMMContext
{
public:
    // Restrict number of AMM offers. If this restriction is removed
    // then need to restrict in some other way because AMM offers are
    // not counted in the BookStep offer counter.
    static constexpr std::uint8_t kMaxIterations = 30;
 
private:
    // Tx account owner is required to get the AMM trading fee in BookStep
    AccountID accountID_;
    // true if payment has multiple paths
    bool multiPath_{false};
    // Is true if AMM offer is consumed during a payment engine iteration.
    bool ammUsed_{false};
    // Counter of payment engine iterations with consumed AMM
    std::uint16_t ammIters_{0};
 
public:
    AMMContext(AccountID const& account, bool multiPath)
        : accountID_(account), multiPath_(multiPath)
    {
    }
    ~AMMContext() = default;
    AMMContext(AMMContext const&) = delete;
    AMMContext&
    operator=(AMMContext const&) = delete;
 
    [[nodiscard]] bool
    multiPath() const
    {
        return multiPath_;
    }
 
    void
    setMultiPath(bool fs)
    {
        multiPath_ = fs;
    }
 
    void
    setAMMUsed()
    {
        ammUsed_ = true;
    }
 
    void
    update()
    {
        if (ammUsed_)
            ++ammIters_;
        ammUsed_ = false;
    }
 
    [[nodiscard]] bool
    maxItersReached() const
    {
        return ammIters_ >= kMaxIterations;
    }
 
    [[nodiscard]] std::uint16_t
    curIters() const
    {
        return ammIters_;
    }
 
    [[nodiscard]] AccountID
    account() const
    {
        return accountID_;
    }

    void
    clear()
    {
        ammUsed_ = false;
    }
};
 
}  // namespace xrpl