1#include <test/jtx/AMM.h>
2#include <test/jtx/Env.h>
4#include <xrpl/basics/safe_cast.h>
5#include <xrpl/protocol/AMMCore.h>
6#include <xrpl/protocol/AmountConversions.h>
7#include <xrpl/protocol/ApiVersion.h>
8#include <xrpl/protocol/jss.h>
9#include <xrpl/tx/transactors/dex/AMMHelpers.h>
10#include <xrpl/tx/transactors/dex/AMMUtils.h>
49 , creatorAccount_(account)
52 , ammID_(keylet::amm(asset1_.issue(), asset2_.issue()).key)
55 , lastPurchasePrice_(0)
59 , lptIssue_(
xrpl::
ammLPTIssue(asset1_.issue().currency, asset2_.issue().currency, ammAccount_))
60 , initialLPTokens_(initialTokens())
119 jv[jss::TradingFee] = tfee;
120 jv[jss::TransactionType] = jss::AMMCreate;
122 jv[jss::Flags] = *
flags;
137 return amm->getAccountID(sfAccount);
151 unsigned apiVersion)
const
157 jv[jss::ledger_index] = *ledgerIndex;
160 if (issue1 || issue2)
179 if (jr.isObject() && jr.isMember(jss::result) && jr[jss::result].isMember(jss::status))
180 return jr[jss::result];
190 auto const ammAccountID = amm->getAccountID(sfAccount);
191 auto const [asset1Balance, asset2Balance] =
ammPoolHolds(
198 auto const lptAMMBalance = account
200 : amm->getFieldAmount(sfLPTokenBalance);
201 return {asset1Balance, asset2Balance, lptAMMBalance};
213 auto const [asset1Balance, asset2Balance, lptAMMBalance] =
215 return asset1 == asset1Balance && asset2 == asset2Balance &&
233 return amm->getFieldAmount(sfLPTokenBalance).iou();
258 return slotFee ==
fee &&
261 ((!timeSlot && slotInterval == 0) || slotInterval == timeSlot) &&
262 slotPrice == expectedPrice;
271 for (
auto const& account : accounts)
276 account.getAccountID(sfAccount)) == authAccounts.
end())
287 return amm && (*amm)[sfTradingFee] ==
fee;
319 auto const& jv = jvRes[jss::amm];
320 if (!jv.isMember(jss::amount) || !jv.isMember(jss::amount2) || !jv.isMember(jss::lp_token))
334 return asset1 == asset1Info && asset2 == asset2Info &&
363 jv[jss::Account] = acct.human();
365 jv[jss::TransactionType] = jss::AMMDeposit;
402 assert(!(asset2In && maxEP));
433 asset1In->setJson(jv[jss::Amount]);
435 asset2In->setJson(jv[jss::Amount2]);
437 maxEP->setJson(jv[jss::EPrice]);
439 jv[jss::TradingFee] = *tfee;
450 jvFlags |= tfLPToken;
452 else if (
tokens && asset1In)
454 jvFlags |= tfOneAssetLPToken;
456 else if (asset1In && asset2In)
458 jvFlags |= tfTwoAsset;
460 else if (maxEP && asset1In)
462 jvFlags |= tfLimitLPToken;
466 jvFlags |= tfSingleAsset;
469 jv[jss::Flags] = jvFlags;
499 jv[jss::Account] = acct.human();
501 jv[jss::TransactionType] = jss::AMMWithdraw;
536 assert(!(asset2Out && maxEP));
565 asset1Out->setJson(jv[jss::Amount]);
567 asset2Out->setJson(jv[jss::Amount2]);
571 saMaxEP.
setJson(jv[jss::EPrice]);
580 jvFlags |= tfLPToken;
582 else if (asset1Out && asset2Out)
584 jvFlags |= tfTwoAsset;
586 else if (
tokens && asset1Out)
588 jvFlags |= tfOneAssetLPToken;
590 else if (asset1Out && maxEP)
592 jvFlags |= tfLimitLPToken;
596 jvFlags |= tfSingleAsset;
599 jv[jss::Flags] = jvFlags;
630 jv[jss::TradingFee] = feeVal;
631 jv[jss::TransactionType] = jss::AMMVote;
633 jv[jss::Flags] = *
flags;
651 !
env_.
current()->rules().enabled(fixInnerObjTemplate) ||
652 amm->isFieldPresent(sfAuctionSlot));
653 if (amm->isFieldPresent(sfAuctionSlot))
655 auto const& auctionSlot =
656 safe_downcast<STObject const&>(amm->peekAtField(sfAuctionSlot));
666 auto getBid = [&](
auto const&
bid) {
681 saTokens.
setJson(jv[jss::BidMin]);
687 saTokens.
setJson(jv[jss::BidMax]);
697 acct[jss::Account] = account.human();
698 authAcct[jss::AuthAccount] = acct;
699 accounts.
append(authAcct);
701 jv[jss::AuthAccounts] = accounts;
704 jv[jss::Flags] = *arg.
flags;
705 jv[jss::TransactionType] = jss::AMMBid;
764 !
env_.
current()->rules().enabled(fixInnerObjTemplate) ||
765 amm->isFieldPresent(sfAuctionSlot));
766 if (amm->isFieldPresent(sfAuctionSlot))
768 auto const& auctionSlot =
769 safe_downcast<STObject const&>(amm->peekAtField(sfAuctionSlot));
770 if (auctionSlot.isFieldPresent(sfAccount))
776 auto const slotFee = auctionSlot[~sfDiscountedFee].value_or(0);
779 auto const slotPrice = auctionSlot[sfPrice].iou();
780 auto const authAccounts = auctionSlot.getFieldArray(sfAuthAccounts);
781 return cb(slotFee, slotInterval, slotPrice, authAccounts);
794 jv[jss::TransactionType] = jss::AMMDelete;
805 Throw<std::runtime_error>(
"trust() requires IOU");
809 jv[jss::TransactionType] = jss::TrustSet;
810 jv[jss::Flags] =
flags;
817 jv[jss::Account] = account.human();
820 jv[jss::TransactionType] = jss::Payment;
833 jv[jss::TransactionType] = jss::AMMClawback;
834 jv[jss::Account] = issuer.
human();
835 jv[jss::Holder] = holder.
human();
836 jv[jss::Asset] =
to_json(asset);
837 jv[jss::Asset2] =
to_json(asset2);
Value & append(Value const &value)
Append value to array at the end.
std::string toStyledString() const
bool isMember(char const *key) const
Return true if the object has a member named key.
Floating point representation of amounts with high dynamic range.
A currency issued by an account.
void setJson(Json::Value &jv) const
Json::Value getJson(JsonOptions=JsonOptions::none) const override
Issue const & issue() const
void setJson(Json::Value &) const
Json::Value getJson(JsonOptions) const override
virtual TimeKeeper & getTimeKeeper()=0
time_point now() const override
Returns the current time, using the server's clock.
Convenience class to test AMM functionality.
bool expectTradingFee(std::uint16_t fee) const
IOUAmount getLPTokensBalance(std::optional< AccountID > const &account=std::nullopt) const
std::optional< IOUAmount > bidMax_
AccountID const ammAccount_
void setTokens(Json::Value &jv, std::optional< std::pair< Issue, Issue > > const &assets=std::nullopt)
IOUAmount lastPurchasePrice_
void vote(std::optional< Account > const &account, std::uint32_t feeVal, std::optional< std::uint32_t > const &flags=std::nullopt, std::optional< jtx::seq > const &seq=std::nullopt, std::optional< std::pair< Issue, Issue > > const &assets=std::nullopt, std::optional< ter > const &ter=std::nullopt)
bool expectAuctionSlot(std::uint32_t fee, std::optional< std::uint8_t > timeSlot, IOUAmount expectedPrice) const
void submit(Json::Value const &jv, std::optional< jtx::seq > const &seq, std::optional< ter > const &ter)
void ammDelete(AccountID const &deleter, std::optional< ter > const &ter=std::nullopt)
AMM(Env &env, Account const &account, STAmount const &asset1, STAmount const &asset2, bool log=false, std::uint16_t tfee=0, std::uint32_t fee=0, std::optional< std::uint32_t > flags=std::nullopt, std::optional< jtx::seq > seq=std::nullopt, std::optional< jtx::msig > ms=std::nullopt, std::optional< ter > const &ter=std::nullopt, bool close=true)
std::tuple< STAmount, STAmount, STAmount > balances(Issue const &issue1, Issue const &issue2, std::optional< AccountID > const &account=std::nullopt) const
Get AMM balances for the token pair.
bool expectAmmRpcInfo(STAmount const &asset1, STAmount const &asset2, IOUAmount const &balance, std::optional< AccountID > const &account=std::nullopt, std::optional< std::string > const &ledger_index=std::nullopt, std::optional< AccountID > const &ammAccount=std::nullopt) const
Account const creatorAccount_
std::optional< msig > const msig_
IOUAmount withdraw(std::optional< Account > const &account, std::optional< LPToken > const &tokens, std::optional< STAmount > const &asset1OutDetails=std::nullopt, std::optional< std::uint32_t > const &flags=std::nullopt, std::optional< ter > const &ter=std::nullopt)
IOUAmount deposit(std::optional< Account > const &account, LPToken tokens, std::optional< STAmount > const &asset1InDetails=std::nullopt, std::optional< std::uint32_t > const &flags=std::nullopt, std::optional< ter > const &ter=std::nullopt)
AccountID const & ammAccount() const
Json::Value ammRpcInfo(std::optional< AccountID > const &account=std::nullopt, std::optional< std::string > const &ledgerIndex=std::nullopt, std::optional< Issue > issue1=std::nullopt, std::optional< Issue > issue2=std::nullopt, std::optional< AccountID > const &ammAccount=std::nullopt, bool ignoreParams=false, unsigned apiVersion=RPC::apiInvalidVersion) const
Send amm_info RPC command.
Json::Value bid(BidArg const &arg)
AccountID create(std::uint32_t tfee=0, std::optional< std::uint32_t > const &flags=std::nullopt, std::optional< jtx::seq > const &seq=std::nullopt, std::optional< ter > const &ter=std::nullopt)
std::optional< IOUAmount > bidMin_
bool expectLPTokens(AccountID const &account, IOUAmount const &tokens) const
bool expectAmmInfo(STAmount const &asset1, STAmount const &asset2, IOUAmount const &balance, Json::Value const &jv) const
IOUAmount initialTokens()
bool expectBalances(STAmount const &asset1, STAmount const &asset2, IOUAmount const &lpt, std::optional< AccountID > const &account=std::nullopt) const
Verify the AMM balances.
Immutable cryptographic account descriptor.
std::string const & human() const
Returns the human readable public key.
A transaction testing environment.
bool close(NetClock::time_point closeTime, std::optional< std::chrono::milliseconds > consensusDelay=std::nullopt)
Close and advance the ledger.
TER ter() const
Return the TER for the last JTx.
Json::Value rpc(unsigned apiVersion, std::unordered_map< std::string, std::string > const &headers, std::string const &cmd, Args &&... args)
Execute an RPC command.
bool enabled(uint256 feature) const
beast::Journal const journal
std::shared_ptr< OpenView const > current() const
Returns the current ledger.
Set the expected result code for a JTx The test will fail if the code doesn't match.
@ arrayValue
array value (ordered list)
static constexpr auto apiInvalidVersion
Keylet amm(Asset const &issue1, Asset const &issue2) noexcept
AMM entry.
Keylet account(AccountID const &id) noexcept
AccountID root.
Json::Value trust(AccountID const &account, STAmount const &amount, std::uint32_t flags=0)
Json::Value pay(Account const &account, AccountID const &to, STAmount const &amount)
Json::Value ammClawback(Account const &issuer, Account const &holder, Issue const &asset, Issue const &asset2, std::optional< STAmount > const &amount)
Json::Value create(AccountID const &account, AccountID const &to, STAmount const &amount, NetClock::duration const &settleDelay, PublicKey const &pk, std::optional< NetClock::time_point > const &cancelAfter, std::optional< std::uint32_t > const &dstTag)
static Number number(STAmount const &a)
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
constexpr FlagValue tfDepositSubTx
bool isXRP(AccountID const &c)
std::string to_string(base_uint< Bits, Tag > const &a)
STAmount toSTAmount(IOUAmount const &iou, Issue const &iss)
STAmount accountHolds(ReadView const &view, AccountID const &account, Currency const ¤cy, AccountID const &issuer, FreezeHandling zeroIfFrozen, beast::Journal j, SpendableHandling includeFullBalance=shSIMPLE_BALANCE)
bool amountFromJsonNoThrow(STAmount &result, Json::Value const &jvSource)
Json::Value to_json(Asset const &asset)
std::pair< STAmount, STAmount > ammPoolHolds(ReadView const &view, AccountID const &ammAccountID, Issue const &issue1, Issue const &issue2, FreezeHandling freezeHandling, beast::Journal const j)
Get AMM pool balances.
std::optional< std::uint8_t > ammAuctionTimeSlot(std::uint64_t current, STObject const &auctionSlot)
Get time slot of the auction slot.
constexpr FlagValue tfWithdrawSubTx
Issue ammLPTIssue(Currency const &cur1, Currency const &cur2, AccountID const &ammAccountID)
Calculate LPT Issue from AMM asset pair.
STAmount ammLPHolds(ReadView const &view, Currency const &cur1, Currency const &cur2, AccountID const &ammAccount, AccountID const &lpAccount, beast::Journal const j)
Get the balance of LP tokens.
std::optional< Account > account
std::optional< std::variant< int, IOUAmount, STAmount > > bidMin
std::vector< Account > authAccounts
std::optional< std::variant< int, IOUAmount, STAmount > > bidMax
std::optional< std::pair< Issue, Issue > > assets
std::optional< std::uint32_t > flags
std::optional< std::uint32_t > flags
std::optional< std::uint16_t > tfee
std::optional< LPToken > tokens
std::optional< STAmount > maxEP
std::optional< jtx::seq > seq
std::optional< std::pair< Issue, Issue > > assets
std::optional< Account > account
std::optional< STAmount > asset2In
std::optional< STAmount > asset1In
std::optional< std::pair< Issue, Issue > > assets
std::optional< jtx::seq > seq
std::optional< Account > account
std::optional< std::uint32_t > flags
std::optional< STAmount > asset2Out
std::optional< std::pair< Issue, Issue > > assets
std::optional< IOUAmount > maxEP
std::optional< STAmount > asset1Out
std::optional< std::uint32_t > flags
std::optional< Account > account
std::optional< LPToken > tokens
std::optional< jtx::seq > seq
Set the sequence number on a JTx.