Bitcoin ABC  0.26.3
P2P Digital Currency
protocol.h
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2019 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 #ifndef __cplusplus
7 #error This header can only be compiled as C++.
8 #endif
9 
10 #ifndef BITCOIN_PROTOCOL_H
11 #define BITCOIN_PROTOCOL_H
12 
13 #include <netaddress.h>
14 #include <serialize.h>
15 #include <uint256.h>
16 #include <version.h>
17 
18 #include <array>
19 #include <cstdint>
20 #include <string>
21 
22 class Config;
23 
28 static const unsigned int MAX_PROTOCOL_MESSAGE_LENGTH = 2 * 1024 * 1024;
29 
38 public:
39  static constexpr size_t MESSAGE_START_SIZE = 4;
40  static constexpr size_t COMMAND_SIZE = 12;
41  static constexpr size_t MESSAGE_SIZE_SIZE = 4;
42  static constexpr size_t CHECKSUM_SIZE = 4;
43  static constexpr size_t MESSAGE_SIZE_OFFSET =
45  static constexpr size_t CHECKSUM_OFFSET =
47  static constexpr size_t HEADER_SIZE =
49  typedef std::array<uint8_t, MESSAGE_START_SIZE> MessageMagic;
50 
51  explicit CMessageHeader(const MessageMagic &pchMessageStartIn);
52 
59  CMessageHeader(const MessageMagic &pchMessageStartIn,
60  const char *pszCommand, unsigned int nMessageSizeIn);
61 
62  std::string GetCommand() const;
63  bool IsValid(const Config &config) const;
64  bool IsValidWithoutConfig(const MessageMagic &magic) const;
65  bool IsOversized(const Config &config) const;
66 
68  READWRITE(obj.pchMessageStart, obj.pchCommand, obj.nMessageSize,
69  obj.pchChecksum);
70  }
71 
73  std::array<char, COMMAND_SIZE> pchCommand;
74  uint32_t nMessageSize;
76 };
77 
82 namespace NetMsgType {
83 
88 extern const char *VERSION;
93 extern const char *VERACK;
98 extern const char *ADDR;
104 extern const char *ADDRV2;
111 extern const char *SENDADDRV2;
116 extern const char *INV;
120 extern const char *GETDATA;
126 extern const char *MERKLEBLOCK;
131 extern const char *GETBLOCKS;
137 extern const char *GETHEADERS;
141 extern const char *TX;
147 extern const char *HEADERS;
151 extern const char *BLOCK;
156 extern const char *GETADDR;
162 extern const char *MEMPOOL;
167 extern const char *PING;
173 extern const char *PONG;
179 extern const char *NOTFOUND;
187 extern const char *FILTERLOAD;
195 extern const char *FILTERADD;
203 extern const char *FILTERCLEAR;
209 extern const char *SENDHEADERS;
215 extern const char *FEEFILTER;
223 extern const char *SENDCMPCT;
229 extern const char *CMPCTBLOCK;
235 extern const char *GETBLOCKTXN;
241 extern const char *BLOCKTXN;
247 extern const char *GETCFILTERS;
252 extern const char *CFILTER;
260 extern const char *GETCFHEADERS;
266 extern const char *CFHEADERS;
273 extern const char *GETCFCHECKPT;
278 extern const char *CFCHECKPT;
282 extern const char *AVAHELLO;
287 extern const char *AVAPOLL;
292 extern const char *AVARESPONSE;
298 extern const char *AVAPROOF;
299 
304 extern const char *GETAVAADDR;
305 
310 extern const char *GETAVAPROOFS;
311 
316 extern const char *AVAPROOFS;
317 
322 extern const char *AVAPROOFSREQ;
323 
329 bool IsBlockLike(const std::string &strCommand);
330 }; // namespace NetMsgType
331 
333 const std::vector<std::string> &getAllNetMessageTypes();
334 
338 enum ServiceFlags : uint64_t {
339  // NOTE: When adding here, be sure to update serviceFlagToStr too
340  // Nothing
342  // NODE_NETWORK means that the node is capable of serving the complete block
343  // chain. It is currently set by all Bitcoin ABC non pruned nodes, and is
344  // unset by SPV clients or other light clients.
345  NODE_NETWORK = (1 << 0),
346  // NODE_GETUTXO means the node is capable of responding to the getutxo
347  // protocol request. Bitcoin ABC does not support this but a patch set
348  // called Bitcoin XT does. See BIP 64 for details on how this is
349  // implemented.
350  NODE_GETUTXO = (1 << 1),
351  // NODE_BLOOM means the node is capable and willing to handle bloom-filtered
352  // connections. Bitcoin ABC nodes used to support this by default, without
353  // advertising this bit, but no longer do as of protocol version 70011 (=
354  // NO_BLOOM_VERSION)
355  NODE_BLOOM = (1 << 2),
356  // Bit 4 was NODE_XTHIN, removed in v0.22.12
357 
358  // Bit 5 was NODE_BITCOIN_CASH, removed in v0.22.8
359 
360  // NODE_COMPACT_FILTERS means the node will service basic block filter
361  // requests.
362  // See BIP157 and BIP158 for details on how this is implemented.
364 
365  // NODE_NETWORK_LIMITED means the same as NODE_NETWORK with the limitation
366  // of only serving the last 288 (2 day) blocks
367  // See BIP159 for details on how this is implemented.
368  NODE_NETWORK_LIMITED = (1 << 10),
369 
370  // The last non experimental service bit, helper for looping over the flags
372 
373  // Bits 24-31 are reserved for temporary experiments. Just pick a bit that
374  // isn't getting used, or one not being used much, and notify the
375  // bitcoin-development mailing list. Remember that service bits are just
376  // unauthenticated advertisements, so your code must be robust against
377  // collisions and other cases where nodes may be advertising a service they
378  // do not actually support. Other service bits should be allocated via the
379  // BIP process.
380 
381  // NODE_AVALANCHE means the node supports Bitcoin Cash's avalanche
382  // preconsensus mechanism.
383  NODE_AVALANCHE = (1 << 24),
384 };
385 
391 std::vector<std::string> serviceFlagsToStr(const uint64_t flags);
392 
418 
423 void SetServiceFlagsIBDCache(bool status);
424 
430 static inline bool HasAllDesirableServiceFlags(ServiceFlags services) {
431  return !(GetDesirableServiceFlags(services) & (~services));
432 }
433 
438 static inline bool MayHaveUsefulAddressDB(ServiceFlags services) {
439  return (services & NODE_NETWORK) || (services & NODE_NETWORK_LIMITED);
440 }
441 
445 class CAddress : public CService {
446  static constexpr uint32_t TIME_INIT{100000000};
447 
448 public:
449  CAddress() : CService{} {};
450  CAddress(CService ipIn, ServiceFlags nServicesIn)
451  : CService{ipIn}, nServices{nServicesIn} {};
452  CAddress(CService ipIn, ServiceFlags nServicesIn, uint32_t nTimeIn)
453  : CService{ipIn}, nTime{nTimeIn}, nServices{nServicesIn} {};
454 
455  void Init();
456 
458  SER_READ(obj, obj.nTime = TIME_INIT);
459  int nVersion = s.GetVersion();
460  if (s.GetType() & SER_DISK) {
461  READWRITE(nVersion);
462  }
463  if ((s.GetType() & SER_DISK) ||
464  (nVersion != INIT_PROTO_VERSION && !(s.GetType() & SER_GETHASH))) {
465  // The only time we serialize a CAddress object without nTime is in
466  // the initial VERSION messages which contain two CAddress records.
467  // At that point, the serialization version is INIT_PROTO_VERSION.
468  // After the version handshake, serialization version is >=
469  // MIN_PEER_PROTO_VERSION and all ADDR messages are serialized with
470  // nTime.
471  READWRITE(obj.nTime);
472  }
473  if (nVersion & ADDRV2_FORMAT) {
474  uint64_t services_tmp;
475  SER_WRITE(obj, services_tmp = obj.nServices);
477  SER_READ(obj,
478  obj.nServices = static_cast<ServiceFlags>(services_tmp));
479  } else {
480  READWRITE(Using<CustomUintFormatter<8>>(obj.nServices));
481  }
482  READWRITEAS(CService, obj);
483  }
484 
485  // disk and network only
486  uint32_t nTime{TIME_INIT};
487 
489 };
490 
492 const uint32_t MSG_TYPE_MASK = 0xffffffff >> 3;
493 
501  MSG_TX = 1,
503  // The following can only occur in getdata. Invs always use TX or BLOCK.
508  MSG_AVA_PROOF = 0x1f000001,
509 };
510 
516 class CInv {
517 public:
518  uint32_t type;
520 
521  CInv() : type(0), hash() {}
522  CInv(uint32_t typeIn, const uint256 &hashIn) : type(typeIn), hash(hashIn) {}
523 
524  SERIALIZE_METHODS(CInv, obj) { READWRITE(obj.type, obj.hash); }
525 
526  friend bool operator<(const CInv &a, const CInv &b) {
527  return a.type < b.type || (a.type == b.type && a.hash < b.hash);
528  }
529 
530  std::string GetCommand() const;
531  std::string ToString() const;
532 
533  uint32_t GetKind() const { return type & MSG_TYPE_MASK; }
534 
535  bool IsMsgTx() const {
536  auto k = GetKind();
537  return k == MSG_TX;
538  }
539  bool IsMsgProof() const {
540  auto k = GetKind();
541  return k == MSG_AVA_PROOF;
542  }
543  bool IsMsgBlk() const {
544  auto k = GetKind();
545  return k == MSG_BLOCK;
546  }
547  bool IsMsgFilteredBlk() const {
548  auto k = GetKind();
549  return k == MSG_FILTERED_BLOCK;
550  }
551  bool IsMsgCmpctBlk() const {
552  auto k = GetKind();
553  return k == MSG_CMPCT_BLOCK;
554  }
555 
556  bool IsGenBlkMsg() const {
557  auto k = GetKind();
558  return k == MSG_BLOCK || k == MSG_FILTERED_BLOCK ||
559  k == MSG_CMPCT_BLOCK;
560  }
561 };
562 
563 #endif // BITCOIN_PROTOCOL_H
int flags
Definition: bitcoin-tx.cpp:534
A CService with information about it as peer.
Definition: protocol.h:445
SERIALIZE_METHODS(CAddress, obj)
Definition: protocol.h:457
ServiceFlags nServices
Definition: protocol.h:488
CAddress()
Definition: protocol.h:449
uint32_t nTime
Definition: protocol.h:486
CAddress(CService ipIn, ServiceFlags nServicesIn)
Definition: protocol.h:450
void Init()
CAddress(CService ipIn, ServiceFlags nServicesIn, uint32_t nTimeIn)
Definition: protocol.h:452
static constexpr uint32_t TIME_INIT
Definition: protocol.h:446
Inv(ventory) message data.
Definition: protocol.h:516
bool IsMsgCmpctBlk() const
Definition: protocol.h:551
friend bool operator<(const CInv &a, const CInv &b)
Definition: protocol.h:526
uint32_t GetKind() const
Definition: protocol.h:533
bool IsMsgBlk() const
Definition: protocol.h:543
std::string ToString() const
Definition: protocol.cpp:238
std::string GetCommand() const
Definition: protocol.cpp:219
CInv()
Definition: protocol.h:521
uint32_t type
Definition: protocol.h:518
CInv(uint32_t typeIn, const uint256 &hashIn)
Definition: protocol.h:522
bool IsMsgTx() const
Definition: protocol.h:535
bool IsMsgFilteredBlk() const
Definition: protocol.h:547
uint256 hash
Definition: protocol.h:519
bool IsMsgProof() const
Definition: protocol.h:539
SERIALIZE_METHODS(CInv, obj)
Definition: protocol.h:524
bool IsGenBlkMsg() const
Definition: protocol.h:556
Message header.
Definition: protocol.h:37
static constexpr size_t MESSAGE_SIZE_OFFSET
Definition: protocol.h:43
static constexpr size_t CHECKSUM_OFFSET
Definition: protocol.h:45
bool IsValidWithoutConfig(const MessageMagic &magic) const
This is a transition method in order to stay compatible with older code that do not use the config.
Definition: protocol.cpp:174
bool IsValid(const Config &config) const
Definition: protocol.cpp:150
std::array< char, COMMAND_SIZE > pchCommand
Definition: protocol.h:73
static constexpr size_t CHECKSUM_SIZE
Definition: protocol.h:42
MessageMagic pchMessageStart
Definition: protocol.h:72
static constexpr size_t MESSAGE_SIZE_SIZE
Definition: protocol.h:41
bool IsOversized(const Config &config) const
Definition: protocol.cpp:191
static constexpr size_t HEADER_SIZE
Definition: protocol.h:47
uint8_t pchChecksum[CHECKSUM_SIZE]
Definition: protocol.h:75
static constexpr size_t MESSAGE_START_SIZE
Definition: protocol.h:39
std::string GetCommand() const
Definition: protocol.cpp:115
CMessageHeader(const MessageMagic &pchMessageStartIn)
Definition: protocol.cpp:87
SERIALIZE_METHODS(CMessageHeader, obj)
Definition: protocol.h:67
static constexpr size_t COMMAND_SIZE
Definition: protocol.h:40
uint32_t nMessageSize
Definition: protocol.h:74
std::array< uint8_t, MESSAGE_START_SIZE > MessageMagic
Definition: protocol.h:49
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:545
Definition: config.h:17
256-bit opaque blob.
Definition: uint256.h:127
Bitcoin protocol message types.
Definition: protocol.cpp:16
bool IsBlockLike(const std::string &strCommand)
Indicate if the message is used to transmit the content of a block.
Definition: protocol.cpp:59
const char * FILTERLOAD
The filterload message tells the receiving peer to filter all relayed transactions and requested merk...
Definition: protocol.cpp:35
const char * CFHEADERS
cfheaders is a response to a getcfheaders request containing a filter header and a vector of filter h...
Definition: protocol.cpp:47
const char * AVAPROOFSREQ
Request for missing avalanche proofs after an avaproofs message has been processed.
Definition: protocol.cpp:57
const char * CFILTER
cfilter is a response to a getcfilters request containing a single compact filter.
Definition: protocol.cpp:45
const char * BLOCK
The block message transmits a single serialized block.
Definition: protocol.cpp:29
const char * FILTERCLEAR
The filterclear message tells the receiving peer to remove a previously-set bloom filter.
Definition: protocol.cpp:37
const char * HEADERS
The headers message sends one or more block headers to a node which previously requested certain head...
Definition: protocol.cpp:28
const char * ADDRV2
The addrv2 message relays connection information for peers on the network just like the addr message,...
Definition: protocol.cpp:20
const char * SENDHEADERS
Indicates that a node prefers to receive new block announcements via a "headers" message rather than ...
Definition: protocol.cpp:38
const char * AVAPROOFS
The avaproofs message the proof short ids of all the valid proofs that we know.
Definition: protocol.cpp:56
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:33
const char * GETAVAPROOFS
The getavaproofs message requests an avaproofs message that provides the proof short ids of all the v...
Definition: protocol.cpp:55
const char * SENDCMPCT
Contains a 1-byte bool and 8-byte LE version number.
Definition: protocol.cpp:40
const char * GETADDR
The getaddr message requests an addr message from the receiving node, preferably one with lots of IP ...
Definition: protocol.cpp:30
const char * GETCFCHECKPT
getcfcheckpt requests evenly spaced compact filter headers, enabling parallelized download and valida...
Definition: protocol.cpp:48
const char * NOTFOUND
The notfound message is a reply to a getdata message which requested an object the receiving node doe...
Definition: protocol.cpp:34
const char * GETAVAADDR
The getavaaddr message requests an addr message from the receiving node, containing IP addresses of t...
Definition: protocol.cpp:54
const char * CMPCTBLOCK
Contains a CBlockHeaderAndShortTxIDs object - providing a header and list of "short txids".
Definition: protocol.cpp:41
const char * MEMPOOL
The mempool message requests the TXIDs of transactions that the receiving node has verified as valid ...
Definition: protocol.cpp:31
const char * GETCFILTERS
getcfilters requests compact filters for a range of blocks.
Definition: protocol.cpp:44
const char * TX
The tx message transmits a single transaction.
Definition: protocol.cpp:27
const char * AVAHELLO
Contains a delegation and a signature.
Definition: protocol.cpp:50
const char * FILTERADD
The filteradd message tells the receiving peer to add a single element to a previously-set bloom filt...
Definition: protocol.cpp:36
const char * ADDR
The addr (IP address) message relays connection information for peers on the network.
Definition: protocol.cpp:19
const char * VERSION
The version message provides information about the transmitting node to the receiving node at the beg...
Definition: protocol.cpp:17
const char * GETBLOCKS
The getblocks message requests an inv message that provides block header hashes starting from a parti...
Definition: protocol.cpp:25
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:39
const char * GETHEADERS
The getheaders message requests a headers message that provides block headers starting from a particu...
Definition: protocol.cpp:26
const char * AVARESPONSE
Contains an avalanche::Response.
Definition: protocol.cpp:52
const char * GETDATA
The getdata message requests one or more data objects from another node.
Definition: protocol.cpp:23
const char * VERACK
The verack message acknowledges a previously-received version message, informing the connecting node ...
Definition: protocol.cpp:18
const char * BLOCKTXN
Contains a BlockTransactions.
Definition: protocol.cpp:43
const char * GETCFHEADERS
getcfheaders requests a compact filter header and the filter hashes for a range of blocks,...
Definition: protocol.cpp:46
const char * SENDADDRV2
The sendaddrv2 message signals support for receiving ADDRV2 messages (BIP155).
Definition: protocol.cpp:21
const char * PING
The ping message is sent periodically to help confirm that the receiving peer is still connected.
Definition: protocol.cpp:32
const char * AVAPOLL
Contains an avalanche::Poll.
Definition: protocol.cpp:51
const char * MERKLEBLOCK
The merkleblock message is a reply to a getdata message which requested a block using the inventory t...
Definition: protocol.cpp:24
const char * AVAPROOF
Contains an avalanche::Proof.
Definition: protocol.cpp:53
const char * CFCHECKPT
cfcheckpt is a response to a getcfcheckpt request containing a vector of evenly spaced filter headers...
Definition: protocol.cpp:49
const char * GETBLOCKTXN
Contains a BlockTransactionsRequest Peer should respond with "blocktxn" message.
Definition: protocol.cpp:42
const char * INV
The inv message (inventory message) transmits one or more inventories of objects known to the transmi...
Definition: protocol.cpp:22
static constexpr int ADDRV2_FORMAT
A flag that is ORed into the protocol version to designate that addresses should be serialized in (un...
Definition: netaddress.h:34
ServiceFlags GetDesirableServiceFlags(ServiceFlags services)
Gets the set of service flags which are "desirable" for a given peer.
Definition: protocol.cpp:207
static const unsigned int MAX_PROTOCOL_MESSAGE_LENGTH
Maximum length of incoming protocol messages (Currently 2MB).
Definition: protocol.h:28
const std::vector< std::string > & getAllNetMessageTypes()
Get a vector of all valid message types (see above)
Definition: protocol.cpp:246
static bool HasAllDesirableServiceFlags(ServiceFlags services)
A shortcut for (services & GetDesirableServiceFlags(services)) == GetDesirableServiceFlags(services),...
Definition: protocol.h:430
GetDataMsg
getdata / inv message types.
Definition: protocol.h:499
@ MSG_TX
Definition: protocol.h:501
@ MSG_FILTERED_BLOCK
Defined in BIP37.
Definition: protocol.h:505
@ MSG_AVA_PROOF
Definition: protocol.h:508
@ MSG_BLOCK
Definition: protocol.h:502
@ UNDEFINED
Definition: protocol.h:500
@ MSG_CMPCT_BLOCK
Defined in BIP152.
Definition: protocol.h:507
void SetServiceFlagsIBDCache(bool status)
Set the current IBD status in order to figure out the desirable service flags.
Definition: protocol.cpp:215
const uint32_t MSG_TYPE_MASK
getdata message type flags
Definition: protocol.h:492
std::vector< std::string > serviceFlagsToStr(const uint64_t flags)
Convert service flags (a bitmask of NODE_*) to human readable strings.
Definition: protocol.cpp:283
ServiceFlags
nServices flags.
Definition: protocol.h:338
@ NODE_NONE
Definition: protocol.h:341
@ NODE_GETUTXO
Definition: protocol.h:350
@ NODE_NETWORK_LIMITED
Definition: protocol.h:368
@ NODE_BLOOM
Definition: protocol.h:355
@ NODE_NETWORK
Definition: protocol.h:345
@ NODE_LAST_NON_EXPERIMENTAL_SERVICE_BIT
Definition: protocol.h:371
@ NODE_COMPACT_FILTERS
Definition: protocol.h:363
@ NODE_AVALANCHE
Definition: protocol.h:383
static bool MayHaveUsefulAddressDB(ServiceFlags services)
Checks if a peer with the given service flags may be capable of having a robust address-storage DB.
Definition: protocol.h:438
#define SER_WRITE(obj, code)
Definition: serialize.h:187
#define READWRITEAS(type, obj)
Definition: serialize.h:181
static Wrapper< Formatter, T & > Using(T &&t)
Cause serialization/deserialization of an object to be done using a specified formatter class.
Definition: serialize.h:592
@ SER_DISK
Definition: serialize.h:167
@ SER_GETHASH
Definition: serialize.h:168
#define SER_READ(obj, code)
Definition: serialize.h:183
#define READWRITE(...)
Definition: serialize.h:180
Formatter for integers in CompactSize format.
Definition: serialize.h:665
Serialization wrapper class for custom integers and enums.
Definition: serialize.h:624
static const int INIT_PROTO_VERSION
initial proto version, to be increased after version/verack negotiation
Definition: version.h:14