block_tree.hpp

Go to the documentation of this file.

#ifndef KAGOME_BLOCK_TREE_HPP
#define KAGOME_BLOCK_TREE_HPP

#include <cstdint>
#include <optional>
#include <vector>

#include "consensus/babe/types/epoch_digest.hpp"
#include "outcome/outcome.hpp"
#include "primitives/block.hpp"
#include "primitives/block_id.hpp"
#include "primitives/common.hpp"
#include "primitives/justification.hpp"
#include "primitives/version.hpp"

namespace kagome::blockchain {
  class BlockTree {
   public:
    using BlockHashVecRes = outcome::result<std::vector<primitives::BlockHash>>;

    virtual ~BlockTree() = default;

    virtual const primitives::BlockHash &getGenesisBlockHash() const = 0;

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

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

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

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

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

    virtual outcome::result<void> addBlockBody(
        primitives::BlockNumber block_number,
        const primitives::BlockHash &block_hash,
        const primitives::BlockBody &block_body) = 0;

    virtual outcome::result<void> addExistingBlock(
        const primitives::BlockHash &block_hash,
        const primitives::BlockHeader &block_header) = 0;

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

    virtual outcome::result<void> removeLeaf(
        const primitives::BlockHash &block_hash) = 0;

    virtual outcome::result<void> finalize(
        const primitives::BlockHash &block,
        const primitives::Justification &justification) = 0;

    enum class GetChainDirection { ASCEND, DESCEND };

    virtual BlockHashVecRes getBestChainFromBlock(
        const primitives::BlockHash &block, uint64_t maximum) const = 0;

    virtual BlockHashVecRes getDescendingChainToBlock(
        const primitives::BlockHash &block, uint64_t maximum) const = 0;

    virtual BlockHashVecRes getChainByBlocks(
        const primitives::BlockHash &ancestor,
        const primitives::BlockHash &descendant) const = 0;

    virtual bool hasDirectChain(
        const primitives::BlockHash &ancestor,
        const primitives::BlockHash &descendant) const = 0;

    virtual primitives::BlockInfo deepestLeaf() const = 0;

    virtual outcome::result<primitives::BlockInfo> getBestContaining(
        const primitives::BlockHash &target_hash,
        const std::optional<primitives::BlockNumber> &max_number) const = 0;

    virtual std::vector<primitives::BlockHash> getLeaves() const = 0;

    virtual BlockHashVecRes getChildren(
        const primitives::BlockHash &block) const = 0;

    virtual primitives::BlockInfo getLastFinalized() const = 0;
  };

}  // namespace kagome::blockchain

#endif  // KAGOME_BLOCK_TREE_HPP