20#include <xrpld/app/main/Application.h>
21#include <xrpld/app/misc/AmendmentTable.h>
22#include <xrpld/app/rdb/Wallet.h>
23#include <xrpld/core/ConfigSections.h>
24#include <xrpl/protocol/Feature.h>
25#include <xrpl/protocol/STValidation.h>
26#include <xrpl/protocol/TxFlags.h>
27#include <xrpl/protocol/jss.h>
28#include <boost/format.hpp>
29#include <boost/regex.hpp>
38 static boost::regex
const re1(
41 "([abcdefABCDEF0-9]{64})"
45 boost::regex_constants::optimize);
49 for (
auto const& line : section.
lines())
53 if (!boost::regex_match(line,
match, re1))
54 Throw<std::runtime_error>(
55 "Invalid entry '" + line +
"' in [" + section.
name() +
"]");
59 if (!
id.parseHex(
match[1]))
60 Throw<std::runtime_error>(
61 "Invalid amendment ID '" +
match[1] +
"' in [" +
62 section.
name() +
"]");
118 newRecordedVotes.reserve(allTrusted.
size());
123 for (
auto& trusted : allTrusted)
134 newRecordedVotes[trusted];
163 using namespace std::chrono_literals;
168 for (
auto const& val : valSet)
171 if (
auto const iter =
recordedVotes_.find(val->getSignerPublic());
174 iter->second.timeout = closeTime + expiresAfter;
175 if (val->isFieldPresent(sfAmendments))
177 auto const& choices = val->getFieldV256(sfAmendments);
178 iter->second.upVotes.assign(choices.begin(), choices.end());
183 iter->second.upVotes.clear();
193 if (closeTime > votes.second.timeout)
195 votes.second.timeout = maxTimeout;
196 votes.second.upVotes.clear();
208 for (
auto& validatorVotes : recordedVotes_)
210 for (
uint256 const& amendment : validatorVotes.second.upVotes)
215 return {recordedVotes_.
size(), ret};
233 bool enabled =
false;
236 bool supported =
false;
252 int trustedValidations_ = 0;
259 threshold_ = !rules_.
enabled(fixAmendmentMajorityCalc)
263 (trustedValidations_ *
269 (trustedValidations_ *
282 auto [trustedCount, newVotes] = trustedVotes.
getVotes(rules, lock);
284 trustedValidations_ = trustedCount;
285 votes_.
swap(newVotes);
287 computeThreshold(trustedValidations_, rules);
293 auto const& it = votes_.
find(amendment);
295 if (it == votes_.
end())
303 if (!rules_.
enabled(fixAmendmentMajorityCalc) ||
304 trustedValidations_ == 1)
305 return it->second >= threshold_;
307 return it->second > threshold_;
313 auto const& it = votes_.
find(amendment);
315 if (it == votes_.
end())
324 return trustedValidations_;
413 veto(
uint256 const& amendment)
override;
415 unVeto(
uint256 const& amendment)
override;
418 enable(
uint256 const& amendment)
override;
421 isEnabled(
uint256 const& amendment)
const override;
423 isSupported(
uint256 const& amendment)
const override;
426 hasUnsupportedEnabled()
const override;
429 firstUnsupportedExpected()
const override;
432 getJson(
bool isAdmin)
const override;
437 needValidatedLedger(
LedgerIndex seq)
const override;
452 getDesired()
const override;
465AmendmentTableImpl::AmendmentTableImpl(
473 , majorityTime_(majorityTime)
474 , unsupportedEnabled_(false)
476 , db_(app.getWalletDB())
481 bool const featureVotesExist = [
this]() {
487 for (
auto const& [name, amendment, votebehavior] : supported)
493 switch (votebehavior)
508 JLOG(
j_.
debug()) <<
"Amendment " << amendment <<
" (" << s.
name
509 <<
") is supported and will be "
511 <<
" voted by default if not enabled on the ledger.";
518 if (featureVotesExist)
520 JLOG(
j_.
warn()) <<
"[amendments] section in config file ignored"
521 " in favor of data in db/wallet.db.";
526 detect_conflict.
insert(a.first);
534 if (featureVotesExist)
537 <<
"[veto_amendments] section in config file ignored"
538 " in favor of data in db/wallet.db.";
543 if (detect_conflict.
count(a.first) == 0)
550 <<
"[veto_amendments] section in config has amendment "
551 <<
'(' << a.first <<
", " << a.second
552 <<
") both [veto_amendments] and [amendments].";
561 [&](boost::optional<std::string> amendment_hash,
562 boost::optional<std::string> amendment_name,
563 boost::optional<AmendmentVote> vote) {
565 if (!amendment_hash || !amendment_name || !vote)
568 Throw<std::runtime_error>(
569 "Invalid FeatureVotes row in wallet.db");
571 if (!amend_hash.
parseHex(*amendment_hash))
573 Throw<std::runtime_error>(
574 "Invalid amendment ID '" + *amendment_hash +
580 if (
auto s =
get(amend_hash, lock))
582 JLOG(
j_.
info()) <<
"Amendment {" << *amendment_name <<
", "
583 << amend_hash <<
"} is downvoted.";
584 if (!amendment_name->empty())
585 s->name = *amendment_name;
595 JLOG(
j_.
debug()) <<
"Amendment {" << *amendment_name <<
", "
596 << amend_hash <<
"} is upvoted.";
597 if (!amendment_name->empty())
598 s.
name = *amendment_name;
646 if (name == e.second.name)
661 "ripple::AmendmentTableImpl::persistVote : valid vote input");
705 JLOG(
j_.
error()) <<
"Unsupported amendment " << amendment
756 (enabled.
count(e.first) == 0))
758 amendments.push_back(e.first);
759 JLOG(
j_.
info()) <<
"Voting for amendment " << e.second.name;
764 if (!amendments.empty())
765 std::sort(amendments.begin(), amendments.end());
786 <<
": " << enabledAmendments.
size() <<
", "
787 << majorityAmendments.
size() <<
", " << valSet.size();
797 JLOG(
j_.
debug()) <<
"Received " << vote->trustedValidations()
798 <<
" trusted validations, threshold is: "
799 << vote->threshold();
810 bool const hasValMajority = vote->passes(entry.first);
813 auto const it = majorityAmendments.
find(entry.first);
814 if (it != majorityAmendments.
end())
815 majorityTime = it->second;
818 if (enabledAmendments.
count(entry.first) != 0)
820 JLOG(
j_.
debug()) << entry.first <<
": amendment already enabled";
827 JLOG(
j_.
debug()) << entry.first <<
": amendment got majority";
833 JLOG(
j_.
debug()) << entry.first <<
": amendment lost majority";
842 JLOG(
j_.
debug()) << entry.first <<
": amendment majority held";
843 actions[entry.first] = 0;
869 for (
auto& e : enabled)
881 for (
auto const& [hash, time] : majority)
890 JLOG(
j_.
info()) <<
"Unsupported amendment " << hash
891 <<
" reached majority at " <<
to_string(time);
916 v[jss::name] = fs.
name;
922 v[jss::vetoed] =
"Obsolete";
930 auto const votesTotal =
lastVote_->trustedValidations();
931 auto const votesNeeded =
lastVote_->threshold();
932 auto const votesFor =
lastVote_->votes(
id);
934 v[jss::count] = votesFor;
935 v[jss::validations] = votesTotal;
938 v[jss::threshold] = votesNeeded;
989 return std::make_unique<AmendmentTableImpl>(
990 app, majorityTime, supported, enabled, vetoed, journal);
A generic endpoint for log messages.
Stream trace() const
Severity stream access functions.
The status of all amendments requested in a given window.
int votes(uint256 const &amendment) const
int trustedValidations() const
void computeThreshold(int trustedValidations, Rules const &rules)
bool passes(uint256 const &amendment) const
hash_map< uint256, int > votes_
AmendmentSet(Rules const &rules, TrustedVotes const &trustedVotes, std::lock_guard< std::mutex > const &lock)
Track the list of "amendments".
uint256 find(std::string const &name) const override
bool unVeto(uint256 const &amendment) override
bool enable(uint256 const &amendment) override
bool needValidatedLedger(LedgerIndex seq) const override
Called to determine whether the amendment logic needs to process a new validated ledger.
std::optional< NetClock::time_point > firstUnsupportedExpected_
std::vector< uint256 > getDesired() const override
bool veto(uint256 const &amendment) override
std::unique_ptr< AmendmentSet > lastVote_
std::chrono::seconds const majorityTime_
void doValidatedLedger(LedgerIndex seq, std::set< uint256 > const &enabled, majorityAmendments_t const &majority) override
bool isEnabled(uint256 const &amendment) const override
AmendmentState & add(uint256 const &amendment, std::lock_guard< std::mutex > const &lock)
TrustedVotes previousTrustedVotes_
hash_map< uint256, AmendmentState > amendmentMap_
void injectJson(Json::Value &v, uint256 const &amendment, AmendmentState const &state, bool isAdmin, std::lock_guard< std::mutex > const &lock) const
Json::Value getJson(bool isAdmin) const override
void trustChanged(hash_set< PublicKey > const &allTrusted) override
std::vector< uint256 > doValidation(std::set< uint256 > const &enabledAmendments) const override
AmendmentState * get(uint256 const &amendment, std::lock_guard< std::mutex > const &lock)
void persistVote(uint256 const &amendment, std::string const &name, AmendmentVote vote) const
bool hasUnsupportedEnabled() const override
returns true if one or more amendments on the network have been enabled that this server does not sup...
std::map< uint256, std::uint32_t > doVoting(Rules const &rules, NetClock::time_point closeTime, std::set< uint256 > const &enabledAmendments, majorityAmendments_t const &majorityAmendments, std::vector< std::shared_ptr< STValidation > > const &validations) override
bool isSupported(uint256 const &amendment) const override
std::optional< NetClock::time_point > firstUnsupportedExpected() const override
std::uint32_t lastUpdateSeq_
The amendment table stores the list of enabled and potential amendments.
LockedSociSession checkoutDb()
Rules controlling protocol behavior.
bool enabled(uint256 const &feature) const
Returns true if a feature is enabled.
Holds a collection of configuration values.
std::string const & name() const
Returns the name of this section.
std::vector< std::string > const & lines() const
Returns all the lines in the section.
TrustedVotes records the most recent votes from trusted validators.
void recordVotes(Rules const &rules, std::vector< std::shared_ptr< STValidation > > const &valSet, NetClock::time_point const closeTime, std::lock_guard< std::mutex > const &lock)
std::pair< int, hash_map< uint256, int > > getVotes(Rules const &rules, std::lock_guard< std::mutex > const &lock) const
hash_map< PublicKey, UpvotesAndTimeout > recordedVotes_
TrustedVotes & operator=(TrustedVotes const &rhs)=delete
static constexpr NetClock::time_point maxTimeout
void trustChanged(hash_set< PublicKey > const &allTrusted, std::lock_guard< std::mutex > const &lock)
TrustedVotes(TrustedVotes const &rhs)=delete
constexpr bool parseHex(std::string_view sv)
Parse a hex string into a base_uint.
@ objectValue
object value (collection of name/value pairs).
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
static std::vector< std::pair< uint256, std::string > > parseSection(Section const §ion)
constexpr std::uint32_t tfGotMajority
bool isAdmin(Port const &port, Json::Value const ¶ms, beast::IP::Address const &remoteIp)
bool createFeatureVotes(soci::session &session)
createFeatureVotes Creates the FeatureVote table if it does not exist.
void readAmendments(soci::session &session, std::function< void(boost::optional< std::string > amendment_hash, boost::optional< std::string > amendment_name, boost::optional< AmendmentVote > vote)> const &callback)
readAmendments Reads all amendments from the FeatureVotes table.
constexpr std::ratio< 80, 100 > postFixAmendmentMajorityCalcThreshold
constexpr std::ratio< 204, 256 > preFixAmendmentMajorityCalcThreshold
The minimum amount of support an amendment should have.
std::string to_string(base_uint< Bits, Tag > const &a)
T get(Section const §ion, std::string const &name, T const &defaultValue=T{})
Retrieve a key/value pair from a section.
Json::Value getJson(LedgerFill const &fill)
Return a new Json::Value representing the ledger with given options.
std::unique_ptr< AmendmentTable > make_AmendmentTable(Application &app, std::chrono::seconds majorityTime, std::vector< AmendmentTable::FeatureInfo > const &supported, Section const &enabled, Section const &vetoed, beast::Journal journal)
constexpr std::uint32_t tfLostMajority
void voteAmendment(soci::session &session, uint256 const &amendment, std::string const &name, AmendmentVote vote)
voteAmendment Set the veto value for a particular amendment.
Current state of an amendment.
bool supported
Indicates an amendment that this server has code support for.
bool enabled
Indicates that the amendment has been enabled.
std::string name
The name of this amendment, possibly empty.
AmendmentVote vote
If an amendment is down-voted, a server will not vote to enable it.
std::vector< uint256 > upVotes
NetClock::time_point timeout
T time_since_epoch(T... args)