1#include <test/jtx/TestHelpers.h>
3#include <test/jtx/Account.h>
4#include <test/jtx/Env.h>
5#include <test/jtx/amount.h>
6#include <test/jtx/balance.h>
7#include <test/jtx/envconfig.h>
8#include <test/jtx/mpt.h>
9#include <test/jtx/offer.h>
10#include <test/jtx/owners.h>
11#include <test/jtx/rate.h>
12#include <test/jtx/trust.h>
14#include <xrpld/core/Config.h>
15#include <xrpld/rpc/RPCHandler.h>
16#include <xrpld/rpc/Role.h>
18#include <xrpl/basics/Number.h>
19#include <xrpl/basics/base_uint.h>
20#include <xrpl/basics/chrono.h>
21#include <xrpl/basics/contract.h>
22#include <xrpl/beast/unit_test/suite.h>
23#include <xrpl/beast/utility/instrumentation.h>
24#include <xrpl/core/Job.h>
25#include <xrpl/core/ServiceRegistry.h>
26#include <xrpl/json/json_value.h>
27#include <xrpl/json/to_string.h>
28#include <xrpl/ledger/helpers/DirectoryHelpers.h>
29#include <xrpl/protocol/AccountID.h>
30#include <xrpl/protocol/ApiVersion.h>
31#include <xrpl/protocol/Book.h>
32#include <xrpl/protocol/Indexes.h>
33#include <xrpl/protocol/Issue.h>
34#include <xrpl/protocol/LedgerFormats.h>
35#include <xrpl/protocol/MPTIssue.h>
36#include <xrpl/protocol/PathAsset.h>
37#include <xrpl/protocol/Quality.h>
38#include <xrpl/protocol/SField.h>
39#include <xrpl/protocol/STAmount.h>
40#include <xrpl/protocol/STParsedJSON.h>
41#include <xrpl/protocol/STPathSet.h>
42#include <xrpl/protocol/UintTypes.h>
43#include <xrpl/protocol/XRPAmount.h>
44#include <xrpl/protocol/jss.h>
45#include <xrpl/resource/Charge.h>
46#include <xrpl/resource/Consumer.h>
47#include <xrpl/resource/Fees.h>
48#include <xrpl/tx/paths/detail/Steps.h>
69 return env.
rpc(
"json",
"account_offers",
to_string(jv))[jss::result];
77 return env.
rpc(
"json",
"account_lines",
to_string(jv))[jss::result];
98 if (sle && sle->isFieldPresent(sfLockedAmount))
99 return (*sle)[sfLockedAmount];
107 if (sle && sle->isFieldPresent(sfLockedAmount))
108 return (*sle)[sfLockedAmount];
116 params[jss::account] = account.human();
117 auto jrr = env.
rpc(
"json",
"gateway_balances",
to_string(params));
118 auto const result = jrr[jss::result];
120 if (obligations.isNull())
121 return {
STAmount(issue, 0), account.name()};
123 return {amount, account.name()};
130 params[jss::account] = account.human();
131 auto jrr = env.
rpc(
"json",
"gateway_balances",
to_string(params));
132 auto const result = jrr[jss::result];
135 return {
STAmount(issue, 0), account.name()};
137 return {amount, account.name()};
185 [&]<
typename TAsset>(TAsset
const& asset) {
196 jv[jss::mpt_issuance_id] =
to_string(asset);
211 jv[jss::command] =
"ripple_path_find";
212 jv[jss::source_account] =
toBase58(src);
213 jv[jss::destination_account] =
toBase58(dst);
236 cfg->pathSearchOld = 7;
238 cfg->pathSearchMax = 10;
256 auto& app = env.
app();
264 .loadType = loadType,
265 .netOps = app.getOPs(),
266 .ledgerMaster = app.getLedgerMaster(),
279 params[jss::command] =
"ripple_path_find";
280 params[jss::source_account] =
toBase58(src);
281 params[jss::destination_account] =
toBase58(dst);
295 params[jss::domain] =
to_string(*domain);
299 app.getJobQueue().postCoro(
JtClient,
"RPC-Client", [&](
auto const& coro) {
300 context.
params = std::move(params);
306 using namespace std::chrono_literals;
324 findPathsRequest(env, src, dst, saDstAmount, saSendMax, srcAsset, srcIssuer, domain);
329 if (result.
isMember(jss::destination_amount))
334 if (result.
isMember(jss::alternatives))
336 auto const& alts = result[jss::alternatives];
339 auto const&
path = alts[0u];
341 if (
path.isMember(jss::source_amount))
344 if (
path.isMember(jss::destination_amount))
347 if (
path.isMember(jss::paths_computed))
350 p[
"Paths"] =
path[jss::paths_computed];
353 paths = po.
object->getFieldPathSet(sfPaths);
358 return std::make_tuple(std::move(paths), std::move(sa), std::move(da));
374 srcElement.
has_value(),
"xrpl::test::jtx::findPathsByElement::srcElement : nullptr");
383 srcElement->getPathAsset(),
393 return env.
current()->fees().base * n;
399 auto const feeDrops = env.
current()->fees().base;
409 bool const accountLow = account < issue.
account;
411 bool expectDefaultTrustLine =
true;
420 expectDefaultTrustLine =
421 sle->getFieldAmount(sfLowLimit) == low && sle->getFieldAmount(sfHighLimit) == high;
424 auto amount = sle->getFieldAmount(sfBalance);
425 amount.get<
Issue>().account = value.getIssuer();
428 return amount == value && expectDefaultTrustLine;
449 [&](
auto const& issue) {
return expectHolding(env, account, value, issue); },
450 value.asset.value());
458 return mptToken && (*mptToken)[sfMPTAmount] == value.mpt().value();
473 if (sle->getType() == ltOFFER)
476 if (std::ranges::find_if(toMatch, [&](auto const& a) {
477 return a.in == sle->getFieldAmount(sfTakerPays) &&
478 a.out == sle->getFieldAmount(sfTakerGets);
484 return size == cnt && ((toMatch.empty() && size != 0) || (matched == toMatch.size()));
499 jvParams[jss::ledger_index] =
"current";
500 jvParams[jss::account_root] = acct.
human();
501 return env.
rpc(
"json",
"ledger_entry",
to_string(jvParams))[jss::result];
508 jvParams[jss::ledger_index] =
"current";
509 jvParams[jss::ripple_state][jss::currency] = currency;
511 jvParams[jss::ripple_state][jss::accounts].
append(acctA.
human());
512 jvParams[jss::ripple_state][jss::accounts].
append(acctB.
human());
513 return env.
rpc(
"json",
"ledger_entry",
to_string(jvParams))[jss::result];
520 jvParams[jss::offer][jss::account] = acct.
human();
521 jvParams[jss::offer][jss::seq] = offerSeq;
522 return env.
rpc(
"json",
"ledger_entry",
to_string(jvParams))[jss::result];
529 jvParams[jss::mptoken][jss::account] = acct.
human();
530 jvParams[jss::mptoken][jss::mpt_issuance_id] =
to_string(mptID);
531 return env.
rpc(
"json",
"ledger_entry",
to_string(jvParams))[jss::result];
538 jvbp[jss::ledger_index] =
"current";
539 takerPays.
setJson(jvbp[jss::taker_pays]);
540 takerGets.
setJson(jvbp[jss::taker_gets]);
541 return env.
rpc(
"json",
"book_offers",
to_string(jvbp))[jss::result];
548 return jrr[jss::node][sfBalance.fieldName];
563 auto const ownerCount = env.
le(account)->getFieldU32(sfOwnerCount);
566 env(
offer(account, in, out));
583 [](
MPTID const& mpt) {
599 [](
Issue const& issue) {
669 auto const tfee = 1. + (
static_cast<double>(args.
transferFee) / 100'000);
672 for (
auto const& account : args.
holders)
690 .maxAmt = args.
limit,
715 jv[sfTransactionType] = jss::LoanBrokerSet;
726 jv[sfTransactionType] = jss::LoanBrokerDelete;
728 jv[sfLoanBrokerID] =
to_string(brokerID);
741 jv[sfTransactionType] = jss::LoanBrokerCoverDeposit;
743 jv[sfLoanBrokerID] =
to_string(brokerID);
757 jv[sfTransactionType] = jss::LoanBrokerCoverWithdraw;
759 jv[sfLoanBrokerID] =
to_string(brokerID);
769 jv[sfTransactionType] = jss::LoanBrokerCoverClawback;
784 Number principalRequested,
788 jv[sfTransactionType] = jss::LoanSet;
790 jv[sfLoanBrokerID] =
to_string(loanBrokerID);
791 jv[sfPrincipalRequested] =
to_string(principalRequested);
800 jv[sfTransactionType] = jss::LoanManage;
811 jv[sfTransactionType] = jss::LoanDelete;
822 jv[sfTransactionType] = jss::LoanPay;
825 jv[sfAmount] = amount.
getJson();
Value & append(Value const &value)
Append value to array at the end.
UInt size() const
Number of values in array or object.
bool isMember(char const *key) const
Return true if the object has a member named key.
void setJson(json::Value &jv) const
constexpr auto visit(Visitors &&... visitors) const -> decltype(auto)
AccountID const & getIssuer() const
A currency issued by an account.
AccountID const & getIssuer() const
constexpr MPTID const & getMptID() const
Number is a floating point type that can represent a wide range of values.
constexpr auto visit(Visitors &&... visitors) const -> decltype(auto)
constexpr std::variant< Currency, MPTID > const & value() const
constexpr TIss const & get() const
json::Value getJson(JsonOptions=JsonOptions::Values::None) const override
AccountID const & getIssuer() const
std::shared_ptr< STLedgerEntry const > const & ConstRef
Holds the serialized result of parsing an input JSON object.
std::optional< STObject > object
The STObject if the parse was successful.
void pushBack(STPathElement const &e)
An endpoint that consumes resources.
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.
std::uint32_t sponsoringAccountCount(Account const &account) const
Return the number of sponsoring accounts owned by an account.
std::uint32_t sponsoringOwnerCount(Account const &account) const
Return the number of sponsoring objects owned by an account.
SLE::const_pointer le(Account const &account) const
Return an account root.
std::uint32_t ownerCount(Account const &account) const
Return the number of objects owned by an account.
json::Value rpc(unsigned apiVersion, std::unordered_map< std::string, std::string > const &headers, std::string const &cmd, Args &&... args)
Execute an RPC command.
std::uint32_t sponsoredOwnerCount(Account const &account) const
Return the number of sponsored objects owned by an account.
beast::Journal const journal
void require(Args const &... args)
Check a set of requirements.
std::shared_ptr< OpenView const > current() const
Returns the current ledger.
bool waitFor(std::chrono::duration< Rep, Period > const &relTime)
Converts to IOU Issue or STAmount.
Test helper for creating, mutating, and asserting MPT and confidential MPT ledger state.
Converts to MPT Issue or STAmount.
xrpl::MPTID const & mpt() const
Match the number of items in the account's owner directory.
@ Array
array value (ordered list)
@ Object
object value (collection of name/value pairs).
Keylet mptoken(MPTID const &issuanceID, AccountID const &holder) noexcept
Keylet mptokenIssuance(MPTID const &issuanceID) noexcept
Keylet trustLine(AccountID const &id0, AccountID const &id1, Currency const ¤cy) noexcept
The index of a trust line for a given currency.
Charge const kFeeReferenceRpc
static constexpr auto kApiVersionIfUnspecified
::rpc::Status doCommand(rpc::JsonContext &context, json::Value &result)
Execute an RPC command and store the results in a json::Value.
MPT issueHelperMPT(IssuerArgs const &args)
IOU issueHelperIOU(IssuerArgs const &args)
json::Value set(AccountID const &account, UInt256 const &vaultId, uint32_t flags)
json::Value coverWithdraw(AccountID const &account, UInt256 const &brokerID, STAmount const &amount, uint32_t flags)
json::Value coverDeposit(AccountID const &account, UInt256 const &brokerID, STAmount const &amount, uint32_t flags)
json::Value del(AccountID const &account, UInt256 const &brokerID, uint32_t flags)
json::Value coverClawback(AccountID const &account, std::uint32_t flags)
json::Value manage(AccountID const &account, UInt256 const &loanID, std::uint32_t flags)
json::Value set(AccountID const &account, UInt256 const &loanBrokerID, Number principalRequested, std::uint32_t flags)
json::Value del(AccountID const &account, UInt256 const &loanID, std::uint32_t flags)
json::Value pay(AccountID const &account, UInt256 const &loanID, STAmount const &amount, std::uint32_t flags)
void nOffers(Env &env, std::size_t n, Account const &account, STAmount const &in, STAmount const &out)
jtx::Env pathTestEnv(beast::unit_test::Suite &suite)
json::Value ledgerEntryMPT(jtx::Env &env, jtx::Account const &acct, MPTID const &mptID)
bool expectLedgerEntryRoot(Env &env, Account const &acct, STAmount const &expectedValue)
PrettyAmount xrpMinusFee(Env const &env, std::int64_t xrpAmount)
STPathElement allPathElements(AccountID const &a, Asset const &asset)
bool expectHolding(Env const &env, AccountID const &account, STAmount const &value, bool defaultLimits)
static void addSourceAsset(json::Value &jv, PathAsset const &srcAsset, std::optional< AccountID > const &srcIssuer)
constexpr XRPAmount kJtxDropsPerXrp
std::tuple< STPathSet, STAmount, STAmount > findPaths(jtx::Env &env, jtx::Account const &src, jtx::Account const &dst, STAmount const &saDstAmount, std::optional< STAmount > const &saSendMax, std::optional< PathAsset > const &srcAsset, std::optional< AccountID > const &srcIssuer, std::optional< UInt256 > const &domain)
json::Value getBookOffers(jtx::Env &env, Asset const &takerPays, Asset const &takerGets)
bool expectOffers(Env const &env, AccountID const &account, std::uint16_t size, std::vector< Amounts > const &toMatch)
std::uint32_t sponsoringAccountCount(Env const &env, Account const &account)
std::uint32_t ownerCount(Env const &env, Account const &account)
jtx::PrettyAmount issuerBalance(jtx::Env &env, jtx::Account const &account, Issue const &issue)
XRPAmount txFee(Env const &env, std::uint16_t n)
json::Value rpf(jtx::Account const &src, jtx::Account const &dst, STAmount const &dstAmount, std::optional< STAmount > const &sendMax, std::optional< PathAsset > const &srcAsset, std::optional< AccountID > const &srcIssuer)
std::uint32_t sponsoringOwnerCount(Env const &env, Account const &account)
STPathElement cpe(PathAsset const &pa)
bool expectMPT(Env const &env, AccountID const &account, STAmount const &value)
json::Value findPathsRequest(jtx::Env &env, jtx::Account const &src, jtx::Account const &dst, STAmount const &saDstAmount, std::optional< STAmount > const &saSendMax, std::optional< PathAsset > const &srcAsset, std::optional< AccountID > const &srcIssuer, std::optional< UInt256 > const &domain)
STPathElement ipe(Asset const &asset)
json::Value ledgerEntryState(Env &env, Account const &acctA, Account const &acctB, std::string const ¤cy)
bool equal(STAmount const &sa1, STAmount const &sa2)
STPathElement iape(AccountID const &account)
json::Value offer(Account const &account, STAmount const &takerPays, STAmount const &takerGets, std::uint32_t flags)
Create an offer.
uint64_t issuerMPTEscrowed(jtx::Env const &env, jtx::MPT const &mpt)
std::uint32_t sponsoredOwnerCount(Env const &env, Account const &account)
json::Value ledgerEntryRoot(Env &env, Account const &acct)
std::unique_ptr< Config > envconfig()
creates and initializes a default configuration for jtx::Env
std::vector< SLE::const_pointer > ownerDirEntries(ReadView const &view, AccountID const &account)
Return the ledger entries in an account's owner directory.
json::Value trust(Account const &account, STAmount const &amount, std::uint32_t flags)
Modify a trust line.
std::tuple< STPathSet, STAmount, STAmount > findPathsByElement(jtx::Env &env, jtx::Account const &src, jtx::Account const &dst, STAmount const &saDstAmount, std::optional< STAmount > const &saSendMax, std::optional< STPathElement > const &srcElement, std::optional< AccountID > const &srcIssuer, std::optional< UInt256 > const &domain)
void stpathAppendOne(STPath &st, Account const &account)
PrettyAmount drops(Integer i)
Returns an XRP PrettyAmount, which is trivially convertible to STAmount.
json::Value accountBalance(Env &env, Account const &acct)
json::Value rate(Account const &account, double multiplier)
Set a transfer rate.
json::Value getAccountLines(Env &env, AccountID const &acctId)
uint64_t mptEscrowed(jtx::Env const &env, jtx::Account const &account, jtx::MPT const &mpt)
bool checkArraySize(json::Value const &val, unsigned int size)
json::Value ledgerEntryOffer(jtx::Env &env, jtx::Account const &acct, std::uint32_t offerSeq)
jtx::PrettyAmount issuerEscrowed(jtx::Env &env, jtx::Account const &account, Issue const &issue)
STPathElement ape(AccountID const &a)
json::Value getAccountOffers(Env &env, AccountID const &acct, bool current)
bool bookStepEqual(Step const &step, xrpl::Book const &book)
bool xrpEndpointStepEqual(Step const &step, AccountID const &acc)
bool mptEndpointStepEqual(Step const &step, AccountID const &src, AccountID const &dst, MPTID const &mptid)
bool directStepEqual(Step const &step, AccountID const &src, AccountID const &dst, Currency const ¤cy)
constexpr XRPAmount
Convert XRP to drops (integral types).
void forEachItem(ReadView const &view, Keylet const &root, std::function< void(SLE::ConstRef)> const &f)
Iterate all items in the given directory.
std::string toBase58(AccountID const &v)
Convert AccountID to base58 checked string.
BaseUInt< 160, detail::CurrencyTag > Currency
Currency is a hash representing a specific currency.
STAmount amountFromString(Asset const &asset, std::string const &amount)
Currency const & xrpCurrency()
XRP currency.
std::string to_string(BaseUInt< Bits, Tag > const &a)
BaseUInt< 192 > MPTID
MPTID is a 192-bit value representing MPT Issuance ID, which is a concatenation of a 32-bit sequence ...
STAmount amountFromJson(SField const &name, json::Value const &v)
BaseUInt< 160, detail::AccountIDTag > AccountID
A 160-bit unsigned that uniquely identifies an account.
AccountID const & xrpAccount()
Compute AccountID from public key.
XRPL_NO_SANITIZE_ADDRESS void Throw(Args &&... args)
std::shared_ptr< JobQueue::Coro > coro
std::optional< std::uint64_t > limit
std::uint16_t transferFee
std::vector< jtx::Account > holders
Represents an XRP, IOU, or MPT quantity This customizes the string conversion and supports XRP conver...