Dogecoin Core  1.14.2
P2P Digital Currency
protocol.cpp
Go to the documentation of this file.
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2016 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.h"
9 #include "utilstrencodings.h"
10 
11 #ifndef WIN32
12 # include <arpa/inet.h>
13 #endif
14 
15 namespace NetMsgType {
16 const char *VERSION="version";
17 const char *VERACK="verack";
18 const char *ADDR="addr";
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 *ALERT="alert";
32 const char *NOTFOUND="notfound";
33 const char *FILTERLOAD="filterload";
34 const char *FILTERADD="filteradd";
35 const char *FILTERCLEAR="filterclear";
36 const char *REJECT="reject";
37 const char *SENDHEADERS="sendheaders";
38 const char *FEEFILTER="feefilter";
39 const char *SENDCMPCT="sendcmpct";
40 const char *CMPCTBLOCK="cmpctblock";
41 const char *GETBLOCKTXN="getblocktxn";
42 const char *BLOCKTXN="blocktxn";
43 };
44 
48 const static std::string allNetMessageTypes[] = {
76 };
77 const static std::vector<std::string> allNetMessageTypesVec(allNetMessageTypes, allNetMessageTypes+ARRAYLEN(allNetMessageTypes));
78 
79 CMessageHeader::CMessageHeader(const MessageStartChars& pchMessageStartIn)
80 {
81  memcpy(pchMessageStart, pchMessageStartIn, MESSAGE_START_SIZE);
82  memset(pchCommand, 0, sizeof(pchCommand));
83  nMessageSize = -1;
84  memset(pchChecksum, 0, CHECKSUM_SIZE);
85 }
86 
87 CMessageHeader::CMessageHeader(const MessageStartChars& pchMessageStartIn, const char* pszCommand, unsigned int nMessageSizeIn)
88 {
89  memcpy(pchMessageStart, pchMessageStartIn, MESSAGE_START_SIZE);
90  memset(pchCommand, 0, sizeof(pchCommand));
91  strncpy(pchCommand, pszCommand, COMMAND_SIZE);
92  nMessageSize = nMessageSizeIn;
93  memset(pchChecksum, 0, CHECKSUM_SIZE);
94 }
95 
96 std::string CMessageHeader::GetCommand() const
97 {
98  return std::string(pchCommand, pchCommand + strnlen(pchCommand, COMMAND_SIZE));
99 }
100 
101 bool CMessageHeader::IsValid(const MessageStartChars& pchMessageStartIn) const
102 {
103  // Check start string
104  if (memcmp(pchMessageStart, pchMessageStartIn, MESSAGE_START_SIZE) != 0)
105  return false;
106 
107  // Check the command string for errors
108  for (const char* p1 = pchCommand; p1 < pchCommand + COMMAND_SIZE; p1++)
109  {
110  if (*p1 == 0)
111  {
112  // Must be all zeros after the first zero
113  for (; p1 < pchCommand + COMMAND_SIZE; p1++)
114  if (*p1 != 0)
115  return false;
116  }
117  else if (*p1 < ' ' || *p1 > 0x7E)
118  return false;
119  }
120 
121  // Message size
122  if (nMessageSize > MAX_SIZE)
123  {
124  LogPrintf("CMessageHeader::IsValid(): (%s, %u bytes) nMessageSize > MAX_SIZE\n", GetCommand(), nMessageSize);
125  return false;
126  }
127 
128  return true;
129 }
130 
131 
132 
134 {
135  Init();
136 }
137 
139 {
140  Init();
141  nServices = nServicesIn;
142 }
143 
145 {
147  nTime = 100000000;
148 }
149 
151 {
152  type = 0;
153  hash.SetNull();
154 }
155 
156 CInv::CInv(int typeIn, const uint256& hashIn)
157 {
158  type = typeIn;
159  hash = hashIn;
160 }
161 
162 bool operator<(const CInv& a, const CInv& b)
163 {
164  return (a.type < b.type || (a.type == b.type && a.hash < b.hash));
165 }
166 
167 std::string CInv::GetCommand() const
168 {
169  std::string cmd;
170  if (type & MSG_WITNESS_FLAG)
171  cmd.append("witness-");
172  int masked = type & MSG_TYPE_MASK;
173  switch (masked)
174  {
175  case MSG_TX: return cmd.append(NetMsgType::TX);
176  case MSG_BLOCK: return cmd.append(NetMsgType::BLOCK);
177  case MSG_FILTERED_BLOCK: return cmd.append(NetMsgType::MERKLEBLOCK);
178  case MSG_CMPCT_BLOCK: return cmd.append(NetMsgType::CMPCTBLOCK);
179  default:
180  throw std::out_of_range(strprintf("CInv::GetCommand(): type=%d unknown type", type));
181  }
182 }
183 
184 std::string CInv::ToString() const
185 {
186  try {
187  return strprintf("%s %s", GetCommand(), hash.ToString());
188  } catch(const std::out_of_range &) {
189  return strprintf("0x%08x %s", type, hash.ToString());
190  }
191 }
192 
193 const std::vector<std::string> &getAllNetMessageTypes()
194 {
195  return allNetMessageTypesVec;
196 }
ServiceFlags nServices
Definition: protocol.h:317
void Init()
Definition: protocol.cpp:144
unsigned int nTime
Definition: protocol.h:320
inv message data
Definition: protocol.h:346
int type
Definition: protocol.h:367
std::string ToString() const
Definition: protocol.cpp:184
std::string GetCommand() const
Definition: protocol.cpp:167
CInv()
Definition: protocol.cpp:150
uint256 hash
Definition: protocol.h:368
@ MESSAGE_START_SIZE
Definition: protocol.h:31
char pchMessageStart[MESSAGE_START_SIZE]
Definition: protocol.h:59
bool IsValid(const MessageStartChars &messageStart) const
Definition: protocol.cpp:101
char pchCommand[COMMAND_SIZE]
Definition: protocol.h:60
uint8_t pchChecksum[CHECKSUM_SIZE]
Definition: protocol.h:62
std::string GetCommand() const
Definition: protocol.cpp:96
uint32_t nMessageSize
Definition: protocol.h:61
CMessageHeader(const MessageStartChars &pchMessageStartIn)
Definition: protocol.cpp:79
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:134
std::string ToString() const
Definition: uint256.cpp:65
void SetNull()
Definition: uint256.h:40
256-bit opaque blob.
Definition: uint256.h:123
void * memcpy(void *a, const void *b, size_t c)
Bitcoin protocol message types.
Definition: protocol.cpp:15
const char * FILTERLOAD
The filterload message tells the receiving peer to filter all relayed transactions and requested merk...
Definition: protocol.cpp:33
const char * BLOCK
The block message transmits a single serialized block.
Definition: protocol.cpp:26
const char * FILTERCLEAR
The filterclear message tells the receiving peer to remove a previously-set bloom filter.
Definition: protocol.cpp:35
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 * SENDHEADERS
Indicates that a node prefers to receive new block announcements via a "headers" message rather than ...
Definition: protocol.cpp:37
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 * SENDCMPCT
Contains a 1-byte bool and 8-byte LE version number.
Definition: protocol.cpp:39
const char * GETADDR
The getaddr message requests an addr message from the receiving node, preferably one with lots of IP ...
Definition: protocol.cpp:27
const char * NOTFOUND
The notfound message is a reply to a getdata message which requested an object the receiving node doe...
Definition: protocol.cpp:32
const char * CMPCTBLOCK
Contains a CBlockHeaderAndShortTxIDs object - providing a header and list of "short txids".
Definition: protocol.cpp:40
const char * MEMPOOL
The mempool message requests the TXIDs of transactions that the receiving node has verified as valid ...
Definition: protocol.cpp:28
const char * TX
The tx message transmits a single transaction.
Definition: protocol.cpp:24
const char * FILTERADD
The filteradd message tells the receiving peer to add a single element to a previously-set bloom filt...
Definition: protocol.cpp:34
const char * ADDR
The addr (IP address) message relays connection information for peers on the network.
Definition: protocol.cpp:18
const char * VERSION
The version message provides information about the transmitting node to the receiving node at the beg...
Definition: protocol.cpp:16
const char * GETBLOCKS
The getblocks message requests an inv message that provides block header hashes starting from a parti...
Definition: protocol.cpp:22
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:38
const char * GETHEADERS
The getheaders message requests a headers message that provides block headers starting from a particu...
Definition: protocol.cpp:23
const char * GETDATA
The getdata message requests one or more data objects from another node.
Definition: protocol.cpp:20
const char * VERACK
The verack message acknowledges a previously-received version message, informing the connecting node ...
Definition: protocol.cpp:17
const char * BLOCKTXN
Contains a BlockTransactions.
Definition: protocol.cpp:42
const char * ALERT
The alert message warns nodes of problems that may affect them or the rest of the network.
Definition: protocol.cpp:31
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 * 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 * REJECT
The reject message informs the receiving node that one of its previous messages has been rejected.
Definition: protocol.cpp:36
const char * GETBLOCKTXN
Contains a BlockTransactionsRequest Peer should respond with "blocktxn" message.
Definition: protocol.cpp:41
const char * INV
The inv message (inventory message) transmits one or more inventories of objects known to the transmi...
Definition: protocol.cpp:19
bool operator<(const CInv &a, const CInv &b)
Definition: protocol.cpp:162
const std::vector< std::string > & getAllNetMessageTypes()
Definition: protocol.cpp:193
const uint32_t MSG_WITNESS_FLAG
getdata message type flags
Definition: protocol.h:324
@ MSG_TX
Definition: protocol.h:334
@ MSG_FILTERED_BLOCK
Defined in BIP37.
Definition: protocol.h:337
@ MSG_BLOCK
Definition: protocol.h:335
@ MSG_CMPCT_BLOCK
Defined in BIP152.
Definition: protocol.h:338
const uint32_t MSG_TYPE_MASK
Definition: protocol.h:325
ServiceFlags
nServices flags
Definition: protocol.h:256
@ NODE_NONE
Definition: protocol.h:258
size_t strnlen(const char *start, size_t max_len)
Definition: strnlen.cpp:12
#define strprintf
Definition: tinyformat.h:1047
#define LogPrintf(...)
Definition: util.h:82
#define ARRAYLEN(array)