authority_manager.hpp

Go to the documentation of this file.

#ifndef KAGOME_AUTHORITY_MANAGER
#define KAGOME_AUTHORITY_MANAGER

#include <boost/optional.hpp>

#include "common/tagged.hpp"
#include "primitives/authority.hpp"
#include "primitives/block_header.hpp"

namespace kagome::storage::trie {
  class TrieStorage;
  class TrieBatch;
}

namespace kagome::crypto {
  class Hasher;
}

namespace kagome::authority {

  using IsBlockFinalized = Tagged<bool, struct IsBlockFinalizedTag>;

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

    virtual outcome::result<void> recalculateStoredState(
        primitives::BlockNumber last_finalized_number) = 0;

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

    virtual std::optional<std::shared_ptr<const primitives::AuthoritySet>>
    authorities(const primitives::BlockInfo &block,
                IsBlockFinalized finalized) const = 0;

    virtual outcome::result<void> applyScheduledChange(
        const primitives::BlockInfo &block,
        const primitives::AuthorityList &authorities,
        primitives::BlockNumber activate_at) = 0;

    virtual outcome::result<void> applyForcedChange(
        const primitives::BlockInfo &block,
        const primitives::AuthorityList &authorities,
        primitives::BlockNumber delay_start,
        size_t delay) = 0;

    virtual outcome::result<void> applyOnDisabled(
        const primitives::BlockInfo &block, uint64_t authority_index) = 0;

    virtual outcome::result<void> applyPause(
        const primitives::BlockInfo &block,
        primitives::BlockNumber activate_at) = 0;

    virtual outcome::result<void> applyResume(
        const primitives::BlockInfo &block,
        primitives::BlockNumber activate_at) = 0;

    virtual void prune(const primitives::BlockInfo &block) = 0;
  };
}  // namespace kagome::authority

#endif  // KAGOME_AUTHORITY_MANAGER