Track the list of "amendments". More...

Inheritance diagram for xrpl::AmendmentTableImpl:

Collaboration diagram for xrpl::AmendmentTableImpl:

[legend]

Public Member Functions
	AmendmentTableImpl (ServiceRegistry &registry, std::chrono::seconds majorityTime, std::vector< FeatureInfo > const &supported, Section const &enabled, Section const &vetoed, beast::Journal journal)
UInt256	find (std::string const &name) const override
bool	veto (UInt256 const &amendment) override
bool	unVeto (UInt256 const &amendment) override
bool	enable (UInt256 const &amendment) override
bool	isEnabled (UInt256 const &amendment) const override
bool	isSupported (UInt256 const &amendment) const override
bool	hasUnsupportedEnabled () const override
	returns true if one or more amendments on the network have been enabled that this server does not support
std::optional< NetClock::time_point >	firstUnsupportedExpected () const override
json::Value	getJson (bool isAdmin) const override
json::Value	getJson (UInt256 const &, bool isAdmin) const override
	Returns a json::ValueType::Object.
bool	needValidatedLedger (LedgerIndex seq) const override
	Called to determine whether the amendment logic needs to process a new validated ledger.
void	doValidatedLedger (LedgerIndex seq, std::set< UInt256 > const &enabled, MajorityAmendmentsT const &majority) override
void	trustChanged (HashSet< PublicKey > const &allTrusted) override
std::vector< UInt256 >	doValidation (std::set< UInt256 > const &enabledAmendments) const override
std::vector< UInt256 >	getDesired () const override
std::map< UInt256, std::uint32_t >	doVoting (Rules const &rules, NetClock::time_point closeTime, std::set< UInt256 > const &enabledAmendments, MajorityAmendmentsT const &majorityAmendments, std::vector< std::shared_ptr< STValidation > > const &validations) override
void	doValidatedLedger (std::shared_ptr< ReadView const > const &lastValidatedLedger)
	Called when a new fully-validated ledger is accepted.
void	doVoting (std::shared_ptr< ReadView const > const &lastClosedLedger, std::vector< std::shared_ptr< STValidation > > const &parentValidations, std::shared_ptr< SHAMap > const &initialPosition, beast::Journal j)

Private Member Functions
AmendmentState &	add (UInt256 const &amendment, std::scoped_lock< std::mutex > const &lock)
AmendmentState *	get (UInt256 const &amendment, std::scoped_lock< std::mutex > const &lock)
AmendmentState const *	get (UInt256 const &amendment, std::scoped_lock< std::mutex > const &lock) const
void	injectJson (json::Value &v, UInt256 const &amendment, AmendmentState const &state, bool isAdmin, std::scoped_lock< std::mutex > const &lock) const
void	persistVote (UInt256 const &amendment, std::string const &name, AmendmentVote vote) const

Private Attributes
std::mutex	mutex_
HashMap< UInt256, AmendmentState >	amendmentMap_
std::uint32_t	lastUpdateSeq_ {0}
TrustedVotes	previousTrustedVotes_
std::chrono::seconds const	majorityTime_
std::unique_ptr< AmendmentSet >	lastVote_
bool	unsupportedEnabled_ {false}
std::optional< NetClock::time_point >	firstUnsupportedExpected_
beast::Journal const	j_
DatabaseCon &	db_

Detailed Description

Track the list of "amendments".

An "amendment" is an option that can affect transaction processing rules. Amendments are proposed and then adopted or rejected by the network. An Amendment is uniquely identified by its AmendmentID, a 256-bit key.

Definition at line 402 of file AmendmentTable.cpp.

Constructor & Destructor Documentation

◆ AmendmentTableImpl()

xrpl::AmendmentTableImpl::AmendmentTableImpl	(	ServiceRegistry &	registry,
		std::chrono::seconds	majorityTime,
		std::vector< FeatureInfo > const &	supported,
		Section const &	enabled,
		Section const &	vetoed,
		beast::Journal	journal )

Definition at line 521 of file AmendmentTable.cpp.

Member Function Documentation

◆ add()

AmendmentState & xrpl::AmendmentTableImpl::add	(	UInt256 const &	amendment,
		std::scoped_lock< std::mutex > const &	lock )

