Basic tests of AMM that do not use offers. More...

Inheritance diagram for ripple::test::AMM_test:

[legend]

Collaboration diagram for ripple::test::AMM_test:

[legend]

Public Member Functions
template<class = void>
void	operator() (runner &r)
	Invokes the test using the specified runner. More...

template<class = void>
void	pass ()
	Record a successful test condition. More...

template<class F , class String >
bool	except (F &&f, String const &reason)

template<class F >
bool	except (F &&f)

template<class E , class F , class String >
bool	except (F &&f, String const &reason)

template<class E , class F >
bool	except (F &&f)

template<class F , class String >
bool	unexcept (F &&f, String const &reason)

template<class F >
bool	unexcept (F &&f)

std::string const &	arg () const
	Return the argument associated with the runner. More...

template<class Condition , class String >
bool	unexpected (Condition shouldBeFalse, String const &reason)

template<class Condition >
bool	unexpected (Condition shouldBeFalse)


template<class String >
void	fail (String const &reason, char const *file, int line)
	Record a failure. More...

template<class = void>
void	fail (std::string const &reason="")


template<class Condition >
bool	expect (Condition const &shouldBeTrue)
	Evaluate a test condition. More...

template<class Condition , class String >
bool	expect (Condition const &shouldBeTrue, String const &reason)

template<class Condition >
bool	expect (Condition const &shouldBeTrue, char const *file, int line)

template<class Condition , class String >
bool	expect (Condition const &shouldBeTrue, String const &reason, char const *file, int line)

Static Public Member Functions
static suite *	this_suite ()
	Returns the "current" running suite. More...

Public Attributes
log_os< char >	log
	Logging output stream. More...

testcase_t	testcase
	Memberspace for declaring test cases. More...

Protected Member Functions
XRPAmount	reserve (jtx::Env &env, std::uint32_t count) const

XRPAmount	ammCrtFee (jtx::Env &env) const

jtx::Env	pathTestEnv ()

Json::Value	find_paths_request (jtx::Env &env, jtx::Account const &src, jtx::Account const &dst, STAmount const &saDstAmount, std::optional< STAmount > const &saSendMax=std::nullopt, std::optional< Currency > const &saSrcCurrency=std::nullopt)

std::tuple< STPathSet, STAmount, STAmount >	find_paths (jtx::Env &env, jtx::Account const &src, jtx::Account const &dst, STAmount const &saDstAmount, std::optional< STAmount > const &saSendMax=std::nullopt, std::optional< Currency > const &saSrcCurrency=std::nullopt)

void	testAMM (std::function< void(jtx::AMM &, jtx::Env &)> &&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={supported_amendments()})
	testAMM() funds 30,000XRP and 30,000IOU for each non-XRP asset to Alice and Carol More...

Protected Attributes
jtx::Account const	gw

jtx::Account const	carol

jtx::Account const	alice

jtx::Account const	bob

jtx::IOU const	USD

jtx::IOU const	EUR

jtx::IOU const	GBP

jtx::IOU const	BTC

jtx::IOU const	BAD

Private Member Functions
void	testInstanceCreate ()

void	testInvalidInstance ()

void	testInvalidDeposit (FeatureBitset features)

void	testDeposit ()

void	testInvalidWithdraw ()

void	testWithdraw ()

void	testInvalidFeeVote ()

void	testFeeVote ()

void	testInvalidBid ()

void	testBid (FeatureBitset features)

void	testInvalidAMMPayment ()

void	testBasicPaymentEngine (FeatureBitset features)

void	testAMMTokens ()

void	testAmendment ()

void	testFlags ()

void	testRippling ()

void	testAMMAndCLOB (FeatureBitset features)

void	testTradingFee (FeatureBitset features)

void	testAdjustedTokens (FeatureBitset features)

void	testAutoDelete ()

void	testClawback ()

void	testAMMID ()

void	testSelection (FeatureBitset features)

void	testFixDefaultInnerObj ()

void	testFixChangeSpotPriceQuality (FeatureBitset features)

void	testMalformed ()

void	testFixOverflowOffer (FeatureBitset features)

void	testSwapRounding ()

void	testFixAMMOfferBlockedByLOB (FeatureBitset features)

