#include <protocol.h>
#include <chainparams.h>
#include <common/system.h>
#include <config.h>
#include <logging.h>
#include <atomic>

Include dependency graph for protocol.cpp:

Namespaces
namespace	NetMsgType
	Bitcoin protocol message types.

Functions
static std::atomic< bool >	g_initial_block_download_completed (false)

bool	NetMsgType::IsBlockLike (const std::string &strCommand)
	Indicate if the message is used to transmit the content of a block.

static const std::vector< std::string >	allNetMessageTypesVec (std::begin(allNetMessageTypes), std::end(allNetMessageTypes))

static bool	CheckHeaderMagicAndCommand (const CMessageHeader &header, const CMessageHeader::MessageMagic &magic)

ServiceFlags	GetDesirableServiceFlags (ServiceFlags services)
	Gets the set of service flags which are "desirable" for a given peer.

void	SetServiceFlagsIBDCache (bool state)
	Set the current IBD status in order to figure out the desirable service flags.

const std::vector< std::string > &	getAllNetMessageTypes ()
	Get a vector of all valid message types (see above)

static std::string	serviceFlagToStr (const size_t bit)
	Convert a service flag (NODE_*) to a human readable string.

std::vector< std::string >	serviceFlagsToStr (const uint64_t flags)
	Convert service flags (a bitmask of NODE_*) to human readable strings.

Variables
const char *	NetMsgType::VERSION = "version"
	The version message provides information about the transmitting node to the receiving node at the beginning of a connection.

const char *	NetMsgType::VERACK = "verack"
	The verack message acknowledges a previously-received version message, informing the connecting node that it can begin to send other messages.

const char *	NetMsgType::ADDR = "addr"
	The addr (IP address) message relays connection information for peers on the network.

const char *	NetMsgType::ADDRV2 = "addrv2"
	The addrv2 message relays connection information for peers on the network just like the addr message, but is extended to allow gossiping of longer node addresses (see BIP155).

const char *	NetMsgType::SENDADDRV2 = "sendaddrv2"
	The sendaddrv2 message signals support for receiving ADDRV2 messages (BIP155).

const char *	NetMsgType::INV = "inv"
	The inv message (inventory message) transmits one or more inventories of objects known to the transmitting peer.

const char *	NetMsgType::GETDATA = "getdata"
	The getdata message requests one or more data objects from another node.

const char *	NetMsgType::MERKLEBLOCK = "merkleblock"
	The merkleblock message is a reply to a getdata message which requested a block using the inventory type MSG_MERKLEBLOCK.

const char *	NetMsgType::GETBLOCKS = "getblocks"
	The getblocks message requests an inv message that provides block header hashes starting from a particular point in the block chain.

const char *	NetMsgType::GETHEADERS = "getheaders"
	The getheaders message requests a headers message that provides block headers starting from a particular point in the block chain.

const char *	NetMsgType::TX = "tx"
	The tx message transmits a single transaction.

const char *	NetMsgType::HEADERS = "headers"
	The headers message sends one or more block headers to a node which previously requested certain headers with a getheaders message.

const char *	NetMsgType::BLOCK = "block"
	The block message transmits a single serialized block.

const char *	NetMsgType::GETADDR = "getaddr"
	The getaddr message requests an addr message from the receiving node, preferably one with lots of IP addresses of other receiving nodes.

const char *	NetMsgType::MEMPOOL = "mempool"
	The mempool message requests the TXIDs of transactions that the receiving node has verified as valid but which have not yet appeared in a block.

const char *	NetMsgType::PING = "ping"
	The ping message is sent periodically to help confirm that the receiving peer is still connected.

const char *	NetMsgType::PONG = "pong"
	The pong message replies to a ping message, proving to the pinging node that the ponging node is still alive.

const char *	NetMsgType::NOTFOUND = "notfound"
	The notfound message is a reply to a getdata message which requested an object the receiving node does not have available for relay.

const char *	NetMsgType::FILTERLOAD = "filterload"
	The filterload message tells the receiving peer to filter all relayed transactions and requested merkle blocks through the provided filter.

const char *	NetMsgType::FILTERADD = "filteradd"
	The filteradd message tells the receiving peer to add a single element to a previously-set bloom filter, such as a new public key.

