mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-03-10 15:46:48 -04:00
e76fc2b84d
Using the zmq notifications to avoid excessive mempool polling can be difficult given the current notifications available. It announces all transactions being added to mempool or included in blocks, but announces no evictions and gives no indication if the transaction is in the mempool or a block. Block notifications for zmq are also substandard, in that it only announces block tips, while all block transactions are still announced. This commit adds a unified stream which can be used to closely track mempool: 1) getrawmempool to fill out mempool knowledge 2) if txhash is announced, add or remove from set based on add/remove flag 3) if blockhash is announced, get block txn list, remove from those transactions local view of mempool 4) if we drop a sequence number, go to (1) The mempool sequence number starts at the value 1, and increments each time a transaction enters the mempool, or is evicted from the mempool for any reason, including block inclusion. The mempool sequence number is published via ZMQ for any transaction-related notification. These features allow for ZMQ/RPC consumer to track mempool state in a more exacting way, without unnecesarily polling getrawmempool. See interface_zmq.py::test_mempool_sync for example usage.
67 lines
2.3 KiB
C++
67 lines
2.3 KiB
C++
// Copyright (c) 2015-2018 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#ifndef BITCOIN_ZMQ_ZMQABSTRACTNOTIFIER_H
|
|
#define BITCOIN_ZMQ_ZMQABSTRACTNOTIFIER_H
|
|
|
|
#include <util/memory.h>
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
class CBlockIndex;
|
|
class CTransaction;
|
|
class CZMQAbstractNotifier;
|
|
|
|
using CZMQNotifierFactory = std::unique_ptr<CZMQAbstractNotifier> (*)();
|
|
|
|
class CZMQAbstractNotifier
|
|
{
|
|
public:
|
|
static const int DEFAULT_ZMQ_SNDHWM {1000};
|
|
|
|
CZMQAbstractNotifier() : psocket(nullptr), outbound_message_high_water_mark(DEFAULT_ZMQ_SNDHWM) { }
|
|
virtual ~CZMQAbstractNotifier();
|
|
|
|
template <typename T>
|
|
static std::unique_ptr<CZMQAbstractNotifier> Create()
|
|
{
|
|
return MakeUnique<T>();
|
|
}
|
|
|
|
std::string GetType() const { return type; }
|
|
void SetType(const std::string &t) { type = t; }
|
|
std::string GetAddress() const { return address; }
|
|
void SetAddress(const std::string &a) { address = a; }
|
|
int GetOutboundMessageHighWaterMark() const { return outbound_message_high_water_mark; }
|
|
void SetOutboundMessageHighWaterMark(const int sndhwm) {
|
|
if (sndhwm >= 0) {
|
|
outbound_message_high_water_mark = sndhwm;
|
|
}
|
|
}
|
|
|
|
virtual bool Initialize(void *pcontext) = 0;
|
|
virtual void Shutdown() = 0;
|
|
|
|
// Notifies of ConnectTip result, i.e., new active tip only
|
|
virtual bool NotifyBlock(const CBlockIndex *pindex);
|
|
// Notifies of every block connection
|
|
virtual bool NotifyBlockConnect(const CBlockIndex *pindex);
|
|
// Notifies of every block disconnection
|
|
virtual bool NotifyBlockDisconnect(const CBlockIndex *pindex);
|
|
// Notifies of every mempool acceptance
|
|
virtual bool NotifyTransactionAcceptance(const CTransaction &transaction, uint64_t mempool_sequence);
|
|
// Notifies of every mempool removal, except inclusion in blocks
|
|
virtual bool NotifyTransactionRemoval(const CTransaction &transaction, uint64_t mempool_sequence);
|
|
// Notifies of transactions added to mempool or appearing in blocks
|
|
virtual bool NotifyTransaction(const CTransaction &transaction);
|
|
|
|
protected:
|
|
void *psocket;
|
|
std::string type;
|
|
std::string address;
|
|
int outbound_message_high_water_mark; // aka SNDHWM
|
|
};
|
|
|
|
#endif // BITCOIN_ZMQ_ZMQABSTRACTNOTIFIER_H
|