void	testLPTokenBalance (FeatureBitset features)

void	testAMMClawback (FeatureBitset features)

void	testAMMDepositWithFrozenAssets (FeatureBitset features)

void	testFixReserveCheckOnWithdrawal (FeatureBitset features)

void	run () override
	Runs the suite. More...

void	propagate_abort ()

Static Private Member Functions
static suite **	p_this_suite ()

Private Attributes
bool	abort_ = false

bool	aborted_ = false

runner *	runner_ = nullptr

Detailed Description

Basic tests of AMM that do not use offers.

Tests incorporating offers are in AMMExtended_test.

Definition at line 50 of file AMM_test.cpp.

Member Function Documentation

◆ testInstanceCreate()

void ripple::test::AMM_test::testInstanceCreate ( )

private

Definition at line 54 of file AMM_test.cpp.

◆ testInvalidInstance()

void ripple::test::AMM_test::testInvalidInstance ( )

private

Definition at line 139 of file AMM_test.cpp.

◆ testInvalidDeposit()

void ripple::test::AMM_test::testInvalidDeposit ( FeatureBitset features )

private

Definition at line 422 of file AMM_test.cpp.

◆ testDeposit()

void ripple::test::AMM_test::testDeposit ( )

private

Definition at line 1307 of file AMM_test.cpp.

◆ testInvalidWithdraw()

void ripple::test::AMM_test::testInvalidWithdraw ( )

private

Definition at line 1606 of file AMM_test.cpp.

◆ testWithdraw()

void ripple::test::AMM_test::testWithdraw ( )

private

Definition at line 2123 of file AMM_test.cpp.

◆ testInvalidFeeVote()

void ripple::test::AMM_test::testInvalidFeeVote ( )

private

Definition at line 2440 of file AMM_test.cpp.

◆ testFeeVote()

void ripple::test::AMM_test::testFeeVote ( )

private

Definition at line 2509 of file AMM_test.cpp.

◆ testInvalidBid()

void ripple::test::AMM_test::testInvalidBid ( )

private

Definition at line 2614 of file AMM_test.cpp.

◆ testBid()

void ripple::test::AMM_test::testBid ( FeatureBitset features )

private

Definition at line 2839 of file AMM_test.cpp.

◆ testInvalidAMMPayment()

void ripple::test::AMM_test::testInvalidAMMPayment ( )

private

Definition at line 3348 of file AMM_test.cpp.

◆ testBasicPaymentEngine()

void ripple::test::AMM_test::testBasicPaymentEngine ( FeatureBitset features )

private

Definition at line 3510 of file AMM_test.cpp.

◆ testAMMTokens()

void ripple::test::AMM_test::testAMMTokens ( )

private

Definition at line 4476 of file AMM_test.cpp.

◆ testAmendment()

void ripple::test::AMM_test::testAmendment ( )

private

Definition at line 4582 of file AMM_test.cpp.

◆ testFlags()

void ripple::test::AMM_test::testFlags ( )

private

Definition at line 4610 of file AMM_test.cpp.

◆ testRippling()

void ripple::test::AMM_test::testRippling ( )

private

Definition at line 4631 of file AMM_test.cpp.

◆ testAMMAndCLOB()

void ripple::test::AMM_test::testAMMAndCLOB ( FeatureBitset features )

private

Definition at line 4681 of file AMM_test.cpp.

◆ testTradingFee()

void ripple::test::AMM_test::testTradingFee ( FeatureBitset features )

private

Definition at line 4752 of file AMM_test.cpp.

◆ testAdjustedTokens()

void ripple::test::AMM_test::testAdjustedTokens ( FeatureBitset features )

private

Definition at line 5141 of file AMM_test.cpp.

◆ testAutoDelete()

void ripple::test::AMM_test::testAutoDelete ( )

private

Definition at line 5297 of file AMM_test.cpp.

◆ testClawback()

void ripple::test::AMM_test::testClawback ( )

private

Definition at line 5410 of file AMM_test.cpp.

◆ testAMMID()

void ripple::test::AMM_test::testAMMID ( )

private

Definition at line 5422 of file AMM_test.cpp.

◆ testSelection()

void ripple::test::AMM_test::testSelection ( FeatureBitset features )