const char *	NetMsgType::FILTERCLEAR = "filterclear"
	The filterclear message tells the receiving peer to remove a previously-set bloom filter.

const char *	NetMsgType::SENDHEADERS = "sendheaders"
	Indicates that a node prefers to receive new block announcements via a "headers" message rather than an "inv".

const char *	NetMsgType::FEEFILTER = "feefilter"
	The feefilter message tells the receiving peer not to inv us any txs which do not meet the specified min fee rate.

const char *	NetMsgType::SENDCMPCT = "sendcmpct"
	Contains a 1-byte bool and 8-byte LE version number.

const char *	NetMsgType::CMPCTBLOCK = "cmpctblock"
	Contains a CBlockHeaderAndShortTxIDs object - providing a header and list of "short txids".

const char *	NetMsgType::GETBLOCKTXN = "getblocktxn"
	Contains a BlockTransactionsRequest Peer should respond with "blocktxn" message.

const char *	NetMsgType::BLOCKTXN = "blocktxn"
	Contains a BlockTransactions.

const char *	NetMsgType::GETCFILTERS = "getcfilters"
	getcfilters requests compact filters for a range of blocks.

const char *	NetMsgType::CFILTER = "cfilter"
	cfilter is a response to a getcfilters request containing a single compact filter.

const char *	NetMsgType::GETCFHEADERS = "getcfheaders"
	getcfheaders requests a compact filter header and the filter hashes for a range of blocks, which can then be used to reconstruct the filter headers for those blocks.

const char *	NetMsgType::CFHEADERS = "cfheaders"
	cfheaders is a response to a getcfheaders request containing a filter header and a vector of filter hashes for each subsequent block in the requested range.

const char *	NetMsgType::GETCFCHECKPT = "getcfcheckpt"
	getcfcheckpt requests evenly spaced compact filter headers, enabling parallelized download and validation of the headers between them.

const char *	NetMsgType::CFCHECKPT = "cfcheckpt"
	cfcheckpt is a response to a getcfcheckpt request containing a vector of evenly spaced filter headers for blocks on the requested chain.

const char *	NetMsgType::AVAHELLO = "avahello"
	Contains a delegation and a signature.

const char *	NetMsgType::AVAPOLL = "avapoll"
	Contains an avalanche::Poll.

const char *	NetMsgType::AVARESPONSE = "avaresponse"
	Contains an avalanche::Response.

const char *	NetMsgType::AVAPROOF = "avaproof"
	Contains an avalanche::Proof.

const char *	NetMsgType::GETAVAADDR = "getavaaddr"
	The getavaaddr message requests an addr message from the receiving node, containing IP addresses of the most active avalanche nodes.

const char *	NetMsgType::GETAVAPROOFS = "getavaproofs"
	The getavaproofs message requests an avaproofs message that provides the proof short ids of all the valid proofs known by our peer.

const char *	NetMsgType::AVAPROOFS = "avaproofs"
	The avaproofs message the proof short ids of all the valid proofs that we know.

const char *	NetMsgType::AVAPROOFSREQ = "avaproofsreq"
	Request for missing avalanche proofs after an avaproofs message has been processed.

static const std::string	allNetMessageTypes []
	All known message types.

Function Documentation

◆ allNetMessageTypesVec()

static const std::vector< std::string > allNetMessageTypesVec	(	std::begin(allNetMessageTypes)	,
		std::end(allNetMessageTypes)
	)

static

Here is the caller graph for this function:

◆ CheckHeaderMagicAndCommand()

static bool CheckHeaderMagicAndCommand	(	const CMessageHeader &	header,
		const CMessageHeader::MessageMagic &	magic
	)

static

Definition at line 126 of file protocol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ g_initial_block_download_completed()

static std::atomic< bool > g_initial_block_download_completed ( false )

static

Here is the caller graph for this function:

◆ getAllNetMessageTypes()

const std::vector< std::string > & getAllNetMessageTypes ( )

Get a vector of all valid message types (see above)

Definition at line 243 of file protocol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDesirableServiceFlags()

ServiceFlags GetDesirableServiceFlags ( ServiceFlags services )

Gets the set of service flags which are "desirable" for a given peer.

