Files
rippled/src/test/app/AMMClawback_test.cpp

2536 lines
98 KiB
C++

#include <test/jtx/AMM.h>
#include <test/jtx/Account.h>
#include <test/jtx/CaptureLogs.h>
#include <test/jtx/Env.h>
#include <test/jtx/TestHelpers.h>
#include <test/jtx/amount.h>
#include <test/jtx/balance.h>
#include <test/jtx/flags.h>
#include <test/jtx/pay.h>
#include <test/jtx/ter.h>
#include <test/jtx/trust.h>
#include <test/jtx/txflags.h>
#include <xrpl/beast/unit_test/suite.h>
#include <xrpl/ledger/helpers/AMMHelpers.h>
#include <xrpl/protocol/Feature.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/TxFlags.h>
#include <xrpl/protocol/XRPAmount.h>
#include <xrpl/protocol/jss.h>
#include <cstdint>
#include <memory>
#include <optional>
#include <utility>
namespace xrpl::test {
class AMMClawback_test : public beast::unit_test::Suite
{
void
testInvalidRequest(FeatureBitset features)
{
testcase("test invalid request");
using namespace jtx;
// Test if holder does not exist.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(100000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
auto const usd = gw["USD"];
env.trust(usd(10000), alice);
env(pay(gw, alice, usd(100)));
AMM const amm(env, alice, XRP(100), usd(100));
env.close();
env(amm::ammClawback(gw, Account("unknown"), usd, XRP, std::nullopt),
Ter(terNO_ACCOUNT));
}
// Test if asset pair provided does not exist. This should
// return terNO_AMM error.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(100000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(10000), alice);
env(pay(gw, alice, usd(100)));
env.close();
// Withdraw all the tokens from the AMMAccount.
// The AMMAccount will be auto deleted.
AMM amm(env, gw, XRP(100), usd(100));
amm.withdrawAll(gw);
BEAST_EXPECT(!amm.ammExists());
env.close();
// The AMM account does not exist at all now.
// It should return terNO_AMM error.
env(amm::ammClawback(gw, alice, usd, gw["EUR"], std::nullopt), Ter(terNO_AMM));
}
// Test if the issuer field and holder field is the same. This should
// return temMALFORMED error.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(10000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(1000), alice);
env(pay(gw, alice, usd(100)));
env.close();
AMM const amm(env, gw, XRP(100), usd(100), Ter(tesSUCCESS));
// Issuer can not clawback from himself.
env(amm::ammClawback(gw, gw, usd, XRP, std::nullopt), Ter(temMALFORMED));
// Holder can not clawback from himself.
env(amm::ammClawback(alice, alice, usd, XRP, std::nullopt), Ter(temMALFORMED));
}
// Test if the Asset field matches the Account field.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(10000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(1000), alice);
env(pay(gw, alice, usd(100)));
env.close();
AMM const amm(env, gw, XRP(100), usd(100), Ter(tesSUCCESS));
// The Asset's issuer field is alice, while the Account field is gw.
// This should return temMALFORMED because they do not match.
env(amm::ammClawback(
gw, alice, Issue{gw["USD"].currency, alice.id()}, XRP, std::nullopt),
Ter(temMALFORMED));
}
// Test if the Amount field matches the Asset field.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(10000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(1000), alice);
env(pay(gw, alice, usd(100)));
env.close();
AMM const amm(env, gw, XRP(100), usd(100), Ter(tesSUCCESS));
// The Asset's issuer subfield is gw account and Amount's issuer
// subfield is alice account. Return temBAD_AMOUNT because
// they do not match.
env(amm::ammClawback(
gw, alice, usd, XRP, STAmount{Issue{gw["USD"].currency, alice.id()}, 1}),
Ter(temBAD_AMOUNT));
}
// Test if the Amount is invalid, which is less than zero.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(10000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(1000), alice);
env(pay(gw, alice, usd(100)));
env.close();
AMM const amm(env, gw, XRP(100), usd(100), Ter(tesSUCCESS));
// Return temBAD_AMOUNT if the Amount value is less than 0.
env(amm::ammClawback(
gw, alice, usd, XRP, STAmount{Issue{gw["USD"].currency, gw.id()}, -1}),
Ter(temBAD_AMOUNT));
// Return temBAD_AMOUNT if the Amount value is 0.
env(amm::ammClawback(
gw, alice, usd, XRP, STAmount{Issue{gw["USD"].currency, gw.id()}, 0}),
Ter(temBAD_AMOUNT));
}
// Test if the issuer did not set asfAllowTrustLineClawback, AMMClawback
// transaction is prohibited.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(10000), gw, alice);
env.close();
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(1000), alice);
env(pay(gw, alice, usd(100)));
env.close();
env.require(Balance(alice, usd(100)));
env.require(Balance(gw, alice["USD"](-100)));
// gw creates AMM pool of XRP/USD.
AMM const amm(env, gw, XRP(100), usd(100), Ter(tesSUCCESS));
// If asfAllowTrustLineClawback is not set, the issuer is not
// allowed to send the AMMClawback transaction.
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt), Ter(tecNO_PERMISSION));
}
// Test invalid flag.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(10000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(1000), alice);
env(pay(gw, alice, usd(100)));
env.close();
AMM const amm(env, gw, XRP(100), usd(100), Ter(tesSUCCESS));
// Return temINVALID_FLAG when providing invalid flag.
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt),
Txflags(tfTwoAssetIfEmpty),
Ter(temINVALID_FLAG));
}
// Test if tfClawTwoAssets is set when the two assets in the AMM pool
// are not issued by the same issuer.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(10000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 100 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(1000), alice);
env(pay(gw, alice, usd(100)));
env.close();
// gw creates AMM pool of XRP/USD.
AMM const amm(env, gw, XRP(100), usd(100), Ter(tesSUCCESS));
// Return temINVALID_FLAG because the issuer set tfClawTwoAssets,
// but the issuer only issues USD in the pool. The issuer is not
// allowed to set tfClawTwoAssets flag if he did not issue both
// assets in the pool.
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt),
Txflags(tfClawTwoAssets),
Ter(temINVALID_FLAG));
}
// Test clawing back XRP is being prohibited.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 3000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(3000)));
env.close();
// Alice creates AMM pool of XRP/USD.
AMM const amm(env, alice, XRP(1000), usd(2000), Ter(tesSUCCESS));
env.close();
// Clawback XRP is prohibited.
env(amm::ammClawback(gw, alice, XRP, usd, std::nullopt), Ter(temMALFORMED));
}
}
void
testFeatureDisabled(FeatureBitset features)
{
testcase("test featureAMMClawback is not enabled.");
using namespace jtx;
if (!features[featureAMMClawback])
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 3000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(3000)));
env.close();
// When featureAMMClawback is not enabled, AMMClawback is disabled.
// Because when featureAMMClawback is disabled, we can not create
// amm account, call amm::ammClawback directly for testing purpose.
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt), Ter(temDISABLED));
}
}
void
testAMMClawbackSpecificAmount(FeatureBitset features)
{
testcase("test AMMClawback specific amount");
using namespace jtx;
// Test AMMClawback for USD/EUR pool. The assets are issued by different
// issuer. Claw back USD, and EUR goes back to the holder.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, gw2, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 3000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(3000)));
env.close();
env.require(Balance(gw, alice["USD"](-3000)));
env.require(Balance(alice, usd(3000)));
// gw2 issues 3000 EUR to Alice.
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(3000)));
env.close();
env.require(Balance(gw2, alice["EUR"](-3000)));
env.require(Balance(alice, eur(3000)));
// Alice creates AMM pool of EUR/USD.
AMM const amm(env, alice, eur(1000), usd(2000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(
amm.expectBalances(usd(2000), eur(1000), IOUAmount{1414213562373095, -12}));
// gw clawback 1000 USD from the AMM pool.
env(amm::ammClawback(gw, alice, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
// Alice's initial balance for USD is 3000 USD. Alice deposited 2000
// USD into the pool, then she has 1000 USD. And 1000 USD was clawed
// back from the AMM pool, so she still has 1000 USD.
env.require(Balance(gw, alice["USD"](-1000)));
env.require(Balance(alice, usd(1000)));
// Alice's initial balance for EUR is 3000 EUR. Alice deposited 1000
// EUR into the pool, 500 EUR was withdrawn proportionally. So she
// has 2500 EUR now.
env.require(Balance(gw2, alice["EUR"](-2500)));
env.require(Balance(alice, eur(2500)));
// 1000 USD and 500 EUR was withdrawn from the AMM pool, so the
// current balance is 1000 USD and 500 EUR.
BEAST_EXPECT(amm.expectBalances(usd(1000), eur(500), IOUAmount{7071067811865475, -13}));
// Alice has half of its initial lptokens Left.
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865475, -13}));
// gw clawback another 1000 USD from the AMM pool. The AMM pool will
// be empty and get deleted.
env(amm::ammClawback(gw, alice, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
// Alice should still has 1000 USD because gw clawed back from the
// AMM pool.
env.require(Balance(gw, alice["USD"](-1000)));
env.require(Balance(alice, usd(1000)));
// Alice should has 3000 EUR now because another 500 EUR was
// withdrawn.
env.require(Balance(gw2, alice["EUR"](-3000)));
env.require(Balance(alice, eur(3000)));
// amm is automatically deleted.
BEAST_EXPECT(!amm.ammExists());
}
// Test AMMClawback for USD/XRP pool. Claw back USD, and XRP goes back
// to the holder.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 3000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(3000)));
env.close();
env.require(Balance(gw, alice["USD"](-3000)));
env.require(Balance(alice, usd(3000)));
// Alice creates AMM pool of XRP/USD.
AMM const amm(env, alice, XRP(1000), usd(2000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(2000), XRP(1000), IOUAmount{1414213562373095, -9}));
auto aliceXrpBalance = env.balance(alice, XRP);
// gw clawback 1000 USD from the AMM pool.
env(amm::ammClawback(gw, alice, usd, XRP, usd(1000)), Ter(tesSUCCESS));
env.close();
// Alice's initial balance for USD is 3000 USD. Alice deposited 2000
// USD into the pool, then she has 1000 USD. And 1000 USD was clawed
// back from the AMM pool, so she still has 1000 USD.
env.require(Balance(gw, alice["USD"](-1000)));
env.require(Balance(alice, usd(1000)));
// Alice will get 500 XRP back.
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(500)));
aliceXrpBalance = env.balance(alice, XRP);
// 1000 USD and 500 XRP was withdrawn from the AMM pool, so the
// current balance is 1000 USD and 500 XRP.
BEAST_EXPECT(amm.expectBalances(usd(1000), XRP(500), IOUAmount{7071067811865475, -10}));
// Alice has half of its initial lptokens Left.
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865475, -10}));
// gw clawback another 1000 USD from the AMM pool. The AMM pool will
// be empty and get deleted.
env(amm::ammClawback(gw, alice, usd, XRP, usd(1000)), Ter(tesSUCCESS));
env.close();
// Alice should still has 1000 USD because gw clawed back from the
// AMM pool.
env.require(Balance(gw, alice["USD"](-1000)));
env.require(Balance(alice, usd(1000)));
// Alice will get another 500 XRP back.
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(500)));
// amm is automatically deleted.
BEAST_EXPECT(!amm.ammExists());
}
}
void
testAMMClawbackExceedBalance(FeatureBitset features)
{
testcase(
"test AMMClawback specific amount which exceeds the current "
"balance");
using namespace jtx;
// Test AMMClawback for USD/EUR pool. The assets are issued by different
// issuer. Claw back USD for multiple times, and EUR goes back to the
// holder. The last AMMClawback transaction exceeds the holder's USD
// balance in AMM pool.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, gw2, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 6000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(6000)));
env.close();
env.require(Balance(alice, usd(6000)));
// gw2 issues 6000 EUR to Alice.
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(6000)));
env.close();
env.require(Balance(alice, eur(6000)));
// Alice creates AMM pool of EUR/USD
AMM const amm(env, alice, eur(5000), usd(4000), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(4000), eur(5000), IOUAmount{4472135954999580, -12}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(4000), eur(5000), IOUAmount{4472135954999579, -12}));
}
// gw clawback 1000 USD from the AMM pool
env(amm::ammClawback(gw, alice, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
// Alice's initial balance for USD is 6000 USD. Alice deposited 4000
// USD into the pool, then she has 2000 USD. And 1000 USD was clawed
// back from the AMM pool, so she still has 2000 USD.
env.require(Balance(alice, usd(2000)));
// Alice's initial balance for EUR is 6000 EUR. Alice deposited 5000
// EUR into the pool, 1250 EUR was withdrawn proportionally. So she
// has 2500 EUR now.
env.require(Balance(alice, eur(2250)));
// 1000 USD and 1250 EUR was withdrawn from the AMM pool, so the
// current balance is 3000 USD and 3750 EUR.
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(3000), eur(3750), IOUAmount{3354101966249685, -12}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(3000), eur(3750), IOUAmount{3354101966249684, -12}));
}
// Alice has 3/4 of its initial lptokens Left.
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{3354101966249685, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{3354101966249684, -12}));
}
// gw clawback another 500 USD from the AMM pool.
env(amm::ammClawback(gw, alice, usd, eur, usd(500)), Ter(tesSUCCESS));
env.close();
// Alice should still has 2000 USD because gw clawed back from the
// AMM pool.
env.require(Balance(alice, usd(2000)));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(2500000000000001), -12},
STAmount{eur, UINT64_C(3125000000000001), -12},
IOUAmount{2795084971874738, -12}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(2500), eur(3125), IOUAmount{2795084971874737, -12}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
env.balance(alice, eur) == STAmount(eur, UINT64_C(2874999999999999), -12));
}
else
{
BEAST_EXPECT(env.balance(alice, eur) == eur(2875));
}
// gw clawback small amount, 1 USD.
env(amm::ammClawback(gw, alice, usd, eur, usd(1)), Ter(tesSUCCESS));
env.close();
// Another 1 USD / 1.25 EUR was withdrawn.
env.require(Balance(alice, usd(2000)));
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(2499000000000002), -12},
STAmount{eur, UINT64_C(3123750000000002), -12},
IOUAmount{2793966937885989, -12}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm.expectBalances(usd(2499), eur(3123.75), IOUAmount{2793966937885987, -12}));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(2499000000000001), -12},
STAmount{eur, UINT64_C(3123750000000001), -12},
IOUAmount{2793966937885988, -12}));
}
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
env.balance(alice, eur) == STAmount(eur, UINT64_C(2876'249999999998), -12));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(env.balance(alice, eur) == eur(2876.25));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(
env.balance(alice, eur) == STAmount(eur, UINT64_C(2876'249999999999), -12));
}
// gw clawback 4000 USD, exceeding the current balance. We
// will clawback all.
env(amm::ammClawback(gw, alice, usd, eur, usd(4000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, usd(2000)));
// All alice's EUR in the pool goes back to alice.
BEAST_EXPECT(env.balance(alice, eur) == STAmount(eur, UINT64_C(6000000000000000), -12));
// amm is automatically deleted.
BEAST_EXPECT(!amm.ammExists());
}
// Test AMMClawback for USD/XRP pool. Claw back USD for multiple times,
// and XRP goes back to the holder. The last AMMClawback transaction
// exceeds the holder's USD balance in AMM pool. In this case, gw
// creates the AMM pool USD/XRP, both alice and bob deposit into it. gw2
// creates the AMM pool EUR/XRP.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
Account const bob{"bob"};
env.fund(XRP(1000000), gw, gw2, alice, bob);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw2 sets asfAllowTrustLineClawback.
env(fset(gw2, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw2, asfAllowTrustLineClawback));
// gw issues 6000 USD to Alice and 5000 USD to Bob.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(6000)));
env.trust(usd(100000), bob);
env(pay(gw, bob, usd(5000)));
env.close();
// gw2 issues 5000 EUR to Alice and 4000 EUR to Bob.
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(5000)));
env.trust(eur(100000), bob);
env(pay(gw2, bob, eur(4000)));
env.close();
// gw creates AMM pool of XRP/USD, alice and bob deposit XRP/USD.
AMM amm(env, gw, XRP(2000), usd(1000), Ter(tesSUCCESS));
BEAST_EXPECT(amm.expectBalances(usd(1000), XRP(2000), IOUAmount{1414213562373095, -9}));
amm.deposit(alice, usd(1000), XRP(2000));
BEAST_EXPECT(amm.expectBalances(usd(2000), XRP(4000), IOUAmount{2828427124746190, -9}));
amm.deposit(bob, usd(1000), XRP(2000));
BEAST_EXPECT(amm.expectBalances(usd(3000), XRP(6000), IOUAmount{4242640687119285, -9}));
env.close();
// gw2 creates AMM pool of XRP/EUR, alice and bob deposit XRP/EUR.
AMM amm2(env, gw2, XRP(3000), eur(1000), Ter(tesSUCCESS));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm2.expectBalances(eur(1000), XRP(3000), IOUAmount{1732050807568878, -9}));
}
else
{
BEAST_EXPECT(
amm2.expectBalances(eur(1000), XRP(3000), IOUAmount{1732050807568877, -9}));
}
amm2.deposit(alice, eur(1000), XRP(3000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm2.expectBalances(eur(2000), XRP(6000), IOUAmount{3464101615137756, -9}));
}
else
{
BEAST_EXPECT(
amm2.expectBalances(eur(2000), XRP(6000), IOUAmount{3464101615137754, -9}));
}
amm2.deposit(bob, eur(1000), XRP(3000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm2.expectBalances(eur(3000), XRP(9000), IOUAmount{5196152422706634, -9}));
}
else
{
BEAST_EXPECT(
amm2.expectBalances(eur(3000), XRP(9000), IOUAmount{5196152422706631, -9}));
}
env.close();
auto aliceXrpBalance = env.balance(alice, XRP);
auto bobXrpBalance = env.balance(bob, XRP);
// gw clawback 500 USD from alice in amm
env(amm::ammClawback(gw, alice, usd, XRP, usd(500)), Ter(tesSUCCESS));
env.close();
// Alice's initial balance for USD is 6000 USD. Alice deposited 1000
// USD into the pool, then she has 5000 USD. And 500 USD was clawed
// back from the AMM pool, so she still has 5000 USD.
env.require(Balance(alice, usd(5000)));
// Bob's balance is not changed.
env.require(Balance(bob, usd(4000)));
// Alice gets 1000 XRP back.
if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(
expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(1000) - XRPAmount(1)));
}
else
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(1000)));
}
aliceXrpBalance = env.balance(alice, XRP);
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm.expectBalances(usd(2500), XRP(5000), IOUAmount{3535533905932738, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm.expectBalances(usd(2500), XRP(5000), IOUAmount{3535533905932737, -9}));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectBalances(
usd(2500), XRPAmount(5000000001), IOUAmount{3'535'533'905932738, -9}));
}
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865480, -10}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865474, -10}));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{707106781186548, -9}));
}
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1414213562373095, -9}));
// gw clawback 10 USD from bob in amm.
env(amm::ammClawback(gw, bob, usd, XRP, usd(10)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, usd(5000)));
env.require(Balance(bob, usd(4000)));
// Bob gets 20 XRP back.
BEAST_EXPECT(expectLedgerEntryRoot(env, bob, bobXrpBalance + XRP(20)));
bobXrpBalance = env.balance(bob, XRP);
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(2490000000000001), -12},
XRP(4980),
IOUAmount{3521391770309008, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm.expectBalances(usd(2'490), XRP(4980), IOUAmount{3521391770309006, -9}));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(2490000000000001), -12},
XRPAmount(4980000001),
IOUAmount{3521391'770309008, -9}));
}
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865480, -10}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865474, -10}));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{707106781186548, -9}));
}
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1400071426749365, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1400071426749364, -9}));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1400071426749365, -9}));
}
// gw2 clawback 200 EUR from amm2.
env(amm::ammClawback(gw2, alice, eur, XRP, eur(200)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, eur(4000)));
env.require(Balance(bob, eur(3000)));
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(600)));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(600)));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(
expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(600) - XRPAmount{1}));
}
aliceXrpBalance = env.balance(alice, XRP);
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm2.expectBalances(eur(2800), XRP(8400), IOUAmount{4849742261192859, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm2.expectBalances(eur(2800), XRP(8400), IOUAmount{4849742261192856, -9}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm2.expectBalances(
eur(2800), XRPAmount(8400000001), IOUAmount{4849742261192856, -9}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm2.expectLPTokens(alice, IOUAmount{1385640646055103, -9}));
}
else
{
BEAST_EXPECT(amm2.expectLPTokens(alice, IOUAmount{1385640646055102, -9}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm2.expectLPTokens(bob, IOUAmount{1732050807568878, -9}));
}
else
{
BEAST_EXPECT(amm2.expectLPTokens(bob, IOUAmount{1732050807568877, -9}));
}
// gw claw back 1000 USD from alice in amm, which exceeds alice's
// balance. This will clawback all the remaining LP tokens of alice
// (corresponding 500 USD / 1000 XRP).
env(amm::ammClawback(gw, alice, usd, XRP, usd(1000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, usd(5000)));
env.require(Balance(bob, usd(4000)));
// Alice gets 1000 XRP back.
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(1000)));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(1000) - XRPAmount{1}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(1000)));
}
aliceXrpBalance = env.balance(alice, XRP);
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0)));
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1400071426749365, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1400071426749364, -9}));
}
else if (features[fixAMMClawbackRounding] && features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{1400071426749365, -9}));
}
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(1990000000000001), -12},
XRP(3980),
IOUAmount{2814284989122460, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
usd(1'990), XRPAmount{3'980'000'001}, IOUAmount{2814284989122459, -9}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(1990000000000001), -12},
XRPAmount{3'980'000'001},
IOUAmount{2814284989122460, -9}));
}
// gw clawback 1000 USD from bob in amm, which also exceeds bob's
// balance in amm. All bob's lptoken in amm will be consumed, which
// corresponds to 990 USD / 1980 XRP
env(amm::ammClawback(gw, bob, usd, XRP, usd(1000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, usd(5000)));
env.require(Balance(bob, usd(4000)));
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance));
BEAST_EXPECT(expectLedgerEntryRoot(env, bob, bobXrpBalance + XRP(1980)));
bobXrpBalance = env.balance(bob, XRP);
// Now neither alice nor bob has any lptoken in amm.
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(0)));
// gw2 claw back 1000 EUR from alice in amm2, which exceeds alice's
// balance. All alice's lptokens will be consumed, which corresponds
// to 800EUR / 2400 XRP.
env(amm::ammClawback(gw2, alice, eur, XRP, eur(1000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, eur(4000)));
env.require(Balance(bob, eur(3000)));
// Alice gets another 2400 XRP back, bob's XRP balance remains the
// same.
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(2400)));
BEAST_EXPECT(expectLedgerEntryRoot(env, bob, bobXrpBalance));
aliceXrpBalance = env.balance(alice, XRP);
// Alice now does not have any lptoken in amm2
BEAST_EXPECT(amm2.expectLPTokens(alice, IOUAmount(0)));
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm2.expectBalances(eur(2000), XRP(6000), IOUAmount{3464101615137756, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm2.expectBalances(eur(2000), XRP(6000), IOUAmount{3464101615137754, -9}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm2.expectBalances(
eur(2000), XRPAmount(6000000001), IOUAmount{3464101615137754, -9}));
}
// gw2 claw back 2000 EUR from bob in amm2, which exceeds bob's
// balance. All bob's lptokens will be consumed, which corresponds
// to 1000EUR / 3000 XRP.
env(amm::ammClawback(gw2, bob, eur, XRP, eur(2000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, eur(4000)));
env.require(Balance(bob, eur(3000)));
// Bob gets another 3000 XRP back. Alice's XRP balance remains the
// same.
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance));
BEAST_EXPECT(expectLedgerEntryRoot(env, bob, bobXrpBalance + XRP(3000)));
bobXrpBalance = env.balance(bob, XRP);
// Neither alice nor bob has any lptoken in amm2
BEAST_EXPECT(amm2.expectLPTokens(alice, IOUAmount(0)));
BEAST_EXPECT(amm2.expectLPTokens(bob, IOUAmount(0)));
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm2.expectBalances(eur(1000), XRP(3000), IOUAmount{1732050807568878, -9}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm2.expectBalances(eur(1000), XRP(3000), IOUAmount{1732050807568877, -9}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm2.expectBalances(
eur(1000), XRPAmount(3000000001), IOUAmount{1732050807568877, -9}));
}
}
}
void
testAMMClawbackAll(FeatureBitset features)
{
testcase("test AMMClawback all the tokens in the AMM pool");
using namespace jtx;
// Test AMMClawback for USD/EUR pool. The assets are issued by different
// issuer. Claw back all the USD for different users.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
Account const bob{"bob"};
Account const carol{"carol"};
env.fund(XRP(1000000), gw, gw2, alice, bob, carol);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw2 sets asfAllowTrustLineClawback.
env(fset(gw2, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw2, asfAllowTrustLineClawback));
// gw issues 6000 USD to Alice, 5000 USD to Bob, and 4000 USD
// to Carol.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(6000)));
env.trust(usd(100000), bob);
env(pay(gw, bob, usd(5000)));
env.trust(usd(100000), carol);
env(pay(gw, carol, usd(4000)));
env.close();
// gw2 issues 6000 EUR to Alice and 5000 EUR to Bob and 4000
// EUR to Carol.
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(6000)));
env.trust(eur(100000), bob);
env(pay(gw2, bob, eur(5000)));
env.trust(eur(100000), carol);
env(pay(gw2, carol, eur(4000)));
env.close();
// Alice creates AMM pool of EUR/USD
AMM amm(env, alice, eur(5000), usd(4000), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(4000), eur(5000), IOUAmount{4472135954999580, -12}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(4000), eur(5000), IOUAmount{4472135954999579, -12}));
}
amm.deposit(bob, usd(2000), eur(2500));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(6000), eur(7500), IOUAmount{6708203932499370, -12}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(6000), eur(7500), IOUAmount{6708203932499368, -12}));
}
amm.deposit(carol, usd(1000), eur(1250));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(7000), eur(8750), IOUAmount{7826237921249265, -12}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(7000), eur(8750), IOUAmount{7826237921249262, -12}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4472135954999580, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4472135954999579, -12}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{2236067977499790, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{2236067977499789, -12}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount{1118033988749895, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount{1118033988749894, -12}));
}
env.require(Balance(alice, usd(2000)));
env.require(Balance(alice, eur(1000)));
env.require(Balance(bob, usd(3000)));
env.require(Balance(bob, eur(2500)));
env.require(Balance(carol, usd(3000)));
env.require(Balance(carol, eur(2750)));
// gw clawback all the bob's USD in amm. (2000 USD / 2500 EUR)
env(amm::ammClawback(gw, bob, usd, eur, std::nullopt), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(4999999999999999), -12},
STAmount{eur, UINT64_C(6249999999999999), -12},
IOUAmount{5590169943749475, -12}));
}
else
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(5000000000000001), -12},
STAmount{eur, UINT64_C(6250000000000001), -12},
IOUAmount{5590169943749473, -12}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4472135954999580, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4472135954999579, -12}));
}
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(0)));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount{1118033988749895, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount{1118033988749894, -12}));
}
// Bob will get 2500 EUR back.
env.require(Balance(alice, usd(2000)));
env.require(Balance(alice, eur(1000)));
BEAST_EXPECT(env.balance(bob, usd) == STAmount(usd, UINT64_C(3000000000000000), -12));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
env.balance(bob, eur) == STAmount(eur, UINT64_C(5000000000000001), -12));
}
else
{
BEAST_EXPECT(
env.balance(bob, eur) == STAmount(eur, UINT64_C(4999999999999999), -12));
}
env.require(Balance(carol, usd(3000)));
env.require(Balance(carol, eur(2750)));
// gw2 clawback all carol's EUR in amm. (1000 USD / 1250 EUR)
env(amm::ammClawback(gw2, carol, eur, usd, std::nullopt), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(3999999999999999), -12},
STAmount{eur, UINT64_C(4999999999999999), -12},
IOUAmount{4472135954999580, -12}));
}
else
{
BEAST_EXPECT(amm.expectBalances(
STAmount{usd, UINT64_C(4000000000000001), -12},
STAmount{eur, UINT64_C(5000000000000002), -12},
IOUAmount{4472135954999579, -12}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4472135954999580, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4472135954999579, -12}));
}
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(0)));
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount(0)));
// gw2 clawback all alice's EUR in amm. (4000 USD / 5000 EUR)
env(amm::ammClawback(gw2, alice, eur, usd, std::nullopt), Ter(tesSUCCESS));
env.close();
env.require(Balance(carol, eur(2750)));
env.require(Balance(carol, usd(4000)));
BEAST_EXPECT(!amm.ammExists());
}
// Test AMMClawback for USD/XRP pool. Claw back all the USD for
// different users.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
Account const bob{"bob"};
env.fund(XRP(1000000), gw, alice, bob);
env.close();
// gw sets asfAllowTrustLineClawback
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 600000 USD to Alice and 500000 USD to Bob.
auto const usd = gw["USD"];
env.trust(usd(1000000), alice);
env(pay(gw, alice, usd(600000)));
env.trust(usd(1000000), bob);
env(pay(gw, bob, usd(500000)));
env.close();
// gw creates AMM pool of XRP/USD, alice and bob deposit XRP/USD.
AMM amm(env, gw, XRP(2000), usd(10000), Ter(tesSUCCESS));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(10000), XRP(2000), IOUAmount{4472135954999580, -9}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(10000), XRP(2000), IOUAmount{4472135954999579, -9}));
}
amm.deposit(alice, usd(1000), XRP(200));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(11000), XRP(2200), IOUAmount{4919349550499538, -9}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(11000), XRP(2200), IOUAmount{4919349550499536, -9}));
}
amm.deposit(bob, usd(2000), XRP(400));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(13000), XRP(2600), IOUAmount{5813776741499453, -9}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(13000), XRP(2600), IOUAmount{5813776741499451, -9}));
}
env.close();
auto aliceXrpBalance = env.balance(alice, XRP);
auto bobXrpBalance = env.balance(bob, XRP);
// gw clawback all alice's USD in amm. (1000 USD / 200 XRP)
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(12000), XRP(2400), IOUAmount{5366563145999495, -9}));
}
else
{
BEAST_EXPECT(amm.expectBalances(
usd(12000), XRPAmount(2400000001), IOUAmount{5366563145999494, -9}));
}
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(200)));
}
else
{
BEAST_EXPECT(
expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(200) - XRPAmount{1}));
}
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0)));
// gw clawback all bob's USD in amm. (2000 USD / 400 XRP)
env(amm::ammClawback(gw, bob, usd, XRP, std::nullopt), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(
amm.expectBalances(usd(10000), XRP(2000), IOUAmount{4472135954999580, -9}));
}
else
{
BEAST_EXPECT(amm.expectBalances(
usd(10000), XRPAmount(2000000001), IOUAmount{4472135954999579, -9}));
}
BEAST_EXPECT(expectLedgerEntryRoot(env, bob, bobXrpBalance + XRP(400)));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(0)));
}
}
void
testAMMClawbackSameIssuerAssets(FeatureBitset features)
{
testcase(
"test AMMClawback from AMM pool with assets having the same "
"issuer");
using namespace jtx;
// Test AMMClawback for USD/EUR pool. The assets are issued by different
// issuer. Claw back all the USD for different users.
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
Account const bob{"bob"};
Account const carol{"carol"};
env.fund(XRP(1000000), gw, alice, bob, carol);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(10000)));
env.trust(usd(100000), bob);
env(pay(gw, bob, usd(9000)));
env.trust(usd(100000), carol);
env(pay(gw, carol, usd(8000)));
env.close();
auto const eur = gw["EUR"];
env.trust(eur(100000), alice);
env(pay(gw, alice, eur(10000)));
env.trust(eur(100000), bob);
env(pay(gw, bob, eur(9000)));
env.trust(eur(100000), carol);
env(pay(gw, carol, eur(8000)));
env.close();
AMM amm(env, alice, eur(2000), usd(8000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(8000), eur(2000), IOUAmount(4000)));
amm.deposit(bob, usd(4000), eur(1000));
BEAST_EXPECT(amm.expectBalances(usd(12000), eur(3000), IOUAmount(6000)));
if (!features[fixAMMv1_3])
{
amm.deposit(carol, usd(2000), eur(500));
}
else
{
amm.deposit(carol, usd(2000.25), eur(500));
}
BEAST_EXPECT(amm.expectBalances(usd(14000), eur(3500), IOUAmount(7000)));
// gw clawback 1000 USD from carol.
env(amm::ammClawback(gw, carol, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(13000), eur(3250), IOUAmount(6500)));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(4000)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(2000)));
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount(500)));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(8000));
BEAST_EXPECT(env.balance(bob, usd) == usd(5000));
BEAST_EXPECT(env.balance(bob, eur) == eur(8000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(env.balance(carol, usd) == usd(6000));
}
else
{
BEAST_EXPECT(
env.balance(carol, usd) == STAmount(usd, UINT64_C(5999'999999999999), -12));
}
// 250 EUR goes back to carol.
BEAST_EXPECT(env.balance(carol, eur) == eur(7750));
// gw clawback 1000 USD from bob with tfClawTwoAssets flag.
// then the corresponding EUR will also be clawed back
// by gw.
env(amm::ammClawback(gw, bob, usd, eur, usd(1000)),
Txflags(tfClawTwoAssets),
Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(12000), eur(3000), IOUAmount(6000)));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(4000)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(1500)));
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount(500)));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(8000));
BEAST_EXPECT(env.balance(bob, usd) == usd(5000));
// 250 EUR did not go back to bob because tfClawTwoAssets is set.
BEAST_EXPECT(env.balance(bob, eur) == eur(8000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(env.balance(carol, usd) == usd(6000));
}
else
{
BEAST_EXPECT(
env.balance(carol, usd) == STAmount(usd, UINT64_C(5999'999999999999), -12));
}
BEAST_EXPECT(env.balance(carol, eur) == eur(7750));
// gw clawback all USD from alice and set tfClawTwoAssets.
env(amm::ammClawback(gw, alice, usd, eur, std::nullopt),
Txflags(tfClawTwoAssets),
Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(4000), eur(1000), IOUAmount(2000)));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(1500)));
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount(500)));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(8000));
BEAST_EXPECT(env.balance(bob, usd) == usd(5000));
BEAST_EXPECT(env.balance(bob, eur) == eur(8000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(env.balance(carol, usd) == usd(6000));
}
else
{
BEAST_EXPECT(
env.balance(carol, usd) == STAmount(usd, UINT64_C(5999'999999999999), -12));
}
BEAST_EXPECT(env.balance(carol, eur) == eur(7750));
}
void
testAMMClawbackSameCurrency(FeatureBitset features)
{
testcase(
"test AMMClawback from AMM pool with assets having the same "
"currency, but from different issuer");
using namespace jtx;
// Test AMMClawback for USD/EUR pool. The assets are issued by different
// issuer. Claw back all the USD for different users.
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
Account const bob{"bob"};
env.fund(XRP(1000000), gw, gw2, alice, bob);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw2 sets asfAllowTrustLineClawback.
env(fset(gw2, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw2, asfAllowTrustLineClawback));
env.trust(gw["USD"](100000), alice);
env(pay(gw, alice, gw["USD"](8000)));
env.trust(gw["USD"](100000), bob);
env(pay(gw, bob, gw["USD"](7000)));
env.trust(gw2["USD"](100000), alice);
env(pay(gw2, alice, gw2["USD"](6000)));
env.trust(gw2["USD"](100000), bob);
env(pay(gw2, bob, gw2["USD"](5000)));
env.close();
AMM amm(env, alice, gw["USD"](1000), gw2["USD"](1500), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(
gw["USD"](1000), gw2["USD"](1500), IOUAmount{1224744871391589, -12}));
amm.deposit(bob, gw["USD"](2000), gw2["USD"](3000));
BEAST_EXPECT(amm.expectBalances(
gw["USD"](3000), gw2["USD"](4500), IOUAmount{3674234614174767, -12}));
// Issuer does not match with asset.
env(amm::ammClawback(
gw,
alice,
gw2["USD"],
gw["USD"],
STAmount{Issue{gw2["USD"].currency, gw2.id()}, 500}),
Ter(temMALFORMED));
// gw2 clawback 500 gw2[USD] from alice.
env(amm::ammClawback(
gw2,
alice,
gw2["USD"],
gw["USD"],
STAmount{Issue{gw2["USD"].currency, gw2.id()}, 500}),
Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(
STAmount{gw["USD"], UINT64_C(2666666666666667), -12},
gw2["USD"](4000),
IOUAmount{3265986323710904, -12}));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{8164965809277260, -13}));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount{2449489742783178, -12}));
BEAST_EXPECT(
env.balance(alice, gw["USD"]) == STAmount(gw["USD"], UINT64_C(7333333333333333), -12));
BEAST_EXPECT(env.balance(alice, gw2["USD"]) == gw2["USD"](4500));
BEAST_EXPECT(env.balance(bob, gw["USD"]) == gw["USD"](5000));
BEAST_EXPECT(env.balance(bob, gw2["USD"]) == gw2["USD"](2000));
// gw clawback all gw["USD"] from bob.
env(amm::ammClawback(gw, bob, gw["USD"], gw2["USD"], std::nullopt), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(
STAmount{gw["USD"], UINT64_C(6666666666666670), -13},
gw2["USD"](1000),
IOUAmount{8164965809277260, -13}));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{8164965809277260, -13}));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(0)));
BEAST_EXPECT(
env.balance(alice, gw["USD"]) == STAmount(gw["USD"], UINT64_C(7333333333333333), -12));
BEAST_EXPECT(env.balance(alice, gw2["USD"]) == gw2["USD"](4500));
BEAST_EXPECT(env.balance(bob, gw["USD"]) == gw["USD"](5000));
// Bob gets 3000 gw2["USD"] back and now his balance is 5000.
BEAST_EXPECT(env.balance(bob, gw2["USD"]) == gw2["USD"](5000));
}
void
testAMMClawbackIssuesEachOther(FeatureBitset features)
{
testcase("test AMMClawback when issuing token for each other");
using namespace jtx;
// gw and gw2 issues token for each other. Test AMMClawback from
// each other.
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, gw2, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw2 sets asfAllowTrustLineClawback.
env(fset(gw2, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw2, asfAllowTrustLineClawback));
auto const usd = gw["USD"];
env.trust(usd(100000), gw2);
env(pay(gw, gw2, usd(5000)));
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(5000)));
auto const eur = gw2["EUR"];
env.trust(eur(100000), gw);
env(pay(gw2, gw, eur(6000)));
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(6000)));
env.close();
AMM amm(env, gw, usd(1000), eur(2000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(1000), eur(2000), IOUAmount{1414213562373095, -12}));
amm.deposit(gw2, usd(2000), eur(4000));
BEAST_EXPECT(amm.expectBalances(usd(3000), eur(6000), IOUAmount{4242640687119285, -12}));
amm.deposit(alice, usd(3000), eur(6000));
BEAST_EXPECT(amm.expectBalances(usd(6000), eur(12000), IOUAmount{8485281374238570, -12}));
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{1414213562373095, -12}));
BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{2828427124746190, -12}));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4242640687119285, -12}));
// gw claws back 1000 USD from gw2.
env(amm::ammClawback(gw, gw2, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3] || !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm.expectBalances(usd(5000), eur(10000), IOUAmount{7071067811865475, -12}));
}
else
{
BEAST_EXPECT(
amm.expectBalances(usd(5000), eur(10000), IOUAmount{7071067811865474, -12}));
}
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{1414213562373095, -12}));
if (!features[fixAMMv1_3] || !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414213562373095, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414213562373094, -12}));
}
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4242640687119285, -12}));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(0));
BEAST_EXPECT(env.balance(gw, eur) == eur(4000));
BEAST_EXPECT(env.balance(gw2, usd) == usd(3000));
// gw2 claws back 1000 EUR from gw.
env(amm::ammClawback(gw2, gw, eur, usd, eur(1000)), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
usd(4500),
STAmount(eur, UINT64_C(9000000000000001), -12),
IOUAmount{6363961030678928, -12}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm.expectBalances(usd(4500), eur(9000), IOUAmount{6363961030678928, -12}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
usd(4500),
STAmount(eur, UINT64_C(9000000000000001), -12),
IOUAmount{6363961030678927, -12}));
}
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{7071067811865480, -13}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{7071067811865475, -13}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{7071067811865480, -13}));
}
if (!features[fixAMMv1_3] || !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414213562373095, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414213562373094, -12}));
}
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{4242640687119285, -12}));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(0));
BEAST_EXPECT(env.balance(gw, eur) == eur(4000));
BEAST_EXPECT(env.balance(gw2, usd) == usd(3000));
// gw2 claws back 4000 EUR from alice.
env(amm::ammClawback(gw2, alice, eur, usd, eur(4000)), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
usd(2500),
STAmount(eur, UINT64_C(5000000000000001), -12),
IOUAmount{3535533905932738, -12}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(
amm.expectBalances(usd(2500), eur(5000), IOUAmount{3535533905932738, -12}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
usd(2500),
STAmount(eur, UINT64_C(5000000000000001), -12),
IOUAmount{3535533905932737, -12}));
}
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{7071067811865480, -13}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{7071067811865475, -13}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw, IOUAmount{7071067811865480, -13}));
}
if (!features[fixAMMv1_3] || !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414213562373095, -12}));
}
else
{
BEAST_EXPECT(amm.expectLPTokens(gw2, IOUAmount{1414213562373094, -12}));
}
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{1414213562373095, -12}));
BEAST_EXPECT(env.balance(alice, usd) == usd(4000));
BEAST_EXPECT(env.balance(alice, eur) == eur(0));
BEAST_EXPECT(env.balance(gw, eur) == eur(4000));
BEAST_EXPECT(env.balance(gw2, usd) == usd(3000));
}
void
testNotHoldingLptoken(FeatureBitset features)
{
testcase(
"test AMMClawback from account which does not own any lptoken in "
"the pool");
using namespace jtx;
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(5000)));
AMM const amm(env, gw, usd(1000), XRP(2000), Ter(tesSUCCESS));
env.close();
// Alice did not deposit in the amm pool. So AMMClawback from Alice
// will fail.
env(amm::ammClawback(gw, alice, usd, XRP, usd(1000)), Ter(tecAMM_BALANCE));
}
void
testAssetFrozen(FeatureBitset features)
{
testcase("test assets frozen");
using namespace jtx;
// test individually frozen trustline.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, gw2, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 3000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(3000)));
env.close();
env.require(Balance(alice, usd(3000)));
// gw2 issues 3000 EUR to Alice.
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(3000)));
env.close();
env.require(Balance(alice, eur(3000)));
// Alice creates AMM pool of EUR/USD.
AMM const amm(env, alice, eur(1000), usd(2000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(
amm.expectBalances(usd(2000), eur(1000), IOUAmount{1414213562373095, -12}));
// freeze trustline
env(trust(gw, alice["USD"](0), tfSetFreeze));
env.close();
// gw clawback 1000 USD from the AMM pool.
env(amm::ammClawback(gw, alice, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, usd(1000)));
env.require(Balance(alice, eur(2500)));
BEAST_EXPECT(amm.expectBalances(usd(1000), eur(500), IOUAmount{7071067811865475, -13}));
// Alice has half of its initial lptokens Left.
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865475, -13}));
// gw clawback another 1000 USD from the AMM pool. The AMM pool will
// be empty and get deleted.
env(amm::ammClawback(gw, alice, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
// Alice should still has 1000 USD because gw clawed back from the
// AMM pool.
env.require(Balance(alice, usd(1000)));
env.require(Balance(alice, eur(3000)));
// amm is automatically deleted.
BEAST_EXPECT(!amm.ammExists());
}
// test individually frozen trustline of both USD and EUR currency.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, gw2, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 3000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(3000)));
env.close();
env.require(Balance(alice, usd(3000)));
// gw2 issues 3000 EUR to Alice.
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(3000)));
env.close();
env.require(Balance(alice, eur(3000)));
// Alice creates AMM pool of EUR/USD.
AMM const amm(env, alice, eur(1000), usd(2000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(
amm.expectBalances(usd(2000), eur(1000), IOUAmount{1414213562373095, -12}));
// freeze trustlines
env(trust(gw, alice["USD"](0), tfSetFreeze));
env(trust(gw2, alice["EUR"](0), tfSetFreeze));
env.close();
// gw clawback 1000 USD from the AMM pool.
env(amm::ammClawback(gw, alice, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, usd(1000)));
env.require(Balance(alice, eur(2500)));
BEAST_EXPECT(amm.expectBalances(usd(1000), eur(500), IOUAmount{7071067811865475, -13}));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865475, -13}));
}
// test gw global freeze.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const gw2{"gateway2"};
Account const alice{"alice"};
env.fund(XRP(1000000), gw, gw2, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 3000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(3000)));
env.close();
env.require(Balance(alice, usd(3000)));
// gw2 issues 3000 EUR to Alice.
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(3000)));
env.close();
env.require(Balance(alice, eur(3000)));
// Alice creates AMM pool of EUR/USD.
AMM const amm(env, alice, eur(1000), usd(2000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(
amm.expectBalances(usd(2000), eur(1000), IOUAmount{1414213562373095, -12}));
// global freeze
env(fset(gw, asfGlobalFreeze));
env.close();
// gw clawback 1000 USD from the AMM pool.
env(amm::ammClawback(gw, alice, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
env.require(Balance(alice, usd(1000)));
env.require(Balance(alice, eur(2500)));
BEAST_EXPECT(amm.expectBalances(usd(1000), eur(500), IOUAmount{7071067811865475, -13}));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount{7071067811865475, -13}));
}
// Test both assets are issued by the same issuer. And issuer sets
// global freeze.
{
Env env(*this, features);
Account const gw{"gateway"};
Account const alice{"alice"};
Account const bob{"bob"};
Account const carol{"carol"};
env.fund(XRP(1000000), gw, alice, bob, carol);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(10000)));
env.trust(usd(100000), bob);
env(pay(gw, bob, usd(9000)));
env.trust(usd(100000), carol);
env(pay(gw, carol, usd(8000)));
env.close();
auto const eur = gw["EUR"];
env.trust(eur(100000), alice);
env(pay(gw, alice, eur(10000)));
env.trust(eur(100000), bob);
env(pay(gw, bob, eur(9000)));
env.trust(eur(100000), carol);
env(pay(gw, carol, eur(8000)));
env.close();
AMM amm(env, alice, eur(2000), usd(8000), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(8000), eur(2000), IOUAmount(4000)));
amm.deposit(bob, usd(4000), eur(1000));
BEAST_EXPECT(amm.expectBalances(usd(12000), eur(3000), IOUAmount(6000)));
if (!features[fixAMMv1_3])
{
amm.deposit(carol, usd(2000), eur(500));
}
else
{
amm.deposit(carol, usd(2000.25), eur(500));
}
BEAST_EXPECT(amm.expectBalances(usd(14000), eur(3500), IOUAmount(7000)));
// global freeze
env(fset(gw, asfGlobalFreeze));
env.close();
// gw clawback 1000 USD from carol.
env(amm::ammClawback(gw, carol, usd, eur, usd(1000)), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(13000), eur(3250), IOUAmount(6500)));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(4000)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(2000)));
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount(500)));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(8000));
BEAST_EXPECT(env.balance(bob, usd) == usd(5000));
BEAST_EXPECT(env.balance(bob, eur) == eur(8000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(env.balance(carol, usd) == usd(6000));
}
else
{
BEAST_EXPECT(
env.balance(carol, usd) == STAmount(usd, UINT64_C(5999'999999999999), -12));
}
// 250 EUR goes back to carol.
BEAST_EXPECT(env.balance(carol, eur) == eur(7750));
// gw clawback 1000 USD from bob with tfClawTwoAssets flag.
// then the corresponding EUR will also be clawed back
// by gw.
env(amm::ammClawback(gw, bob, usd, eur, usd(1000)),
Txflags(tfClawTwoAssets),
Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(12000), eur(3000), IOUAmount(6000)));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(4000)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(1500)));
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount(500)));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(8000));
BEAST_EXPECT(env.balance(bob, usd) == usd(5000));
// 250 EUR did not go back to bob because tfClawTwoAssets is set.
BEAST_EXPECT(env.balance(bob, eur) == eur(8000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(env.balance(carol, usd) == usd(6000));
}
else
{
BEAST_EXPECT(
env.balance(carol, usd) == STAmount(usd, UINT64_C(5999'999999999999), -12));
}
BEAST_EXPECT(env.balance(carol, eur) == eur(7750));
// gw clawback all USD from alice and set tfClawTwoAssets.
env(amm::ammClawback(gw, alice, usd, eur, std::nullopt),
Txflags(tfClawTwoAssets),
Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(4000), eur(1000), IOUAmount(2000)));
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0)));
BEAST_EXPECT(amm.expectLPTokens(bob, IOUAmount(1500)));
BEAST_EXPECT(amm.expectLPTokens(carol, IOUAmount(500)));
BEAST_EXPECT(env.balance(alice, usd) == usd(2000));
BEAST_EXPECT(env.balance(alice, eur) == eur(8000));
BEAST_EXPECT(env.balance(bob, usd) == usd(5000));
BEAST_EXPECT(env.balance(bob, eur) == eur(8000));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(env.balance(carol, usd) == usd(6000));
}
else
{
BEAST_EXPECT(
env.balance(carol, usd) == STAmount(usd, UINT64_C(5999'999999999999), -12));
}
BEAST_EXPECT(env.balance(carol, eur) == eur(7750));
}
}
void
testSingleDepositAndClawback(FeatureBitset features)
{
testcase("test single deposit and clawback");
using namespace jtx;
std::string logs;
// Test AMMClawback for USD/XRP pool. Claw back USD, and XRP goes back
// to the holder.
Env env(*this, features, std::make_unique<CaptureLogs>(&logs));
Account const gw{"gateway"};
Account const alice{"alice"};
env.fund(XRP(1000000000), gw, alice);
env.close();
// gw sets asfAllowTrustLineClawback.
env(fset(gw, asfAllowTrustLineClawback));
env.close();
env.require(Flags(gw, asfAllowTrustLineClawback));
// gw issues 1000 USD to Alice.
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(1000)));
env.close();
env.require(Balance(alice, usd(1000)));
// gw creates AMM pool of XRP/USD.
AMM amm(env, gw, XRP(100), usd(400), Ter(tesSUCCESS));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(400), XRP(100), IOUAmount(200000)));
amm.deposit(alice, usd(400));
env.close();
BEAST_EXPECT(amm.expectBalances(usd(800), XRP(100), IOUAmount{2828427124746190, -10}));
auto aliceXrpBalance = env.balance(alice, XRP);
env(amm::ammClawback(gw, alice, usd, XRP, usd(400)), Ter(tesSUCCESS));
env.close();
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(5656854249492380), -13), XRP(70.710678), IOUAmount(200000)));
}
else
{
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(565'685424949238), -12), XRP(70.710679), IOUAmount(200000)));
}
BEAST_EXPECT(amm.expectLPTokens(alice, IOUAmount(0)));
if (!features[fixAMMv1_3])
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(29.289322)));
}
else
{
BEAST_EXPECT(expectLedgerEntryRoot(env, alice, aliceXrpBalance + XRP(29.289321)));
}
}
void
testLastHolderLPTokenBalance(FeatureBitset features)
{
testcase(
"test last holder's lptoken balance not equal to AMM's lptoken "
"balance before clawback");
using namespace jtx;
std::string logs;
auto setupAccounts =
[&](Env& env, Account const& gw, Account const& alice, Account const& bob) {
env.fund(XRP(100000), gw, alice, bob);
env.close();
env(fset(gw, asfAllowTrustLineClawback));
env.close();
auto const usd = gw["USD"];
env.trust(usd(100000), alice);
env(pay(gw, alice, usd(50000)));
env.trust(usd(100000), bob);
env(pay(gw, bob, usd(40000)));
env.close();
return usd;
};
auto getLPTokenBalances = [&](auto& env,
auto const& amm,
auto const& account) -> std::pair<std::string, std::string> {
auto const lpToken =
getAccountLines(env, account, amm.lptIssue())[jss::lines][0u][jss::balance]
.asString();
auto const lpTokenBalance =
amm.ammRpcInfo()[jss::amm][jss::lp_token][jss::value].asString();
return {lpToken, lpTokenBalance};
};
// IOU/XRP pool. AMMClawback almost last holder's USD balance
{
Env env(*this, features, std::make_unique<CaptureLogs>(&logs));
Account const gw{"gateway"}, alice{"alice"}, bob{"bob"};
auto const usd = setupAccounts(env, gw, alice, bob);
AMM amm(env, alice, XRP(2), usd(1));
amm.deposit(alice, IOUAmount{1'876123487565916, -15});
amm.deposit(bob, IOUAmount{1'000'000});
amm.withdraw(alice, IOUAmount{1'876123487565916, -15});
amm.withdrawAll(bob);
auto [lpToken, lpTokenBalance] = getLPTokenBalances(env, amm, alice);
BEAST_EXPECT(lpToken == "1414.21356237366" && lpTokenBalance == "1414.213562374");
auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice);
BEAST_EXPECT(res && res.value());
if (!features[fixAMMClawbackRounding] || !features[fixAMMv1_3])
{
env(amm::ammClawback(gw, alice, usd, XRP, usd(1)), Ter(tecAMM_BALANCE));
BEAST_EXPECT(amm.ammExists());
}
else
{
auto const lpBalance = IOUAmount{989, -12};
env(amm::ammClawback(gw, alice, usd, XRP, usd(1)));
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(7000000000000000), -28), XRPAmount(1), lpBalance));
BEAST_EXPECT(amm.expectLPTokens(alice, lpBalance));
}
}
// IOU/XRP pool. AMMClawback part of last holder's USD balance
{
Env env(*this, features, std::make_unique<CaptureLogs>(&logs));
Account const gw{"gateway"}, alice{"alice"}, bob{"bob"};
auto const usd = setupAccounts(env, gw, alice, bob);
AMM amm(env, alice, XRP(2), usd(1));
amm.deposit(alice, IOUAmount{1'876123487565916, -15});
amm.deposit(bob, IOUAmount{1'000'000});
amm.withdrawAll(bob);
auto [lpToken, lpTokenBalance] = getLPTokenBalances(env, amm, alice);
BEAST_EXPECT(lpToken == "1416.08968586066" && lpTokenBalance == "1416.089685861");
auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice);
BEAST_EXPECT(res && res.value());
env(amm::ammClawback(gw, alice, usd, XRP, usd(0.5)));
if (!features[fixAMMv1_3] && !features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(5013266196406), -13),
XRPAmount(1002653),
IOUAmount{708'9829046744236, -13}));
}
else if (!features[fixAMMClawbackRounding])
{
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(5013266196407), -13),
XRPAmount(1002654),
IOUAmount{708'9829046744941, -13}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
auto const lpBalance = IOUAmount{708'9829046743238, -13};
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(5013266196406999), -16), XRPAmount(1002655), lpBalance));
BEAST_EXPECT(amm.expectLPTokens(alice, lpBalance));
}
}
// IOU/XRP pool. AMMClawback all of last holder's USD balance
{
Env env(*this, features, std::make_unique<CaptureLogs>(&logs));
Account const gw{"gateway"}, alice{"alice"}, bob{"bob"};
auto const usd = setupAccounts(env, gw, alice, bob);
AMM amm(env, alice, XRP(2), usd(1));
amm.deposit(alice, IOUAmount{1'876123487565916, -15});
amm.deposit(bob, IOUAmount{1'000'000});
amm.withdraw(alice, IOUAmount{1'876123487565916, -15});
amm.withdrawAll(bob);
auto [lpToken, lpTokenBalance] = getLPTokenBalances(env, amm, alice);
BEAST_EXPECT(lpToken == "1414.21356237366" && lpTokenBalance == "1414.213562374");
auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice);
BEAST_EXPECT(res && res.value());
if (!features[fixAMMClawbackRounding] && !features[fixAMMv1_3])
{
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt), Ter(tecAMM_BALANCE));
}
else if (!features[fixAMMClawbackRounding])
{
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt));
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(2410000000000000), -28),
XRPAmount(1),
IOUAmount{34, -11}));
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
env(amm::ammClawback(gw, alice, usd, XRP, std::nullopt));
BEAST_EXPECT(!amm.ammExists());
}
}
// IOU/IOU pool, different issuers
{
Env env(*this, features, std::make_unique<CaptureLogs>(&logs));
Account const gw{"gateway"}, alice{"alice"}, bob{"bob"};
auto const usd = setupAccounts(env, gw, alice, bob);
Account const gw2{"gateway2"};
env.fund(XRP(100000), gw2);
env.close();
auto const eur = gw2["EUR"];
env.trust(eur(100000), alice);
env(pay(gw2, alice, eur(50000)));
env.trust(eur(100000), bob);
env(pay(gw2, bob, eur(50000)));
env.close();
AMM amm(env, alice, usd(2), eur(1));
amm.deposit(alice, IOUAmount{1'576123487565916, -15});
amm.deposit(bob, IOUAmount{1'000});
amm.withdraw(alice, IOUAmount{1'576123487565916, -15});
amm.withdrawAll(bob);
auto [lpToken, lpTokenBalance] = getLPTokenBalances(env, amm, alice);
BEAST_EXPECT(lpToken == "1.414213562374011" && lpTokenBalance == "1.414213562374");
auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice);
BEAST_EXPECT(res && res.value());
if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
env(amm::ammClawback(gw, alice, usd, eur, std::nullopt));
BEAST_EXPECT(!amm.ammExists());
}
else
{
env(amm::ammClawback(gw, alice, usd, eur, std::nullopt), Ter(tecINTERNAL));
BEAST_EXPECT(amm.ammExists());
}
}
// IOU/IOU pool, same issuer
{
Env env(*this, features, std::make_unique<CaptureLogs>(&logs));
Account const gw{"gateway"}, alice{"alice"}, bob{"bob"};
auto const usd = setupAccounts(env, gw, alice, bob);
auto const eur = gw["EUR"];
env.trust(eur(100000), alice);
env(pay(gw, alice, eur(50000)));
env.trust(eur(100000), bob);
env(pay(gw, bob, eur(50000)));
env.close();
AMM amm(env, alice, usd(1), eur(2));
amm.deposit(alice, IOUAmount{1'076123487565916, -15});
amm.deposit(bob, IOUAmount{1'000});
amm.withdraw(alice, IOUAmount{1'076123487565916, -15});
amm.withdrawAll(bob);
auto [lpToken, lpTokenBalance] = getLPTokenBalances(env, amm, alice);
BEAST_EXPECT(lpToken == "1.414213562374011" && lpTokenBalance == "1.414213562374");
auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice);
BEAST_EXPECT(res && res.value());
if (features[fixAMMClawbackRounding])
{
env(amm::ammClawback(gw, alice, usd, eur, std::nullopt), Txflags(tfClawTwoAssets));
BEAST_EXPECT(!amm.ammExists());
}
else
{
env(amm::ammClawback(gw, alice, usd, eur, std::nullopt),
Txflags(tfClawTwoAssets),
Ter(tecINTERNAL));
BEAST_EXPECT(amm.ammExists());
}
}
// IOU/IOU pool, larger asset ratio
{
Env env(*this, features, std::make_unique<CaptureLogs>(&logs));
Account const gw{"gateway"}, alice{"alice"}, bob{"bob"};
auto const usd = setupAccounts(env, gw, alice, bob);
auto const eur = gw["EUR"];
env.trust(eur(1000000000), alice);
env(pay(gw, alice, eur(500000000)));
env.trust(eur(1000000000), bob);
env(pay(gw, bob, eur(500000000)));
env.close();
AMM amm(env, alice, usd(1), eur(2000000));
amm.deposit(alice, IOUAmount{1'076123487565916, -12});
amm.deposit(bob, IOUAmount{10000});
amm.withdraw(alice, IOUAmount{1'076123487565916, -12});
amm.withdrawAll(bob);
auto [lpToken, lpTokenBalance] = getLPTokenBalances(env, amm, alice);
BEAST_EXPECT(lpToken == "1414.213562373101" && lpTokenBalance == "1414.2135623731");
auto res = isOnlyLiquidityProvider(*env.current(), amm.lptIssue(), alice);
BEAST_EXPECT(res && res.value());
if (!features[fixAMMClawbackRounding] && !features[fixAMMv1_3])
{
env(amm::ammClawback(gw, alice, usd, eur, usd(1)));
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(4), -15),
STAmount(eur, UINT64_C(8), -9),
IOUAmount{6, -12}));
}
else if (!features[fixAMMClawbackRounding])
{
// sqrt(amount * amount2) >= LPTokens and exceeds the allowed
// tolerance
env(amm::ammClawback(gw, alice, usd, eur, usd(1)), Ter(tecINVARIANT_FAILED));
BEAST_EXPECT(amm.ammExists());
}
else if (features[fixAMMv1_3] && features[fixAMMClawbackRounding])
{
env(amm::ammClawback(gw, alice, usd, eur, usd(1)), Txflags(tfClawTwoAssets));
auto const lpBalance = IOUAmount{5, -12};
BEAST_EXPECT(amm.expectBalances(
STAmount(usd, UINT64_C(4), -15), STAmount(eur, UINT64_C(8), -9), lpBalance));
BEAST_EXPECT(amm.expectLPTokens(alice, lpBalance));
}
}
}
void
run() override
{
// For now, just disable SAV entirely, which locks in the small Number
// mantissas
FeatureBitset const all =
jtx::testableAmendments() - featureSingleAssetVault - featureLendingProtocol;
testInvalidRequest(all);
testInvalidRequest(all - featureMPTokensV2);
testFeatureDisabled(all - featureAMMClawback);
for (auto const& features :
{all - fixAMMv1_3 - fixAMMClawbackRounding - featureMPTokensV2,
all - fixAMMClawbackRounding - featureMPTokensV2,
all - featureMPTokensV2,
all})
{
testAMMClawbackSpecificAmount(features);
testAMMClawbackExceedBalance(features);
testAMMClawbackAll(features);
testAMMClawbackSameIssuerAssets(features);
testAMMClawbackSameCurrency(features);
testAMMClawbackIssuesEachOther(features);
testNotHoldingLptoken(features);
testAssetFrozen(features);
testSingleDepositAndClawback(features);
testLastHolderLPTokenBalance(features);
}
}
};
BEAST_DEFINE_TESTSUITE(AMMClawback, app, xrpl);
} // namespace xrpl::test