private

Definition at line 5475 of file AMM_test.cpp.

◆ testFixDefaultInnerObj()

void ripple::test::AMM_test::testFixDefaultInnerObj ( )

private

Definition at line 5958 of file AMM_test.cpp.

◆ testFixChangeSpotPriceQuality()

void ripple::test::AMM_test::testFixChangeSpotPriceQuality ( FeatureBitset features )

private

Definition at line 6058 of file AMM_test.cpp.

◆ testMalformed()

void ripple::test::AMM_test::testMalformed ( )

private

Definition at line 6274 of file AMM_test.cpp.

◆ testFixOverflowOffer()

void ripple::test::AMM_test::testFixOverflowOffer ( FeatureBitset features )

private

Definition at line 6333 of file AMM_test.cpp.

◆ testSwapRounding()

void ripple::test::AMM_test::testSwapRounding ( )

private

Definition at line 6656 of file AMM_test.cpp.

◆ testFixAMMOfferBlockedByLOB()

void ripple::test::AMM_test::testFixAMMOfferBlockedByLOB ( FeatureBitset features )

private

Definition at line 6693 of file AMM_test.cpp.

◆ testLPTokenBalance()

void ripple::test::AMM_test::testLPTokenBalance ( FeatureBitset features )

private

Definition at line 6821 of file AMM_test.cpp.

◆ testAMMClawback()

void ripple::test::AMM_test::testAMMClawback ( FeatureBitset features )

private

Definition at line 6939 of file AMM_test.cpp.

◆ testAMMDepositWithFrozenAssets()

void ripple::test::AMM_test::testAMMDepositWithFrozenAssets ( FeatureBitset features )

private

Definition at line 6986 of file AMM_test.cpp.

◆ testFixReserveCheckOnWithdrawal()

void ripple::test::AMM_test::testFixReserveCheckOnWithdrawal ( FeatureBitset features )

private

Definition at line 7068 of file AMM_test.cpp.

◆ run()

void ripple::test::AMM_test::run ( )

overrideprivatevirtual

Runs the suite.

Implements beast::unit_test::suite.

Definition at line 7117 of file AMM_test.cpp.

◆ reserve()

XRPAmount ripple::test::jtx::AMMTest::reserve	(	jtx::Env &	env,
		std::uint32_t	count
	)		const

protectedinherited

Definition at line 153 of file AMMTest.cpp.

◆ ammCrtFee()

XRPAmount ripple::test::jtx::AMMTest::ammCrtFee ( jtx::Env & env ) const

protectedinherited

Definition at line 159 of file AMMTest.cpp.

◆ pathTestEnv()

jtx::Env ripple::test::jtx::AMMTest::pathTestEnv ( )

protectedinherited

Definition at line 165 of file AMMTest.cpp.

◆ find_paths_request()

Json::Value ripple::test::jtx::AMMTest::find_paths_request	(	jtx::Env &	env,
		jtx::Account const &	src,
		jtx::Account const &	dst,
		STAmount const &	saDstAmount,
		std::optional< STAmount > const &	saSendMax = `std::nullopt`,
		std::optional< Currency > const &	saSrcCurrency = `std::nullopt`
	)

protectedinherited

Definition at line 179 of file AMMTest.cpp.

◆ find_paths()

std::tuple< STPathSet, STAmount, STAmount > ripple::test::jtx::AMMTest::find_paths	(	jtx::Env &	env,
		jtx::Account const &	src,
		jtx::Account const &	dst,
		STAmount const &	saDstAmount,
		std::optional< STAmount > const &	saSendMax = `std::nullopt`,
		std::optional< Currency > const &	saSrcCurrency = `std::nullopt`
	)

protectedinherited

Definition at line 238 of file AMMTest.cpp.

◆ testAMM()

void ripple::test::jtx::AMMTestBase::testAMM	(	std::function< void(jtx::AMM &, jtx::Env &)> &&	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 = `{supported_amendments()}`
	)

protectedinherited

testAMM() funds 30,000XRP and 30,000IOU for each non-XRP asset to Alice and Carol

Definition at line 101 of file AMMTest.cpp.

◆ this_suite()

static suite * beast::unit_test::suite::this_suite ( )

staticinherited

