Bitcoin Core  21.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-2020 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/strencodings.h>
9 #include <util/system.h>
10 
11 static std::atomic<bool> g_initial_block_download_completed(false);
12 
13 namespace NetMsgType {
14 const char *VERSION="version";
15 const char *VERACK="verack";
16 const char *ADDR="addr";
17 const char *ADDRV2="addrv2";
18 const char *SENDADDRV2="sendaddrv2";
19 const char *INV="inv";
20 const char *GETDATA="getdata";
21 const char *MERKLEBLOCK="merkleblock";
22 const char *GETBLOCKS="getblocks";
23 const char *GETHEADERS="getheaders";
24 const char *TX="tx";
25 const char *HEADERS="headers";
26 const char *BLOCK="block";
27 const char *GETADDR="getaddr";
28 const char *MEMPOOL="mempool";
29 const char *PING="ping";
30 const char *PONG="pong";
31 const char *NOTFOUND="notfound";
32 const char *FILTERLOAD="filterload";
33 const char *FILTERADD="filteradd";
34 const char *FILTERCLEAR="filterclear";
35 const char *SENDHEADERS="sendheaders";
36 const char *FEEFILTER="feefilter";
37 const char *SENDCMPCT="sendcmpct";
38 const char *CMPCTBLOCK="cmpctblock";
39 const char *GETBLOCKTXN="getblocktxn";
40 const char *BLOCKTXN="blocktxn";
41 const char *GETCFILTERS="getcfilters";
42 const char *CFILTER="cfilter";
43 const char *GETCFHEADERS="getcfheaders";
44 const char *CFHEADERS="cfheaders";
45 const char *GETCFCHECKPT="getcfcheckpt";
46 const char *CFCHECKPT="cfcheckpt";
47 const char *WTXIDRELAY="wtxidrelay";
48 } // namespace NetMsgType
49 
53 const static std::string allNetMessageTypes[] = {
88 };
90 
92 {
93  memset(pchMessageStart, 0, MESSAGE_START_SIZE);
94  memset(pchCommand, 0, sizeof(pchCommand));
95  nMessageSize = -1;
96  memset(pchChecksum, 0, CHECKSUM_SIZE);
97 }
98 
99 CMessageHeader::CMessageHeader(const MessageStartChars& pchMessageStartIn, const char* pszCommand, unsigned int nMessageSizeIn)
100 {
101  memcpy(pchMessageStart, pchMessageStartIn, MESSAGE_START_SIZE);
102 
103  // Copy the command name, zero-padding to COMMAND_SIZE bytes
104  size_t i = 0;
105  for (; i < COMMAND_SIZE && pszCommand[i] != 0; ++i) pchCommand[i] = pszCommand[i];
106  assert(pszCommand[i] == 0); // Assert that the command name passed in is not longer than COMMAND_SIZE
107  for (; i < COMMAND_SIZE; ++i) pchCommand[i] = 0;
108 
109  nMessageSize = nMessageSizeIn;
110  memset(pchChecksum, 0, CHECKSUM_SIZE);
111 }
112 
113 std::string CMessageHeader::GetCommand() const
114 {
115  return std::string(pchCommand, pchCommand + strnlen(pchCommand, COMMAND_SIZE));
116 }
117 
119 {
120  // Check the command string for errors
121  for (const char* p1 = pchCommand; p1 < pchCommand + COMMAND_SIZE; ++p1) {
122  if (*p1 == 0) {
123  // Must be all zeros after the first zero
124  for (; p1 < pchCommand + COMMAND_SIZE; ++p1) {
125  if (*p1 != 0) {
126  return false;
127  }
128  }
129  } else if (*p1 < ' ' || *p1 > 0x7E) {
130  return false;
131  }
132  }
133 
134  return true;
135 }
136 
137 
140  return ServiceFlags(NODE_NETWORK_LIMITED | NODE_WITNESS);
141  }
143 }
144 
145 void SetServiceFlagsIBDCache(bool state) {
147 }
148 
150 {
151  type = 0;
152  hash.SetNull();
153 }
154 
155 CInv::CInv(uint32_t typeIn, const uint256& hashIn) : type(typeIn), hash(hashIn) {}
156 
157 bool operator<(const CInv& a, const CInv& b)
158 {
159  return (a.type < b.type || (a.type == b.type && a.hash < b.hash));
160 }
161 
162 std::string CInv::GetCommand() const
163 {
164  std::string cmd;
165  if (type & MSG_WITNESS_FLAG)
166  cmd.append("witness-");
167  int masked = type & MSG_TYPE_MASK;
168  switch (masked)
169  {
170  case MSG_TX: return cmd.append(NetMsgType::TX);
171  // WTX is not a message type, just an inv type
172  case MSG_WTX: return cmd.append("wtx");
173  case MSG_BLOCK: return cmd.append(NetMsgType::BLOCK);
174  case MSG_FILTERED_BLOCK: return cmd.append(NetMsgType::MERKLEBLOCK);
175  case MSG_CMPCT_BLOCK: return cmd.append(NetMsgType::CMPCTBLOCK);
176  default:
177  throw std::out_of_range(strprintf("CInv::GetCommand(): type=%d unknown type", type));
178  }
179 }
180 
181 std::string CInv::ToString() const
182 {
183  try {
184  return strprintf("%s %s", GetCommand(), hash.ToString());
185  } catch(const std::out_of_range &) {
186  return strprintf("0x%08x %s", type, hash.ToString());
187  }
188 }
189 
190 const std::vector<std::string> &getAllNetMessageTypes()
191 {
192  return allNetMessageTypesVec;
193 }
194 
200 static std::string serviceFlagToStr(size_t bit)
201 {
202  const uint64_t service_flag = 1ULL << bit;
203  switch ((ServiceFlags)service_flag) {
204  case NODE_NONE: abort(); // impossible
205  case NODE_NETWORK: return "NETWORK";
206  case NODE_BLOOM: return "BLOOM";
207  case NODE_WITNESS: return "WITNESS";
208  case NODE_COMPACT_FILTERS: return "COMPACT_FILTERS";
209  case NODE_NETWORK_LIMITED: return "NETWORK_LIMITED";
210  // Not using default, so we get warned when a case is missing
211  }
212 
213  std::ostringstream stream;
214  stream.imbue(std::locale::classic());
215  stream << "UNKNOWN[";
216  stream << "2^" << bit;
217  stream << "]";
218  return stream.str();
219 }
220 
221 std::vector<std::string> serviceFlagsToStr(uint64_t flags)
222 {
223  std::vector<std::string> str_flags;
224 
225  for (size_t i = 0; i < sizeof(flags) * 8; ++i) {
226  if (flags & (1ULL << i)) {
227  str_flags.emplace_back(serviceFlagToStr(i));
228  }
229  }
230 
231  return str_flags;
232 }
233 
234 GenTxid ToGenTxid(const CInv& inv)
235 {
236  assert(inv.IsGenTxMsg());
237  return {inv.IsMsgWtx(), inv.hash};
238 }
const char * GETCFILTERS
getcfilters requests compact filters for a range of blocks.
Definition: protocol.cpp:41
bool IsMsgWtx() const
Definition: protocol.h:439
const char * PING
The ping message is sent periodically to help confirm that the receiving peer is still connected...
Definition: protocol.cpp:29
const char * FILTERLOAD
The filterload message tells the receiving peer to filter all relayed transactions and requested merk...
Definition: protocol.cpp:32
const char * MERKLEBLOCK
The merkleblock message is a reply to a getdata message which requested a block using the inventory t...
Definition: protocol.cpp:21
const char * BLOCKTXN
Contains a BlockTransactions.
Definition: protocol.cpp:40
const char * SENDADDRV2
The sendaddrv2 message signals support for receiving ADDRV2 messages (BIP155).
Definition: protocol.cpp:18
static const std::string allNetMessageTypes[]
All known message types.
Definition: protocol.cpp:53
ServiceFlags
nServices flags
Definition: protocol.h:269
assert(!tx.IsCoinBase())
std::string GetCommand() const
Definition: protocol.cpp:162
std::string ToString() const
Definition: protocol.cpp:181
const char * GETADDR
The getaddr message requests an addr message from the receiving node, preferably one with lots of IP ...
Definition: protocol.cpp:27
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1164
inv message data
Definition: protocol.h:423
const char * SENDCMPCT
Contains a 1-byte bool and 8-byte LE version number.
Definition: protocol.cpp:37
static const std::vector< std::string > allNetMessageTypesVec(allNetMessageTypes, allNetMessageTypes+ARRAYLEN(allNetMessageTypes))
#define ARRAYLEN(array)
Utilities for converting data from/to strings.
Definition: strencodings.h:20
const char * CFHEADERS
cfheaders is a response to a getcfheaders request containing a filter header and a vector of filter h...
Definition: protocol.cpp:44
Defined in BIP152.
Definition: protocol.h:414
void SetServiceFlagsIBDCache(bool state)
Set the current IBD status in order to figure out the desirable service flags.
Definition: protocol.cpp:145
std::vector< std::string > serviceFlagsToStr(uint64_t flags)
Convert service flags (a bitmask of NODE_*) to human readable strings.
Definition: protocol.cpp:221
const uint32_t MSG_WITNESS_FLAG
getdata message type flags
Definition: protocol.h:400
const char * CFILTER
cfilter is a response to a getcfilters request containing a single compact filter.
Definition: protocol.cpp:42
const uint32_t MSG_TYPE_MASK
Definition: protocol.h:401
std::string GetCommand() const
Definition: protocol.cpp:113
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:30
const char * WTXIDRELAY
Indicates that a node prefers to relay transactions via wtxid, rather than txid.
Definition: protocol.cpp:47
const char * HEADERS
The headers message sends one or more block headers to a node which previously requested certain head...
Definition: protocol.cpp:25
const char * GETCFCHECKPT
getcfcheckpt requests evenly spaced compact filter headers, enabling parallelized download and valida...
Definition: protocol.cpp:45
const char * INV
The inv message (inventory message) transmits one or more inventories of objects known to the transmi...
Definition: protocol.cpp:19
bool IsCommandValid() const
Definition: protocol.cpp:118
static std::atomic< bool > g_initial_block_download_completed(false)
GenTxid ToGenTxid(const CInv &inv)
Convert a TX/WITNESS_TX/WTX CInv to a GenTxid.
Definition: protocol.cpp:234
const char * GETHEADERS
The getheaders message requests a headers message that provides block headers starting from a particu...
Definition: protocol.cpp:23
Bitcoin protocol message types.
Definition: protocol.cpp:13
const char * ADDRV2
The addrv2 message relays connection information for peers on the network just like the addr message...
Definition: protocol.cpp:17
const char * SENDHEADERS
Indicates that a node prefers to receive new block announcements via a "headers" message rather than ...
Definition: protocol.cpp:35
const char * MEMPOOL
The mempool message requests the TXIDs of transactions that the receiving node has verified as valid ...
Definition: protocol.cpp:28
bool IsGenTxMsg() const
Definition: protocol.h:445
const std::vector< std::string > & getAllNetMessageTypes()
Definition: protocol.cpp:190
uint256 hash
Definition: protocol.h:455
const char * ADDR
The addr (IP address) message relays connection information for peers on the network.
Definition: protocol.cpp:16
const char * FILTERCLEAR
The filterclear message tells the receiving peer to remove a previously-set bloom filter...
Definition: protocol.cpp:34
std::string ToString() const
Definition: uint256.cpp:64
const char * NOTFOUND
The notfound message is a reply to a getdata message which requested an object the receiving node doe...
Definition: protocol.cpp:31
const char * BLOCK
The block message transmits a single serialized block.
Definition: protocol.cpp:26
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:36
const char * GETCFHEADERS
getcfheaders requests a compact filter header and the filter hashes for a range of blocks...
Definition: protocol.cpp:43
const char * GETBLOCKS
The getblocks message requests an inv message that provides block header hashes starting from a parti...
Definition: protocol.cpp:22
int flags
Definition: bitcoin-tx.cpp:512
static std::string serviceFlagToStr(size_t bit)
Convert a service flag (NODE_*) to a human readable string.
Definition: protocol.cpp:200
const char * VERACK
The verack message acknowledges a previously-received version message, informing the connecting node ...
Definition: protocol.cpp:15
256-bit opaque blob.
Definition: uint256.h:124
const char * CMPCTBLOCK
Contains a CBlockHeaderAndShortTxIDs object - providing a header and list of "short txids"...
Definition: protocol.cpp:38
const char * VERSION
The version message provides information about the transmitting node to the receiving node at the beg...
Definition: protocol.cpp:14
void * memcpy(void *a, const void *b, size_t c)
size_t strnlen(const char *start, size_t max_len)
Definition: strnlen.cpp:12
ServiceFlags GetDesirableServiceFlags(ServiceFlags services)
Gets the set of service flags which are "desirable" for a given peer.
Definition: protocol.cpp:138
uint32_t type
Definition: protocol.h:454
const char * GETDATA
The getdata message requests one or more data objects from another node.
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:46
CInv()
Definition: protocol.cpp:149
const char * TX
The tx message transmits a single transaction.
Definition: protocol.cpp:24
Defined in BIP37.
Definition: protocol.h:413
Defined in BIP 339.
Definition: protocol.h:411
friend bool operator<(const CInv &a, const CInv &b)
Definition: protocol.cpp:157
A generic txid reference (txid or wtxid).
Definition: transaction.h:390
const char * FILTERADD
The filteradd message tells the receiving peer to add a single element to a previously-set bloom filt...
Definition: protocol.cpp:33
const char * GETBLOCKTXN
Contains a BlockTransactionsRequest Peer should respond with "blocktxn" message.
Definition: protocol.cpp:39