Collaboration diagram for ripple::RCLConsensus::Adaptor:

[legend]

Public Types
using	Ledger_t = RCLCxLedger

using	NodeID_t = NodeID

using	NodeKey_t = PublicKey

using	TxSet_t = RCLTxSet

using	PeerPosition_t = RCLCxPeerPos

using	Result = ConsensusResult< Adaptor >

Public Member Functions
	Adaptor (Application &app, std::unique_ptr< FeeVote > &&feeVote, LedgerMaster &ledgerMaster, LocalTxs &localTxs, InboundTransactions &inboundTransactions, ValidatorKeys const &validatorKeys, beast::Journal journal)

bool	validating () const

std::size_t	prevProposers () const

std::chrono::milliseconds	prevRoundTime () const

ConsensusMode	mode () const

bool	preStartRound (RCLCxLedger const &prevLedger, hash_set< NodeID > const &nowTrusted)
	Called before kicking off a new consensus round.

bool	haveValidated () const

LedgerIndex	getValidLedgerIndex () const

std::pair< std::size_t, hash_set< NodeKey_t > >	getQuorumKeys () const

std::size_t	laggards (Ledger_t::Seq const seq, hash_set< NodeKey_t > &trustedKeys) const

bool	validator () const
	Whether I am a validator.

void	updateOperatingMode (std::size_t const positions) const
	Update operating mode based on current peer positions.

ConsensusParms const &	parms () const
	Consensus simulation parameters.

Private Member Functions
std::optional< RCLCxLedger >	acquireLedger (LedgerHash const &hash)
	Attempt to acquire a specific ledger.

void	share (RCLCxPeerPos const &peerPos)
	Share the given proposal with all peers.

void	share (RCLCxTx const &tx)
	Share disputed transaction to peers.

std::optional< RCLTxSet >	acquireTxSet (RCLTxSet::ID const &setId)
	Acquire the transaction set associated with a proposal.

bool	hasOpenTransactions () const
	Whether the open ledger has any transactions.

std::size_t	proposersValidated (LedgerHash const &h) const
	Number of proposers that have validated the given ledger.

std::size_t	proposersFinished (RCLCxLedger const &ledger, LedgerHash const &h) const
	Number of proposers that have validated a ledger descended from requested ledger.

void	propose (RCLCxPeerPos::Proposal const &proposal)
	Propose the given position to my peers.

void	share (RCLTxSet const &txns)
	Share the given tx set to peers.

uint256	getPrevLedger (uint256 ledgerID, RCLCxLedger const &ledger, ConsensusMode mode)
	Get the ID of the previous ledger/last closed ledger(LCL) on the network.

void	onModeChange (ConsensusMode before, ConsensusMode after)
	Notified of change in consensus mode.

Result	onClose (RCLCxLedger const &ledger, NetClock::time_point const &closeTime, ConsensusMode mode)
	Close the open ledger and return initial consensus position.

void	onAccept (Result const &result, RCLCxLedger const &prevLedger, NetClock::duration const &closeResolution, ConsensusCloseTimes const &rawCloseTimes, ConsensusMode const &mode, Json::Value &&consensusJson, bool const validating)
	Process the accepted ledger.

void	onForceAccept (Result const &result, RCLCxLedger const &prevLedger, NetClock::duration const &closeResolution, ConsensusCloseTimes const &rawCloseTimes, ConsensusMode const &mode, Json::Value &&consensusJson)
	Process the accepted ledger that was a result of simulation/force accept.

void	notify (protocol::NodeEvent ne, RCLCxLedger const &ledger, bool haveCorrectLCL)
	Notify peers of a consensus state change.

void	doAccept (Result const &result, RCLCxLedger const &prevLedger, NetClock::duration closeResolution, ConsensusCloseTimes const &rawCloseTimes, ConsensusMode const &mode, Json::Value &&consensusJson)
	Accept a new ledger based on the given transactions.

RCLCxLedger	buildLCL (RCLCxLedger const &previousLedger, CanonicalTXSet &retriableTxs, NetClock::time_point closeTime, bool closeTimeCorrect, NetClock::duration closeResolution, std::chrono::milliseconds roundTime, std::set< TxID > &failedTxs)
	Build the new last closed ledger.

void	validate (RCLCxLedger const &ledger, RCLTxSet const &txns, bool proposing)
	Validate the given ledger and share with peers as necessary.

Private Attributes
Application &	app_

std::unique_ptr< FeeVote >	feeVote_

LedgerMaster &	ledgerMaster_

