kauri

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 27, 2025 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package kauri contains the implementation of the Kauri protocol

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() modules.Kauri

New initializes the kauri structure

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

func (k *Kauri) InitModule(mods *modules.Core)

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
}

Jump to

Keyboard shortcuts

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