AMMWithdraw.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2023 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_TX_AMMWITHDRAW_H_INCLUDED
#define RIPPLE_TX_AMMWITHDRAW_H_INCLUDED
 
#include <xrpld/app/tx/detail/Transactor.h>
 
#include <xrpl/ledger/View.h>
 
namespace ripple {
 
class Sandbox;
 
enum class WithdrawAll : bool { No = false, Yes };
 
class AMMWithdraw : public Transactor
{
public:
    static constexpr ConsequencesFactoryType ConsequencesFactory{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;
 
    static std::tuple<TER, STAmount, STAmount, std::optional<STAmount>>
    equalWithdrawTokens(
        Sandbox& view,
        SLE const& ammSle,
        AccountID const account,
        AccountID const& ammAccount,
        STAmount const& amountBalance,
        STAmount const& amount2Balance,
        STAmount const& lptAMMBalance,
        STAmount const& lpTokens,
        STAmount const& lpTokensWithdraw,
        std::uint16_t tfee,
        FreezeHandling freezeHanding,
        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,
        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,
        WithdrawAll withdrawAll,
        XRPAmount const& priorBalance,
        beast::Journal const& journal);
 
    static std::pair<TER, bool>
    deleteAMMAccountIfEmpty(
        Sandbox& sb,
        std::shared_ptr<SLE> const ammSle,
        STAmount const& lpTokenBalance,
        Issue const& issue1,
        Issue const& issue2,
        beast::Journal const& journal);
 
private:
    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 ripple
 
#endif  // RIPPLE_TX_AMMWITHDRAW_H_INCLUDED