xrpld/overlay/Peer.h

#pragma once
 
#include <xrpld/overlay/Message.h>
 
#include <xrpl/basics/base_uint.h>
#include <xrpl/beast/net/IPEndpoint.h>
#include <xrpl/json/json_value.h>
#include <xrpl/protocol/PublicKey.h>
 
#include <cstddef>
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
 
namespace xrpl {
 
namespace resource {
class Charge;
}  // namespace resource
 
enum class ProtocolFeature {
    LedgerReplay,
    LedgerNodeDepth,
};

class Peer
{
public:
    using Ptr = std::shared_ptr<Peer>;

    using ID = std::uint32_t;
 
    virtual ~Peer() = default;
 
    //
    // Network
    //
 
    virtual void
    send(std::shared_ptr<Message> const& m) = 0;
 
    [[nodiscard]] virtual beast::ip::Endpoint
    getRemoteAddress() const = 0;

    virtual void
    sendTxQueue() = 0;

    virtual void
    addTxQueue(UInt256 const&) = 0;

    virtual void
    removeTxQueue(UInt256 const&) = 0;

    virtual void
    charge(resource::Charge const& fee, std::string const& context) = 0;
 
    //
    // Identity
    //
 
    [[nodiscard]] virtual ID
    id() const = 0;

    [[nodiscard]] virtual bool
    cluster() const = 0;
 
    [[nodiscard]] virtual bool
    isHighLatency() const = 0;
 
    [[nodiscard]] virtual int
    getScore(bool) const = 0;
 
    [[nodiscard]] virtual PublicKey const&
    getNodePublic() const = 0;
 
    virtual json::Value
    json() = 0;
 
    [[nodiscard]] virtual bool
    supportsFeature(ProtocolFeature f) const = 0;
 
    [[nodiscard]] virtual std::optional<std::size_t>
    publisherListSequence(PublicKey const&) const = 0;
 
    virtual void
    setPublisherListSequence(PublicKey const&, std::size_t const) = 0;
 
    [[nodiscard]] virtual std::string const&
    fingerprint() const = 0;
    //
    // Ledger
    //
 
    [[nodiscard]] virtual UInt256
    getClosedLedgerHash() const = 0;
    [[nodiscard]] virtual bool
    hasLedger(UInt256 const& hash, std::uint32_t seq) const = 0;
    virtual void
    ledgerRange(std::uint32_t& minSeq, std::uint32_t& maxSeq) const = 0;
    [[nodiscard]] virtual bool
    hasTxSet(UInt256 const& hash) const = 0;
    virtual void
    cycleStatus() = 0;
    virtual bool
    hasRange(std::uint32_t uMin, std::uint32_t uMax) = 0;
 
    [[nodiscard]] virtual bool
    compressionEnabled() const = 0;
 
    [[nodiscard]] virtual bool
    txReduceRelayEnabled() const = 0;
};
 
}  // namespace xrpl