gadgets

Documentation

Index

• type Heights
  • func NewHeights() *Heights
  • func (g *Heights) BlockFinalized(block *flow.Header)
  • func (g *Heights) OnHeight(height uint64, callback func())
• type IdentityDeltas
  • func NewIdentityDeltas(cb func()) *IdentityDeltas
  • func (g *IdentityDeltas) EpochCommittedPhaseStarted(_ uint64, _ *flow.Header)
  • func (g *IdentityDeltas) EpochSetupPhaseStarted(_ uint64, _ *flow.Header)
  • func (g *IdentityDeltas) EpochTransition(_ uint64, _ *flow.Header)
• type Views
  • func NewViews() *Views
  • func (v *Views) BlockFinalized(block *flow.Header)
  • func (v *Views) OnView(view uint64, callback events.OnViewCallback)

Types

type Heights

type Heights struct {
	events.Noop
	// contains filtered or unexported fields
}

Heights is a protocol events consumer that provides an interface to subscribe to callbacks when chain state reaches a particular height.

func NewHeights

func NewHeights() *Heights

NewHeights returns a new Heights events gadget.

func (*Heights) BlockFinalized

func (g *Heights) BlockFinalized(block *flow.Header)

BlockFinalized handles block finalized protocol events, triggering height callbacks as needed.

func (*Heights) OnHeight

func (g *Heights) OnHeight(height uint64, callback func())

OnHeight registers the callback for the given height, only if the height has not already been finalized.

type IdentityDeltas

type IdentityDeltas struct {
	events.Noop
	// contains filtered or unexported fields
}

IdentityDeltas is a protocol events consumer that provides an interface to subscribe to callbacks any time an identity table change (or possible change) is finalized.

TODO(EFM, #6123) add slashing/ejection events here once implemented TODO(EFM, #6123): Consider consolidating this with ProtocolStateIDCache

func NewIdentityDeltas

func NewIdentityDeltas(cb func()) *IdentityDeltas

NewIdentityDeltas returns a new IdentityDeltas events gadget.

func (*IdentityDeltas) EpochCommittedPhaseStarted

func (g *IdentityDeltas) EpochCommittedPhaseStarted(_ uint64, _ *flow.Header)

func (*IdentityDeltas) EpochSetupPhaseStarted

func (g *IdentityDeltas) EpochSetupPhaseStarted(_ uint64, _ *flow.Header)

func (*IdentityDeltas) EpochTransition

func (g *IdentityDeltas) EpochTransition(_ uint64, _ *flow.Header)

type Views

type Views struct {
	sync.Mutex
	events.Noop
	// contains filtered or unexported fields
}

Views is a protocol events consumer that provides an interface to subscribe to callbacks when consensus reaches a particular view. When a callback is registered for a view, it will be invoked when the first block with block.View >= V is finalized. Callbacks for earlier views are executed before callbacks for later views, and callbacks for the same view are executed on a FIFO basis.

func NewViews

func NewViews() *Views

NewViews returns a new Views events gadget.

func (*Views) BlockFinalized

func (v *Views) BlockFinalized(block *flow.Header)

BlockFinalized handles block finalized protocol events, triggering view callbacks as needed.

func (*Views) OnView

func (v *Views) OnView(view uint64, callback events.OnViewCallback)

OnView registers the callback for the given view.