block_storage.hpp

Go to the documentation of this file.

#ifndef KAGOME_BLOCK_STORAGE_HPP
#define KAGOME_BLOCK_STORAGE_HPP

#include "primitives/block.hpp"
#include "primitives/block_data.hpp"
#include "primitives/block_id.hpp"
#include "primitives/justification.hpp"

namespace kagome::blockchain {

  class BlockStorage {
   public:
    virtual ~BlockStorage() = default;

    virtual outcome::result<std::vector<primitives::BlockHash>>
    getBlockTreeLeaves() const = 0;

    virtual outcome::result<void> setBlockTreeLeaves(
        std::vector<primitives::BlockHash> leaves) = 0;

    virtual outcome::result<bool> hasBlockHeader(
        const primitives::BlockId &id) const = 0;

    virtual outcome::result<std::optional<primitives::BlockHeader>>
    getBlockHeader(const primitives::BlockId &id) const = 0;

    virtual outcome::result<std::optional<primitives::BlockBody>> getBlockBody(
        const primitives::BlockId &id) const = 0;

    virtual outcome::result<std::optional<primitives::BlockData>> getBlockData(
        const primitives::BlockId &id) const = 0;

    virtual outcome::result<std::optional<primitives::Justification>>
    getJustification(const primitives::BlockId &block) const = 0;

    virtual outcome::result<void> putNumberToIndexKey(
        const primitives::BlockInfo &block) = 0;

    virtual outcome::result<primitives::BlockHash> putBlockHeader(
        const primitives::BlockHeader &header) = 0;

    virtual outcome::result<void> putBlockData(
        primitives::BlockNumber, const primitives::BlockData &block_data) = 0;

    virtual outcome::result<void> removeBlockData(
        primitives::BlockNumber block_number,
        const primitives::BlockDataFlags &remove_flags) = 0;
    virtual outcome::result<primitives::BlockHash> putBlock(
        const primitives::Block &block) = 0;

    virtual outcome::result<void> putJustification(
        const primitives::Justification &justification,
        const primitives::BlockHash &hash,
        primitives::BlockNumber number) = 0;

    virtual outcome::result<void> removeJustification(
        const primitives::BlockHash &hash, primitives::BlockNumber number) = 0;

    virtual outcome::result<primitives::BlockInfo> getLastFinalized() const = 0;

    virtual outcome::result<void> removeBlock(
        const primitives::BlockInfo &block) = 0;
  };

}  // namespace kagome::blockchain

#endif  // KAGOME_BLOCK_STORAGE_HPP