Documentation
¶
Overview ¶
Package kauri contains the implementation of the Kauri protocol
Index ¶
- func New() modules.Kauri
- type ContributionRecvEvent
- type Kauri
- func (k *Kauri) Begin(pc hotstuff.PartialCert, p hotstuff.ProposeMsg)
- func (k *Kauri) InitModule(mods *modules.Core)
- func (k *Kauri) OnContributionRecv(event ContributionRecvEvent)
- func (k *Kauri) OnWaitTimerExpired(event WaitTimerExpiredEvent)
- func (k *Kauri) SendContributionToParent()
- func (k *Kauri) SendProposalToChildren(p hotstuff.ProposeMsg)
- func (k *Kauri) WaitToAggregate()
- type WaitTimerExpiredEvent
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ContributionRecvEvent ¶
type ContributionRecvEvent struct {
Contribution *kauripb.Contribution
}
ContributionRecvEvent is raised when a contribution is received.
type Kauri ¶
type Kauri struct {
// contains filtered or unexported fields
}
Kauri structure contains the modules for kauri protocol implementation.
func (*Kauri) Begin ¶
func (k *Kauri) Begin(pc hotstuff.PartialCert, p hotstuff.ProposeMsg)
Begin starts dissemination of proposal and aggregation of votes.
func (*Kauri) InitModule ¶
InitModule initializes the Handel module.
func (*Kauri) OnContributionRecv ¶
func (k *Kauri) OnContributionRecv(event ContributionRecvEvent)
OnContributionRecv is invoked upon receiving the vote for aggregation.
func (*Kauri) OnWaitTimerExpired ¶
func (k *Kauri) OnWaitTimerExpired(event WaitTimerExpiredEvent)
func (*Kauri) SendContributionToParent ¶
func (k *Kauri) SendContributionToParent()
SendContributionToParent sends contribution to the parent node.
func (*Kauri) SendProposalToChildren ¶
func (k *Kauri) SendProposalToChildren(p hotstuff.ProposeMsg)
SendProposalToChildren sends the proposal to the children.
func (*Kauri) WaitToAggregate ¶
func (k *Kauri) WaitToAggregate()
type WaitTimerExpiredEvent ¶
type WaitTimerExpiredEvent struct {
// contains filtered or unexported fields
}
Click to show internal directories.
Click to hide internal directories.