chain.hpp

Go to the documentation of this file.

#ifndef KAGOME_CORE_CONSENSUS_GRANDPA_CHAIN_HPP
#define KAGOME_CORE_CONSENSUS_GRANDPA_CHAIN_HPP

#include <vector>

#include <optional>
#include <outcome/outcome.hpp>
#include "consensus/grandpa/common.hpp"
#include "consensus/grandpa/structs.hpp"

namespace kagome::consensus::grandpa {

  struct Chain {
    virtual ~Chain() = default;

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

    virtual outcome::result<std::vector<primitives::BlockHash>> getAncestry(
        const primitives::BlockHash &base,
        const primitives::BlockHash &block) const = 0;

    virtual bool hasAncestry(const primitives::BlockHash &base,
                             const primitives::BlockHash &block) const = 0;

    virtual outcome::result<BlockInfo> bestChainContaining(
        const primitives::BlockHash &base,
        std::optional<VoterSetId> voter_set_id) const = 0;

    inline bool isEqualOrDescendOf(const primitives::BlockHash &base,
                                   const primitives::BlockHash &block) const {
      return base == block ? true : hasAncestry(base, block);
    }
  };

}  // namespace kagome::consensus::grandpa

#endif  // KAGOME_CORE_CONSENSUS_GRANDPA_CHAIN_HPP