bft

README

BFT Consensus library

Notes on Execution provider (Polygon)

• The proposer of each block will add a transaction indicating the current height of polygon for the purpose of validating redeem events.
  • This height is verified in FinalizeBlock by nodes using a spread calculated by the cometbft configured ~10 + blockTime / 2 (2 second polygon time, add 10 as 'slack')

Documentation

Index

• type Instance
  • func NewInstance(collector *collector.CollectorInstance, tracker validatorpass_tracker.Tracker) (*Instance, error)
  • func (i *Instance) SetTracker(tracker *validatorpass_tracker.Tracker) error
  • func (inst *Instance) Start(ctx context.Context)
  • func (i *Instance) Stop() error

Types

type Instance

type Instance struct {
	Config     *cfg.Config
	Addr       []byte
	BftNode    *nm.Node
	FullPubKey []byte
	// contains filtered or unexported fields
}

Instance is the CometBFT instance

func NewInstance

func NewInstance(collector *collector.CollectorInstance, tracker validatorpass_tracker.Tracker) (*Instance, error)

NewInstance initialise a CometBFT instance use the config specified

func (*Instance) SetTracker

func (i *Instance) SetTracker(tracker *validatorpass_tracker.Tracker) error

func (*Instance) Start

func (inst *Instance) Start(ctx context.Context)

Start the CometBFT node

func (*Instance) Stop

func (i *Instance) Stop() error

Stop the CometBFT node