blockgadget

Documentation

Index

• Variables
• type Events
• type Gadget

Variables

var NewEvents = event.CreateGroupConstructor(func() (newEvents *Events) {
	return &Events{
		BlockPreAccepted:  event.New1[*blocks.Block](),
		BlockPreConfirmed: event.New1[*blocks.Block](),
		BlockAccepted:     event.New1[*blocks.Block](),
		BlockConfirmed:    event.New1[*blocks.Block](),
	}
})

NewEvents contains the constructor of the Events object (it is generated by a generic factory).

Types

type Events

type Events struct {
	BlockPreAccepted  *event.Event1[*blocks.Block]
	BlockPreConfirmed *event.Event1[*blocks.Block]
	BlockAccepted     *event.Event1[*blocks.Block]
	BlockConfirmed    *event.Event1[*blocks.Block]

	event.Group[Events, *Events]
}

type Gadget

type Gadget interface {
	module.Interface

	TrackWitnessWeight(votingBlock *blocks.Block)
	SetAccepted(block *blocks.Block) bool

	// Reset resets the component to a clean state as if it was created at the last commitment.
	Reset()
}