voting_round.hpp

Go to the documentation of this file.

#ifndef KAGOME_CONSENSUS_GRANDPA_VOTINGROUND
#define KAGOME_CONSENSUS_GRANDPA_VOTINGROUND

#include "common/tagged.hpp"
#include "consensus/grandpa/movable_round_state.hpp"
#include "consensus/grandpa/round_observer.hpp"

namespace kagome::consensus::grandpa {

  class VotingRound : public std::enable_shared_from_this<VotingRound> {
   public:
    virtual ~VotingRound() = default;

    // Getters

    virtual RoundNumber roundNumber() const = 0;

    virtual VoterSetId voterSetId() const = 0;

    virtual bool completable() const = 0;

    virtual BlockInfo lastFinalizedBlock() const = 0;

    virtual BlockInfo bestPrevoteCandidate() = 0;

    virtual BlockInfo bestFinalCandidate() = 0;

    virtual const std::optional<BlockInfo> &finalizedBlock() const = 0;

    virtual MovableRoundState state() const = 0;

    // Control lifecycle

    virtual void play() = 0;
    virtual void end() = 0;

    // Doing some activity

    virtual void doProposal() = 0;

    virtual void doPrevote() = 0;

    virtual void doPrecommit() = 0;

    virtual void doFinalize() = 0;

    virtual void doCommit() = 0;

    virtual void doCatchUpResponse(const libp2p::peer::PeerId &peer_id) = 0;

    // Handling incoming messages

    enum class Propagation : bool { NEEDLESS = false, REQUESTED = true };

    virtual void onProposal(const SignedMessage &primary_propose,
                            Propagation propagation) = 0;

    virtual bool onPrevote(const SignedMessage &prevote,
                           Propagation propagation) = 0;

    virtual bool onPrecommit(const SignedMessage &precommit,
                             Propagation propagation) = 0;

    using IsPreviousRoundChanged = Tagged<bool, struct IsPreviousRoundChanged>;
    using IsPrevotesChanged = Tagged<bool, struct IsPrevotesChanged>;
    using IsPrecommitsChanged = Tagged<bool, struct IsPrecommitsChanged>;

    virtual void update(IsPreviousRoundChanged is_previous_round_changed,
                        IsPrevotesChanged is_prevotes_changed,
                        IsPrecommitsChanged is_precommits_changed) = 0;

    // Auxiliary methods

    virtual std::shared_ptr<VotingRound> getPreviousRound() const = 0;

    virtual void forgetPreviousRound() = 0;

    virtual outcome::result<void> applyJustification(
        const BlockInfo &block_info,
        const GrandpaJustification &justification) = 0;

    virtual void attemptToFinalizeRound() = 0;
  };

}  // namespace kagome::consensus::grandpa

#endif  // KAGOME_CONSENSUS_GRANDPA_VOTINGROUND