Store a list of transactions to be broadcast privately. More...

#include <private_broadcast.h>

Collaboration diagram for PrivateBroadcast:

Classes
struct	CTransactionRefComp

struct	CTransactionRefHash

struct	PeerSendInfo

struct	Priority
	Cumulative stats from all the send attempts for a transaction. Used to prioritize transactions. More...

struct	SendStatus
	Status of a transaction sent to a given node. More...

struct	TxAndSendStatusForNode
	A pair of a transaction and a sent status for a given node. Convenience return type of GetSendStatusByNode(). More...

struct	TxBroadcastInfo

struct	TxSendStatus

Public Types
enum class	AddResult { Added , AlreadyPresent , QueueFull }
	Outcome of Add(). More...

Public Member Functions
	PrivateBroadcast (size_t max_transactions=MAX_TRANSACTIONS)

AddResult	Add (const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Add a transaction to the storage. More...

std::optional< size_t >	Remove (const CTransactionRef &tx) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Forget a transaction. More...

std::optional< CTransactionRef >	PickTxForSend (const NodeId &will_send_to_nodeid, const CService &will_send_to_address) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Pick the transaction with the fewest send attempts, and confirmations, and oldest send/confirm times. More...

std::optional< CTransactionRef >	GetTxForNode (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Get the transaction that was picked for sending to a given node by PickTxForSend(). More...

void	NodeConfirmedReception (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Mark that the node has confirmed reception of the transaction we sent it by responding with `PONG` to our `PING` message. More...

bool	DidNodeConfirmReception (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Check if the node has confirmed reception of the transaction. More...

bool	HavePendingTransactions () EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Check if there are transactions that need to be broadcast. More...

std::vector< CTransactionRef >	GetStale () const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Get the transactions that have not been broadcast recently. More...

std::vector< TxBroadcastInfo >	GetBroadcastInfo () const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
	Get stats about all transactions currently being privately broadcast. More...

Static Public Attributes
static constexpr auto	INITIAL_STALE_DURATION {5min}
	If a transaction is not sent to any peer for this duration, then we consider it stale / for rebroadcasting. More...

static constexpr auto	STALE_DURATION {1min}
	If a transaction is not received back from the network for this duration after it is broadcast, then we consider it stale / for rebroadcasting. More...

static constexpr size_t	MAX_TRANSACTIONS {10'000}
	Maximum number of transactions tracked simultaneously. More...

Private Member Functions
std::optional< TxAndSendStatusForNode >	GetSendStatusByNode (const NodeId &nodeid) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
	Find which transaction we sent to a given node (marked by PickTxForSend()). More...

std::unordered_map< CTransactionRef, TxSendStatus, CTransactionRefHash, CTransactionRefComp > m_transactions	GUARDED_BY (m_mutex)

Static Private Member Functions
static Priority	DerivePriority (const std::vector< SendStatus > &sent_to)
	Derive the sending priority of a transaction. More...

Private Attributes
const size_t	m_max_transactions
	Cap on the number of simultaneously tracked transactions (see Add()). More...

Mutex	m_mutex

Detailed Description

Store a list of transactions to be broadcast privately.

Supports the following operations:

Add a new transaction
Remove a transaction
Pick a transaction for sending to one recipient
Query which transaction has been picked for sending to a given recipient node
Mark that a given recipient node has confirmed receipt of a transaction
Query whether a given recipient node has confirmed reception
Query whether any transactions that need sending are currently on the list

Definition at line 29 of file private_broadcast.h.

Member Enumeration Documentation

◆ AddResult

enum class PrivateBroadcast::AddResult

strong

Outcome of Add().

Enumerator
Added	The transaction was newly added.
AlreadyPresent	The transaction was already present; no change.
QueueFull	Rejected: the queue is already at MAX_TRANSACTIONS.

Definition at line 63 of file private_broadcast.h.

Constructor & Destructor Documentation

◆ PrivateBroadcast()

PrivateBroadcast::PrivateBroadcast ( size_t max_transactions = MAX_TRANSACTIONS )

inlineexplicit

Parameters

[in] max_transactions Cap on the number of simultaneously tracked transactions. Defaults to MAX_TRANSACTIONS.

Definition at line 47 of file private_broadcast.h.

Member Function Documentation

◆ Add()

PrivateBroadcast::AddResult PrivateBroadcast::Add ( const CTransactionRef & tx )

Add a transaction to the storage.

Parameters

[in] tx The transaction to add.

Returns: Whether the transaction was newly added, was already present, or was rejected because the queue is full (see AddResult).

Definition at line 12 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ DerivePriority()

PrivateBroadcast::Priority PrivateBroadcast::DerivePriority ( const std::vector< SendStatus > & sent_to )

staticprivate

Derive the sending priority of a transaction.

Parameters

[in] sent_to List of nodes that the transaction has been sent to.

Definition at line 136 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ DidNodeConfirmReception()

bool PrivateBroadcast::DidNodeConfirmReception ( const NodeId & nodeid )

Check if the node has confirmed reception of the transaction.

Return values

true	Node has confirmed, `NodeConfirmedReception()` has been called.
false	Node has not confirmed, `NodeConfirmedReception()` has not been called.

Definition at line 82 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ GetBroadcastInfo()

std::vector< PrivateBroadcast::TxBroadcastInfo > PrivateBroadcast::GetBroadcastInfo ( ) const

Get stats about all transactions currently being privately broadcast.

Definition at line 117 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ GetSendStatusByNode()

std::optional< PrivateBroadcast::TxAndSendStatusForNode > PrivateBroadcast::GetSendStatusByNode ( const NodeId & nodeid )

private

Find which transaction we sent to a given node (marked by PickTxForSend()).

Returns: That transaction together with the send status or nullopt if we did not send any transaction to the given node.

Definition at line 150 of file private_broadcast.cpp.

Here is the call graph for this function:

◆ GetStale()

std::vector< CTransactionRef > PrivateBroadcast::GetStale ( ) const

Get the transactions that have not been broadcast recently.

Definition at line 100 of file private_broadcast.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTxForNode()

std::optional< CTransactionRef > PrivateBroadcast::GetTxForNode ( const NodeId & nodeid )

Get the transaction that was picked for sending to a given node by PickTxForSend().

Parameters

[in] nodeid Node to which a transaction is being (or was) sent.

Returns: Transaction or nullopt if the nodeid is unknown.

Definition at line 61 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ GUARDED_BY()

std::unordered_map< CTransactionRef, TxSendStatus, CTransactionRefHash, CTransactionRefComp > m_transactions PrivateBroadcast::GUARDED_BY ( m_mutex )

private

◆ HavePendingTransactions()

bool PrivateBroadcast::HavePendingTransactions ( )

Check if there are transactions that need to be broadcast.

Definition at line 93 of file private_broadcast.cpp.

Here is the caller graph for this function:

◆ NodeConfirmedReception()

void PrivateBroadcast::NodeConfirmedReception ( const NodeId & nodeid )

Mark that the node has confirmed reception of the transaction we sent it by responding with PONG to our PING message.

Parameters

[in] nodeid Node that we sent a transaction to.

Definition at line 72 of file private_broadcast.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PickTxForSend()

std::optional< CTransactionRef > PrivateBroadcast::PickTxForSend	(	const NodeId &	will_send_to_nodeid,
		const CService &	will_send_to_address
	)

Pick the transaction with the fewest send attempts, and confirmations, and oldest send/confirm times.

Parameters

[in]	will_send_to_nodeid	Will remember that the returned transaction was picked for sending to this node. Calling this method more than once with the same `will_send_to_nodeid` is not allowed because sending more than one transaction to one node would be a privacy leak.
[in]	will_send_to_address	Address of the peer to which this transaction will be sent.

Returns: Most urgent transaction or nullopt if there are no transactions.

Definition at line 37 of file private_broadcast.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Remove()

std::optional< size_t > PrivateBroadcast::Remove ( const CTransactionRef & tx )

Forget a transaction.

Parameters

[in] tx Transaction to forget.

Return values

!nullopt	The number of times the transaction was sent and confirmed by the recipient (if the transaction existed and was removed).
nullopt	The transaction was not in the storage.

Definition at line 25 of file private_broadcast.cpp.

Here is the caller graph for this function:

Member Data Documentation

◆ INITIAL_STALE_DURATION

constexpr auto PrivateBroadcast::INITIAL_STALE_DURATION {5min}

staticconstexpr

If a transaction is not sent to any peer for this duration, then we consider it stale / for rebroadcasting.

Definition at line 35 of file private_broadcast.h.

◆ m_max_transactions

const size_t PrivateBroadcast::m_max_transactions

private

Cap on the number of simultaneously tracked transactions (see Add()).

Definition at line 219 of file private_broadcast.h.

◆ m_mutex

Mutex PrivateBroadcast::m_mutex

mutableprivate

Definition at line 220 of file private_broadcast.h.

◆ MAX_TRANSACTIONS

constexpr size_t PrivateBroadcast::MAX_TRANSACTIONS {10'000}

staticconstexpr

Maximum number of transactions tracked simultaneously.

Additions that would exceed this are rejected (see Add()).

Definition at line 43 of file private_broadcast.h.

◆ STALE_DURATION

constexpr auto PrivateBroadcast::STALE_DURATION {1min}

staticconstexpr

If a transaction is not received back from the network for this duration after it is broadcast, then we consider it stale / for rebroadcasting.

Definition at line 39 of file private_broadcast.h.

The documentation for this class was generated from the following files:

src/private_broadcast.h
src/private_broadcast.cpp

Classes

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ AddResult

Constructor & Destructor Documentation

◆ PrivateBroadcast()

Member Function Documentation

◆ Add()

◆ DerivePriority()

◆ DidNodeConfirmReception()

◆ GetBroadcastInfo()

◆ GetSendStatusByNode()

◆ GetStale()

◆ GetTxForNode()

◆ GUARDED_BY()

◆ HavePendingTransactions()

◆ NodeConfirmedReception()

◆ PickTxForSend()

◆ Remove()

Member Data Documentation

◆ INITIAL_STALE_DURATION

◆ m_max_transactions

◆ m_mutex

◆ MAX_TRANSACTIONS

◆ STALE_DURATION