zbft

type Config struct {
	// Key pair for the node
	KeyPair *keypair.KeyPair

	// Blockchain instance
	Blockchain *blockchain.Blockchain

	// Finite state machine for the blockchain
	FSM FSM

	// Logger
	Logger *log.Logger
}

type FSM interface {
	// Initializes the fsm with the given read-only tx store
	Init(store TxStore)
	// Prepare prepares the tx set writing the outputs back into the tx outputs
	Prepare(txs []*bcpb.Tx) error
	// Executes applies the given transactions
	Execute(txs []*bcpb.Tx, block *bcpb.BlockHeader, leader bool) error
}

type Future struct {
	// contains filtered or unexported fields
}

type TxStore interface {
	// Returns the output associated to the given input
	GetTXO(txi *bcpb.TxInput) (*bcpb.TxOutput, error)
}

type ZBFT interface {
	// Start zbft
	Start()
	// SetGenesis is used to set the genesis block.  This can only be called
	// once for each ledger
	SetGenesis(blk *bcpb.Block, txs []*bcpb.Tx) *Future
	// Submits message to consensus algo
	Step(msg zbftpb.Message)
	// SetTimeout sets the timeout for a given consensus round
	SetTimeout(d time.Duration)
	// ProposeTxs proposes Transactions to the ledger.  They are first prepared,
	// added to a block then proposes to be added to the ledger
	ProposeTxs(txs []*bcpb.Tx) *Future
	// BroadcastMessages returns a read-only channel of messages that need to be
	// broadcasted to the network
	BroadcastMessages() <-chan zbftpb.Message
}