protocol.h

Go to the documentation of this file.

// Copyright (c) 2009-2010 Satoshi Nakamoto
// Copyright (c) 2009-2015 The Bitcoin developers
// Distributed under the MIT/X11 software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#ifndef __cplusplus
#error This header can only be compiled as C++.
#endif
 
#ifndef BITCOIN_PROTOCOL_H
#define BITCOIN_PROTOCOL_H
 
#include "netaddress.h"
#include "serialize.h"
#include "uint256.h"
#include "version.h"
 
#include <stdint.h>
#include <string>
 
#define MESSAGE_START_SIZE 4
 
class CMessageHeader
{
public:
    CMessageHeader();
    CMessageHeader(const char* pszCommand, unsigned int nMessageSizeIn);
 
    std::string GetCommand() const;
    bool IsValid() const;
 
    ADD_SERIALIZE_METHODS;
 
    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);
    }
 
    // TODO: make private (improves encapsulation)
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;
};
 
namespace NetMsgType {
 
extern const char *VERSION;
extern const char *VERACK;
extern const char *ADDR;
extern const char *INV;
extern const char *GETDATA;
extern const char *MERKLEBLOCK;
extern const char *GETBLOCKS;
extern const char *GETHEADERS;
extern const char *TX;
extern const char *DSC;
extern const char *DSF;
extern const char *DSQ;
extern const char *DSR;
extern const char *DSTX;
extern const char *DSEE;
extern const char *DSEG;
extern const char *DSEEP;
extern const char *DSSU;
extern const char *HEADERS;
extern const char *BLOCK;
extern const char *GETADDR;
extern const char *MEMPOOL;
extern const char *PING;
extern const char *PONG;
extern const char *ALERT;
extern const char *NOTFOUND;
extern const char *FILTERLOAD;
extern const char *FILTERADD;
extern const char *FILTERCLEAR;
extern const char *REJECT;
extern const char *SENDHEADERS;
extern const char *IX;
extern const char *IXLOCKVOTE;
extern const char *SPORK;
extern const char *GETSPORKS;
extern const char *MNBROADCAST;
extern const char *MNPING;
extern const char *MNWINNER;
extern const char *GETMNWINNERS;
extern const char *BUDGETPROPOSAL;
extern const char *BUDGETVOTE;
extern const char *BUDGETVOTESYNC;
extern const char *FINALBUDGET;
extern const char *FINALBUDGETVOTE;
extern const char *SYNCSTATUSCOUNT;
};
 
/* Get a vector of all valid message types (see above) */
const std::vector<std::string> &getAllNetMessageTypes();
 
enum ServiceFlags : uint64_t {
    // Nothing
    NODE_NONE = 0,
    // NODE_NETWORK means that the node is capable of serving the block chain. It is currently
    // set by all Bitcoin Core nodes, and is unset by SPV clients or other peers that just want
    // network services but don't provide them.
    NODE_NETWORK = (1 << 0),
 
    // NODE_BLOOM means the node is capable and willing to handle bloom-filtered connections.
    // Bitcoin Core nodes used to support this by default, without advertising this bit,
    // but no longer do as of protocol version 70011 (= NO_BLOOM_VERSION)
    NODE_BLOOM = (1 << 2),
 
    // NODE_BLOOM_WITHOUT_MN means the node has the same features as NODE_BLOOM with the only difference
    // that the node doesn't want to receive master nodes messages. (the 1<<3 was not picked as constant because on bitcoin 0.14 is witness and we want that update here )
    NODE_BLOOM_WITHOUT_MN = (1 << 4),
 
    // 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.
};
 
class CAddress : public CService
{
public:
    CAddress();
    explicit CAddress(CService ipIn, ServiceFlags nServicesIn);
 
    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);
        uint64_t nServicesInt = nServices;
        READWRITE(nServicesInt);
        nServices = (ServiceFlags)nServicesInt;
        READWRITE(*(CService*)this);
    }
 
    // TODO: make private (improves encapsulation)
public:
    ServiceFlags nServices;
 
    // disk and network only
    unsigned int nTime;
};
 
class CInv
{
public:
    CInv();
    CInv(int typeIn, const uint256& hashIn);
    CInv(const std::string& strType, const uint256& hashIn);
 
    ADD_SERIALIZE_METHODS;
 
    template <typename Stream, typename Operation>
    inline void SerializationOp(Stream& s, Operation ser_action, int nType, int nVersion)
    {
        READWRITE(type);
        READWRITE(hash);
    }
 
    friend bool operator<(const CInv& a, const CInv& b);
 
    bool IsKnownType() const;
    bool IsMasterNodeType() const;
    const char* GetCommand() const;
    std::string ToString() const;
 
    // TODO: make private (improves encapsulation)
public:
    int type;
    uint256 hash;
};
 
enum {
    MSG_TX = 1,
    MSG_BLOCK,
    // 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,
    MSG_TXLOCK_REQUEST,
    MSG_TXLOCK_VOTE,
    MSG_MASTERNODE_WINNER,
    MSG_MASTERNODE_SCANNING_ERROR,
    MSG_BUDGET_VOTE,
    MSG_BUDGET_PROPOSAL,
    MSG_BUDGET_FINALIZED,
    MSG_BUDGET_FINALIZED_VOTE,
    MSG_MASTERNODE_QUORUM,
    MSG_MASTERNODE_ANNOUNCE,
    MSG_MASTERNODE_PING,
    MSG_DSTX
};
 
#endif // BITCOIN_PROTOCOL_H