rippled
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ripple::AmendmentTableImpl Class Referencefinal

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

Inheritance diagram for ripple::AmendmentTableImpl:
Inheritance graph
[legend]
Collaboration diagram for ripple::AmendmentTableImpl:
Collaboration graph
[legend]

Public Member Functions

 AmendmentTableImpl (Application &app, 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_pointfirstUnsupportedExpected () const override
 
Json::Value getJson (bool isAdmin) const override
 
Json::Value getJson (uint256 const &, bool isAdmin) const override
 Returns a Json::objectValue.
 
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, majorityAmendments_t const &majority) override
 
void trustChanged (hash_set< PublicKey > const &allTrusted) override
 
std::vector< uint256doValidation (std::set< uint256 > const &enabledAmendments) const override
 
std::vector< uint256getDesired () const override
 
std::map< uint256, std::uint32_tdoVoting (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
 
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

AmendmentStateadd (uint256 const &amendment, std::lock_guard< std::mutex > const &lock)
 
AmendmentStateget (uint256 const &amendment, std::lock_guard< std::mutex > const &lock)
 
AmendmentState const * get (uint256 const &amendment, std::lock_guard< std::mutex > const &lock) const
 
void injectJson (Json::Value &v, uint256 const &amendment, AmendmentState const &state, bool isAdmin, std::lock_guard< std::mutex > const &lock) const
 
void persistVote (uint256 const &amendment, std::string const &name, AmendmentVote vote) const
 

Private Attributes

std::mutex mutex_
 
hash_map< uint256, AmendmentStateamendmentMap_
 
std::uint32_t lastUpdateSeq_
 
TrustedVotes previousTrustedVotes_
 
std::chrono::seconds const majorityTime_
 
std::unique_ptr< AmendmentSetlastVote_
 
bool unsupportedEnabled_
 
std::optional< NetClock::time_pointfirstUnsupportedExpected_
 
beast::Journal const j_
 
DatabaseCondb_
 

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 391 of file AmendmentTable.cpp.

Constructor & Destructor Documentation

◆ AmendmentTableImpl()

ripple::AmendmentTableImpl::AmendmentTableImpl ( Application app,
std::chrono::seconds  majorityTime,
std::vector< FeatureInfo > const &  supported,
Section const &  enabled,
Section const &  vetoed,
beast::Journal  journal 
)

Definition at line 514 of file AmendmentTable.cpp.

Member Function Documentation

◆ add()

AmendmentState & ripple::AmendmentTableImpl::add ( uint256 const &  amendment,
std::lock_guard< std::mutex > const &  lock 
)
private

Definition at line 656 of file AmendmentTable.cpp.

◆ get() [1/2]

AmendmentState * ripple::AmendmentTableImpl::get ( uint256 const &  amendment,
std::lock_guard< std::mutex > const &  lock 
)
private

Definition at line 665 of file AmendmentTable.cpp.

◆ get() [2/2]

AmendmentState const * ripple::AmendmentTableImpl::get ( uint256 const &  amendment,
std::lock_guard< std::mutex > const &  lock 
) const
private

Definition at line 675 of file AmendmentTable.cpp.

◆ injectJson()

void ripple::AmendmentTableImpl::injectJson ( Json::Value v,
uint256 const &  amendment,
AmendmentState const &  state,
bool  isAdmin,
std::lock_guard< std::mutex > const &  lock 
) const
private

Definition at line 979 of file AmendmentTable.cpp.

◆ persistVote()

void ripple::AmendmentTableImpl::persistVote ( uint256 const &  amendment,
std::string const &  name,
AmendmentVote  vote 
) const
private

Definition at line 703 of file AmendmentTable.cpp.

◆ find()

uint256 ripple::AmendmentTableImpl::find ( std::string const &  name) const
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 689 of file AmendmentTable.cpp.

◆ veto()

bool ripple::AmendmentTableImpl::veto ( uint256 const &  amendment)
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 716 of file AmendmentTable.cpp.

◆ unVeto()

bool ripple::AmendmentTableImpl::unVeto ( uint256 const &  amendment)
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 729 of file AmendmentTable.cpp.

◆ enable()

bool ripple::AmendmentTableImpl::enable ( uint256 const &  amendment)
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 742 of file AmendmentTable.cpp.

◆ isEnabled()

bool ripple::AmendmentTableImpl::isEnabled ( uint256 const &  amendment) const
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 763 of file AmendmentTable.cpp.

◆ isSupported()

bool ripple::AmendmentTableImpl::isSupported ( uint256 const &  amendment) const
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 771 of file AmendmentTable.cpp.

◆ hasUnsupportedEnabled()

bool ripple::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 ripple::AmendmentTable.

Definition at line 779 of file AmendmentTable.cpp.

◆ firstUnsupportedExpected()

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

Implements ripple::AmendmentTable.

Definition at line 786 of file AmendmentTable.cpp.

◆ getJson() [1/2]

Json::Value ripple::AmendmentTableImpl::getJson ( bool  isAdmin) const
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 1014 of file AmendmentTable.cpp.

◆ getJson() [2/2]

Json::Value ripple::AmendmentTableImpl::getJson ( uint256 const &  amendment,
bool  isAdmin 
) const
overridevirtual

Returns a Json::objectValue.

Implements ripple::AmendmentTable.

Definition at line 1033 of file AmendmentTable.cpp.

◆ needValidatedLedger()

bool ripple::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 ripple::AmendmentTable.

Definition at line 924 of file AmendmentTable.cpp.

◆ doValidatedLedger() [1/2]

void ripple::AmendmentTableImpl::doValidatedLedger ( LedgerIndex  seq,
std::set< uint256 > const &  enabled,
majorityAmendments_t const &  majority 
)
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 935 of file AmendmentTable.cpp.

◆ trustChanged()

void ripple::AmendmentTableImpl::trustChanged ( hash_set< PublicKey > const &  allTrusted)
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 972 of file AmendmentTable.cpp.

◆ doValidation()

std::vector< uint256 > ripple::AmendmentTableImpl::doValidation ( std::set< uint256 > const &  enabledAmendments) const
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 793 of file AmendmentTable.cpp.

◆ getDesired()

std::vector< uint256 > ripple::AmendmentTableImpl::getDesired ( ) const
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 820 of file AmendmentTable.cpp.

◆ doVoting() [1/2]

std::map< uint256, std::uint32_t > ripple::AmendmentTableImpl::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 
)
overridevirtual

