README
¶
Go implementation of Fast Finality in Filecoin
This repository contains the golang implementation of the Fast Finality (F3) protocol for Filecoin as specified by FIP-0086. This protocol uses GossipPBFT consensus protocol to finalize tipsets when voted for by more than two-thirds of the storage power.
Key Features
- Core Implementation of GossipBFT Consensus Protocol: The heart of Go-F3.
- F3 Filecoin Integration Module: Streamlines the integration of the F3 protocol within the broader Filecoin ecosystem, specifically Lotus and other Filecoin full nodes.
- Simulation Package: Includes a robust simulation environment with various adversary models, enabling rigorous testing of the protocol under different network conditions and attack scenarios.
- Emulator Package: Facilitates message-by-message interaction with the GossipPBFT protocol, providing a detailed view of protocol mechanics and performance.
- Standalone F3 Participant Implementation: A complete implementation of an F3 protocol participant, capable of operating independently within the Filecoin network.
- Finality Certificate: Implements the generation and management of finality certificates, which cary transportable proofs of finality.
- Finality Certificate Exchange Protocol: Features an adaptive self-configuring polling mechanism, enhancing the efficiency and reliability of certificate exchange among participants.
Status
🧪 Under Passive Testing
The implementation of Go-F3 is complete and is currently undergoing passive testing in nv23. It has also been integrated into Lotus.
Project Structure
blssig: BLS signature schemes.certexchange: Certificate exchange mechanisms.certstore: Certificate storage.cmd: Command line to run a standalone F3 participant.ec: Expected Consensus utilities.emulator: Network emulation tools.gpbft: GossipPBFT protocol implementation.merkle: Merkle tree implementations.sim: Simulation harness.test: Test suite for various components.
License
This project is dual-licensed under the MIT and Apache 2.0 licenses. See LICENSE-APACHE and LICENSE-MIT for more details.
Documentation
¶
Index ¶
- Variables
- type BroadcastMessage
- type F3
- func (m *F3) Broadcast(ctx context.Context, signatureBuilder *gpbft.SignatureBuilder, msgSig []byte, ...)
- func (m *F3) GetCert(ctx context.Context, instance uint64) (*certs.FinalityCertificate, error)
- func (m *F3) GetLatestCert(context.Context) (*certs.FinalityCertificate, error)
- func (m *F3) GetPowerTable(ctx context.Context, ts gpbft.TipSetKey) (gpbft.PowerEntries, error)
- func (m *F3) IsRunning() bool
- func (m *F3) Manifest() *manifest.Manifest
- func (m *F3) MessagesToSign() <-chan *gpbft.MessageBuilder
- func (m *F3) Progress() (instant gpbft.InstanceProgress)
- func (m *F3) Start(startCtx context.Context) (_err error)
- func (m *F3) Stop(stopCtx context.Context) (_err error)
- type PartialGMessage
- type PartialMessageValidator
- type PartiallyValidatedMessage
Constants ¶
This section is empty.
Variables ¶
var ErrF3NotRunning = errors.New("f3 is not running")
ErrF3NotRunning is returned when an operation is attempted on a non-running F3 instance.
Functions ¶
This section is empty.
Types ¶
type BroadcastMessage ¶ added in v0.0.3
type BroadcastMessage func(*gpbft.MessageBuilder)
type F3 ¶
type F3 struct {
// contains filtered or unexported fields
}
func New ¶
func New(_ctx context.Context, manifest manifest.ManifestProvider, ds datastore.Datastore, h host.Host, ps *pubsub.PubSub, verif gpbft.Verifier, ec ec.Backend, diskPath string) (*F3, error)
New creates and setups f3 with libp2p The context is used for initialization not runtime.
func (*F3) GetLatestCert ¶
func (*F3) GetPowerTable ¶ added in v0.0.3
GetPowerTable returns the power table for the given tipset Used mainly for testing purposes
func (*F3) IsRunning ¶ added in v0.0.3
IsRunning returns true if gpbft is running Used mainly for testing purposes
func (*F3) MessagesToSign ¶ added in v0.0.3
func (m *F3) MessagesToSign() <-chan *gpbft.MessageBuilder
MessageStoSign returns a channel of outbound messages that need to be signed by the client(s). - The same channel is shared between all callers and will never be closed. - GPBFT will block if this channel is not read from.
func (*F3) Progress ¶ added in v0.4.0
func (m *F3) Progress() (instant gpbft.InstanceProgress)
type PartialGMessage ¶ added in v0.8.0
type PartialGMessage struct {
*gpbft.GMessage
VoteValueKey gpbft.ECChainKey `cborgen:"maxlen=32"`
}
func (*PartialGMessage) MarshalCBOR ¶ added in v0.8.0
func (t *PartialGMessage) MarshalCBOR(w io.Writer) error
func (*PartialGMessage) UnmarshalCBOR ¶ added in v0.8.0
func (t *PartialGMessage) UnmarshalCBOR(r io.Reader) (err error)
type PartialMessageValidator ¶ added in v0.8.0
type PartialMessageValidator interface {
PartiallyValidateMessage(msg *PartialGMessage) (*PartiallyValidatedMessage, error)
ValidateMessage(msg *PartiallyValidatedMessage) (gpbft.ValidatedMessage, error)
}
type PartiallyValidatedMessage ¶ added in v0.8.0
type PartiallyValidatedMessage struct {
*PartialGMessage
}
Source Files
Directories