grandpa_api.hpp

Go to the documentation of this file.

#ifndef KAGOME_RUNTIME_GRANDPAAPI
#define KAGOME_RUNTIME_GRANDPAAPI

#include <optional>

#include "common/buffer.hpp"
#include "outcome/outcome.hpp"
#include "primitives/authority.hpp"
#include "primitives/block_id.hpp"
#include "primitives/common.hpp"
#include "primitives/digest.hpp"
#include "primitives/scheduled_change.hpp"
#include "primitives/session_key.hpp"

namespace kagome::runtime {
  // https://github.com/paritytech/substrate/blob/8bf08ca63491961fafe6adf414a7411cb3953dcf/core/finality-grandpa/primitives/src/lib.rs#L56

  class GrandpaApi {
   protected:
    using Digest = primitives::Digest;
    using ScheduledChange = primitives::ScheduledChange;
    using BlockNumber = primitives::BlockNumber;
    using AuthorityList = primitives::AuthorityList;
    using ForcedChange = primitives::ForcedChange;
    using BlockId = primitives::BlockId;

   public:
    virtual ~GrandpaApi() = default;
    virtual outcome::result<std::optional<ScheduledChange>> pending_change(
        primitives::BlockHash const &block, const Digest &digest) = 0;

    virtual outcome::result<std::optional<ForcedChange>> forced_change(
        primitives::BlockHash const &block, const Digest &digest) = 0;

    virtual outcome::result<AuthorityList> authorities(
        const primitives::BlockId &block_id) = 0;

    virtual outcome::result<primitives::AuthoritySetId> current_set_id(
        const primitives::BlockHash &block) = 0;
  };

}  // namespace kagome::runtime

#endif  // KAGOME_RUNTIME_GRANDPAAPI