LocalTxs &	localTxs_

InboundTransactions &	inboundTransactions_

beast::Journal const	j_

ValidatorKeys const &	validatorKeys_

std::uint64_t const	valCookie_

LedgerHash	acquiringLedger_

ConsensusParms	parms_

NetClock::time_point	lastValidationTime_

std::atomic< bool >	validating_ {false}

std::atomic< std::size_t >	prevProposers_ {0}

std::atomic< std::chrono::milliseconds >	prevRoundTime_

std::atomic< ConsensusMode >	mode_ {ConsensusMode::observing}

RCLCensorshipDetector< TxID, LedgerIndex >	censorshipDetector_

NegativeUNLVote	nUnlVote_

Friends
class	Consensus< Adaptor >

Detailed Description

Definition at line 40 of file RCLConsensus.h.

Member Typedef Documentation

◆ Ledger_t

using ripple::RCLConsensus::Adaptor::Ledger_t = RCLCxLedger

Definition at line 74 of file RCLConsensus.h.

◆ NodeID_t

using ripple::RCLConsensus::Adaptor::NodeID_t = NodeID

Definition at line 75 of file RCLConsensus.h.

◆ NodeKey_t

using ripple::RCLConsensus::Adaptor::NodeKey_t = PublicKey

Definition at line 76 of file RCLConsensus.h.

◆ TxSet_t

using ripple::RCLConsensus::Adaptor::TxSet_t = RCLTxSet

Definition at line 77 of file RCLConsensus.h.

◆ PeerPosition_t

using ripple::RCLConsensus::Adaptor::PeerPosition_t = RCLCxPeerPos

Definition at line 78 of file RCLConsensus.h.

◆ Result

using ripple::RCLConsensus::Adaptor::Result = ConsensusResult<Adaptor>

Definition at line 80 of file RCLConsensus.h.

Constructor & Destructor Documentation

◆ Adaptor()

ripple::RCLConsensus::Adaptor::Adaptor	(	Application &	app,
		std::unique_ptr< FeeVote > &&	feeVote,
		LedgerMaster &	ledgerMaster,
		LocalTxs &	localTxs,
		InboundTransactions &	inboundTransactions,
		ValidatorKeys const &	validatorKeys,
		beast::Journal	journal
	)

Definition at line 57 of file RCLConsensus.cpp.

Member Function Documentation

◆ validating()

bool ripple::RCLConsensus::Adaptor::validating ( ) const

Definition at line 92 of file RCLConsensus.h.

◆ prevProposers()

std::size_t ripple::RCLConsensus::Adaptor::prevProposers ( ) const

Definition at line 98 of file RCLConsensus.h.

◆ prevRoundTime()

std::chrono::milliseconds ripple::RCLConsensus::Adaptor::prevRoundTime ( ) const

Definition at line 104 of file RCLConsensus.h.

◆ mode()

ConsensusMode ripple::RCLConsensus::Adaptor::mode ( ) const

Definition at line 110 of file RCLConsensus.h.

◆ preStartRound()

bool ripple::RCLConsensus::Adaptor::preStartRound	(	RCLCxLedger const &	prevLedger,
		hash_set< NodeID > const &	nowTrusted
	)

Called before kicking off a new consensus round.

Parameters

prevLedger	Ledger that will be prior ledger for next round
nowTrusted	the new validators

Returns: Whether we enter the round proposing

Definition at line 980 of file RCLConsensus.cpp.

◆ haveValidated()

bool ripple::RCLConsensus::Adaptor::haveValidated ( ) const

Definition at line 1031 of file RCLConsensus.cpp.

◆ getValidLedgerIndex()

LedgerIndex ripple::RCLConsensus::Adaptor::getValidLedgerIndex ( ) const

Definition at line 1037 of file RCLConsensus.cpp.

◆ getQuorumKeys()

std::pair< std::size_t, hash_set< RCLConsensus::Adaptor::NodeKey_t > > ripple::RCLConsensus::Adaptor::getQuorumKeys ( ) const

Definition at line 1043 of file RCLConsensus.cpp.

◆ laggards()

std::size_t ripple::RCLConsensus::Adaptor::laggards	(	Ledger_t::Seq const	seq,
		hash_set< NodeKey_t > &	trustedKeys
	)		const

Definition at line 1049 of file RCLConsensus.cpp.

◆ validator()

bool ripple::RCLConsensus::Adaptor::validator ( ) const

Whether I am a validator.

Returns: whether I am a validator.

Definition at line 1057 of file RCLConsensus.cpp.

