LedgerCacheInterface.hpp

#pragma once
 
#include "data/Types.hpp"
#include "etl/Models.hpp"
 
#include <xrpl/basics/base_uint.h>
#include <xrpl/basics/hardened_hash.h>
 
#include <cstddef>
#include <cstdint>
#include <expected>
#include <optional>
#include <string>
#include <vector>
 
namespace data {

class LedgerCacheInterface {
public:
    virtual ~LedgerCacheInterface() = default;
    LedgerCacheInterface() = default;
    LedgerCacheInterface(LedgerCacheInterface&&) = delete;
    LedgerCacheInterface(LedgerCacheInterface const&) = delete;
    LedgerCacheInterface&
    operator=(LedgerCacheInterface&&) = delete;
    LedgerCacheInterface&
    operator=(LedgerCacheInterface const&) = delete;

    virtual void
    update(std::vector<LedgerObject> const& objs, uint32_t seq, bool isBackground = false) = 0;

    virtual void
    update(std::vector<etl::model::Object> const& objs, uint32_t seq) = 0;

    virtual std::optional<Blob>
    get(ripple::uint256 const& key, uint32_t seq) const = 0;

    virtual std::optional<Blob>
    getDeleted(ripple::uint256 const& key, uint32_t seq) const = 0;

    virtual std::optional<LedgerObject>
    getSuccessor(ripple::uint256 const& key, uint32_t seq) const = 0;

    virtual std::optional<LedgerObject>
    getPredecessor(ripple::uint256 const& key, uint32_t seq) const = 0;

    virtual void
    setDisabled() = 0;

    virtual bool
    isDisabled() const = 0;

    virtual void
    setFull() = 0;

    virtual uint32_t
    latestLedgerSequence() const = 0;

    virtual bool
    isFull() const = 0;

    virtual size_t
    size() const = 0;

    virtual float
    getObjectHitRate() const = 0;

    virtual float
    getSuccessorHitRate() const = 0;

    virtual void
    waitUntilCacheContainsSeq(uint32_t seq) = 0;

    [[nodiscard]] virtual std::expected<void, std::string>
    saveToFile(std::string const& path) const = 0;

    [[nodiscard]] virtual std::expected<void, std::string>
    loadFromFile(std::string const& path, uint32_t minLatestSequence) = 0;

    virtual void
    startLoading() = 0;

    [[nodiscard]] virtual bool
    isCurrentlyLoading() const = 0;
};
 
}  // namespace data