tortoise

Documentation

Index

• type Config
  • func DefaultConfig() Config
• type DecodedBallot
• type EncodeVotesOpts
  • func EncodeVotesWithCurrent(current types.LayerID) EncodeVotesOpts
• type Opt
  • func WithConfig(cfg Config) Opt
  • func WithContext(ctx context.Context) Opt
  • func WithLogger(logger log.Log) Opt
• type Tortoise
  • func New(cdb *datastore.CachedDB, beacons system.BeaconGetter, opts ...Opt) (*Tortoise, error)
  • func (t *Tortoise) DecodeBallot(ballot *types.Ballot) (*DecodedBallot, error)
  • func (t *Tortoise) EncodeVotes(ctx context.Context, opts ...EncodeVotesOpts) (*types.Opinion, error)
  • func (t *Tortoise) LatestComplete() types.LayerID
  • func (t *Tortoise) OnAtx(atx *types.ActivationTxHeader)
  • func (t *Tortoise) OnBallot(ballot *types.Ballot)
  • func (t *Tortoise) OnBlock(block *types.Block)
  • func (t *Tortoise) OnHareOutput(lid types.LayerID, bid types.BlockID)
  • func (t *Tortoise) StoreBallot(decoded *DecodedBallot) error
  • func (t *Tortoise) TallyVotes(ctx context.Context, lid types.LayerID)
  • func (t *Tortoise) Updates() map[types.LayerID]map[types.BlockID]bool

Types

type Config

type Config struct {
	Hdist uint32 `mapstructure:"tortoise-hdist"` // hare output lookback distance
	Zdist uint32 `mapstructure:"tortoise-zdist"` // hare result wait distance
	// how long we are waiting for a switch from verifying to full. relevant during rerun.
	WindowSize    uint32 `mapstructure:"tortoise-window-size"`    // size of the tortoise sliding window (in layers)
	MaxExceptions int    `mapstructure:"tortoise-max-exceptions"` // if candidate for base ballot has more than max exceptions it will be ignored
	// number of layers to delay votes for blocks with bad beacon values during self-healing. ideally a full epoch.
	BadBeaconVoteDelayLayers uint32 `mapstructure:"tortoise-delay-layers"`

	LayerSize uint32
}

Config for protocol parameters.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig for Tortoise.

type DecodedBallot

type DecodedBallot struct {
	*types.Ballot
	// contains filtered or unexported fields
}

DecodedBallot created after unwrapping exceptions list and computing internal opinion.

type EncodeVotesOpts

type EncodeVotesOpts func(*encodeConf)

EncodeVotesOpts is for configuring EncodeVotes options.

func EncodeVotesWithCurrent

func EncodeVotesWithCurrent(current types.LayerID) EncodeVotesOpts

EncodeVotesWithCurrent changes last known layer that will be used for encoding votes.

NOTE(dshulyak) why do we need this? tortoise computes threshold from last non-verified till the last known layer, since we dont download atxs before starting tortoise we won't be able to compute threshold based on the last clock layer (see https://github.com/spacemeshos/go-spacemesh/issues/3003)

type Opt

type Opt func(t *Tortoise)

Opt for configuring tortoise.

func WithConfig

func WithConfig(cfg Config) Opt

WithConfig defines protocol parameters.

func WithContext

func WithContext(ctx context.Context) Opt

WithContext defines context for tortoise.

func WithLogger

func WithLogger(logger log.Log) Opt

WithLogger defines logger for tortoise.

type Tortoise

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

Tortoise is a thread safe verifying tortoise wrapper, it just locks all actions.

func New

func New(cdb *datastore.CachedDB, beacons system.BeaconGetter, opts ...Opt) (*Tortoise, error)

New creates Tortoise instance.

func (*Tortoise) DecodeBallot

func (t *Tortoise) DecodeBallot(ballot *types.Ballot) (*DecodedBallot, error)

DecodeBallot decodes ballot if it wasn't processed earlier.

func (*Tortoise) EncodeVotes

func (t *Tortoise) EncodeVotes(ctx context.Context, opts ...EncodeVotesOpts) (*types.Opinion, error)

EncodeVotes chooses a base ballot and creates a differences list. needs the hare results for latest layers.

func (*Tortoise) LatestComplete

func (t *Tortoise) LatestComplete() types.LayerID

LatestComplete returns the latest verified layer.

func (*Tortoise) OnAtx

func (t *Tortoise) OnAtx(atx *types.ActivationTxHeader)

OnAtx is expected to be called before ballots that use this atx.

func (*Tortoise) OnBallot

func (t *Tortoise) OnBallot(ballot *types.Ballot)

OnBallot should be called every time new ballot is received. BaseBallot and RefBallot must be always processed first. And ATX must be stored in the database.

func (*Tortoise) OnBlock

func (t *Tortoise) OnBlock(block *types.Block)

OnBlock should be called every time new block is received.

func (*Tortoise) OnHareOutput

func (t *Tortoise) OnHareOutput(lid types.LayerID, bid types.BlockID)

OnHareOutput should be called when hare terminated or certificate for a block was synced from a peer. This method is expected to be called any number of times, with layers in any order.

This method should be called with EmptyBlockID if node received proof of malicious behavior, such as signing same block id by members of the same committee.

func (*Tortoise) StoreBallot

func (t *Tortoise) StoreBallot(decoded *DecodedBallot) error

StoreBallot stores previously decoded ballot.

func (*Tortoise) TallyVotes

func (t *Tortoise) TallyVotes(ctx context.Context, lid types.LayerID)

TallyVotes up to the specified layer.

func (*Tortoise) Updates

func (t *Tortoise) Updates() map[types.LayerID]map[types.BlockID]bool