A transaction discovered to be in dispute during consensus. More...

#include <DisputedTx.h>

Collaboration diagram for xrpl::DisputedTx< Tx_t, NodeID_t >:

[legend]

Public Member Functions
	DisputedTx (Tx_t const &tx, bool ourVote, std::size_t numPeers, beast::Journal j)
	Constructor.

TxID_t const &	ID () const
	The unique id/hash of the disputed transaction.

bool	getOurVote () const
	Our vote on whether the transaction should be included.

bool	stalled (ConsensusParms const &p, bool proposing, int peersUnchanged, beast::Journal j, std::unique_ptr< std::stringstream > const &clog) const
	Are we and our peers "stalled" where we probably won't change our vote?

Tx_t const &	tx () const
	The disputed transaction.

void	setOurVote (bool o)
	Change our vote.

bool	setVote (NodeID_t const &peer, bool votesYes)
	Change a peer's vote.

void	unVote (NodeID_t const &peer)
	Remove a peer's vote.

bool	updateVote (int percentTime, bool proposing, ConsensusParms const &p)
	Update our vote given progression of consensus.

Json::Value	getJson () const
	JSON representation of dispute, used for debugging.

Private Types
using	TxID_t = typename Tx_t::ID

using	Map_t = boost::container::flat_map< NodeID_t, bool >

Private Attributes
int	yays_ {0}

int	nays_ {0}

bool	ourVote_

Tx_t	tx_

Map_t	votes_

std::size_t	currentVoteCounter_ = 0
	The number of rounds we've gone without changing our vote.

ConsensusParms::AvalancheState	avalancheState_ = ConsensusParms::init
	Which minimum acceptance percentage phase we are currently in.

std::size_t	avalancheCounter_ = 0
	How long we have been in the current acceptance phase.

beast::Journal const	j_

Detailed Description

template<class Tx_t, class NodeID_t>
class xrpl::DisputedTx< Tx_t, NodeID_t >

A transaction discovered to be in dispute during consensus.

During consensus, a DisputedTx is created when a transaction is discovered to be disputed. The object persists only as long as the dispute.

Undisputed transactions have no corresponding DisputedTx object.

Refer to Consensus for details on the template type requirements.

Template Parameters

Tx_t	The type for a transaction
NodeID_t	The type for a node identifier

Definition at line 28 of file DisputedTx.h.

Member Typedef Documentation

◆ TxID_t

template<class Tx_t , class NodeID_t >

using xrpl::DisputedTx< Tx_t, NodeID_t >::TxID_t = typename Tx_t::ID

private

Definition at line 30 of file DisputedTx.h.

◆ Map_t

template<class Tx_t , class NodeID_t >

using xrpl::DisputedTx< Tx_t, NodeID_t >::Map_t = boost::container::flat_map<NodeID_t, bool>

private

Definition at line 31 of file DisputedTx.h.

Constructor & Destructor Documentation

◆ DisputedTx()

template<class Tx_t , class NodeID_t >

xrpl::DisputedTx< Tx_t, NodeID_t >::DisputedTx	(	Tx_t const &	tx,
		bool	ourVote,
		std::size_t	numPeers,
		beast::Journal	j
	)

Constructor.

Parameters

tx	The transaction under dispute
ourVote	Our vote on whether tx should be included
numPeers	Anticipated number of peer votes
j	Journal for debugging

Definition at line 41 of file DisputedTx.h.

Member Function Documentation

◆ ID()

template<class Tx_t , class NodeID_t >

TxID_t const & xrpl::DisputedTx< Tx_t, NodeID_t >::ID ( ) const

The unique id/hash of the disputed transaction.

Definition at line 49 of file DisputedTx.h.

◆ getOurVote()

template<class Tx_t , class NodeID_t >

bool xrpl::DisputedTx< Tx_t, NodeID_t >::getOurVote ( ) const

Our vote on whether the transaction should be included.

Definition at line 56 of file DisputedTx.h.

◆ stalled()

template<class Tx_t , class NodeID_t >

bool xrpl::DisputedTx< Tx_t, NodeID_t >::stalled	(	ConsensusParms const &	p,
		bool	proposing,
		int	peersUnchanged,
		beast::Journal	j,
		std::unique_ptr< std::stringstream > const &	clog
	)		const

Are we and our peers "stalled" where we probably won't change our vote?

Definition at line 64 of file DisputedTx.h.

◆ tx()

template<class Tx_t , class NodeID_t >

Tx_t const & xrpl::DisputedTx< Tx_t, NodeID_t >::tx ( ) const

The disputed transaction.

Definition at line 127 of file DisputedTx.h.

