shardchain

Documentation

Index

• func NewEpochStartTrigger(args *ArgsShardEpochStartTrigger) (*trigger, error)
• type ArgsShardEpochStartTrigger
• type TestTrigger
  • func (t TestTrigger) Epoch() uint32
  • func (t TestTrigger) EpochFinalityAttestingRound() uint64
  • func (t TestTrigger) EpochStartMetaHdrHash() []byte
  • func (t TestTrigger) EpochStartRound() uint64
  • func (t TestTrigger) ForceEpochStart(_ uint64) error
  • func (t *TestTrigger) GetRoundsPerEpoch() uint64
  • func (t TestTrigger) GetSavedStateKey() []byte
  • func (t TestTrigger) IsEpochStart() bool
  • func (t TestTrigger) IsInterfaceNil() bool
  • func (t TestTrigger) LoadState(key []byte) error
  • func (t TestTrigger) ReceivedHeader(header data.HeaderHandler)
  • func (t TestTrigger) RequestEpochStartIfNeeded(interceptedHeader data.HeaderHandler)
  • func (t TestTrigger) Revert(_ uint64)
  • func (t TestTrigger) SetCurrentEpochStartRound(_ uint64)
  • func (t TestTrigger) SetFinalityAttestingRound(_ uint64)
  • func (t TestTrigger) SetProcessed(header data.HeaderHandler)
  • func (t *TestTrigger) SetRoundsPerEpoch(roundsPerEpoch uint64)
  • func (t *TestTrigger) SetTrigger(triggerHandler epochStart.TriggerHandler)
  • func (t TestTrigger) Update(_ uint64)
• type TriggerRegistry

Functions

func NewEpochStartTrigger

func NewEpochStartTrigger(args *ArgsShardEpochStartTrigger) (*trigger, error)

NewEpochStartTrigger creates a trigger to signal start of epoch

Types

type ArgsShardEpochStartTrigger

type ArgsShardEpochStartTrigger struct {
	Marshalizer marshal.Marshalizer
	Hasher      hashing.Hasher

	HeaderValidator epochStart.HeaderValidator
	Uint64Converter typeConverters.Uint64ByteSliceConverter

	DataPool           dataRetriever.PoolsHolder
	Storage            dataRetriever.StorageService
	RequestHandler     epochStart.RequestHandler
	EpochStartNotifier epochStart.EpochStartNotifier

	Epoch    uint32
	Validity uint64
	Finality uint64
}

ArgsShardEpochStartTrigger struct { defines the arguments needed for new start of epoch trigger

type TestTrigger

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

TestTrigger extends start of epoch trigger and is used in integration tests as it exposes some functions that are not supposed to be used in production code Exported functions simplify the reproduction of edge cases

func (TestTrigger) Epoch

func (t TestTrigger) Epoch() uint32

Epoch returns the current epoch number

func (TestTrigger) EpochFinalityAttestingRound

func (t TestTrigger) EpochFinalityAttestingRound() uint64

EpochFinalityAttestingRound returns the round when epoch start block was finalized

func (TestTrigger) EpochStartMetaHdrHash

func (t TestTrigger) EpochStartMetaHdrHash() []byte

EpochStartMetaHdrHash returns the announcing meta header hash which created the new epoch

func (TestTrigger) EpochStartRound

func (t TestTrigger) EpochStartRound() uint64

EpochStartRound returns the start round of the current epoch

func (TestTrigger) ForceEpochStart

func (t TestTrigger) ForceEpochStart(_ uint64) error

ForceEpochStart sets the conditions for start of epoch to true in case of edge cases

func (*TestTrigger) GetRoundsPerEpoch

func (t *TestTrigger) GetRoundsPerEpoch() uint64

GetRoundsPerEpoch gets the number of rounds per epoch

func (TestTrigger) GetSavedStateKey

func (t TestTrigger) GetSavedStateKey() []byte

GetSavedStateKey returns the last saved trigger state key

func (TestTrigger) IsEpochStart

func (t TestTrigger) IsEpochStart() bool

IsEpochStart returns true if conditions are fulfilled for start of epoch

func (TestTrigger) IsInterfaceNil

func (t TestTrigger) IsInterfaceNil() bool

IsInterfaceNil returns true if underlying object is nil

func (TestTrigger) LoadState

func (t TestTrigger) LoadState(key []byte) error

LoadState loads into trigger the saved state

func (TestTrigger) ReceivedHeader

func (t TestTrigger) ReceivedHeader(header data.HeaderHandler)

ReceivedHeader saves the header into pool to verify if end-of-epoch conditions are fulfilled only called with validated metablocks

func (TestTrigger) RequestEpochStartIfNeeded

func (t TestTrigger) RequestEpochStartIfNeeded(interceptedHeader data.HeaderHandler)

RequestEpochStartIfNeeded request the needed epoch start block if metablock with new epoch was received

func (TestTrigger) Revert

func (t TestTrigger) Revert(_ uint64)

Revert sets the start of epoch back to true

func (TestTrigger) SetCurrentEpochStartRound

func (t TestTrigger) SetCurrentEpochStartRound(_ uint64)

SetCurrentEpochStartRound sets the round when the current epoch started

func (TestTrigger) SetFinalityAttestingRound

func (t TestTrigger) SetFinalityAttestingRound(_ uint64)

SetFinalityAttestingRound sets the round which finalized the start of epoch block

func (TestTrigger) SetProcessed

func (t TestTrigger) SetProcessed(header data.HeaderHandler)

SetProcessed sets start of epoch to false and cleans underlying structure

func (*TestTrigger) SetRoundsPerEpoch

func (t *TestTrigger) SetRoundsPerEpoch(roundsPerEpoch uint64)

SetRoundsPerEpoch sets the number of round between epochs

func (*TestTrigger) SetTrigger

func (t *TestTrigger) SetTrigger(triggerHandler epochStart.TriggerHandler)

SetTrigger sets the start of epoch trigger

func (TestTrigger) Update

func (t TestTrigger) Update(_ uint64)

Update updates the end-of-epoch trigger

type TriggerRegistry

type TriggerRegistry struct {
	Epoch                       uint32
	CurrentRoundIndex           int64
	EpochStartRound             uint64
	EpochMetaBlockHash          []byte
	IsEpochStart                bool
	NewEpochHeaderReceived      bool
	EpochFinalityAttestingRound uint64
}

TriggerRegistry holds the data required to correctly initialize the trigger when booting from saved state