Returns the "current" running suite.

If no suite is running, nullptr is returned.

Definition at line 159 of file suite.h.

◆ operator()()

template<class >

void beast::unit_test::suite::operator() ( runner & r )

inherited

Invokes the test using the specified runner.

Data members are set up here instead of the constructor as a convenience to writing the derived class to avoid repetition of forwarded constructor arguments to the base. Normally this is called by the framework for you.

Definition at line 397 of file suite.h.

◆ pass()

template<class >

void beast::unit_test::suite::pass

inherited

Record a successful test condition.

Definition at line 509 of file suite.h.

◆ fail() [1/2]

template<class String >

void beast::unit_test::suite::fail	(	String const &	reason,
		char const *	file,
		int	line
	)

inherited

Record a failure.

Parameters

reason	Optional text added to the output on a failure.
file	The source code file where the test failed.
line	The source code line number where the test failed.

Definition at line 531 of file suite.h.

◆ fail() [2/2]

template<class >

void beast::unit_test::suite::fail ( std::string const & reason = "" )

inherited

Definition at line 518 of file suite.h.

◆ expect() [1/4]

template<class Condition >

bool beast::unit_test::suite::expect ( Condition const & shouldBeTrue )

inherited

Evaluate a test condition.

This function provides improved logging by incorporating the file name and line number into the reported output on failure, as well as additional text specified by the caller.

Parameters

shouldBeTrue	The condition to test. The condition is evaluated in a boolean context.
reason	Optional added text to output on a failure.
file	The source code file where the test failed.
line	The source code line number where the test failed.

Returns: true if the test condition indicates success.

Definition at line 227 of file suite.h.

◆ expect() [2/4]

template<class Condition , class String >

bool beast::unit_test::suite::expect	(	Condition const &	shouldBeTrue,
		String const &	reason
	)

inherited

Definition at line 414 of file suite.h.

◆ expect() [3/4]

template<class Condition >

bool beast::unit_test::suite::expect	(	Condition const &	shouldBeTrue,
		char const *	file,
		int	line
	)

inherited

Definition at line 238 of file suite.h.

◆ expect() [4/4]

template<class Condition , class String >

bool beast::unit_test::suite::expect	(	Condition const &	shouldBeTrue,
		String const &	reason,
		char const *	file,
		int	line
	)

inherited

Definition at line 427 of file suite.h.

◆ except() [1/4]

template<class F , class String >

bool beast::unit_test::suite::except	(	F &&	f,
		String const &	reason
	)

inherited

Definition at line 446 of file suite.h.

◆ except() [2/4]

template<class F >

bool beast::unit_test::suite::except ( F && f )

inherited

Definition at line 261 of file suite.h.

◆ except() [3/4]

template<class E , class F , class String >

bool beast::unit_test::suite::except	(	F &&	f,
		String const &	reason
	)

inherited

Definition at line 463 of file suite.h.

◆ except() [4/4]

template<class E , class F >

bool beast::unit_test::suite::except ( F && f )

inherited

Definition at line 270 of file suite.h.

◆ unexcept() [1/2]

template<class F , class String >

bool beast::unit_test::suite::unexcept	(	F &&	f,
		String const &	reason
	)

inherited

Definition at line 480 of file suite.h.

◆ unexcept() [2/2]

template<class F >

bool beast::unit_test::suite::unexcept ( F && f )

inherited

Definition at line 279 of file suite.h.

◆ arg()

std::string const & beast::unit_test::suite::arg ( ) const

inherited

Return the argument associated with the runner.

Definition at line 286 of file suite.h.

◆ unexpected() [1/2]

template<class Condition , class String >

bool beast::unit_test::suite::unexpected	(	Condition	shouldBeFalse,
		String const &	reason
	)

inherited

Definition at line 497 of file suite.h.

◆ unexpected() [2/2]

template<class Condition >

bool beast::unit_test::suite::unexpected ( Condition shouldBeFalse )

inherited

Definition at line 299 of file suite.h.

◆ p_this_suite()

static suite ** beast::unit_test::suite::p_this_suite ( )

staticprivateinherited

Definition at line 308 of file suite.h.

◆ propagate_abort()

void beast::unit_test::suite::propagate_abort ( )