◆ setOurVote()

template<class Tx_t , class NodeID_t >

void xrpl::DisputedTx< Tx_t, NodeID_t >::setOurVote ( bool o )

Change our vote.

Definition at line 134 of file DisputedTx.h.

◆ setVote()

template<class Tx_t , class NodeID_t >

bool xrpl::DisputedTx< Tx_t, NodeID_t >::setVote	(	NodeID_t const &	peer,
		bool	votesYes
	)

Change a peer's vote.

Parameters

peer	Identifier of peer.
votesYes	Whether peer votes to include the disputed transaction.

Returns: bool Whether the peer changed its vote. (A new vote counts as a change.)

Definition at line 193 of file DisputedTx.h.

◆ unVote()

template<class Tx_t , class NodeID_t >

void xrpl::DisputedTx< Tx_t, NodeID_t >::unVote ( NodeID_t const & peer )

Remove a peer's vote.

Parameters

peer	Identifier of peer.

Definition at line 236 of file DisputedTx.h.

◆ updateVote()

template<class Tx_t , class NodeID_t >

bool xrpl::DisputedTx< Tx_t, NodeID_t >::updateVote	(	int	percentTime,
		bool	proposing,
		ConsensusParms const &	p
	)

Update our vote given progression of consensus.

Updates our vote on this disputed transaction based on our peers' votes and how far along consensus has proceeded.

Parameters

percentTime	Percentage progress through consensus, e.g. 50% through or 90%.
proposing	Whether we are proposing to our peers in this round.
p	Consensus parameters controlling thresholds for voting

Returns: Whether our vote changed

Definition at line 253 of file DisputedTx.h.

◆ getJson()

template<class Tx_t , class NodeID_t >

Json::Value xrpl::DisputedTx< Tx_t, NodeID_t >::getJson ( ) const

JSON representation of dispute, used for debugging.

Definition at line 311 of file DisputedTx.h.

Member Data Documentation

◆ yays_

template<class Tx_t , class NodeID_t >

int xrpl::DisputedTx< Tx_t, NodeID_t >::yays_ {0}

private

Definition at line 176 of file DisputedTx.h.

◆ nays_

template<class Tx_t , class NodeID_t >

int xrpl::DisputedTx< Tx_t, NodeID_t >::nays_ {0}

private

Definition at line 177 of file DisputedTx.h.

◆ ourVote_

template<class Tx_t , class NodeID_t >

bool xrpl::DisputedTx< Tx_t, NodeID_t >::ourVote_

private

Definition at line 178 of file DisputedTx.h.

◆ tx_

template<class Tx_t , class NodeID_t >

Tx_t xrpl::DisputedTx< Tx_t, NodeID_t >::tx_

private

Definition at line 179 of file DisputedTx.h.

◆ votes_

template<class Tx_t , class NodeID_t >

Map_t xrpl::DisputedTx< Tx_t, NodeID_t >::votes_

private

Definition at line 180 of file DisputedTx.h.

◆ currentVoteCounter_

template<class Tx_t , class NodeID_t >

std::size_t xrpl::DisputedTx< Tx_t, NodeID_t >::currentVoteCounter_ = 0

private

The number of rounds we've gone without changing our vote.

Definition at line 182 of file DisputedTx.h.

◆ avalancheState_

template<class Tx_t , class NodeID_t >

ConsensusParms::AvalancheState xrpl::DisputedTx< Tx_t, NodeID_t >::avalancheState_ = ConsensusParms::init

private

Which minimum acceptance percentage phase we are currently in.

Definition at line 184 of file DisputedTx.h.

◆ avalancheCounter_

template<class Tx_t , class NodeID_t >

std::size_t xrpl::DisputedTx< Tx_t, NodeID_t >::avalancheCounter_ = 0

private

How long we have been in the current acceptance phase.

Definition at line 186 of file DisputedTx.h.

◆ j_

template<class Tx_t , class NodeID_t >

beast::Journal const xrpl::DisputedTx< Tx_t, NodeID_t >::j_

private

Definition at line 187 of file DisputedTx.h.

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ TxID_t

◆ Map_t

Constructor & Destructor Documentation

◆ DisputedTx()

Member Function Documentation

◆ ID()

◆ getOurVote()

◆ stalled()

◆ tx()

◆ setOurVote()

◆ setVote()

◆ unVote()

◆ updateVote()

◆ getJson()

Member Data Documentation

◆ yays_

◆ nays_

◆ ourVote_

◆ tx_

◆ votes_

◆ currentVoteCounter_

◆ avalancheState_

◆ avalancheCounter_

◆ j_