babe.hpp

Go to the documentation of this file.

#ifndef KAGOME_BABE_HPP
#define KAGOME_BABE_HPP

#include <optional>

#include "consensus/babe/common.hpp"
#include "consensus/babe/types/epoch_descriptor.hpp"
#include "network/block_announce_observer.hpp"

namespace kagome::consensus::babe {
  class Babe : public network::BlockAnnounceObserver {
   public:
    ~Babe() override = default;

    enum class State {
      WAIT_REMOTE_STATUS,  // Node is just launched and waits status of remote
                           // peer to sync missing blocks
      HEADERS_LOADING,     // Fast sync requested; phase of headers downloading
      HEADERS_LOADED,      // Fast sync requested; headers downloaded, ready to
                           // syncing of state
      STATE_LOADING,       // Fast sync requested; phase of state downloading
      CATCHING_UP,  // Node recognized the missing blocks and started fetching
                    // blocks between the best missing one and one of the
                    // available ones
      WAIT_BLOCK_ANNOUNCE,  // Node is fetched missed blocks and wait block
                            // announce with next block to confirm state
                            // 'synchronized'
      SYNCHRONIZED  // All missing blocks were received and applied, current
                    // peer doing block production
    };

    virtual void runEpoch(EpochDescriptor epoch) = 0;

    virtual State getCurrentState() const = 0;

    virtual bool wasSynchronized() const = 0;
  };
}  // namespace kagome::consensus::babe

#endif  // KAGOME_BABE_HPP