These are the flags which are required for a peer to support for them to be "interesting" to us, ie for us to wish to use one of our few outbound connection slots for or for us to wish to prioritize keeping their connection around.

Relevant service flags may be peer- and state-specific in that the version of the peer may determine which flags are required (eg in the case of NODE_NETWORK_LIMITED where we seek out NODE_NETWORK peers unless they set NODE_NETWORK_LIMITED and we are out of IBD, in which case NODE_NETWORK_LIMITED suffices).

Thus, generally, avoid calling with peerServices == NODE_NONE, unless state-specific flags must absolutely be avoided. When called with peerServices == NODE_NONE, the returned desirable service flags are guaranteed to not change dependent on state - ie they are suitable for use when describing peers which we know to be desirable, but for which we do not have a confirmed set of service flags.

If the NODE_NONE return value is changed, contrib/seeds/makeseeds.py should be updated appropriately to filter for the same nodes.

Definition at line 204 of file protocol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serviceFlagsToStr()

std::vector< std::string > serviceFlagsToStr ( const uint64_t flags )

Convert service flags (a bitmask of NODE_*) to human readable strings.

It supports unknown service flags which will be returned as "UNKNOWN[...]".

Parameters

[in] flags multiple NODE_* bitwise-OR-ed together

Definition at line 280 of file protocol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ serviceFlagToStr()

static std::string serviceFlagToStr ( const size_t bit )

static

Convert a service flag (NODE_*) to a human readable string.

It supports unknown service flags which will be returned as "UNKNOWN[...]".

Parameters

[in] bit the service flag is calculated as (1 << bit)

Definition at line 252 of file protocol.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetServiceFlagsIBDCache()

void SetServiceFlagsIBDCache ( bool state )

Set the current IBD status in order to figure out the desirable service flags.

Definition at line 212 of file protocol.cpp.

Here is the call graph for this function:

Variable Documentation

◆ allNetMessageTypes

const std::string allNetMessageTypes[]

static

Initial value:

= {
    NetMsgType::VERSION,     NetMsgType::VERACK,       NetMsgType::ADDR,
    NetMsgType::ADDRV2,      NetMsgType::SENDADDRV2,   NetMsgType::INV,
    NetMsgType::GETDATA,     NetMsgType::MERKLEBLOCK,  NetMsgType::GETBLOCKS,
    NetMsgType::GETHEADERS,  NetMsgType::TX,           NetMsgType::HEADERS,
    NetMsgType::BLOCK,       NetMsgType::GETADDR,      NetMsgType::MEMPOOL,
    NetMsgType::PING,        NetMsgType::PONG,         NetMsgType::NOTFOUND,
    NetMsgType::FILTERLOAD,  NetMsgType::FILTERADD,    NetMsgType::FILTERCLEAR,
    NetMsgType::SENDHEADERS, NetMsgType::FEEFILTER,    NetMsgType::SENDCMPCT,
    NetMsgType::CMPCTBLOCK,  NetMsgType::GETBLOCKTXN,  NetMsgType::BLOCKTXN,
    NetMsgType::GETCFILTERS, NetMsgType::CFILTER,      NetMsgType::GETCFHEADERS,
    NetMsgType::CFHEADERS,   NetMsgType::GETCFCHECKPT, NetMsgType::CFCHECKPT,
    NetMsgType::AVAHELLO,    NetMsgType::AVAPOLL,      NetMsgType::AVARESPONSE,
    NetMsgType::AVAPROOF,    NetMsgType::GETAVAADDR,   NetMsgType::GETAVAPROOFS,
    NetMsgType::AVAPROOFS,   NetMsgType::AVAPROOFSREQ,
}

All known message types.

Keep this in the same order as the list of messages above and in protocol.h.

Definition at line 71 of file protocol.cpp.

Namespaces

Functions

Variables

Function Documentation

◆ allNetMessageTypesVec()

◆ CheckHeaderMagicAndCommand()

◆ g_initial_block_download_completed()

◆ getAllNetMessageTypes()

◆ GetDesirableServiceFlags()

◆ serviceFlagsToStr()

◆ serviceFlagToStr()

◆ SetServiceFlagsIBDCache()

Variable Documentation

◆ allNetMessageTypes