tx/transactors/dex/AMMWithdraw.h

#pragma once
 
#include <xrpl/beast/utility/Journal.h>
#include <xrpl/core/ServiceRegistry.h>
#include <xrpl/ledger/ReadView.h>
#include <xrpl/ledger/helpers/TokenHelpers.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/Asset.h>
#include <xrpl/protocol/STAmount.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/XRPAmount.h>
#include <xrpl/tx/ApplyContext.h>
#include <xrpl/tx/Transactor.h>
 
#include <cstdint>
#include <optional>
#include <tuple>
#include <utility>
 
namespace xrpl {
 
class Sandbox;

 
enum class WithdrawAll : bool { No = false, Yes };
 
class AMMWithdraw : public Transactor
{
public:
    static constexpr auto kConsequencesFactory = ConsequencesFactoryType::Normal;
 
    explicit AMMWithdraw(ApplyContext& ctx) : Transactor(ctx)
    {
    }
 
    static bool
    checkExtraFeatures(PreflightContext const& ctx);
 
    static std::uint32_t
    getFlagsMask(PreflightContext const& ctx);
 
    static NotTEC
    preflight(PreflightContext const& ctx);
 
    static TER
    preclaim(PreclaimContext const& ctx);
 
    TER
    doApply() override;
 
    void
    visitInvariantEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after) override;
 
    [[nodiscard]] bool
    finalizeInvariants(
        STTx const& tx,
        TER result,
        XRPAmount fee,
        ReadView const& view,
        beast::Journal const& j) override;

    static std::tuple<TER, STAmount, STAmount, std::optional<STAmount>>
    equalWithdrawTokens(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const account,
        std::optional<AccountID> const& clawbackIssuer,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& amount2Balance,
        STAmount const& lptAMMBalance,
        STAmount const& lpTokens,
        STAmount const& lpTokensWithdraw,
        std::uint16_t tfee,
        FreezeHandling freezeHandling,
        AuthHandling authHandling,
        WithdrawAll withdrawAll,
        XRPAmount const& priorBalance,
        beast::Journal const& journal);

    static std::tuple<TER, STAmount, STAmount, std::optional<STAmount>>
    withdraw(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const& ammAccount,
        std::optional<AccountID> const& clawbackIssuer,
        AccountID const& account,
        STAmount const& amountBalance,
        STAmount const& amountWithdraw,
        std::optional<STAmount> const& amount2Withdraw,
        STAmount const& lpTokensAMMBalance,
        STAmount const& lpTokensWithdraw,
        std::uint16_t tfee,
        FreezeHandling freezeHandling,
        AuthHandling authHandling,
        WithdrawAll withdrawAll,
        XRPAmount const& priorBalance,
        beast::Journal const& journal);
 
    static std::pair<TER, bool>
    deleteAMMAccountIfEmpty(
        Sandbox& sb,
        SLE::pointer const ammSle,
        STAmount const& lpTokenBalance,
        Asset const& asset1,
        Asset const& asset2,
        beast::Journal const& journal);
 
private:
    [[nodiscard]] FreezeHandling
    issuerFreezeHandling() const;
 
    std::pair<TER, bool>
    applyGuts(Sandbox& view);

    std::pair<TER, STAmount>
    withdraw(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& amountWithdraw,
        std::optional<STAmount> const& amount2Withdraw,
        STAmount const& lpTokensAMMBalance,
        STAmount const& lpTokensWithdraw,
        std::uint16_t tfee);

    std::pair<TER, STAmount>
    equalWithdrawTokens(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& amount2Balance,
        STAmount const& lptAMMBalance,
        STAmount const& lpTokens,
        STAmount const& lpTokensWithdraw,
        std::uint16_t tfee);

    std::pair<TER, STAmount>
    equalWithdrawLimit(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& amount2Balance,
        STAmount const& lptAMMBalance,
        STAmount const& amount,
        STAmount const& amount2,
        std::uint16_t tfee);

    std::pair<TER, STAmount>
    singleWithdraw(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& lptAMMBalance,
        STAmount const& amount,
        std::uint16_t tfee);

    std::pair<TER, STAmount>
    singleWithdrawTokens(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& lptAMMBalance,
        STAmount const& amount,
        STAmount const& lpTokensWithdraw,
        std::uint16_t tfee);

    std::pair<TER, STAmount>
    singleWithdrawEPrice(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& lptAMMBalance,
        STAmount const& amount,
        STAmount const& ePrice,
        std::uint16_t tfee);

    static WithdrawAll
    isWithdrawAll(STTx const& tx);
};
 
}  // namespace xrpl