Files
xahaud/src/test/app/SetTrust_test.cpp
RichardAH 5f12c22fbe featureDisallowIncoming: Opt-out of incoming Checks, PayChans, NFTokenOffers and Trustlines (#4336)
featureDisallowIncoming is a new amendment that would allow users to opt-out of incoming Checks, Payment Channels, NFTokenOffers, and trust lines. This commit includes tests.

Adds four new AccountSet Flags:
1. asfDisallowIncomingNFTOffer
2. asfDisallowIncomingCheck
3. asfDisallowIncomingPayChan
4. asfDisallowIncomingTrustline
2023-01-23 22:03:58 -05:00

378 lines
12 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012-2016 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#include <ripple/protocol/TxFlags.h>
#include <ripple/protocol/jss.h>
#include <test/jtx.h>
namespace ripple {
namespace test {
class SetTrust_test : public beast::unit_test::suite
{
FeatureBitset const disallowIncoming{featureDisallowIncoming};
public:
void
testFreeTrustlines(
FeatureBitset features,
bool thirdLineCreatesLE,
bool createOnHighAcct)
{
if (thirdLineCreatesLE)
testcase("Allow two free trustlines");
else
testcase("Dynamic reserve for trustline");
using namespace jtx;
Env env(*this, features);
auto const gwA = Account{"gwA"};
auto const gwB = Account{"gwB"};
auto const acctC = Account{"acctC"};
auto const acctD = Account{"acctD"};
auto const& creator = createOnHighAcct ? acctD : acctC;
auto const& assistor = createOnHighAcct ? acctC : acctD;
auto const txFee = env.current()->fees().base;
auto const baseReserve = env.current()->fees().accountReserve(0);
auto const threelineReserve = env.current()->fees().accountReserve(3);
env.fund(XRP(10000), gwA, gwB, assistor);
// Fund creator with ...
env.fund(
baseReserve /* enough to hold an account */
+ drops(3 * txFee) /* and to pay for 3 transactions */,
creator);
env(trust(creator, gwA["USD"](100)), require(lines(creator, 1)));
env(trust(creator, gwB["USD"](100)), require(lines(creator, 2)));
if (thirdLineCreatesLE)
{
// creator does not have enough for the third trust line
env(trust(creator, assistor["USD"](100)),
ter(tecNO_LINE_INSUF_RESERVE),
require(lines(creator, 2)));
}
else
{
// First establish opposite trust direction from assistor
env(trust(assistor, creator["USD"](100)),
require(lines(creator, 3)));
// creator does not have enough to create the other direction on
// the existing trust line ledger entry
env(trust(creator, assistor["USD"](100)),
ter(tecINSUF_RESERVE_LINE));
}
// Fund creator additional amount to cover
env(pay(env.master, creator, STAmount{threelineReserve - baseReserve}));
if (thirdLineCreatesLE)
{
env(trust(creator, assistor["USD"](100)),
require(lines(creator, 3)));
}
else
{
env(trust(creator, assistor["USD"](100)),
require(lines(creator, 3)));
Json::Value jv;
jv["account"] = creator.human();
auto const lines = env.rpc("json", "account_lines", to_string(jv));
// Verify that all lines have 100 limit from creator
BEAST_EXPECT(lines[jss::result][jss::lines].isArray());
BEAST_EXPECT(lines[jss::result][jss::lines].size() == 3);
for (auto const& line : lines[jss::result][jss::lines])
{
BEAST_EXPECT(line[jss::limit] == "100");
}
}
}
void
testTicketSetTrust(FeatureBitset features)
{
testcase("SetTrust using a ticket");
using namespace jtx;
// Verify that TrustSet transactions can use tickets.
Env env{*this, features};
auto const gw = Account{"gateway"};
auto const alice = Account{"alice"};
auto const USD = gw["USD"];
env.fund(XRP(10000), gw, alice);
env.close();
// Cannot pay alice without a trustline.
env(pay(gw, alice, USD(200)), ter(tecPATH_DRY));
env.close();
// Create a ticket.
std::uint32_t const ticketSeq{env.seq(alice) + 1};
env(ticket::create(alice, 1));
env.close();
// Use that ticket to create a trust line.
env(trust(alice, USD(1000)), ticket::use(ticketSeq));
env.close();
// Now the payment succeeds.
env(pay(gw, alice, USD(200)));
env.close();
}
Json::Value
trust_explicit_amt(jtx::Account const& a, STAmount const& amt)
{
Json::Value jv;
jv[jss::Account] = a.human();
jv[jss::LimitAmount] = amt.getJson(JsonOptions::none);
jv[jss::TransactionType] = jss::TrustSet;
jv[jss::Flags] = 0;
return jv;
}
void
testMalformedTransaction(FeatureBitset features)
{
testcase("SetTrust checks for malformed transactions");
using namespace jtx;
Env env{*this, features};
auto const gw = Account{"gateway"};
auto const alice = Account{"alice"};
env.fund(XRP(10000), gw, alice);
// Require valid tf flags
for (std::uint64_t badFlag = 1u;
badFlag <= std::numeric_limits<std::uint32_t>::max();
badFlag *= 2)
{
if (badFlag & tfTrustSetMask)
env(trust(
alice,
gw["USD"](100),
static_cast<std::uint32_t>(badFlag)),
ter(temINVALID_FLAG));
}
// trust amount can't be XRP
env(trust_explicit_amt(alice, drops(10000)), ter(temBAD_LIMIT));
// trust amount can't be badCurrency IOU
env(trust_explicit_amt(alice, gw[to_string(badCurrency())](100)),
ter(temBAD_CURRENCY));
// trust amount can't be negative
env(trust(alice, gw["USD"](-1000)), ter(temBAD_LIMIT));
// trust amount can't be from invalid issuer
env(trust_explicit_amt(
alice, STAmount{Issue{to_currency("USD"), noAccount()}, 100}),
ter(temDST_NEEDED));
// trust cannot be to self
env(trust(alice, alice["USD"](100)), ter(temDST_IS_SRC));
// tfSetAuth flag should not be set if not required by lsfRequireAuth
env(trust(alice, gw["USD"](100), tfSetfAuth), ter(tefNO_AUTH_REQUIRED));
}
void
testModifyQualityOfTrustline(
FeatureBitset features,
bool createQuality,
bool createOnHighAcct)
{
testcase << "SetTrust " << (createQuality ? "creates" : "removes")
<< " quality of trustline for "
<< (createOnHighAcct ? "high" : "low") << " account";
using namespace jtx;
Env env{*this, features};
auto const alice = Account{"alice"};
auto const bob = Account{"bob"};
auto const& fromAcct = createOnHighAcct ? alice : bob;
auto const& toAcct = createOnHighAcct ? bob : alice;
env.fund(XRP(10000), fromAcct, toAcct);
auto txWithoutQuality = trust(toAcct, fromAcct["USD"](100));
txWithoutQuality["QualityIn"] = "0";
txWithoutQuality["QualityOut"] = "0";
auto txWithQuality = txWithoutQuality;
txWithQuality["QualityIn"] = "1000";
txWithQuality["QualityOut"] = "1000";
auto& tx1 = createQuality ? txWithQuality : txWithoutQuality;
auto& tx2 = createQuality ? txWithoutQuality : txWithQuality;
auto check_quality = [&](const bool exists) {
Json::Value jv;
jv["account"] = toAcct.human();
auto const lines = env.rpc("json", "account_lines", to_string(jv));
auto quality = exists ? 1000 : 0;
BEAST_EXPECT(lines[jss::result][jss::lines].isArray());
BEAST_EXPECT(lines[jss::result][jss::lines].size() == 1);
BEAST_EXPECT(
lines[jss::result][jss::lines][0u][jss::quality_in] == quality);
BEAST_EXPECT(
lines[jss::result][jss::lines][0u][jss::quality_out] ==
quality);
};
env(tx1, require(lines(toAcct, 1)), require(lines(fromAcct, 1)));
check_quality(createQuality);
env(tx2, require(lines(toAcct, 1)), require(lines(fromAcct, 1)));
check_quality(!createQuality);
}
void
testDisallowIncoming(FeatureBitset features)
{
testcase("Create trustline with disallow incoming");
using namespace test::jtx;
// test flag doesn't set unless amendment enabled
{
Env env{*this, features - disallowIncoming};
Account const alice{"alice"};
env.fund(XRP(10000), alice);
env(fset(alice, asfDisallowIncomingTrustline));
env.close();
auto const sle = env.le(alice);
uint32_t flags = sle->getFlags();
BEAST_EXPECT(!(flags & lsfDisallowIncomingTrustline));
}
Env env{*this, features | disallowIncoming};
auto const gw = Account{"gateway"};
auto const alice = Account{"alice"};
auto const bob = Account{"bob"};
auto const USD = gw["USD"];
env.fund(XRP(10000), gw, alice, bob);
env.close();
// Set flag on gateway
env(fset(gw, asfDisallowIncomingTrustline));
env.close();
// Create a trustline which will fail
env(trust(alice, USD(1000)), ter(tecNO_PERMISSION));
env.close();
// Unset the flag
env(fclear(gw, asfDisallowIncomingTrustline));
env.close();
// Create a trustline which will now succeed
env(trust(alice, USD(1000)));
env.close();
// Now the payment succeeds.
env(pay(gw, alice, USD(200)));
env.close();
// Set flag on gateway again
env(fset(gw, asfDisallowIncomingTrustline));
env.close();
// Destroy the balance by sending it back
env(pay(gw, alice, USD(200)));
env.close();
// The trustline still exists in default state
// So a further payment should work
env(pay(gw, alice, USD(200)));
env.close();
// Also set the flag on bob
env(fset(bob, asfDisallowIncomingTrustline));
env.close();
// But now bob can't open a trustline because he didn't already have one
env(trust(bob, USD(1000)), ter(tecNO_PERMISSION));
env.close();
// The gateway also can't open this trustline because bob has the flag
// set
env(trust(gw, bob["USD"](1000)), ter(tecNO_PERMISSION));
env.close();
// Unset the flag only on the gateway
env(fclear(gw, asfDisallowIncomingTrustline));
env.close();
// Now bob can open a trustline
env(trust(bob, USD(1000)));
env.close();
// And the gateway can send bob a balance
env(pay(gw, bob, USD(200)));
env.close();
}
void
testWithFeats(FeatureBitset features)
{
testFreeTrustlines(features, true, false);
testFreeTrustlines(features, false, true);
testFreeTrustlines(features, false, true);
// true, true case doesn't matter since creating a trustline ledger
// entry requires reserve from the creator
// independent of hi/low account ids for endpoints
testTicketSetTrust(features);
testMalformedTransaction(features);
testModifyQualityOfTrustline(features, false, false);
testModifyQualityOfTrustline(features, false, true);
testModifyQualityOfTrustline(features, true, false);
testModifyQualityOfTrustline(features, true, true);
testDisallowIncoming(features);
}
public:
void
run() override
{
using namespace test::jtx;
auto const sa = supported_amendments();
testWithFeats(sa - disallowIncoming);
testWithFeats(sa);
}
};
BEAST_DEFINE_TESTSUITE(SetTrust, app, ripple);
} // namespace test
} // namespace ripple