xrpld
Loading...
Searching...
No Matches
tx/transactors/dex/AMMDeposit.h
1#pragma once
2
3#include <xrpl/beast/utility/Journal.h>
4#include <xrpl/core/ServiceRegistry.h>
5#include <xrpl/ledger/ReadView.h>
6#include <xrpl/protocol/AccountID.h>
7#include <xrpl/protocol/Asset.h>
8#include <xrpl/protocol/STAmount.h>
9#include <xrpl/protocol/STTx.h>
10#include <xrpl/protocol/TER.h>
11#include <xrpl/protocol/XRPAmount.h>
12#include <xrpl/tx/ApplyContext.h>
13#include <xrpl/tx/Transactor.h>
14
15#include <cstdint>
16#include <optional>
17#include <utility>
18
19namespace xrpl {
20
21class Sandbox;
22
57class AMMDeposit : public Transactor
58{
59public:
61
62 explicit AMMDeposit(ApplyContext& ctx) : Transactor(ctx)
63 {
64 }
65
66 static bool
68
69 static std::uint32_t
71
72 static NotTEC
73 preflight(PreflightContext const& ctx);
74
75 static TER
76 preclaim(PreclaimContext const& ctx);
77
78 TER
79 doApply() override;
80
81 void
82 visitInvariantEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after) override;
83
84 [[nodiscard]] bool
86 STTx const& tx,
87 TER result,
88 XRPAmount fee,
89 ReadView const& view,
90 beast::Journal const& j) override;
91
92private:
95
113 deposit(
114 Sandbox& view,
115 AccountID const& ammAccount,
116 STAmount const& amountBalance,
117 STAmount const& amountDeposit,
118 std::optional<STAmount> const& amount2Deposit,
119 STAmount const& lptAMMBalance,
120 STAmount const& lpTokensDeposit,
121 std::optional<STAmount> const& depositMin,
122 std::optional<STAmount> const& deposit2Min,
123 std::optional<STAmount> const& lpTokensDepositMin,
124 std::uint16_t tfee);
125
142 Sandbox& view,
143 AccountID const& ammAccount,
144 STAmount const& amountBalance,
145 STAmount const& amount2Balance,
146 STAmount const& lptAMMBalance,
147 STAmount const& lpTokensDeposit,
148 std::optional<STAmount> const& depositMin,
149 std::optional<STAmount> const& deposit2Min,
150 std::uint16_t tfee);
151
169 Sandbox& view,
170 AccountID const& ammAccount,
171 STAmount const& amountBalance,
172 STAmount const& amount2Balance,
173 STAmount const& lptAMMBalance,
174 STAmount const& amount,
175 STAmount const& amount2,
176 std::optional<STAmount> const& lpTokensDepositMin,
177 std::uint16_t tfee);
178
193 Sandbox& view,
194 AccountID const& ammAccount,
195 STAmount const& amountBalance,
196 STAmount const& lptAMMBalance,
197 STAmount const& amount,
198 std::optional<STAmount> const& lpTokensDepositMin,
199 std::uint16_t tfee);
200
215 Sandbox& view,
216 AccountID const& ammAccount,
217 STAmount const& amountBalance,
218 STAmount const& amount,
219 STAmount const& lptAMMBalance,
220 STAmount const& lpTokensDeposit,
221 std::uint16_t tfee);
222
237 Sandbox& view,
238 AccountID const& ammAccount,
239 STAmount const& amountBalance,
240 STAmount const& amount,
241 STAmount const& lptAMMBalance,
242 STAmount const& ePrice,
243 std::uint16_t tfee);
244
256 Sandbox& view,
257 AccountID const& ammAccount,
258 STAmount const& amount,
259 STAmount const& amount2,
260 Asset const& lptIssue,
261 std::uint16_t tfee);
262};
263
264} // namespace xrpl
A generic endpoint for log messages.
Definition Journal.h:44
static TER preclaim(PreclaimContext const &ctx)
static bool checkExtraFeatures(PreflightContext const &ctx)
static std::uint32_t getFlagsMask(PreflightContext const &ctx)
static constexpr auto kConsequencesFactory
void visitInvariantEntry(bool isDelete, SLE::const_ref before, SLE::const_ref after) override
Inspect a single ledger entry modified by this transaction.
std::pair< TER, STAmount > singleDepositTokens(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &amount, STAmount const &lptAMMBalance, STAmount const &lpTokensDeposit, std::uint16_t tfee)
Single asset deposit (Asset1In, LPTokens) by the tokens.
std::pair< TER, STAmount > equalDepositInEmptyState(Sandbox &view, AccountID const &ammAccount, STAmount const &amount, STAmount const &amount2, Asset const &lptIssue, std::uint16_t tfee)
Equal deposit in empty AMM state (LP tokens balance is 0).
std::pair< TER, STAmount > equalDepositTokens(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &amount2Balance, STAmount const &lptAMMBalance, STAmount const &lpTokensDeposit, std::optional< STAmount > const &depositMin, std::optional< STAmount > const &deposit2Min, std::uint16_t tfee)
Equal asset deposit (LPTokens) for the specified share of the AMM instance pools.
std::pair< TER, STAmount > singleDepositEPrice(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &amount, STAmount const &lptAMMBalance, STAmount const &ePrice, std::uint16_t tfee)
Single asset deposit (Asset1In, EPrice) with two constraints.
std::pair< TER, bool > applyGuts(Sandbox &view)
std::pair< TER, STAmount > singleDeposit(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &lptAMMBalance, STAmount const &amount, std::optional< STAmount > const &lpTokensDepositMin, std::uint16_t tfee)
Single asset deposit (Asset1In) by the amount.
static NotTEC preflight(PreflightContext const &ctx)
TER doApply() override
bool finalizeInvariants(STTx const &tx, TER result, XRPAmount fee, ReadView const &view, beast::Journal const &j) override
Check transaction-specific post-conditions after all entries have been visited.
std::pair< TER, STAmount > equalDepositLimit(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &amount2Balance, STAmount const &lptAMMBalance, STAmount const &amount, STAmount const &amount2, std::optional< STAmount > const &lpTokensDepositMin, std::uint16_t tfee)
Equal asset deposit (Asset1In, Asset2In) with the constraint on the maximum amount of both assets tha...
std::pair< TER, STAmount > deposit(Sandbox &view, AccountID const &ammAccount, STAmount const &amountBalance, STAmount const &amountDeposit, std::optional< STAmount > const &amount2Deposit, STAmount const &lptAMMBalance, STAmount const &lpTokensDeposit, std::optional< STAmount > const &depositMin, std::optional< STAmount > const &deposit2Min, std::optional< STAmount > const &lpTokensDepositMin, std::uint16_t tfee)
Deposit requested assets and token amount into LP account.
State information when applying a tx.
A view into a ledger.
Definition ReadView.h:41
std::shared_ptr< STLedgerEntry const > const & const_ref
Discardable, editable view to a ledger.
Definition Sandbox.h:18
ApplyView & view()
Definition Transactor.h:175
Transactor(Transactor const &)=delete
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition algorithm.h:5
TERSubset< CanCvtToNotTEC > NotTEC
Definition TER.h:607
bool after(NetClock::time_point now, std::uint32_t mark)
Has the specified time passed?
Definition View.cpp:572
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
Definition AccountID.h:34
TERSubset< CanCvtToTER > TER
Definition TER.h:647
State information when determining if a tx is likely to claim a fee.
Definition Transactor.h:83
State information when preflighting a tx.
Definition Transactor.h:38