instance

package

v0.4.0 Latest Latest Go to latest Published: Feb 1, 2023 License: GPL-3.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bloxapp/ssv

Links

Open Source Insights

Documentation ¶

Index ¶

func BaseCommitValidation(config qbft.IConfig, signedCommit *specqbft.SignedMessage, ...) error
func CreateCommit(state *specqbft.State, config qbft.IConfig, value []byte) (*specqbft.SignedMessage, error)
func CreatePrepare(state *specqbft.State, config qbft.IConfig, newRound specqbft.Round, ...) (*specqbft.SignedMessage, error)
func CreateProposal(state *specqbft.State, config qbft.IConfig, value []byte, ...) (*specqbft.SignedMessage, error)
func CreateRoundChange(state *specqbft.State, config qbft.IConfig, newRound specqbft.Round, ...) (*specqbft.SignedMessage, error)
type Instance
- func NewInstance(config qbft.IConfig, share *spectypes.Share, identifier []byte, ...) *Instance

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BaseCommitValidation ¶

func BaseCommitValidation(
	config qbft.IConfig,
	signedCommit *specqbft.SignedMessage,
	height specqbft.Height,
	operators []*spectypes.Operator,
) error

func CreateCommit ¶

func CreateCommit(state *specqbft.State, config qbft.IConfig, value []byte) (*specqbft.SignedMessage, error)

CreateCommit * Commit(

signCommit(
    UnsignedCommit(
        |current.blockchain|,
        current.round,
        signHash(hashBlockForCommitSeal(proposedBlock), current.id),
        digest(proposedBlock)),
        current.id
    )
);

func CreatePrepare ¶

func CreatePrepare(state *specqbft.State, config qbft.IConfig, newRound specqbft.Round, value []byte) (*specqbft.SignedMessage, error)

CreatePrepare * Prepare(

    signPrepare(
        UnsignedPrepare(
            |current.blockchain|,
            newRound,
            digest(m.proposedBlock)),
        current.id
        )
);

func CreateProposal ¶

func CreateProposal(state *specqbft.State, config qbft.IConfig, value []byte, roundChanges, prepares []*specqbft.SignedMessage) (*specqbft.SignedMessage, error)

CreateProposal *

	Proposal(
                      signProposal(
                          UnsignedProposal(
                              |current.blockchain|,
                              newRound,
                              digest(block)),
                          current.id),
                      block,
                      extractSignedRoundChanges(roundChanges),
                      extractSignedPrepares(prepares));

func CreateRoundChange ¶

func CreateRoundChange(state *specqbft.State, config qbft.IConfig, newRound specqbft.Round, instanceStartValue []byte) (*specqbft.SignedMessage, error)

CreateRoundChange * RoundChange(

    signRoundChange(
        UnsignedRoundChange(
            |current.blockchain|,
            newRound,
            digestOptionalBlock(current.lastPreparedBlock),
            current.lastPreparedRound),
    current.id),
    current.lastPreparedBlock,
    getRoundChangeJustification(current)
)

Types ¶

type Instance ¶

type Instance struct {
	State *specqbft.State

	StartValue []byte
	// contains filtered or unexported fields
}

Instance is a single QBFT instance that starts with a Start call (including a value). Every new msg the ProcessMsg function needs to be called

func NewInstance ¶

func NewInstance(
	config qbft.IConfig,
	share *spectypes.Share,
	identifier []byte,
	height specqbft.Height,
) *Instance

func (*Instance) BaseMsgValidation ¶

func (i *Instance) BaseMsgValidation(msg *specqbft.SignedMessage) error

func (*Instance) Broadcast ¶

func (i *Instance) Broadcast(msg *specqbft.SignedMessage) error

func (*Instance) Decode ¶

func (i *Instance) Decode(data []byte) error

Decode implementation

func (*Instance) Encode ¶

func (i *Instance) Encode() ([]byte, error)

Encode implementation

func (*Instance) GetConfig ¶

func (i *Instance) GetConfig() qbft.IConfig

GetConfig returns the instance config

func (*Instance) GetHeight ¶

func (i *Instance) GetHeight() specqbft.Height

GetHeight interface implementation

func (*Instance) GetRoot ¶

func (i *Instance) GetRoot() ([]byte, error)

GetRoot returns the state's deterministic root

func (*Instance) IsDecided ¶

func (i *Instance) IsDecided() (bool, []byte)

IsDecided interface implementation

func (*Instance) ProcessMsg ¶

func (i *Instance) ProcessMsg(msg *specqbft.SignedMessage) (decided bool, decidedValue []byte, aggregatedCommit *specqbft.SignedMessage, err error)

ProcessMsg processes a new QBFT msg, returns non nil error on msg processing error

func (*Instance) SetConfig ¶

func (i *Instance) SetConfig(config qbft.IConfig)

SetConfig returns the instance config

func (*Instance) Start ¶

func (i *Instance) Start(value []byte, height specqbft.Height)

Start is an interface implementation

func (*Instance) UponCommit ¶

func (i *Instance) UponCommit(signedCommit *specqbft.SignedMessage, commitMsgContainer *specqbft.MsgContainer) (bool, []byte, *specqbft.SignedMessage, error)

UponCommit returns true if a quorum of commit messages was received. Assumes commit message is valid!

func (*Instance) UponRoundTimeout ¶

func (i *Instance) UponRoundTimeout() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL