Documentation
¶
Overview ¶
Package bft provides a thin wrapper around github.com/luxfi/bft (Simplex BFT) for integration with the Lux consensus engine interface.
Simplex BFT is maintained as an external MPL-licensed package. This wrapper provides glue code to integrate it with the consensus engine.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
NodeID string
Validators []string
EpochLength uint64
EpochConfig luxbft.EpochConfig // Pass-through to Simplex
}
Config for BFT engine wrapper
type Engine ¶ added in v1.22.1
type Engine struct {
// contains filtered or unexported fields
}
Engine wraps the Simplex BFT consensus engine
func New ¶ added in v1.22.1
New creates a new BFT consensus engine using Simplex For full Simplex configuration, use Config.EpochConfig
func (*Engine) GetSimplex ¶ added in v1.22.1
GetSimplex returns the underlying Simplex BFT engine Use this for direct access to Simplex features like: - ProposeBlock() - AddNode() - OnQC()
func (*Engine) HealthCheck ¶ added in v1.22.1
HealthCheck returns the health status
func (*Engine) IsBootstrapped ¶ added in v1.22.1
IsBootstrapped returns whether the engine has finished bootstrapping