Bitcoin Core  24.99.0
P2P Digital Currency
protocol.cpp
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2022 The Bitcoin Core developers
3 // Distributed under the MIT software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 
6 #include <protocol.h>
7 
8 #include <util/system.h>
9 
10 static std::atomic<bool> g_initial_block_download_completed(false);
11 
12 namespace NetMsgType {
13 const char *VERSION="version";
14 const char *VERACK="verack";
15 const char *ADDR="addr";
16 const char *ADDRV2="addrv2";
17 const char *SENDADDRV2="sendaddrv2";
18 const char *INV="inv";
19 const char *GETDATA="getdata";
20 const char *MERKLEBLOCK="merkleblock";
21 const char *GETBLOCKS="getblocks";
22 const char *GETHEADERS="getheaders";
23 const char *TX="tx";
24 const char *HEADERS="headers";
25 const char *BLOCK="block";
26 const char *GETADDR="getaddr";
27 const char *MEMPOOL="mempool";
28 const char *PING="ping";
29 const char *PONG="pong";
30 const char *NOTFOUND="notfound";
31 const char *FILTERLOAD="filterload";
32 const char *FILTERADD="filteradd";
33 const char *FILTERCLEAR="filterclear";
34 const char *SENDHEADERS="sendheaders";
35 const char *FEEFILTER="feefilter";
36 const char *SENDCMPCT="sendcmpct";
37 const char *CMPCTBLOCK="cmpctblock";
38 const char *GETBLOCKTXN="getblocktxn";
39 const char *BLOCKTXN="blocktxn";
40 const char *GETCFILTERS="getcfilters";
41 const char *CFILTER="cfilter";
42 const char *GETCFHEADERS="getcfheaders";
43 const char *CFHEADERS="cfheaders";
44 const char *GETCFCHECKPT="getcfcheckpt";
45 const char *CFCHECKPT="cfcheckpt";
46 const char *WTXIDRELAY="wtxidrelay";
47 const char *SENDTXRCNCL="sendtxrcncl";
48 } // namespace NetMsgType
49 
53 const static std::string allNetMessageTypes[] = {
89 };
90 const static std::vector<std::string> allNetMessageTypesVec(std::begin(allNetMessageTypes), std::end(allNetMessageTypes));
91 
92 CMessageHeader::CMessageHeader(const MessageStartChars& pchMessageStartIn, const char* pszCommand, unsigned int nMessageSizeIn)
93 {
94  memcpy(pchMessageStart, pchMessageStartIn, MESSAGE_START_SIZE);
95 
96  // Copy the command name
97  size_t i = 0;
98  for (; i < COMMAND_SIZE && pszCommand[i] != 0; ++i) pchCommand[i] = pszCommand[i];
99  assert(pszCommand[i] == 0); // Assert that the command name passed in is not longer than COMMAND_SIZE
100 
101  nMessageSize = nMessageSizeIn;
102 }
103 
104 std::string CMessageHeader::GetCommand() const
105 {
106  return std::string(pchCommand, pchCommand + strnlen(pchCommand, COMMAND_SIZE));
107 }
108 
110 {
111  // Check the command string for errors
112  for (const char* p1 = pchCommand; p1 < pchCommand + COMMAND_SIZE; ++p1) {
113  if (*p1 == 0) {
114  // Must be all zeros after the first zero
115  for (; p1 < pchCommand + COMMAND_SIZE; ++p1) {
116  if (*p1 != 0) {
117  return false;
118  }
119  }
120  } else if (*p1 < ' ' || *p1 > 0x7E) {
121  return false;
122  }
123  }
124 
125  return true;
126 }
127 
128 
132  }
134 }
135 
136 void SetServiceFlagsIBDCache(bool state) {
138 }
139 
141 {
142  type = 0;
143  hash.SetNull();
144 }
145 
146 CInv::CInv(uint32_t typeIn, const uint256& hashIn) : type(typeIn), hash(hashIn) {}
147 
148 bool operator<(const CInv& a, const CInv& b)
149 {
150  return (a.type < b.type || (a.type == b.type && a.hash < b.hash));
151 }
152 
153 std::string CInv::GetCommand() const
154 {
155  std::string cmd;
156  if (type & MSG_WITNESS_FLAG)
157  cmd.append("witness-");
158  int masked = type & MSG_TYPE_MASK;
159  switch (masked)
160  {
161  case MSG_TX: return cmd.append(NetMsgType::TX);
162  // WTX is not a message type, just an inv type
163  case MSG_WTX: return cmd.append("wtx");
164  case MSG_BLOCK: return cmd.append(NetMsgType::BLOCK);
165  case MSG_FILTERED_BLOCK: return cmd.append(NetMsgType::MERKLEBLOCK);
166  case MSG_CMPCT_BLOCK: return cmd.append(NetMsgType::CMPCTBLOCK);
167  default:
168  throw std::out_of_range(strprintf("CInv::GetCommand(): type=%d unknown type", type));
169  }
170 }
171 
172 std::string CInv::ToString() const
173 {
174  try {
175  return strprintf("%s %s", GetCommand(), hash.ToString());
176  } catch(const std::out_of_range &) {
177  return strprintf("0x%08x %s", type, hash.ToString());
178  }
179 }
180 
181 const std::vector<std::string> &getAllNetMessageTypes()
182 {
183  return allNetMessageTypesVec;
184 }
185 
191 static std::string serviceFlagToStr(size_t bit)
192 {
193  const uint64_t service_flag = 1ULL << bit;
194  switch ((ServiceFlags)service_flag) {
195  case NODE_NONE: abort(); // impossible
196  case NODE_NETWORK: return "NETWORK";
197  case NODE_BLOOM: return "BLOOM";
198  case NODE_WITNESS: return "WITNESS";
199  case NODE_COMPACT_FILTERS: return "COMPACT_FILTERS";
200  case NODE_NETWORK_LIMITED: return "NETWORK_LIMITED";
201  // Not using default, so we get warned when a case is missing
202  }
203 
204  return strprintf("UNKNOWN[2^%u]", bit);
205 }
206 
207 std::vector<std::string> serviceFlagsToStr(uint64_t flags)
208 {
209  std::vector<std::string> str_flags;
210 
211  for (size_t i = 0; i < sizeof(flags) * 8; ++i) {
212  if (flags & (1ULL << i)) {
213  str_flags.emplace_back(serviceFlagToStr(i));
214  }
215  }
216 
217  return str_flags;
218 }
219 
220 GenTxid ToGenTxid(const CInv& inv)
221 {
222  assert(inv.IsGenTxMsg());
223  return inv.IsMsgWtx() ? GenTxid::Wtxid(inv.hash) : GenTxid::Txid(inv.hash);
224 }
int flags
Definition: bitcoin-tx.cpp:525
const auto cmd
inv message data
Definition: protocol.h:478
std::string ToString() const
Definition: protocol.cpp:172
std::string GetCommand() const
Definition: protocol.cpp:153
bool IsMsgWtx() const
Definition: protocol.h:493
CInv()
Definition: protocol.cpp:140
uint32_t type
Definition: protocol.h:508
bool IsGenTxMsg() const
Definition: protocol.h:499
uint256 hash
Definition: protocol.h:509
char pchMessageStart[MESSAGE_START_SIZE]
Definition: protocol.h:50
CMessageHeader()=default
char pchCommand[COMMAND_SIZE]
Definition: protocol.h:51
static constexpr size_t MESSAGE_START_SIZE
Definition: protocol.h:29
std::string GetCommand() const
Definition: protocol.cpp:104
static constexpr size_t COMMAND_SIZE
Definition: protocol.h:30
uint32_t nMessageSize
Definition: protocol.h:52
bool IsCommandValid() const
Definition: protocol.cpp:109
A generic txid reference (txid or wtxid).
Definition: transaction.h:426
static GenTxid Wtxid(const uint256 &hash)
Definition: transaction.h:433
static GenTxid Txid(const uint256 &hash)
Definition: transaction.h:432
std::string ToString() const
Definition: uint256.cpp:64
void SetNull()
Definition: uint256.h:42
256-bit opaque blob.
Definition: uint256.h:119
Bitcoin protocol message types.
Definition: protocol.cpp:12
const char * FILTERLOAD
The filterload message tells the receiving peer to filter all relayed transactions and requested merk...
Definition: protocol.cpp:31
const char * CFHEADERS
cfheaders is a response to a getcfheaders request containing a filter header and a vector of filter h...
Definition: protocol.cpp:43
const char * CFILTER
cfilter is a response to a getcfilters request containing a single compact filter.
Definition: protocol.cpp:41
const char * BLOCK
The block message transmits a single serialized block.
Definition: protocol.cpp:25
const char * FILTERCLEAR
The filterclear message tells the receiving peer to remove a previously-set bloom filter.
Definition: protocol.cpp:33
const char * HEADERS
The headers message sends one or more block headers to a node which previously requested certain head...
Definition: protocol.cpp:24
const char * ADDRV2
The addrv2 message relays connection information for peers on the network just like the addr message,...
Definition: protocol.cpp:16
const char * SENDHEADERS
Indicates that a node prefers to receive new block announcements via a "headers" message rather than ...
Definition: protocol.cpp:34
const char * PONG
The pong message replies to a ping message, proving to the pinging node that the ponging node is stil...
Definition: protocol.cpp:29
const char * SENDCMPCT
Contains a 1-byte bool and 8-byte LE version number.
Definition: protocol.cpp:36
const char * GETADDR
The getaddr message requests an addr message from the receiving node, preferably one with lots of IP ...
Definition: protocol.cpp:26
const char * GETCFCHECKPT
getcfcheckpt requests evenly spaced compact filter headers, enabling parallelized download and valida...
Definition: protocol.cpp:44
const char * NOTFOUND
The notfound message is a reply to a getdata message which requested an object the receiving node doe...
Definition: protocol.cpp:30
const char * CMPCTBLOCK
Contains a CBlockHeaderAndShortTxIDs object - providing a header and list of "short txids".
Definition: protocol.cpp:37
const char * SENDTXRCNCL
Contains a 4-byte version number and an 8-byte salt.
Definition: protocol.cpp:47
const char * MEMPOOL
The mempool message requests the TXIDs of transactions that the receiving node has verified as valid ...
Definition: protocol.cpp:27
const char * GETCFILTERS
getcfilters requests compact filters for a range of blocks.
Definition: protocol.cpp:40
const char * TX
The tx message transmits a single transaction.
Definition: protocol.cpp:23
const char * FILTERADD
The filteradd message tells the receiving peer to add a single element to a previously-set bloom filt...
Definition: protocol.cpp:32
const char * ADDR
The addr (IP address) message relays connection information for peers on the network.
Definition: protocol.cpp:15
const char * VERSION
The version message provides information about the transmitting node to the receiving node at the beg...
Definition: protocol.cpp:13
const char * GETBLOCKS
The getblocks message requests an inv message that provides block header hashes starting from a parti...
Definition: protocol.cpp:21
const char * FEEFILTER
The feefilter message tells the receiving peer not to inv us any txs which do not meet the specified ...
Definition: protocol.cpp:35
const char * GETHEADERS
The getheaders message requests a headers message that provides block headers starting from a particu...
Definition: protocol.cpp:22
const char * GETDATA
The getdata message requests one or more data objects from another node.
Definition: protocol.cpp:19
const char * VERACK
The verack message acknowledges a previously-received version message, informing the connecting node ...
Definition: protocol.cpp:14
const char * BLOCKTXN
Contains a BlockTransactions.
Definition: protocol.cpp:39
const char * GETCFHEADERS
getcfheaders requests a compact filter header and the filter hashes for a range of blocks,...
Definition: protocol.cpp:42
const char * SENDADDRV2
The sendaddrv2 message signals support for receiving ADDRV2 messages (BIP155).
Definition: protocol.cpp:17
const char * WTXIDRELAY
Indicates that a node prefers to relay transactions via wtxid, rather than txid.
Definition: protocol.cpp:46
const char * PING
The ping message is sent periodically to help confirm that the receiving peer is still connected.
Definition: protocol.cpp:28
const char * MERKLEBLOCK
The merkleblock message is a reply to a getdata message which requested a block using the inventory t...
Definition: protocol.cpp:20
const char * CFCHECKPT
cfcheckpt is a response to a getcfcheckpt request containing a vector of evenly spaced filter headers...
Definition: protocol.cpp:45
const char * GETBLOCKTXN
Contains a BlockTransactionsRequest Peer should respond with "blocktxn" message.
Definition: protocol.cpp:38
const char * INV
The inv message (inventory message) transmits one or more inventories of objects known to the transmi...
Definition: protocol.cpp:18
void SetServiceFlagsIBDCache(bool state)
Set the current IBD status in order to figure out the desirable service flags.
Definition: protocol.cpp:136
bool operator<(const CInv &a, const CInv &b)
Definition: protocol.cpp:148
GenTxid ToGenTxid(const CInv &inv)
Convert a TX/WITNESS_TX/WTX CInv to a GenTxid.
Definition: protocol.cpp:220
ServiceFlags GetDesirableServiceFlags(ServiceFlags services)
Gets the set of service flags which are "desirable" for a given peer.
Definition: protocol.cpp:129
const std::vector< std::string > & getAllNetMessageTypes()
Definition: protocol.cpp:181
static std::string serviceFlagToStr(size_t bit)
Convert a service flag (NODE_*) to a human readable string.
Definition: protocol.cpp:191
static std::atomic< bool > g_initial_block_download_completed(false)
static const std::vector< std::string > allNetMessageTypesVec(std::begin(allNetMessageTypes), std::end(allNetMessageTypes))
std::vector< std::string > serviceFlagsToStr(uint64_t flags)
Convert service flags (a bitmask of NODE_*) to human readable strings.
Definition: protocol.cpp:207
static const std::string allNetMessageTypes[]
All known message types.
Definition: protocol.cpp:53
const uint32_t MSG_WITNESS_FLAG
getdata message type flags
Definition: protocol.h:454
const uint32_t MSG_TYPE_MASK
Definition: protocol.h:455
@ MSG_TX
Definition: protocol.h:463
@ MSG_FILTERED_BLOCK
Defined in BIP37.
Definition: protocol.h:467
@ MSG_WTX
Defined in BIP 339.
Definition: protocol.h:465
@ MSG_BLOCK
Definition: protocol.h:464
@ MSG_CMPCT_BLOCK
Defined in BIP152.
Definition: protocol.h:468
ServiceFlags
nServices flags
Definition: protocol.h:273
@ NODE_NONE
Definition: protocol.h:276
@ NODE_WITNESS
Definition: protocol.h:286
@ NODE_NETWORK_LIMITED
Definition: protocol.h:293
@ NODE_BLOOM
Definition: protocol.h:283
@ NODE_NETWORK
Definition: protocol.h:279
@ NODE_COMPACT_FILTERS
Definition: protocol.h:289
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1162
assert(!tx.IsCoinBase())