consensus

Documentation

Index

• type FakeEC
  • func NewFakeEC(o ...FakeECOption) *FakeEC
  • func (ec *FakeEC) Finalize(_ context.Context, tsk gpbft.TipSetKey) error
  • func (ec *FakeEC) GetCurrentHead() int64
  • func (ec *FakeEC) GetHead(ctx context.Context) (ec.TipSet, error)
  • func (ec *FakeEC) GetParent(ctx context.Context, ts ec.TipSet) (ec.TipSet, error)
  • func (ec *FakeEC) GetPowerTable(_ context.Context, tsk gpbft.TipSetKey) (gpbft.PowerEntries, error)
  • func (ec *FakeEC) GetTipset(_ context.Context, tsk gpbft.TipSetKey) (ec.TipSet, error)
  • func (ec *FakeEC) GetTipsetByEpoch(_ context.Context, epoch int64) (ec.TipSet, error)
  • func (ec *FakeEC) Pause()
  • func (ec *FakeEC) Resume()
• type FakeECOption
  • func WithBootstrapEpoch(epoch int64) FakeECOption
  • func WithClock(clock clock.Clock) FakeECOption
  • func WithECPeriod(ecPeriod time.Duration) FakeECOption
  • func WithEvolvingPowerTable(fn PowerTableMutator) FakeECOption
  • func WithForkAfterEpochs(e int64) FakeECOption
  • func WithForkSeed(e int64) FakeECOption
  • func WithInitialPowerTable(initialPowerTable gpbft.PowerEntries) FakeECOption
  • func WithMaxLookback(distance int64) FakeECOption
  • func WithNullTipsetProbability(p float64) FakeECOption
  • func WithSeed(seed int64) FakeECOption
• type PowerTableMutator

Types

type FakeEC

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

func NewFakeEC

func NewFakeEC(o ...FakeECOption) *FakeEC

func (*FakeEC) Finalize

func (ec *FakeEC) Finalize(_ context.Context, tsk gpbft.TipSetKey) error

func (*FakeEC) GetCurrentHead

func (ec *FakeEC) GetCurrentHead() int64

func (*FakeEC) GetHead

func (ec *FakeEC) GetHead(ctx context.Context) (ec.TipSet, error)

func (*FakeEC) GetParent

func (ec *FakeEC) GetParent(ctx context.Context, ts ec.TipSet) (ec.TipSet, error)

func (*FakeEC) GetPowerTable

func (ec *FakeEC) GetPowerTable(_ context.Context, tsk gpbft.TipSetKey) (gpbft.PowerEntries, error)

func (*FakeEC) GetTipset

func (ec *FakeEC) GetTipset(_ context.Context, tsk gpbft.TipSetKey) (ec.TipSet, error)

func (*FakeEC) GetTipsetByEpoch

func (ec *FakeEC) GetTipsetByEpoch(_ context.Context, epoch int64) (ec.TipSet, error)

GetTipsetByEpoch returns the tipset at a given epoch. If the epoch does not yet exist, it returns an error.

func (*FakeEC) Pause

func (ec *FakeEC) Pause()

Pause pauses EC.

func (*FakeEC) Resume

func (ec *FakeEC) Resume()

Resume resumes EC.

type FakeECOption

type FakeECOption func(*fakeECOptions)

func WithBootstrapEpoch

func WithBootstrapEpoch(epoch int64) FakeECOption

func WithClock

func WithClock(clock clock.Clock) FakeECOption

WithClock sets the clock used to determine the current time. This is useful for testing purposes, as it allows you to control the time progression of the EC. The default clock is the system clock.

func WithECPeriod

func WithECPeriod(ecPeriod time.Duration) FakeECOption

func WithEvolvingPowerTable

func WithEvolvingPowerTable(fn PowerTableMutator) FakeECOption

func WithForkAfterEpochs

func WithForkAfterEpochs(e int64) FakeECOption

WithForkAfterEpochs sets the minimum number of epochs from the latest finalized tipset key after which this EC may fork away.

func WithForkSeed

func WithForkSeed(e int64) FakeECOption

WithForkSeed sets the seed used to generate fork chains. For this option to take effect, WithForkAfterEpochs must be set to a value greater than 0.

func WithInitialPowerTable

func WithInitialPowerTable(initialPowerTable gpbft.PowerEntries) FakeECOption

func WithMaxLookback

func WithMaxLookback(distance int64) FakeECOption

func WithNullTipsetProbability

func WithNullTipsetProbability(p float64) FakeECOption

func WithSeed

func WithSeed(seed int64) FakeECOption

type PowerTableMutator

type PowerTableMutator func(epoch int64, pt gpbft.PowerEntries) gpbft.PowerEntries