cmd

Documentation

Index

• Variables
• func Execute()
• type HotstuffReader
  • func NewHotstuffReader(db *badger.DB, chainID flow.ChainID) HotstuffReader

Variables

var GetLivenessCmd = &cobra.Command{
	Use:   "get-liveness",
	Short: "get hotstuff liveness data (current view, newest QC, last view TC)",
	Run:   runGetLivenessData,
}

var GetSafetyCmd = &cobra.Command{
	Use:   "get-safety",
	Short: "get hotstuff safety data (locked view, highest acked view, last timeout)",
	Run:   runGetSafetyData,
}

var RootCmd = rootCmd

Functions

func Execute

func Execute()

Types

type HotstuffReader

type HotstuffReader interface {
	// GetLivenessData retrieves the latest persisted liveness data.
	GetLivenessData() (*hotstuff.LivenessData, error)
	// GetSafetyData retrieves the latest persisted safety data.
	GetSafetyData() (*hotstuff.SafetyData, error)
}

HotstuffReader exposes only the read-only parts of the Hotstuff Persister component. This is used to read information about the HotStuff instance's current state from CLI tools. CAUTION: the write functions are hidden here, because it is NOT SAFE to use them outside the Hotstuff state machine.

func NewHotstuffReader

func NewHotstuffReader(db *badger.DB, chainID flow.ChainID) HotstuffReader

NewHotstuffReader returns a new Persister, constrained to read-only operations.