mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
7aad6e5127
Add the ability to mark amendments as obsolete. There are some known amendments that should not be voted for because they are broken (or similar reasons). This commit marks four amendments as obsolete: 1. `CryptoConditionsSuite` 2. `NonFungibleTokensV1` 3. `fixNFTokenDirV1` 4. `fixNFTokenNegOffer` When an amendment is `Obsolete`, voting for the amendment is prevented. A determined operator can still vote for the amendment by changing the source, and doing so does not break any protocol rules. The "feature" command now does not modify the vote for obsolete amendments. Before this change, there were two options for an amendment's `DefaultVote` behavior: yes and no. After this change, there are three options for an amendment's `VoteBehavior`: DefaultYes, DefaultNo, and Obsolete. To be clear, if an obsolete amendment were to (somehow) be activated by consensus, the server still has the code to process transactions according to that amendment, and would not be amendment blocked. It would function the same as if it had been voting "no" on the amendment. Resolves #4014. Incorporates review feedback from @scottschurr.
495 lines
18 KiB
C++
495 lines
18 KiB
C++
//------------------------------------------------------------------------------
|
|
/*
|
|
This file is part of rippled: https://github.com/ripple/rippled
|
|
Copyright (c) 2012-2017 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/app/misc/AmendmentTable.h>
|
|
#include <ripple/protocol/Feature.h>
|
|
#include <ripple/protocol/jss.h>
|
|
#include <test/jtx.h>
|
|
|
|
namespace ripple {
|
|
|
|
class Feature_test : public beast::unit_test::suite
|
|
{
|
|
void
|
|
testInternals()
|
|
{
|
|
testcase("internals");
|
|
|
|
std::map<std::string, VoteBehavior> const& supported =
|
|
ripple::detail::supportedAmendments();
|
|
BEAST_EXPECT(
|
|
supported.size() ==
|
|
ripple::detail::numDownVotedAmendments() +
|
|
ripple::detail::numUpVotedAmendments());
|
|
std::size_t up = 0, down = 0, obsolete = 0;
|
|
for (std::pair<std::string const, VoteBehavior> const& amendment :
|
|
supported)
|
|
{
|
|
switch (amendment.second)
|
|
{
|
|
case VoteBehavior::DefaultYes:
|
|
++up;
|
|
break;
|
|
case VoteBehavior::DefaultNo:
|
|
++down;
|
|
break;
|
|
case VoteBehavior::Obsolete:
|
|
++obsolete;
|
|
break;
|
|
default:
|
|
fail("Unknown VoteBehavior", __FILE__, __LINE__);
|
|
}
|
|
}
|
|
BEAST_EXPECT(
|
|
down + obsolete == ripple::detail::numDownVotedAmendments());
|
|
BEAST_EXPECT(up == ripple::detail::numUpVotedAmendments());
|
|
}
|
|
|
|
void
|
|
testFeatureLookups()
|
|
{
|
|
testcase("featureToName");
|
|
|
|
// Test all the supported features. In a perfect world, this would test
|
|
// FeatureCollections::featureNames, but that's private. Leave it that
|
|
// way.
|
|
auto const supported = ripple::detail::supportedAmendments();
|
|
|
|
for (auto const& [feature, vote] : supported)
|
|
{
|
|
(void)vote;
|
|
auto const registered = getRegisteredFeature(feature);
|
|
if (BEAST_EXPECT(registered))
|
|
{
|
|
BEAST_EXPECT(featureToName(*registered) == feature);
|
|
BEAST_EXPECT(
|
|
bitsetIndexToFeature(featureToBitsetIndex(*registered)) ==
|
|
*registered);
|
|
}
|
|
}
|
|
|
|
// Test an arbitrary unknown feature
|
|
uint256 zero{0};
|
|
BEAST_EXPECT(featureToName(zero) == to_string(zero));
|
|
BEAST_EXPECT(
|
|
featureToName(zero) ==
|
|
"0000000000000000000000000000000000000000000000000000000000000000");
|
|
|
|
// Test looking up an unknown feature
|
|
BEAST_EXPECT(!getRegisteredFeature("unknown"));
|
|
|
|
// Test a random sampling of the variables. If any of these get retired
|
|
// or removed, swap out for any other feature.
|
|
BEAST_EXPECT(featureToName(featureOwnerPaysFee) == "OwnerPaysFee");
|
|
BEAST_EXPECT(featureToName(featureFlow) == "Flow");
|
|
BEAST_EXPECT(featureToName(featureNegativeUNL) == "NegativeUNL");
|
|
BEAST_EXPECT(featureToName(fix1578) == "fix1578");
|
|
BEAST_EXPECT(
|
|
featureToName(fixTakerDryOfferRemoval) ==
|
|
"fixTakerDryOfferRemoval");
|
|
}
|
|
|
|
void
|
|
testNoParams()
|
|
{
|
|
testcase("No Params, None Enabled");
|
|
|
|
using namespace test::jtx;
|
|
Env env{*this};
|
|
|
|
std::map<std::string, VoteBehavior> const& votes =
|
|
ripple::detail::supportedAmendments();
|
|
|
|
auto jrr = env.rpc("feature")[jss::result];
|
|
if (!BEAST_EXPECT(jrr.isMember(jss::features)))
|
|
return;
|
|
for (auto const& feature : jrr[jss::features])
|
|
{
|
|
if (!BEAST_EXPECT(feature.isMember(jss::name)))
|
|
return;
|
|
// default config - so all should be disabled, and
|
|
// supported. Some may be vetoed.
|
|
bool expectVeto =
|
|
(votes.at(feature[jss::name].asString()) ==
|
|
VoteBehavior::DefaultNo);
|
|
bool expectObsolete =
|
|
(votes.at(feature[jss::name].asString()) ==
|
|
VoteBehavior::Obsolete);
|
|
BEAST_EXPECTS(
|
|
feature.isMember(jss::enabled) &&
|
|
!feature[jss::enabled].asBool(),
|
|
feature[jss::name].asString() + " enabled");
|
|
BEAST_EXPECTS(
|
|
feature.isMember(jss::vetoed) &&
|
|
feature[jss::vetoed].isBool() == !expectObsolete &&
|
|
(!feature[jss::vetoed].isBool() ||
|
|
feature[jss::vetoed].asBool() == expectVeto) &&
|
|
(feature[jss::vetoed].isBool() ||
|
|
feature[jss::vetoed].asString() == "Obsolete"),
|
|
feature[jss::name].asString() + " vetoed");
|
|
BEAST_EXPECTS(
|
|
feature.isMember(jss::supported) &&
|
|
feature[jss::supported].asBool(),
|
|
feature[jss::name].asString() + " supported");
|
|
}
|
|
}
|
|
|
|
void
|
|
testSingleFeature()
|
|
{
|
|
testcase("Feature Param");
|
|
|
|
using namespace test::jtx;
|
|
Env env{*this};
|
|
|
|
auto jrr = env.rpc("feature", "MultiSignReserve")[jss::result];
|
|
BEAST_EXPECTS(jrr[jss::status] == jss::success, "status");
|
|
jrr.removeMember(jss::status);
|
|
BEAST_EXPECT(jrr.size() == 1);
|
|
BEAST_EXPECT(
|
|
jrr.isMember("586480873651E106F1D6339B0C4A8945BA705A777F3F4524626FF"
|
|
"1FC07EFE41D"));
|
|
auto feature = *(jrr.begin());
|
|
|
|
BEAST_EXPECTS(feature[jss::name] == "MultiSignReserve", "name");
|
|
BEAST_EXPECTS(!feature[jss::enabled].asBool(), "enabled");
|
|
BEAST_EXPECTS(
|
|
feature[jss::vetoed].isBool() && !feature[jss::vetoed].asBool(),
|
|
"vetoed");
|
|
BEAST_EXPECTS(feature[jss::supported].asBool(), "supported");
|
|
|
|
// feature names are case-sensitive - expect error here
|
|
jrr = env.rpc("feature", "multiSignReserve")[jss::result];
|
|
BEAST_EXPECT(jrr[jss::error] == "badFeature");
|
|
BEAST_EXPECT(jrr[jss::error_message] == "Feature unknown or invalid.");
|
|
}
|
|
|
|
void
|
|
testInvalidFeature()
|
|
{
|
|
testcase("Invalid Feature");
|
|
|
|
using namespace test::jtx;
|
|
Env env{*this};
|
|
|
|
auto jrr = env.rpc("feature", "AllTheThings")[jss::result];
|
|
BEAST_EXPECT(jrr[jss::error] == "badFeature");
|
|
BEAST_EXPECT(jrr[jss::error_message] == "Feature unknown or invalid.");
|
|
}
|
|
|
|
void
|
|
testNonAdmin()
|
|
{
|
|
testcase("Feature Without Admin");
|
|
|
|
using namespace test::jtx;
|
|
Env env{*this, envconfig([](std::unique_ptr<Config> cfg) {
|
|
(*cfg)["port_rpc"].set("admin", "");
|
|
(*cfg)["port_ws"].set("admin", "");
|
|
return cfg;
|
|
})};
|
|
|
|
auto jrr = env.rpc("feature")[jss::result];
|
|
// The current HTTP/S ServerHandler returns an HTTP 403 error code here
|
|
// rather than a noPermission JSON error. The JSONRPCClient just eats
|
|
// that error and returns an null result.
|
|
BEAST_EXPECT(jrr.isNull());
|
|
}
|
|
|
|
void
|
|
testSomeEnabled()
|
|
{
|
|
testcase("No Params, Some Enabled");
|
|
|
|
using namespace test::jtx;
|
|
Env env{
|
|
*this, FeatureBitset(featureDepositAuth, featureDepositPreauth)};
|
|
|
|
std::map<std::string, VoteBehavior> const& votes =
|
|
ripple::detail::supportedAmendments();
|
|
|
|
auto jrr = env.rpc("feature")[jss::result];
|
|
if (!BEAST_EXPECT(jrr.isMember(jss::features)))
|
|
return;
|
|
for (auto it = jrr[jss::features].begin();
|
|
it != jrr[jss::features].end();
|
|
++it)
|
|
{
|
|
uint256 id;
|
|
(void)id.parseHex(it.key().asString().c_str());
|
|
if (!BEAST_EXPECT((*it).isMember(jss::name)))
|
|
return;
|
|
bool expectEnabled = env.app().getAmendmentTable().isEnabled(id);
|
|
bool expectSupported =
|
|
env.app().getAmendmentTable().isSupported(id);
|
|
bool expectVeto =
|
|
(votes.at((*it)[jss::name].asString()) ==
|
|
VoteBehavior::DefaultNo);
|
|
bool expectObsolete =
|
|
(votes.at((*it)[jss::name].asString()) ==
|
|
VoteBehavior::Obsolete);
|
|
BEAST_EXPECTS(
|
|
(*it).isMember(jss::enabled) &&
|
|
(*it)[jss::enabled].asBool() == expectEnabled,
|
|
(*it)[jss::name].asString() + " enabled");
|
|
if (expectEnabled)
|
|
BEAST_EXPECTS(
|
|
!(*it).isMember(jss::vetoed),
|
|
(*it)[jss::name].asString() + " vetoed");
|
|
else
|
|
BEAST_EXPECTS(
|
|
(*it).isMember(jss::vetoed) &&
|
|
(*it)[jss::vetoed].isBool() == !expectObsolete &&
|
|
(!(*it)[jss::vetoed].isBool() ||
|
|
(*it)[jss::vetoed].asBool() == expectVeto) &&
|
|
((*it)[jss::vetoed].isBool() ||
|
|
(*it)[jss::vetoed].asString() == "Obsolete"),
|
|
(*it)[jss::name].asString() + " vetoed");
|
|
BEAST_EXPECTS(
|
|
(*it).isMember(jss::supported) &&
|
|
(*it)[jss::supported].asBool() == expectSupported,
|
|
(*it)[jss::name].asString() + " supported");
|
|
}
|
|
}
|
|
|
|
void
|
|
testWithMajorities()
|
|
{
|
|
testcase("With Majorities");
|
|
|
|
using namespace test::jtx;
|
|
Env env{*this, envconfig(validator, "")};
|
|
|
|
auto jrr = env.rpc("feature")[jss::result];
|
|
if (!BEAST_EXPECT(jrr.isMember(jss::features)))
|
|
return;
|
|
|
|
// at this point, there are no majorities so no fields related to
|
|
// amendment voting
|
|
for (auto const& feature : jrr[jss::features])
|
|
{
|
|
if (!BEAST_EXPECT(feature.isMember(jss::name)))
|
|
return;
|
|
BEAST_EXPECTS(
|
|
!feature.isMember(jss::majority),
|
|
feature[jss::name].asString() + " majority");
|
|
BEAST_EXPECTS(
|
|
!feature.isMember(jss::count),
|
|
feature[jss::name].asString() + " count");
|
|
BEAST_EXPECTS(
|
|
!feature.isMember(jss::threshold),
|
|
feature[jss::name].asString() + " threshold");
|
|
BEAST_EXPECTS(
|
|
!feature.isMember(jss::validations),
|
|
feature[jss::name].asString() + " validations");
|
|
BEAST_EXPECTS(
|
|
!feature.isMember(jss::vote),
|
|
feature[jss::name].asString() + " vote");
|
|
}
|
|
|
|
auto majorities = getMajorityAmendments(*env.closed());
|
|
if (!BEAST_EXPECT(majorities.empty()))
|
|
return;
|
|
|
|
// close ledgers until the amendments show up.
|
|
for (auto i = 0; i <= 256; ++i)
|
|
{
|
|
env.close();
|
|
majorities = getMajorityAmendments(*env.closed());
|
|
if (!majorities.empty())
|
|
break;
|
|
}
|
|
|
|
// There should be at least 5 amendments. Don't do exact comparison
|
|
// to avoid maintenance as more amendments are added in the future.
|
|
BEAST_EXPECT(majorities.size() >= 5);
|
|
std::map<std::string, VoteBehavior> const& votes =
|
|
ripple::detail::supportedAmendments();
|
|
|
|
jrr = env.rpc("feature")[jss::result];
|
|
if (!BEAST_EXPECT(jrr.isMember(jss::features)))
|
|
return;
|
|
for (auto const& feature : jrr[jss::features])
|
|
{
|
|
if (!BEAST_EXPECT(feature.isMember(jss::name)))
|
|
return;
|
|
bool expectVeto =
|
|
(votes.at(feature[jss::name].asString()) ==
|
|
VoteBehavior::DefaultNo);
|
|
bool expectObsolete =
|
|
(votes.at(feature[jss::name].asString()) ==
|
|
VoteBehavior::Obsolete);
|
|
BEAST_EXPECTS(
|
|
(expectVeto || expectObsolete) ^
|
|
feature.isMember(jss::majority),
|
|
feature[jss::name].asString() + " majority");
|
|
BEAST_EXPECTS(
|
|
feature.isMember(jss::vetoed) &&
|
|
feature[jss::vetoed].isBool() == !expectObsolete &&
|
|
(!feature[jss::vetoed].isBool() ||
|
|
feature[jss::vetoed].asBool() == expectVeto) &&
|
|
(feature[jss::vetoed].isBool() ||
|
|
feature[jss::vetoed].asString() == "Obsolete"),
|
|
feature[jss::name].asString() + " vetoed");
|
|
BEAST_EXPECTS(
|
|
feature.isMember(jss::count),
|
|
feature[jss::name].asString() + " count");
|
|
BEAST_EXPECTS(
|
|
feature.isMember(jss::threshold),
|
|
feature[jss::name].asString() + " threshold");
|
|
BEAST_EXPECTS(
|
|
feature.isMember(jss::validations),
|
|
feature[jss::name].asString() + " validations");
|
|
BEAST_EXPECT(
|
|
feature[jss::count] ==
|
|
((expectVeto || expectObsolete) ? 0 : 1));
|
|
BEAST_EXPECT(feature[jss::threshold] == 1);
|
|
BEAST_EXPECT(feature[jss::validations] == 1);
|
|
BEAST_EXPECTS(
|
|
expectVeto || expectObsolete || feature[jss::majority] == 2540,
|
|
"Majority: " + feature[jss::majority].asString());
|
|
}
|
|
}
|
|
|
|
void
|
|
testVeto()
|
|
{
|
|
testcase("Veto");
|
|
|
|
using namespace test::jtx;
|
|
Env env{*this, FeatureBitset(featureMultiSignReserve)};
|
|
constexpr const char* featureName = "MultiSignReserve";
|
|
|
|
auto jrr = env.rpc("feature", featureName)[jss::result];
|
|
if (!BEAST_EXPECTS(jrr[jss::status] == jss::success, "status"))
|
|
return;
|
|
jrr.removeMember(jss::status);
|
|
if (!BEAST_EXPECT(jrr.size() == 1))
|
|
return;
|
|
auto feature = *(jrr.begin());
|
|
BEAST_EXPECTS(feature[jss::name] == featureName, "name");
|
|
BEAST_EXPECTS(
|
|
feature[jss::vetoed].isBool() && !feature[jss::vetoed].asBool(),
|
|
"vetoed");
|
|
|
|
jrr = env.rpc("feature", featureName, "reject")[jss::result];
|
|
if (!BEAST_EXPECTS(jrr[jss::status] == jss::success, "status"))
|
|
return;
|
|
jrr.removeMember(jss::status);
|
|
if (!BEAST_EXPECT(jrr.size() == 1))
|
|
return;
|
|
feature = *(jrr.begin());
|
|
BEAST_EXPECTS(feature[jss::name] == featureName, "name");
|
|
BEAST_EXPECTS(
|
|
feature[jss::vetoed].isBool() && feature[jss::vetoed].asBool(),
|
|
"vetoed");
|
|
|
|
jrr = env.rpc("feature", featureName, "accept")[jss::result];
|
|
if (!BEAST_EXPECTS(jrr[jss::status] == jss::success, "status"))
|
|
return;
|
|
jrr.removeMember(jss::status);
|
|
if (!BEAST_EXPECT(jrr.size() == 1))
|
|
return;
|
|
feature = *(jrr.begin());
|
|
BEAST_EXPECTS(feature[jss::name] == featureName, "name");
|
|
BEAST_EXPECTS(
|
|
feature[jss::vetoed].isBool() && !feature[jss::vetoed].asBool(),
|
|
"vetoed");
|
|
|
|
// anything other than accept or reject is an error
|
|
jrr = env.rpc("feature", featureName, "maybe");
|
|
BEAST_EXPECT(jrr[jss::error] == "invalidParams");
|
|
BEAST_EXPECT(jrr[jss::error_message] == "Invalid parameters.");
|
|
}
|
|
|
|
void
|
|
testObsolete()
|
|
{
|
|
testcase("Obsolete");
|
|
|
|
using namespace test::jtx;
|
|
Env env{*this};
|
|
constexpr const char* featureName = "NonFungibleTokensV1";
|
|
|
|
auto jrr = env.rpc("feature", featureName)[jss::result];
|
|
if (!BEAST_EXPECTS(jrr[jss::status] == jss::success, "status"))
|
|
return;
|
|
jrr.removeMember(jss::status);
|
|
if (!BEAST_EXPECT(jrr.size() == 1))
|
|
return;
|
|
auto feature = *(jrr.begin());
|
|
BEAST_EXPECTS(feature[jss::name] == featureName, "name");
|
|
BEAST_EXPECTS(
|
|
feature[jss::vetoed].isString() &&
|
|
feature[jss::vetoed].asString() == "Obsolete",
|
|
"vetoed");
|
|
|
|
jrr = env.rpc("feature", featureName, "reject")[jss::result];
|
|
if (!BEAST_EXPECTS(jrr[jss::status] == jss::success, "status"))
|
|
return;
|
|
jrr.removeMember(jss::status);
|
|
if (!BEAST_EXPECT(jrr.size() == 1))
|
|
return;
|
|
feature = *(jrr.begin());
|
|
BEAST_EXPECTS(feature[jss::name] == featureName, "name");
|
|
BEAST_EXPECTS(
|
|
feature[jss::vetoed].isString() &&
|
|
feature[jss::vetoed].asString() == "Obsolete",
|
|
"vetoed");
|
|
|
|
jrr = env.rpc("feature", featureName, "accept")[jss::result];
|
|
if (!BEAST_EXPECTS(jrr[jss::status] == jss::success, "status"))
|
|
return;
|
|
jrr.removeMember(jss::status);
|
|
if (!BEAST_EXPECT(jrr.size() == 1))
|
|
return;
|
|
feature = *(jrr.begin());
|
|
BEAST_EXPECTS(feature[jss::name] == featureName, "name");
|
|
BEAST_EXPECTS(
|
|
feature[jss::vetoed].isString() &&
|
|
feature[jss::vetoed].asString() == "Obsolete",
|
|
"vetoed");
|
|
|
|
// anything other than accept or reject is an error
|
|
jrr = env.rpc("feature", featureName, "maybe");
|
|
BEAST_EXPECT(jrr[jss::error] == "invalidParams");
|
|
BEAST_EXPECT(jrr[jss::error_message] == "Invalid parameters.");
|
|
}
|
|
|
|
public:
|
|
void
|
|
run() override
|
|
{
|
|
testInternals();
|
|
testFeatureLookups();
|
|
testNoParams();
|
|
testSingleFeature();
|
|
testInvalidFeature();
|
|
testNonAdmin();
|
|
testSomeEnabled();
|
|
testWithMajorities();
|
|
testVeto();
|
|
testObsolete();
|
|
}
|
|
};
|
|
|
|
BEAST_DEFINE_TESTSUITE(Feature, rpc, ripple);
|
|
|
|
} // namespace ripple
|