xrpld
Toggle main menu visibility
Loading...
Searching...
No Matches
test
jtx
AMMTest.h
1
#pragma once
2
3
#include <test/jtx/Account.h>
4
#include <test/jtx/Env.h>
5
#include <test/jtx/amount.h>
6
#include <test/jtx/ter.h>
7
8
#include <xrpl/beast/unit_test/suite.h>
9
#include <xrpl/protocol/Feature.h>
10
#include <xrpl/protocol/STAmount.h>
11
#include <xrpl/protocol/XRPAmount.h>
12
13
#include <
chrono
>
14
#include <
condition_variable
>
15
#include <
cstdint
>
16
#include <
functional
>
17
#include <
mutex
>
18
#include <
optional
>
19
#include <
utility
>
20
#include <
vector
>
21
22
namespace
xrpl::test::jtx
{
23
24
class
AMM
;
25
26
enum class
Fund
{
All
,
Acct
,
Gw
,
TokenOnly
};
27
28
struct
TestAMMArg
29
{
30
std::optional<std::pair<STAmount, STAmount>
>
pool
= std::nullopt;
31
std::uint16_t
tfee
= 0;
32
std::optional<jtx::Ter>
ter
= std::nullopt;
33
std::vector<FeatureBitset>
features
= {
34
// For now, just disable SAV entirely, which locks in the small Number
35
// mantissas
36
jtx::testableAmendments
() - featureSingleAssetVault - featureLendingProtocol,
37
};
38
39
bool
noLog
=
false
;
40
};
41
42
// A hint to testAMM() or fund() to create/fund MPT.
43
// A distinct MPT is created if both AMM assets
44
// are MPT. The actual MPT asset can be accessed
45
// via AMM::operator[](0|1).
46
inline
static
auto
gAmmmpt
=
MPT
(
"AMM"
);
47
48
[[maybe_unused]]
std::vector<STAmount>
49
fund
(
50
jtx::Env
& env,
51
jtx::Account
const
& gw,
52
std::vector<jtx::Account>
const
& accounts,
53
std::vector<STAmount>
const
& amts,
54
Fund
how);
55
56
[[maybe_unused]]
std::vector<STAmount>
57
fund
(
58
jtx::Env
& env,
59
jtx::Account
const
& gw,
60
std::vector<jtx::Account>
const
& accounts,
61
STAmount
const
& xrp,
62
std::vector<STAmount>
const
& amts = {},
63
Fund
how =
Fund::All
);
64
65
[[maybe_unused]]
std::vector<STAmount>
66
fund
(
67
jtx::Env
& env,
68
std::vector<jtx::Account>
const
& accounts,
69
STAmount
const
& xrp,
70
std::vector<STAmount>
const
& amts = {},
71
Fund
how =
Fund::All
,
72
std::optional<Account>
const
& mptIssuer = std::nullopt);
73
74
struct
TestAMMArgs
75
{
76
std::optional<std::pair<STAmount, STAmount>
>
const
&
pool
= std::nullopt;
77
std::uint16_t
tfee
= 0;
78
std::optional<jtx::Ter>
const
&
ter
= std::nullopt;
79
std::vector<FeatureBitset>
const
&
features
= {
testableAmendments
()};
80
};
81
82
class
AMMTestBase
:
public
beast::unit_test::Suite
83
{
84
protected
:
85
jtx::Account
const
gw_
;
86
jtx::Account
const
carol_
;
87
jtx::Account
const
alice_
;
88
jtx::Account
const
bob_
;
89
jtx::IOU
const
USD
;
// NOLINT(readability-identifier-naming)
90
jtx::IOU
const
EUR
;
// NOLINT(readability-identifier-naming)
91
jtx::IOU
const
GBP
;
// NOLINT(readability-identifier-naming)
92
jtx::IOU
const
BTC
;
// NOLINT(readability-identifier-naming)
93
jtx::IOU
const
BAD
;
// NOLINT(readability-identifier-naming)
94
95
public
:
96
AMMTestBase
();
97
98
static
FeatureBitset
99
testableAmendments
()
100
{
101
// For now, just disable SAV entirely, which locks in the small Number
102
// mantissas
103
return
jtx::testableAmendments
() - featureSingleAssetVault - featureLendingProtocol;
104
}
105
106
protected
:
111
void
112
testAMM
(
113
std::function
<
void
(
jtx::AMM
&,
jtx::Env
&)>
const
& cb,
114
std::optional
<
std::pair<STAmount, STAmount>
>
const
& pool = std::nullopt,
115
std::uint16_t
tfee = 0,
116
std::optional<jtx::Ter>
const
& ter = std::nullopt,
117
std::vector<FeatureBitset>
const
& features = {
testableAmendments
()});
118
119
void
120
testAMM
(
std::function
<
void
(
jtx::AMM
&,
jtx::Env
&)>
const
& cb,
TestAMMArg
const
&
arg
);
121
};
122
123
class
AMMTest
:
public
jtx::AMMTestBase
124
{
125
protected
:
126
static
XRPAmount
127
reserve
(
jtx::Env
& env,
std::uint32_t
count);
128
129
static
XRPAmount
130
ammCrtFee
(
jtx::Env
& env);
131
132
/* Path_test */
133
/************************************************/
134
class
Gate
135
{
136
private
:
137
std::condition_variable
cv_
;
138
std::mutex
mutex_
;
139
bool
signaled_
=
false
;
140
141
public
:
142
// Thread safe, blocks until signaled or period expires.
143
// Returns `true` if signaled.
144
template
<
class
Rep,
class
Period>
145
bool
146
waitFor
(
std::chrono::duration<Rep, Period>
const
& relTime)
147
{
148
std::unique_lock<std::mutex>
lk(
mutex_
);
149
auto
b =
cv_
.wait_for(lk, relTime, [
this
] {
return
signaled_
; });
150
signaled_
=
false
;
151
return
b;
152
}
153
154
void
155
signal
()
156
{
157
std::scoped_lock
const
lk(
mutex_
);
158
signaled_
=
true
;
159
cv_
.notify_all();
160
}
161
};
162
163
jtx::Env
164
pathTestEnv
();
165
};
166
167
}
// namespace xrpl::test::jtx
chrono
beast::unit_test::Suite
A testsuite class.
Definition
suite.h:52
beast::unit_test::Suite::arg
std::string const & arg() const
Return the argument associated with the runner.
Definition
suite.h:292
xrpl::FeatureBitset
Definition
Feature.h:196
xrpl::STAmount
Definition
STAmount.h:46
xrpl::test::jtx::AMMTestBase
Definition
AMMTest.h:83
xrpl::test::jtx::AMMTestBase::EUR
jtx::IOU const EUR
Definition
AMMTest.h:90
xrpl::test::jtx::AMMTestBase::BTC
jtx::IOU const BTC
Definition
AMMTest.h:92
xrpl::test::jtx::AMMTestBase::USD
jtx::IOU const USD
Definition
AMMTest.h:89
xrpl::test::jtx::AMMTestBase::alice_
jtx::Account const alice_
Definition
AMMTest.h:87
xrpl::test::jtx::AMMTestBase::AMMTestBase
AMMTestBase()
Definition
AMMTest.cpp:106
xrpl::test::jtx::AMMTestBase::GBP
jtx::IOU const GBP
Definition
AMMTest.h:91
xrpl::test::jtx::AMMTestBase::testAMM
void testAMM(std::function< void(jtx::AMM &, jtx::Env &)> const &cb, std::optional< std::pair< STAmount, STAmount > > const &pool=std::nullopt, std::uint16_t tfee=0, std::optional< jtx::Ter > const &ter=std::nullopt, std::vector< FeatureBitset > const &features={testableAmendments()})
testAMM() funds 30,000XRP and 30,000IOU for each non-XRP asset to Alice and Carol
Definition
AMMTest.cpp:120
xrpl::test::jtx::AMMTestBase::gw_
jtx::Account const gw_
Definition
AMMTest.h:85
xrpl::test::jtx::AMMTestBase::testableAmendments
static FeatureBitset testableAmendments()
Definition
AMMTest.h:99
xrpl::test::jtx::AMMTestBase::carol_
jtx::Account const carol_
Definition
AMMTest.h:86
xrpl::test::jtx::AMMTestBase::bob_
jtx::Account const bob_
Definition
AMMTest.h:88
xrpl::test::jtx::AMMTestBase::BAD
jtx::IOU const BAD
Definition
AMMTest.h:93
xrpl::test::jtx::AMMTest::Gate
Definition
AMMTest.h:135
xrpl::test::jtx::AMMTest::Gate::waitFor
bool waitFor(std::chrono::duration< Rep, Period > const &relTime)
Definition
AMMTest.h:146
xrpl::test::jtx::AMMTest::Gate::mutex_
std::mutex mutex_
Definition
AMMTest.h:138
xrpl::test::jtx::AMMTest::Gate::signal
void signal()
Definition
AMMTest.h:155
xrpl::test::jtx::AMMTest::Gate::cv_
std::condition_variable cv_
Definition
AMMTest.h:137
xrpl::test::jtx::AMMTest::Gate::signaled_
bool signaled_
Definition
AMMTest.h:139
xrpl::test::jtx::AMMTest
Definition
AMMTest.h:124
xrpl::test::jtx::AMMTest::reserve
static XRPAmount reserve(jtx::Env &env, std::uint32_t count)
Definition
AMMTest.cpp:199
xrpl::test::jtx::AMMTest::ammCrtFee
static XRPAmount ammCrtFee(jtx::Env &env)
Definition
AMMTest.cpp:205
xrpl::test::jtx::AMMTest::pathTestEnv
jtx::Env pathTestEnv()
Definition
AMMTest.cpp:211
xrpl::test::jtx::AMM
Convenience class to test AMM functionality.
Definition
src/test/jtx/AMM.h:138
xrpl::test::jtx::Account
Immutable cryptographic account descriptor.
Definition
jtx/Account.h:21
xrpl::test::jtx::Env
A transaction testing environment.
Definition
Env.h:161
xrpl::test::jtx::IOU
Converts to IOU Issue or STAmount.
Definition
src/test/jtx/amount.h:404
xrpl::test::jtx::MPT
Converts to MPT Issue or STAmount.
Definition
src/test/jtx/amount.h:497
condition_variable
cstdint
std::chrono::duration
std::function
functional
std::uint16_t
mutex
xrpl::test::jtx
Definition
Oracle_test.cpp:34
xrpl::test::jtx::fund
std::vector< STAmount > fund(jtx::Env &env, jtx::Account const &gw, std::vector< jtx::Account > const &accounts, std::vector< STAmount > const &amts, Fund how)
Definition
AMMTest.cpp:34
xrpl::test::jtx::testableAmendments
FeatureBitset testableAmendments()
Definition
Env.h:92
xrpl::test::jtx::gAmmmpt
static auto gAmmmpt
Definition
AMMTest.h:46
xrpl::test::jtx::Fund
Fund
Definition
AMMTest.h:26
xrpl::test::jtx::Fund::Gw
@ Gw
Definition
AMMTest.h:26
xrpl::test::jtx::Fund::Acct
@ Acct
Definition
AMMTest.h:26
xrpl::test::jtx::Fund::TokenOnly
@ TokenOnly
Definition
AMMTest.h:26
xrpl::test::jtx::Fund::All
@ All
Definition
AMMTest.h:26
xrpl::test::XRPAmount
constexpr XRPAmount
Convert XRP to drops (integral types).
Definition
TxTest.h:53
optional
std::pair
std::scoped_lock
xrpl::test::jtx::TestAMMArg
Definition
AMMTest.h:29
xrpl::test::jtx::TestAMMArg::ter
std::optional< jtx::Ter > ter
Definition
AMMTest.h:32
xrpl::test::jtx::TestAMMArg::pool
std::optional< std::pair< STAmount, STAmount > > pool
Definition
AMMTest.h:30
xrpl::test::jtx::TestAMMArg::tfee
std::uint16_t tfee
Definition
AMMTest.h:31
xrpl::test::jtx::TestAMMArg::noLog
bool noLog
Definition
AMMTest.h:39
xrpl::test::jtx::TestAMMArg::features
std::vector< FeatureBitset > features
Definition
AMMTest.h:33
xrpl::test::jtx::TestAMMArgs
Definition
AMMTest.h:75
xrpl::test::jtx::TestAMMArgs::pool
std::optional< std::pair< STAmount, STAmount > > const & pool
Definition
AMMTest.h:76
xrpl::test::jtx::TestAMMArgs::tfee
std::uint16_t tfee
Definition
AMMTest.h:77
xrpl::test::jtx::TestAMMArgs::ter
std::optional< jtx::Ter > const & ter
Definition
AMMTest.h:78
xrpl::test::jtx::TestAMMArgs::features
std::vector< FeatureBitset > const & features
Definition
AMMTest.h:79
std::unique_lock
utility
vector
Generated by
1.17.0