tortoise

Documentation

Index

• type Config
  • func DefaultConfig() Config
• type Opinion
• type Opt
  • func WithConfig(cfg Config) Opt
  • func WithContext(ctx context.Context) Opt
  • func WithLogger(logger log.Log) Opt
• type Tortoise
  • func New(db database.Database, mdb blockDataProvider, atxdb atxDataProvider, ...) *Tortoise
  • func (trtl *Tortoise) BaseBlock(ctx context.Context) (types.BlockID, [][]types.BlockID, error)
  • func (trtl *Tortoise) HandleIncomingLayer(ctx context.Context, layerID types.LayerID) (types.LayerID, types.LayerID, bool)
  • func (trtl *Tortoise) LatestComplete() types.LayerID
  • func (trtl *Tortoise) Persist(ctx context.Context) error
  • func (trtl *Tortoise) Stop()

Types

type Config

type Config struct {
	Hdist           uint32        `mapstructure:"tortoise-hdist"`            // hare/input vector lookback distance
	Zdist           uint32        `mapstructure:"tortoise-zdist"`            // hare result wait distance
	ConfidenceParam uint32        `mapstructure:"tortoise-confidence-param"` // layers to wait for global consensus
	WindowSize      uint32        `mapstructure:"tortoise-window-size"`      // size of the tortoise sliding window (in layers)
	GlobalThreshold *big.Rat      `mapstructure:"tortoise-global-threshold"` // threshold for finalizing blocks and layers
	LocalThreshold  *big.Rat      `mapstructure:"tortoise-local-threshold"`  // threshold for choosing when to use weak coin
	RerunInterval   time.Duration `mapstructure:"tortoise-rerun-interval"`
	MaxExceptions   int           `mapstructure:"tortoise-max-exceptions"` // if candidate for base block has more than max exceptions it will be ignored

	LayerSize                uint32
	BadBeaconVoteDelayLayers uint32 // number of layers to delay votes for blocks with bad beacon values during self-healing
}

Config for protocol parameters.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig for Tortoise.

type Opinion

type Opinion map[types.BlockID]vec

Opinion is opinions on other blocks.

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(db database.Database, mdb blockDataProvider, atxdb atxDataProvider, beacons system.BeaconGetter, opts ...Opt) *Tortoise

New creates Tortoise instance.

func (*Tortoise) BaseBlock

func (trtl *Tortoise) BaseBlock(ctx context.Context) (types.BlockID, [][]types.BlockID, error)

BaseBlock chooses a base block and creates a differences list. needs the hare results for latest layers.

func (*Tortoise) HandleIncomingLayer

func (trtl *Tortoise) HandleIncomingLayer(ctx context.Context, layerID types.LayerID) (types.LayerID, types.LayerID, bool)

HandleIncomingLayer processes all layer block votes returns the old verified layer and new verified layer after taking into account the blocks votes.

func (*Tortoise) LatestComplete

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

LatestComplete returns the latest verified layer.

func (*Tortoise) Persist

func (trtl *Tortoise) Persist(ctx context.Context) error

Persist saves a copy of the current tortoise state to the database.

func (*Tortoise) Stop

func (trtl *Tortoise) Stop()

Stop background workers.