Implements ripple::AmendmentTable.

Definition at line 827 of file AmendmentTable.cpp.

◆ doValidatedLedger() [2/2]

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

Called when a new fully-validated ledger is accepted.

Definition at line 93 of file AmendmentTable.h.

◆ doVoting() [2/2]

void ripple::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 148 of file AmendmentTable.h.

Member Data Documentation

◆ mutex_

std::mutex ripple::AmendmentTableImpl::mutex_
mutableprivate

Definition at line 394 of file AmendmentTable.cpp.

◆ amendmentMap_

hash_map<uint256, AmendmentState> ripple::AmendmentTableImpl::amendmentMap_
private

Definition at line 396 of file AmendmentTable.cpp.

◆ lastUpdateSeq_

std::uint32_t ripple::AmendmentTableImpl::lastUpdateSeq_
private

Definition at line 397 of file AmendmentTable.cpp.

◆ previousTrustedVotes_

TrustedVotes ripple::AmendmentTableImpl::previousTrustedVotes_
private

Definition at line 400 of file AmendmentTable.cpp.

◆ majorityTime_

std::chrono::seconds const ripple::AmendmentTableImpl::majorityTime_
private

Definition at line 403 of file AmendmentTable.cpp.

◆ lastVote_

std::unique_ptr<AmendmentSet> ripple::AmendmentTableImpl::lastVote_
private

Definition at line 407 of file AmendmentTable.cpp.

◆ unsupportedEnabled_

bool ripple::AmendmentTableImpl::unsupportedEnabled_
private

Definition at line 410 of file AmendmentTable.cpp.

◆ firstUnsupportedExpected_

std::optional<NetClock::time_point> ripple::AmendmentTableImpl::firstUnsupportedExpected_
private

Definition at line 415 of file AmendmentTable.cpp.

◆ j_

beast::Journal const ripple::AmendmentTableImpl::j_
private

Definition at line 417 of file AmendmentTable.cpp.

◆ db_

DatabaseCon& ripple::AmendmentTableImpl::db_
private

Definition at line 420 of file AmendmentTable.cpp.