◆ updateOperatingMode()

void ripple::RCLConsensus::Adaptor::updateOperatingMode ( std::size_t const positions ) const

Update operating mode based on current peer positions.

If our current ledger has no agreement from the network, then we cannot be in the omFULL mode.

Parameters

positions Number of current peer positions.

Definition at line 1063 of file RCLConsensus.cpp.

◆ parms()

ConsensusParms const & ripple::RCLConsensus::Adaptor::parms ( ) const

Consensus simulation parameters.

Definition at line 159 of file RCLConsensus.h.

◆ acquireLedger()

std::optional< RCLCxLedger > ripple::RCLConsensus::Adaptor::acquireLedger ( LedgerHash const & hash )

private

Attempt to acquire a specific ledger.

If not available, asynchronously acquires from the network.

Parameters

hash	The ID/hash of the ledger acquire

Returns: Optional ledger, will be seated if we locally had the ledger

Definition at line 107 of file RCLConsensus.cpp.

◆ share() [1/3]

void ripple::RCLConsensus::Adaptor::share ( RCLCxPeerPos const & peerPos )

private

Share the given proposal with all peers.

Parameters

peerPos The peer position to share.

Definition at line 148 of file RCLConsensus.cpp.

◆ share() [2/3]

void ripple::RCLConsensus::Adaptor::share ( RCLCxTx const & tx )

private

Share disputed transaction to peers.

Only share if the provided transaction hasn't been shared recently.

Parameters

tx	The disputed transaction to share.

Definition at line 172 of file RCLConsensus.cpp.

◆ acquireTxSet()

std::optional< RCLTxSet > ripple::RCLConsensus::Adaptor::acquireTxSet ( RCLTxSet::ID const & setId )

private

Acquire the transaction set associated with a proposal.

If the transaction set is not available locally, will attempt acquire it from the network.

Parameters

setId The transaction set ID associated with the proposal

Returns: Optional set of transactions, seated if available.

Definition at line 244 of file RCLConsensus.cpp.

◆ hasOpenTransactions()

bool ripple::RCLConsensus::Adaptor::hasOpenTransactions ( ) const

private

Whether the open ledger has any transactions.

Definition at line 254 of file RCLConsensus.cpp.

◆ proposersValidated()

std::size_t ripple::RCLConsensus::Adaptor::proposersValidated ( LedgerHash const & h ) const

private

Number of proposers that have validated the given ledger.

Parameters

h	The hash of the ledger of interest

Returns: the number of proposers that validated a ledger

Definition at line 260 of file RCLConsensus.cpp.

◆ proposersFinished()

std::size_t ripple::RCLConsensus::Adaptor::proposersFinished	(	RCLCxLedger const &	ledger,
		LedgerHash const &	h
	)		const

private

Number of proposers that have validated a ledger descended from requested ledger.

Parameters

ledger	The current working ledger
h	The hash of the preferred working ledger

Returns: The number of validating peers that have validated a ledger descended from the preferred working ledger.

Definition at line 266 of file RCLConsensus.cpp.

◆ propose()

void ripple::RCLConsensus::Adaptor::propose ( RCLCxPeerPos::Proposal const & proposal )

private

Propose the given position to my peers.

Parameters

proposal Our proposed position

Definition at line 193 of file RCLConsensus.cpp.

◆ share() [3/3]

void ripple::RCLConsensus::Adaptor::share ( RCLTxSet const & txns )

private

Share the given tx set to peers.

Parameters

txns	The TxSet to share.

Definition at line 238 of file RCLConsensus.cpp.

◆ getPrevLedger()

uint256 ripple::RCLConsensus::Adaptor::getPrevLedger	(	uint256	ledgerID,
		RCLCxLedger const &	ledger,
		ConsensusMode	mode
	)

private

Get the ID of the previous ledger/last closed ledger(LCL) on the network.

Parameters

ledgerID	ID of previous ledger used by consensus
ledger	Previous ledger consensus has available
mode	Current consensus mode

Returns: The id of the last closed network

Note: ledgerID may not match ledger.id() if we haven't acquired the ledger matching ledgerID from the network

Definition at line 276 of file RCLConsensus.cpp.

◆ onModeChange()

void ripple::RCLConsensus::Adaptor::onModeChange	(	ConsensusMode	before,
		ConsensusMode	after
	)

private

Notified of change in consensus mode.

Parameters

before	The prior consensus mode
after	The new consensus mode

Definition at line 895 of file RCLConsensus.cpp.

◆ onClose()

