hotstuff

type Acceptor interface {
	// Accept returns true if the replica should accept the command, false otherwise
	Accept(Command) bool
}

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

type BlockChain interface {
	// Store stores a block in the blockchain
	Store(*Block)
	// Get retrieves a block given its hash
	Get(Hash) (*Block, bool)
}

type Command string

type CommandQueue interface {
	// GetCommand returns the next command to be proposed.
	GetCommand() *Command
}

type Config interface {
	// ID returns the id of this replica
	ID() ID
	// PrivateKey returns the id of this replica
	PrivateKey() PrivateKey
	// Replicas returns all of the replicas in the configuration
	Replicas() map[ID]Replica
	// Replica returns a replica if present in the configuration
	Replica(ID) (replica Replica, ok bool)
	// Len returns the number of replicas in the configuration
	Len() int
	// QuorumSize returns the size of a quorum
	QuorumSize() int
	// Propose sends the block to all replicas in the configuration
	Propose(block *Block)
	// Fetch requests a block from all the replicas in the configuration
	Fetch(ctx context.Context, hash Hash)
}

type Consensus interface {
	// Config returns the configuration of this replica
	Config() Config
	// LastVote returns the view in which the replica last voted
	LastVote() View
	// HighQC returns the highest QC known to the replica
	HighQC() QuorumCert
	// Leaf returns the last proposed block
	Leaf() *Block
	// BlockChain returns the datastructure containing the blocks known to the replica
	BlockChain() BlockChain
	// CreateDummy inserts a dummy block at View+1.
	// This is useful when a view must be skipped.
	CreateDummy()
	// Propose starts a new proposal
	Propose()
	// NewView sends a NewView message to the next leader
	NewView()
	// OnPropose handles an incoming proposal
	OnPropose(block *Block)
	// OnVote handles an incoming vote
	OnVote(cert PartialCert)
	// OnNewView handles an incoming NewView
	OnNewView(msg NewView)
	// OnDeliver handles an incoming block
	OnDeliver(block *Block)
}

type Credentials interface{}

type Executor interface {
	// Exec executes the given command
	Exec(Command)
}

type Hash [32]byte

type ID uint32

type LeaderRotation interface {
	// GetLeader returns the id of the leader in the given view
	GetLeader(View) ID
}

type NewView struct {
	// The ID of the replica who sent the message
	ID ID
	// The view that the replica wants to enter
	View View
	// The quorum certificate
	QC QuorumCert
}

type PartialCert interface {
	ToBytes
	// Signature returns the signature
	Signature() Signature
	// BlockHash returns the hash of the block that was signed
	BlockHash() Hash
}

type PrivateKey interface {
	// PublicKey returns the public key associated with this private key
	PublicKey() PublicKey
}

type PublicKey interface{}

type QuorumCert interface {
	ToBytes
	// BlockHash returns the hash of the block for which the certificate was created
	BlockHash() Hash
}

type Replica interface {
	// ID returns the replica's id
	ID() ID
	// PublicKey returns the replica's public key
	PublicKey() PublicKey
	// Vote sends the partial certificate to the other replica
	Vote(cert PartialCert)
	// NewView sends the quorum certificate to the other replica
	NewView(msg NewView)
	// Deliver sends the block to the other replica
	Deliver(block *Block)
}

type Signature interface {
	ToBytes
	// Signer returns the ID of the replica that generated the signature.
	Signer() ID
}

type Signer interface {
	// Sign signs a single block and returns the signature
	Sign(block *Block) (cert PartialCert, err error)
	// CreateQuourmCert creates a from a list of partial certificates
	CreateQuorumCert(block *Block, signatures []PartialCert) (cert QuorumCert, err error)
}

type ToBytes interface {
	// ToBytes returns the object as bytes
	ToBytes() []byte
}

type Verifier interface {
	// VerifyPartialCert verifies a single partial certificate
	VerifyPartialCert(cert PartialCert) bool
	// VerifyQuorumCert verifies a quorum certificate
	VerifyQuorumCert(qc QuorumCert) bool
}

type View uint64

type ViewSynchronizer interface {
	LeaderRotation
	// OnPropose should be called when a replica has received a new valid proposal.
	OnPropose()
	// OnFinishQC should be called when a replica has created a new qc
	OnFinishQC()
	// OnNewView should be called when a replica receives a valid NewView message
	OnNewView()
	// Init gives the synchronizer a consensus instance to synchronize
	Init(Consensus)
	// Start starts the synchronizer
	Start()
	// Stop stops the synchronizer
	Stop()
}