private

Definition at line 653 of file AmendmentTable.cpp.

◆ get() [1/2]

AmendmentState * xrpl::AmendmentTableImpl::get	(	UInt256 const &	amendment,
		std::scoped_lock< std::mutex > const &	lock )

private

Definition at line 660 of file AmendmentTable.cpp.

◆ get() [2/2]

AmendmentState const * xrpl::AmendmentTableImpl::get	(	UInt256 const &	amendment,
		std::scoped_lock< std::mutex > const &	lock ) const

private

Definition at line 668 of file AmendmentTable.cpp.

◆ injectJson()

void xrpl::AmendmentTableImpl::injectJson	(	json::Value &	v,
		UInt256 const &	amendment,
		AmendmentState const &	state,
		bool	isAdmin,
		std::scoped_lock< std::mutex > const &	lock ) const

private

Definition at line 963 of file AmendmentTable.cpp.

◆ persistVote()

void xrpl::AmendmentTableImpl::persistVote	(	UInt256 const &	amendment,
		std::string const &	name,
		AmendmentVote	vote ) const

private

Definition at line 694 of file AmendmentTable.cpp.

◆ find()

UInt256 xrpl::AmendmentTableImpl::find ( std::string const & name ) const

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 680 of file AmendmentTable.cpp.

◆ veto()

bool xrpl::AmendmentTableImpl::veto ( UInt256 const & amendment )

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 707 of file AmendmentTable.cpp.

◆ unVeto()

bool xrpl::AmendmentTableImpl::unVeto ( UInt256 const & amendment )

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 720 of file AmendmentTable.cpp.

◆ enable()

bool xrpl::AmendmentTableImpl::enable ( UInt256 const & amendment )

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 733 of file AmendmentTable.cpp.

◆ isEnabled()

bool xrpl::AmendmentTableImpl::isEnabled ( UInt256 const & amendment ) const

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 753 of file AmendmentTable.cpp.

◆ isSupported()

bool xrpl::AmendmentTableImpl::isSupported ( UInt256 const & amendment ) const

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 761 of file AmendmentTable.cpp.

◆ hasUnsupportedEnabled()

bool xrpl::AmendmentTableImpl::hasUnsupportedEnabled ( ) const

overridevirtual

returns true if one or more amendments on the network have been enabled that this server does not support

Returns: true if an unsupported feature is enabled on the network

Implements xrpl::AmendmentTable.

Definition at line 769 of file AmendmentTable.cpp.

◆ firstUnsupportedExpected()

std::optional< NetClock::time_point > xrpl::AmendmentTableImpl::firstUnsupportedExpected ( ) const

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 776 of file AmendmentTable.cpp.

◆ getJson() [1/2]

json::Value xrpl::AmendmentTableImpl::getJson ( bool isAdmin ) const

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 1002 of file AmendmentTable.cpp.

◆ getJson() [2/2]

json::Value xrpl::AmendmentTableImpl::getJson	(	UInt256 const &	amendment,
		bool	isAdmin ) const

overridevirtual

Returns a json::ValueType::Object.

Implements xrpl::AmendmentTable.

Definition at line 1021 of file AmendmentTable.cpp.

◆ needValidatedLedger()

bool xrpl::AmendmentTableImpl::needValidatedLedger ( LedgerIndex seq ) const

overridevirtual

Called to determine whether the amendment logic needs to process a new validated ledger.

(If it could have changed things.)

Implements xrpl::AmendmentTable.

Definition at line 908 of file AmendmentTable.cpp.

◆ doValidatedLedger() [1/2]

void xrpl::AmendmentTableImpl::doValidatedLedger	(	LedgerIndex	seq,
		std::set< UInt256 > const &	enabled,
		MajorityAmendmentsT const &	majority )

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 919 of file AmendmentTable.cpp.

◆ trustChanged()

void xrpl::AmendmentTableImpl::trustChanged ( HashSet< PublicKey > const & allTrusted )

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 956 of file AmendmentTable.cpp.

◆ doValidation()

std::vector< UInt256 > xrpl::AmendmentTableImpl::doValidation ( std::set< UInt256 > const & enabledAmendments ) const

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 783 of file AmendmentTable.cpp.