auto ripple::RCLConsensus::Adaptor::onClose	(	RCLCxLedger const &	ledger,
		NetClock::time_point const &	closeTime,
		ConsensusMode	mode
	)

private

Close the open ledger and return initial consensus position.

Parameters

ledger	the ledger we are changing to
closeTime	When consensus closed the ledger
mode	Current consensus mode

Returns: Tentative consensus result

Definition at line 298 of file RCLConsensus.cpp.

◆ onAccept()

void ripple::RCLConsensus::Adaptor::onAccept	(	Result const &	result,
		RCLCxLedger const &	prevLedger,
		NetClock::duration const &	closeResolution,
		ConsensusCloseTimes const &	rawCloseTimes,
		ConsensusMode const &	mode,
		Json::Value &&	consensusJson,
		bool const	validating
	)

private

Process the accepted ledger.

Parameters

result	The result of consensus
prevLedger	The closed ledger consensus worked from
closeResolution	The resolution used in agreeing on an effective closeTime
rawCloseTimes	The unrounded closetimes of ourself and our peers
mode	Our participating mode at the time consensus was declared
consensusJson	Json representation of consensus state
validating	whether this is a validator

Definition at line 414 of file RCLConsensus.cpp.

◆ onForceAccept()

void ripple::RCLConsensus::Adaptor::onForceAccept	(	Result const &	result,
		RCLCxLedger const &	prevLedger,
		NetClock::duration const &	closeResolution,
		ConsensusCloseTimes const &	rawCloseTimes,
		ConsensusMode const &	mode,
		Json::Value &&	consensusJson
	)

private

Process the accepted ledger that was a result of simulation/force accept.

onAccept

Definition at line 396 of file RCLConsensus.cpp.

◆ notify()

void ripple::RCLConsensus::Adaptor::notify	(	protocol::NodeEvent	ne,
		RCLCxLedger const &	ledger,
		bool	haveCorrectLCL
	)

private

Notify peers of a consensus state change.

Parameters

ne	Event type for notification
ledger	The ledger at the time of the state change
haveCorrectLCL	Whether we believe we have the correct LCL.

Definition at line 717 of file RCLConsensus.cpp.

◆ doAccept()

void ripple::RCLConsensus::Adaptor::doAccept	(	Result const &	result,
		RCLCxLedger const &	prevLedger,
		NetClock::duration	closeResolution,
		ConsensusCloseTimes const &	rawCloseTimes,
		ConsensusMode const &	mode,
		Json::Value &&	consensusJson
	)

private

Accept a new ledger based on the given transactions.

onAccept

Definition at line 445 of file RCLConsensus.cpp.

◆ buildLCL()

RCLCxLedger ripple::RCLConsensus::Adaptor::buildLCL	(	RCLCxLedger const &	previousLedger,
		CanonicalTXSet &	retriableTxs,
		NetClock::time_point	closeTime,
		bool	closeTimeCorrect,
		NetClock::duration	closeResolution,
		std::chrono::milliseconds	roundTime,
		std::set< TxID > &	failedTxs
	)

private

Build the new last closed ledger.

Accept the given the provided set of consensus transactions and build the last closed ledger. Since consensus just agrees on which transactions to apply, but not whether they make it into the closed ledger, this function also populates retriableTxs with those that can be retried in the next round.

Parameters

previousLedger	Prior ledger building upon
retriableTxs	On entry, the set of transactions to apply to the ledger; on return, the set of transactions to retry in the next round.
closeTime	The time the ledger closed
closeTimeCorrect	Whether consensus agreed on close time
closeResolution	Resolution used to determine consensus close time
roundTime	Duration of this consensus round
failedTxs	Populate with transactions that we could not successfully apply.

Returns: The newly built ledger

Definition at line 756 of file RCLConsensus.cpp.

◆ validate()

void ripple::RCLConsensus::Adaptor::validate	(	RCLCxLedger const &	ledger,
		RCLTxSet const &	txns,
		bool	proposing
	)

private

Validate the given ledger and share with peers as necessary.

Parameters

ledger	The ledger to validate
txns	The consensus transaction set
proposing	Whether we were proposing transactions while generating this ledger. If we are not proposing, a validation can still be sent to inform peers that we know we aren't fully participating in consensus but are still around and trying to catch up.

Definition at line 799 of file RCLConsensus.cpp.

Friends And Related Symbol Documentation

◆ Consensus< Adaptor >

friend class Consensus< Adaptor >

friend

Definition at line 159 of file RCLConsensus.h.

Member Data Documentation

