beacon

Documentation

Index

• func BeaconEntriesForBlock(ctx context.Context, bSchedule Schedule, nv network.Version, ...) ([]types.BeaconEntry, error)
• func ValidateBlockValues(bSchedule Schedule, nv network.Version, h *types.BlockHeader, ...) error
• type BeaconPoint
• type MockBeacon
  • func (mb *MockBeacon) Entry(ctx context.Context, index uint64) <-chan Response
  • func (mb *MockBeacon) IsChained() bool
  • func (mb *MockBeacon) MaxBeaconRoundForEpoch(nv network.Version, epoch abi.ChainEpoch) uint64
  • func (mb *MockBeacon) RoundTime() time.Duration
  • func (mb *MockBeacon) SetMaxIndex(maxIndex int, blockTillNoneWaiting bool)
  • func (mb *MockBeacon) VerifyEntry(from types.BeaconEntry, _prevEntrySig []byte) error
  • func (mb *MockBeacon) WaitingOnEntryCount() int
• type RandomBeacon
  • func NewMockBeacon(interval time.Duration) RandomBeacon
• type Response
• type Schedule
  • func (bs Schedule) BeaconForEpoch(e abi.ChainEpoch) RandomBeacon

Functions

func BeaconEntriesForBlock

func BeaconEntriesForBlock(ctx context.Context, bSchedule Schedule, nv network.Version, epoch abi.ChainEpoch, parentEpoch abi.ChainEpoch, prev types.BeaconEntry) ([]types.BeaconEntry, error)

func ValidateBlockValues

func ValidateBlockValues(bSchedule Schedule, nv network.Version, h *types.BlockHeader, parentEpoch abi.ChainEpoch,
	prevEntry types.BeaconEntry) error

Types

type BeaconPoint

type BeaconPoint struct {
	Start  abi.ChainEpoch
	Beacon RandomBeacon
}

type MockBeacon

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

MockBeacon assumes that filecoin rounds are 1:1 mapped with the beacon rounds

func (*MockBeacon) Entry

func (mb *MockBeacon) Entry(ctx context.Context, index uint64) <-chan Response

func (*MockBeacon) IsChained

func (mb *MockBeacon) IsChained() bool

func (*MockBeacon) MaxBeaconRoundForEpoch

func (mb *MockBeacon) MaxBeaconRoundForEpoch(nv network.Version, epoch abi.ChainEpoch) uint64

func (*MockBeacon) RoundTime

func (mb *MockBeacon) RoundTime() time.Duration

func (*MockBeacon) SetMaxIndex

func (mb *MockBeacon) SetMaxIndex(maxIndex int, blockTillNoneWaiting bool)

SetMaxIndex sets the maximum index that the beacon will return, and optionally blocks until all waiting requests are satisfied. If maxIndex is -1, the beacon will return entries indefinitely.

func (*MockBeacon) VerifyEntry

func (mb *MockBeacon) VerifyEntry(from types.BeaconEntry, _prevEntrySig []byte) error

func (*MockBeacon) WaitingOnEntryCount

func (mb *MockBeacon) WaitingOnEntryCount() int

WaitingOnEntryCount returns the number of requests that are currently waiting for an entry. Where maxIndex has not been set, this will always return 0 as beacon entries are generated on demand.

type RandomBeacon

type RandomBeacon interface {
	Entry(context.Context, uint64) <-chan Response
	VerifyEntry(entry types.BeaconEntry, prevEntrySig []byte) error
	MaxBeaconRoundForEpoch(network.Version, abi.ChainEpoch) uint64
	IsChained() bool
}

RandomBeacon represents a system that provides randomness to Lotus. Other components interrogate the RandomBeacon to acquire randomness that's valid for a specific chain epoch. Also to verify beacon entries that have been posted on chain.

func NewMockBeacon

func NewMockBeacon(interval time.Duration) RandomBeacon

type Response

type Response struct {
	Entry types.BeaconEntry
	Err   error
}

type Schedule

type Schedule []BeaconPoint

func (Schedule) BeaconForEpoch

func (bs Schedule) BeaconForEpoch(e abi.ChainEpoch) RandomBeacon