◆ getDesired()

std::vector< UInt256 > xrpl::AmendmentTableImpl::getDesired ( ) const

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 810 of file AmendmentTable.cpp.

◆ doVoting() [1/2]

std::map< UInt256, std::uint32_t > xrpl::AmendmentTableImpl::doVoting	(	Rules const &	rules,
		NetClock::time_point	closeTime,
		std::set< UInt256 > const &	enabledAmendments,
		MajorityAmendmentsT const &	majorityAmendments,
		std::vector< std::shared_ptr< STValidation > > const &	validations )

overridevirtual

Implements xrpl::AmendmentTable.

Definition at line 817 of file AmendmentTable.cpp.

◆ doValidatedLedger() [2/2]

void xrpl::AmendmentTable::doValidatedLedger ( std::shared_ptr< ReadView const > const & lastValidatedLedger )

inherited

Called when a new fully-validated ledger is accepted.

Definition at line 104 of file AmendmentTable.h.

◆ doVoting() [2/2]

void xrpl::AmendmentTable::doVoting	(	std::shared_ptr< ReadView const > const &	lastClosedLedger,
		std::vector< std::shared_ptr< STValidation > > const &	parentValidations,
		std::shared_ptr< SHAMap > const &	initialPosition,
		beast::Journal	j )

inherited

Definition at line 161 of file AmendmentTable.h.

Member Data Documentation

◆ mutex_

std::mutex xrpl::AmendmentTableImpl::mutex_

mutableprivate

Definition at line 405 of file AmendmentTable.cpp.

◆ amendmentMap_

HashMap<UInt256, AmendmentState> xrpl::AmendmentTableImpl::amendmentMap_

private

Definition at line 407 of file AmendmentTable.cpp.

◆ lastUpdateSeq_

std::uint32_t xrpl::AmendmentTableImpl::lastUpdateSeq_ {0}

private

Definition at line 408 of file AmendmentTable.cpp.

◆ previousTrustedVotes_

TrustedVotes xrpl::AmendmentTableImpl::previousTrustedVotes_

private

Definition at line 411 of file AmendmentTable.cpp.

◆ majorityTime_

std::chrono::seconds const xrpl::AmendmentTableImpl::majorityTime_

private

Definition at line 414 of file AmendmentTable.cpp.

◆ lastVote_

std::unique_ptr<AmendmentSet> xrpl::AmendmentTableImpl::lastVote_

private

Definition at line 418 of file AmendmentTable.cpp.

◆ unsupportedEnabled_

bool xrpl::AmendmentTableImpl::unsupportedEnabled_ {false}

private

Definition at line 421 of file AmendmentTable.cpp.

◆ firstUnsupportedExpected_

std::optional<NetClock::time_point> xrpl::AmendmentTableImpl::firstUnsupportedExpected_

private

Definition at line 426 of file AmendmentTable.cpp.

◆ j_

beast::Journal const xrpl::AmendmentTableImpl::j_

private

Definition at line 428 of file AmendmentTable.cpp.

◆ db_

DatabaseCon& xrpl::AmendmentTableImpl::db_

private

Definition at line 431 of file AmendmentTable.cpp.

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AmendmentTableImpl()

Member Function Documentation

◆ add()

◆ get() [1/2]

◆ get() [2/2]

◆ injectJson()

◆ persistVote()

◆ find()

◆ veto()

◆ unVeto()

◆ enable()

◆ isEnabled()

◆ isSupported()

◆ hasUnsupportedEnabled()

◆ firstUnsupportedExpected()

◆ getJson() [1/2]

◆ getJson() [2/2]

◆ needValidatedLedger()

◆ doValidatedLedger() [1/2]

◆ trustChanged()

◆ doValidation()

◆ getDesired()

◆ doVoting() [1/2]

◆ doValidatedLedger() [2/2]

◆ doVoting() [2/2]

Member Data Documentation

◆ mutex_

◆ amendmentMap_

◆ lastUpdateSeq_

◆ previousTrustedVotes_

◆ majorityTime_

◆ lastVote_

◆ unsupportedEnabled_

◆ firstUnsupportedExpected_

◆ j_

◆ db_