◆ app_

Application& ripple::RCLConsensus::Adaptor::app_

private

Definition at line 42 of file RCLConsensus.h.

◆ feeVote_

std::unique_ptr<FeeVote> ripple::RCLConsensus::Adaptor::feeVote_

private

Definition at line 43 of file RCLConsensus.h.

◆ ledgerMaster_

LedgerMaster& ripple::RCLConsensus::Adaptor::ledgerMaster_

private

Definition at line 44 of file RCLConsensus.h.

◆ localTxs_

LocalTxs& ripple::RCLConsensus::Adaptor::localTxs_

private

Definition at line 45 of file RCLConsensus.h.

◆ inboundTransactions_

InboundTransactions& ripple::RCLConsensus::Adaptor::inboundTransactions_

private

Definition at line 46 of file RCLConsensus.h.

◆ j_

beast::Journal const ripple::RCLConsensus::Adaptor::j_

private

Definition at line 47 of file RCLConsensus.h.

◆ validatorKeys_

ValidatorKeys const& ripple::RCLConsensus::Adaptor::validatorKeys_

private

Definition at line 50 of file RCLConsensus.h.

◆ valCookie_

std::uint64_t const ripple::RCLConsensus::Adaptor::valCookie_

private

Definition at line 53 of file RCLConsensus.h.

◆ acquiringLedger_

LedgerHash ripple::RCLConsensus::Adaptor::acquiringLedger_

private

Definition at line 56 of file RCLConsensus.h.

◆ parms_

ConsensusParms ripple::RCLConsensus::Adaptor::parms_

private

Definition at line 57 of file RCLConsensus.h.

◆ lastValidationTime_

NetClock::time_point ripple::RCLConsensus::Adaptor::lastValidationTime_

private

Definition at line 60 of file RCLConsensus.h.

◆ validating_

std::atomic<bool> ripple::RCLConsensus::Adaptor::validating_ {false}

private

Definition at line 64 of file RCLConsensus.h.

◆ prevProposers_

std::atomic<std::size_t> ripple::RCLConsensus::Adaptor::prevProposers_ {0}

private

Definition at line 65 of file RCLConsensus.h.

◆ prevRoundTime_

std::atomic<std::chrono::milliseconds> ripple::RCLConsensus::Adaptor::prevRoundTime_

private

Initial value:

{

std::chrono::milliseconds{0}}

std::chrono::milliseconds

Definition at line 66 of file RCLConsensus.h.

◆ mode_

std::atomic<ConsensusMode> ripple::RCLConsensus::Adaptor::mode_ {ConsensusMode::observing}

private

Definition at line 68 of file RCLConsensus.h.

◆ censorshipDetector_

RCLCensorshipDetector<TxID, LedgerIndex> ripple::RCLConsensus::Adaptor::censorshipDetector_

private

Definition at line 70 of file RCLConsensus.h.

◆ nUnlVote_

NegativeUNLVote ripple::RCLConsensus::Adaptor::nUnlVote_

private

Definition at line 71 of file RCLConsensus.h.

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Ledger_t

◆ NodeID_t

◆ NodeKey_t

◆ TxSet_t

◆ PeerPosition_t

◆ Result

Constructor & Destructor Documentation

◆ Adaptor()

Member Function Documentation

◆ validating()

◆ prevProposers()

◆ prevRoundTime()

◆ mode()

◆ preStartRound()

◆ haveValidated()

◆ getValidLedgerIndex()

◆ getQuorumKeys()

◆ laggards()

◆ validator()

◆ updateOperatingMode()

◆ parms()

◆ acquireLedger()

◆ share() [1/3]

◆ share() [2/3]

◆ acquireTxSet()

◆ hasOpenTransactions()

◆ proposersValidated()

◆ proposersFinished()

◆ propose()

◆ share() [3/3]

◆ getPrevLedger()

◆ onModeChange()

◆ onClose()

◆ onAccept()

◆ onForceAccept()

◆ notify()

◆ doAccept()

◆ buildLCL()

◆ validate()

Friends And Related Symbol Documentation

◆ Consensus< Adaptor >

Member Data Documentation

◆ app_

◆ feeVote_

◆ ledgerMaster_

◆ localTxs_

◆ inboundTransactions_

◆ j_

◆ validatorKeys_

◆ valCookie_

◆ acquiringLedger_

◆ parms_

◆ lastValidationTime_

◆ validating_

◆ prevProposers_

◆ prevRoundTime_

◆ mode_

◆ censorshipDetector_

◆ nUnlVote_