2011-08-11 18:14:53 +02:00
|
|
|
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
2015-12-13 14:51:43 +01:00
|
|
|
// Copyright (c) 2009-2015 The Bitcoin Core developers
|
2014-12-13 05:09:33 +01:00
|
|
|
// Distributed under the MIT software license, see the accompanying
|
2012-05-18 16:02:28 +02:00
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
2011-08-11 18:14:53 +02:00
|
|
|
|
|
|
|
#ifndef __cplusplus
|
2014-09-19 19:21:46 +02:00
|
|
|
#error This header can only be compiled as C++.
|
2011-08-11 18:14:53 +02:00
|
|
|
#endif
|
|
|
|
|
2024-12-16 19:40:22 +01:00
|
|
|
#ifndef NEOBYTES_PROTOCOL_H
|
|
|
|
#define NEOBYTES_PROTOCOL_H
|
2011-08-11 18:14:53 +02:00
|
|
|
|
2012-01-03 23:33:31 +01:00
|
|
|
#include "netbase.h"
|
2013-04-13 07:13:08 +02:00
|
|
|
#include "serialize.h"
|
2011-08-11 18:49:03 +02:00
|
|
|
#include "uint256.h"
|
2014-05-09 17:38:44 +02:00
|
|
|
#include "version.h"
|
2011-08-11 18:14:53 +02:00
|
|
|
|
2013-04-13 07:13:08 +02:00
|
|
|
#include <stdint.h>
|
|
|
|
#include <string>
|
|
|
|
|
2014-06-04 12:51:29 +02:00
|
|
|
#define MESSAGE_START_SIZE 4
|
|
|
|
|
2012-03-26 16:48:23 +02:00
|
|
|
/** Message header.
|
|
|
|
* (4) message start.
|
|
|
|
* (12) command.
|
|
|
|
* (4) size.
|
|
|
|
* (4) checksum.
|
|
|
|
*/
|
2011-08-11 18:14:53 +02:00
|
|
|
class CMessageHeader
|
|
|
|
{
|
2014-09-19 19:21:46 +02:00
|
|
|
public:
|
2014-10-28 01:24:31 +01:00
|
|
|
typedef unsigned char MessageStartChars[MESSAGE_START_SIZE];
|
|
|
|
|
|
|
|
CMessageHeader(const MessageStartChars& pchMessageStartIn);
|
|
|
|
CMessageHeader(const MessageStartChars& pchMessageStartIn, const char* pszCommand, unsigned int nMessageSizeIn);
|
2011-08-11 18:14:53 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
std::string GetCommand() const;
|
2014-10-28 01:24:31 +01:00
|
|
|
bool IsValid(const MessageStartChars& messageStart) const;
|
2011-08-11 18:14:53 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
ADD_SERIALIZE_METHODS;
|
2011-08-11 18:14:53 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
template <typename Stream, typename Operation>
|
|
|
|
inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
|
|
|
|
{
|
|
|
|
READWRITE(FLATDATA(pchMessageStart));
|
|
|
|
READWRITE(FLATDATA(pchCommand));
|
|
|
|
READWRITE(nMessageSize);
|
|
|
|
READWRITE(nChecksum);
|
|
|
|
}
|
2011-08-11 18:14:53 +02:00
|
|
|
|
|
|
|
// TODO: make private (improves encapsulation)
|
2014-09-19 19:21:46 +02:00
|
|
|
public:
|
|
|
|
enum {
|
|
|
|
COMMAND_SIZE = 12,
|
|
|
|
MESSAGE_SIZE_SIZE = sizeof(int),
|
|
|
|
CHECKSUM_SIZE = sizeof(int),
|
|
|
|
|
|
|
|
MESSAGE_SIZE_OFFSET = MESSAGE_START_SIZE + COMMAND_SIZE,
|
|
|
|
CHECKSUM_OFFSET = MESSAGE_SIZE_OFFSET + MESSAGE_SIZE_SIZE,
|
|
|
|
HEADER_SIZE = MESSAGE_START_SIZE + COMMAND_SIZE + MESSAGE_SIZE_SIZE + CHECKSUM_SIZE
|
|
|
|
};
|
|
|
|
char pchMessageStart[MESSAGE_START_SIZE];
|
|
|
|
char pchCommand[COMMAND_SIZE];
|
|
|
|
unsigned int nMessageSize;
|
|
|
|
unsigned int nChecksum;
|
2011-08-11 18:14:53 +02:00
|
|
|
};
|
|
|
|
|
2015-12-07 15:31:32 +01:00
|
|
|
/**
|
|
|
|
* Bitcoin protocol message types. When adding new message types, don't forget
|
|
|
|
* to update allNetMessageTypes in protocol.cpp.
|
|
|
|
*/
|
|
|
|
namespace NetMsgType {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The version message provides information about the transmitting node to the
|
|
|
|
* receiving node at the beginning of a connection.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#version
|
|
|
|
*/
|
|
|
|
extern const char *VERSION;
|
|
|
|
/**
|
|
|
|
* The verack message acknowledges a previously-received version message,
|
|
|
|
* informing the connecting node that it can begin to send other messages.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#verack
|
|
|
|
*/
|
|
|
|
extern const char *VERACK;
|
|
|
|
/**
|
|
|
|
* The addr (IP address) message relays connection information for peers on the
|
|
|
|
* network.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#addr
|
|
|
|
*/
|
|
|
|
extern const char *ADDR;
|
|
|
|
/**
|
|
|
|
* The inv message (inventory message) transmits one or more inventories of
|
|
|
|
* objects known to the transmitting peer.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#inv
|
|
|
|
*/
|
|
|
|
extern const char *INV;
|
|
|
|
/**
|
|
|
|
* The getdata message requests one or more data objects from another node.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#getdata
|
|
|
|
*/
|
|
|
|
extern const char *GETDATA;
|
|
|
|
/**
|
|
|
|
* The merkleblock message is a reply to a getdata message which requested a
|
|
|
|
* block using the inventory type MSG_MERKLEBLOCK.
|
|
|
|
* @since protocol version 70001 as described by BIP37.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#merkleblock
|
|
|
|
*/
|
|
|
|
extern const char *MERKLEBLOCK;
|
|
|
|
/**
|
|
|
|
* The getblocks message requests an inv message that provides block header
|
|
|
|
* hashes starting from a particular point in the block chain.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#getblocks
|
|
|
|
*/
|
|
|
|
extern const char *GETBLOCKS;
|
|
|
|
/**
|
|
|
|
* The getheaders message requests a headers message that provides block
|
|
|
|
* headers starting from a particular point in the block chain.
|
|
|
|
* @since protocol version 31800.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#getheaders
|
|
|
|
*/
|
|
|
|
extern const char *GETHEADERS;
|
|
|
|
/**
|
|
|
|
* The tx message transmits a single transaction.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#tx
|
|
|
|
*/
|
|
|
|
extern const char *TX;
|
|
|
|
/**
|
|
|
|
* The headers message sends one or more block headers to a node which
|
|
|
|
* previously requested certain headers with a getheaders message.
|
|
|
|
* @since protocol version 31800.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#headers
|
|
|
|
*/
|
|
|
|
extern const char *HEADERS;
|
|
|
|
/**
|
|
|
|
* The block message transmits a single serialized block.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#block
|
|
|
|
*/
|
|
|
|
extern const char *BLOCK;
|
|
|
|
/**
|
|
|
|
* The getaddr message requests an addr message from the receiving node,
|
|
|
|
* preferably one with lots of IP addresses of other receiving nodes.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#getaddr
|
|
|
|
*/
|
|
|
|
extern const char *GETADDR;
|
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
* @since protocol version 60002.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#mempool
|
|
|
|
*/
|
|
|
|
extern const char *MEMPOOL;
|
|
|
|
/**
|
|
|
|
* The ping message is sent periodically to help confirm that the receiving
|
|
|
|
* peer is still connected.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#ping
|
|
|
|
*/
|
|
|
|
extern const char *PING;
|
|
|
|
/**
|
|
|
|
* The pong message replies to a ping message, proving to the pinging node that
|
|
|
|
* the ponging node is still alive.
|
|
|
|
* @since protocol version 60001 as described by BIP31.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#pong
|
|
|
|
*/
|
|
|
|
extern const char *PONG;
|
|
|
|
/**
|
|
|
|
* The alert message warns nodes of problems that may affect them or the rest
|
|
|
|
* of the network.
|
|
|
|
* @since protocol version 311.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#alert
|
|
|
|
*/
|
|
|
|
extern const char *ALERT;
|
|
|
|
/**
|
|
|
|
* The notfound message is a reply to a getdata message which requested an
|
|
|
|
* object the receiving node does not have available for relay.
|
|
|
|
* @ince protocol version 70001.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#notfound
|
|
|
|
*/
|
|
|
|
extern const char *NOTFOUND;
|
|
|
|
/**
|
|
|
|
* The filterload message tells the receiving peer to filter all relayed
|
|
|
|
* transactions and requested merkle blocks through the provided filter.
|
|
|
|
* @since protocol version 70001 as described by BIP37.
|
|
|
|
* Only available with service bit NODE_BLOOM since protocol version
|
|
|
|
* 70011 as described by BIP111.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#filterload
|
|
|
|
*/
|
|
|
|
extern const char *FILTERLOAD;
|
|
|
|
/**
|
|
|
|
* The filteradd message tells the receiving peer to add a single element to a
|
|
|
|
* previously-set bloom filter, such as a new public key.
|
|
|
|
* @since protocol version 70001 as described by BIP37.
|
|
|
|
* Only available with service bit NODE_BLOOM since protocol version
|
|
|
|
* 70011 as described by BIP111.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#filteradd
|
|
|
|
*/
|
|
|
|
extern const char *FILTERADD;
|
|
|
|
/**
|
|
|
|
* The filterclear message tells the receiving peer to remove a previously-set
|
|
|
|
* bloom filter.
|
|
|
|
* @since protocol version 70001 as described by BIP37.
|
|
|
|
* Only available with service bit NODE_BLOOM since protocol version
|
|
|
|
* 70011 as described by BIP111.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#filterclear
|
|
|
|
*/
|
|
|
|
extern const char *FILTERCLEAR;
|
|
|
|
/**
|
|
|
|
* The reject message informs the receiving node that one of its previous
|
|
|
|
* messages has been rejected.
|
|
|
|
* @since protocol version 70002 as described by BIP61.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#reject
|
|
|
|
*/
|
|
|
|
extern const char *REJECT;
|
|
|
|
/**
|
|
|
|
* Indicates that a node prefers to receive new block announcements via a
|
|
|
|
* "headers" message rather than an "inv".
|
|
|
|
* @since protocol version 70012 as described by BIP130.
|
|
|
|
* @see https://bitcoin.org/en/developer-reference#sendheaders
|
|
|
|
*/
|
|
|
|
extern const char *SENDHEADERS;
|
|
|
|
|
2024-12-16 19:40:22 +01:00
|
|
|
// Neobytes message types
|
2016-08-05 18:25:03 +02:00
|
|
|
// NOTE: do NOT declare non-implmented here, we don't want them to be exposed to the outside
|
2016-02-17 23:18:57 +01:00
|
|
|
// TODO: add description
|
2016-09-15 22:07:01 +02:00
|
|
|
extern const char *TXLOCKREQUEST;
|
|
|
|
extern const char *TXLOCKVOTE;
|
2016-02-17 23:18:57 +01:00
|
|
|
extern const char *SPORK;
|
|
|
|
extern const char *GETSPORKS;
|
2016-09-21 16:45:29 +02:00
|
|
|
extern const char *MASTERNODEPAYMENTVOTE;
|
|
|
|
extern const char *MASTERNODEPAYMENTSYNC;
|
2016-02-17 23:18:57 +01:00
|
|
|
extern const char *MNANNOUNCE;
|
|
|
|
extern const char *MNPING;
|
|
|
|
extern const char *DSACCEPT;
|
|
|
|
extern const char *DSVIN;
|
|
|
|
extern const char *DSFINALTX;
|
|
|
|
extern const char *DSSIGNFINALTX;
|
2016-03-09 22:33:48 +01:00
|
|
|
extern const char *DSCOMPLETE;
|
2016-02-17 23:18:57 +01:00
|
|
|
extern const char *DSSTATUSUPDATE;
|
|
|
|
extern const char *DSTX;
|
|
|
|
extern const char *DSQUEUE;
|
|
|
|
extern const char *DSEG;
|
|
|
|
extern const char *SYNCSTATUSCOUNT;
|
2016-08-05 18:25:03 +02:00
|
|
|
extern const char *MNGOVERNANCESYNC;
|
|
|
|
extern const char *MNGOVERNANCEOBJECT;
|
|
|
|
extern const char *MNGOVERNANCEOBJECTVOTE;
|
2016-10-20 23:11:30 +02:00
|
|
|
extern const char *MNVERIFY;
|
2015-12-07 15:31:32 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Get a vector of all valid message types (see above) */
|
|
|
|
const std::vector<std::string> &getAllNetMessageTypes();
|
|
|
|
|
2012-03-26 16:48:23 +02:00
|
|
|
/** nServices flags */
|
2014-09-19 19:21:46 +02:00
|
|
|
enum {
|
2015-03-10 19:33:46 +01:00
|
|
|
// NODE_NETWORK means that the node is capable of serving the block chain. It is currently
|
2024-12-16 19:40:22 +01:00
|
|
|
// set by all Neobytes Core nodes, and is unset by SPV clients or other peers that just want
|
2015-03-10 19:33:46 +01:00
|
|
|
// network services but don't provide them.
|
2011-08-11 18:40:12 +02:00
|
|
|
NODE_NETWORK = (1 << 0),
|
2015-03-10 19:33:46 +01:00
|
|
|
// NODE_GETUTXO means the node is capable of responding to the getutxo protocol request.
|
2024-12-16 19:40:22 +01:00
|
|
|
// Neobytes Core does not support this but a patch set called Bitcoin XT does.
|
2015-03-10 19:33:46 +01:00
|
|
|
// See BIP 64 for details on how this is implemented.
|
|
|
|
NODE_GETUTXO = (1 << 1),
|
2015-08-21 06:15:27 +02:00
|
|
|
// NODE_BLOOM means the node is capable and willing to handle bloom-filtered connections.
|
2024-12-16 19:40:22 +01:00
|
|
|
// Neobytes Core nodes used to support this by default, without advertising this bit,
|
2016-08-12 07:41:23 +02:00
|
|
|
// but no longer do as of protocol version 70201 (= NO_BLOOM_VERSION)
|
2015-08-21 06:15:27 +02:00
|
|
|
NODE_BLOOM = (1 << 2),
|
2014-06-21 15:05:24 +02:00
|
|
|
|
|
|
|
// Bits 24-31 are reserved for temporary experiments. Just pick a bit that
|
|
|
|
// isn't getting used, or one not being used much, and notify the
|
|
|
|
// bitcoin-development mailing list. Remember that service bits are just
|
|
|
|
// unauthenticated advertisements, so your code must be robust against
|
|
|
|
// collisions and other cases where nodes may be advertising a service they
|
|
|
|
// do not actually support. Other service bits should be allocated via the
|
|
|
|
// BIP process.
|
2011-08-11 18:40:12 +02:00
|
|
|
};
|
|
|
|
|
2012-03-26 16:48:23 +02:00
|
|
|
/** A CService with information about it as peer */
|
2012-01-03 23:33:31 +01:00
|
|
|
class CAddress : public CService
|
2011-08-11 18:40:12 +02:00
|
|
|
{
|
2014-09-19 19:21:46 +02:00
|
|
|
public:
|
|
|
|
CAddress();
|
|
|
|
explicit CAddress(CService ipIn, uint64_t nServicesIn = NODE_NETWORK);
|
|
|
|
|
|
|
|
void Init();
|
|
|
|
|
|
|
|
ADD_SERIALIZE_METHODS;
|
|
|
|
|
|
|
|
template <typename Stream, typename Operation>
|
|
|
|
inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
|
|
|
|
{
|
|
|
|
if (ser_action.ForRead())
|
|
|
|
Init();
|
|
|
|
if (nType & SER_DISK)
|
|
|
|
READWRITE(nVersion);
|
|
|
|
if ((nType & SER_DISK) ||
|
|
|
|
(nVersion >= CADDR_TIME_VERSION && !(nType & SER_GETHASH)))
|
|
|
|
READWRITE(nTime);
|
|
|
|
READWRITE(nServices);
|
|
|
|
READWRITE(*(CService*)this);
|
|
|
|
}
|
2011-08-11 18:40:12 +02:00
|
|
|
|
|
|
|
// TODO: make private (improves encapsulation)
|
2014-09-19 19:21:46 +02:00
|
|
|
public:
|
|
|
|
uint64_t nServices;
|
2011-08-11 18:40:12 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
// disk and network only
|
|
|
|
unsigned int nTime;
|
2011-08-11 18:40:12 +02:00
|
|
|
};
|
|
|
|
|
2012-03-26 16:48:23 +02:00
|
|
|
/** inv message data */
|
2011-08-11 18:49:03 +02:00
|
|
|
class CInv
|
|
|
|
{
|
2014-09-19 19:21:46 +02:00
|
|
|
public:
|
|
|
|
CInv();
|
|
|
|
CInv(int typeIn, const uint256& hashIn);
|
|
|
|
CInv(const std::string& strType, const uint256& hashIn);
|
2011-08-11 18:49:03 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
ADD_SERIALIZE_METHODS;
|
2011-08-11 18:49:03 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
template <typename Stream, typename Operation>
|
|
|
|
inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
|
|
|
|
{
|
|
|
|
READWRITE(type);
|
|
|
|
READWRITE(hash);
|
|
|
|
}
|
2011-08-11 18:49:03 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
friend bool operator<(const CInv& a, const CInv& b);
|
2011-08-11 18:49:03 +02:00
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
bool IsKnownType() const;
|
|
|
|
const char* GetCommand() const;
|
|
|
|
std::string ToString() const;
|
2011-08-11 18:49:03 +02:00
|
|
|
|
|
|
|
// TODO: make private (improves encapsulation)
|
2014-09-19 19:21:46 +02:00
|
|
|
public:
|
|
|
|
int type;
|
|
|
|
uint256 hash;
|
2011-08-11 18:49:03 +02:00
|
|
|
};
|
|
|
|
|
2014-09-19 19:21:46 +02:00
|
|
|
enum {
|
2012-08-13 09:02:44 +02:00
|
|
|
MSG_TX = 1,
|
|
|
|
MSG_BLOCK,
|
2012-08-19 05:45:19 +02:00
|
|
|
// Nodes may always request a MSG_FILTERED_BLOCK in a getdata, however,
|
|
|
|
// MSG_FILTERED_BLOCK should not appear in any invs except as a part of getdata.
|
|
|
|
MSG_FILTERED_BLOCK,
|
2024-12-16 19:40:22 +01:00
|
|
|
// Neobytes message types
|
2016-08-05 18:25:03 +02:00
|
|
|
// NOTE: declare non-implmented here, we must keep this enum consistent and backwards compatible
|
2016-09-15 22:07:01 +02:00
|
|
|
MSG_TXLOCK_REQUEST,
|
|
|
|
MSG_TXLOCK_VOTE,
|
2015-02-09 21:22:31 +01:00
|
|
|
MSG_SPORK,
|
2016-09-21 16:45:29 +02:00
|
|
|
MSG_MASTERNODE_PAYMENT_VOTE,
|
|
|
|
MSG_MASTERNODE_PAYMENT_BLOCK, // reusing, was MSG_MASTERNODE_SCANNING_ERROR previousely, was NOT used in 12.0
|
2016-08-05 18:25:03 +02:00
|
|
|
MSG_BUDGET_VOTE, // depreciated since 12.1
|
|
|
|
MSG_BUDGET_PROPOSAL, // depreciated since 12.1
|
|
|
|
MSG_BUDGET_FINALIZED, // depreciated since 12.1
|
|
|
|
MSG_BUDGET_FINALIZED_VOTE, // depreciated since 12.1
|
2016-05-29 13:46:39 +02:00
|
|
|
MSG_MASTERNODE_QUORUM, // not implemented
|
2015-04-22 16:33:44 +02:00
|
|
|
MSG_MASTERNODE_ANNOUNCE,
|
2015-07-27 21:34:02 +02:00
|
|
|
MSG_MASTERNODE_PING,
|
2016-08-05 18:25:03 +02:00
|
|
|
MSG_DSTX,
|
|
|
|
MSG_GOVERNANCE_OBJECT,
|
2016-10-20 23:11:30 +02:00
|
|
|
MSG_GOVERNANCE_OBJECT_VOTE,
|
|
|
|
MSG_MASTERNODE_VERIFY,
|
2012-08-13 09:02:44 +02:00
|
|
|
};
|
|
|
|
|
2024-12-16 19:40:22 +01:00
|
|
|
#endif // NEOBYTES_PROTOCOL_H
|