privateinherited

Definition at line 537 of file suite.h.

Member Data Documentation

◆ gw

jtx::Account const ripple::test::jtx::AMMTestBase::gw

protectedinherited

Definition at line 64 of file AMMTest.h.

◆ carol

jtx::Account const ripple::test::jtx::AMMTestBase::carol

protectedinherited

Definition at line 65 of file AMMTest.h.

◆ alice

jtx::Account const ripple::test::jtx::AMMTestBase::alice

protectedinherited

Definition at line 66 of file AMMTest.h.

◆ bob

jtx::Account const ripple::test::jtx::AMMTestBase::bob

protectedinherited

Definition at line 67 of file AMMTest.h.

◆ USD

jtx::IOU const ripple::test::jtx::AMMTestBase::USD

protectedinherited

Definition at line 68 of file AMMTest.h.

◆ EUR

jtx::IOU const ripple::test::jtx::AMMTestBase::EUR

protectedinherited

Definition at line 69 of file AMMTest.h.

◆ GBP

jtx::IOU const ripple::test::jtx::AMMTestBase::GBP

protectedinherited

Definition at line 70 of file AMMTest.h.

◆ BTC

jtx::IOU const ripple::test::jtx::AMMTestBase::BTC

protectedinherited

Definition at line 71 of file AMMTest.h.

◆ BAD

jtx::IOU const ripple::test::jtx::AMMTestBase::BAD

protectedinherited

Definition at line 72 of file AMMTest.h.

◆ abort_

bool beast::unit_test::suite::abort_ = false

privateinherited

Definition at line 55 of file suite.h.

◆ aborted_

bool beast::unit_test::suite::aborted_ = false

privateinherited

Definition at line 56 of file suite.h.

◆ runner_

runner* beast::unit_test::suite::runner_ = nullptr

privateinherited

Definition at line 57 of file suite.h.

◆ log

log_os<char> beast::unit_test::suite::log

inherited

Logging output stream.

Text sent to the log output stream will be forwarded to the output stream associated with the runner.

Definition at line 150 of file suite.h.

◆ testcase

testcase_t beast::unit_test::suite::testcase

inherited

Memberspace for declaring test cases.

Definition at line 153 of file suite.h.

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ testInstanceCreate()

◆ testInvalidInstance()

◆ testInvalidDeposit()

◆ testDeposit()

◆ testInvalidWithdraw()

◆ testWithdraw()

◆ testInvalidFeeVote()

◆ testFeeVote()

◆ testInvalidBid()

◆ testBid()

◆ testInvalidAMMPayment()

◆ testBasicPaymentEngine()

◆ testAMMTokens()

◆ testAmendment()

◆ testFlags()

◆ testRippling()

◆ testAMMAndCLOB()

◆ testTradingFee()

◆ testAdjustedTokens()

◆ testAutoDelete()

◆ testClawback()

◆ testAMMID()

◆ testSelection()

◆ testFixDefaultInnerObj()

◆ testFixChangeSpotPriceQuality()

◆ testMalformed()

◆ testFixOverflowOffer()

◆ testSwapRounding()

◆ testFixAMMOfferBlockedByLOB()

◆ testLPTokenBalance()

◆ testAMMClawback()

◆ testAMMDepositWithFrozenAssets()

◆ testFixReserveCheckOnWithdrawal()

◆ run()

◆ reserve()

◆ ammCrtFee()

◆ pathTestEnv()

◆ find_paths_request()

◆ find_paths()

◆ testAMM()

◆ this_suite()

◆ operator()()

◆ pass()

◆ fail() [1/2]

◆ fail() [2/2]

◆ expect() [1/4]

◆ expect() [2/4]

◆ expect() [3/4]

◆ expect() [4/4]

◆ except() [1/4]

◆ except() [2/4]

◆ except() [3/4]

◆ except() [4/4]

◆ unexcept() [1/2]

◆ unexcept() [2/2]

◆ arg()

◆ unexpected() [1/2]

◆ unexpected() [2/2]

◆ p_this_suite()

◆ propagate_abort()

Member Data Documentation

◆ gw

◆ carol

◆ alice

◆ bob

◆ USD

◆ EUR

◆ GBP

◆ BTC

◆ BAD