eligibility

Documentation

Index

• type Beacon
  • func NewBeacon(beaconGetter system.BeaconGetter, logger log.Log) *Beacon
  • func (b *Beacon) Value(ctx context.Context, epochID types.EpochID) (uint32, error)
• type Oracle
  • func New(beacon valueProvider, atxdb atxProvider, meshdb meshProvider, ...) *Oracle
  • func (o *Oracle) CalcEligibility(ctx context.Context, layer types.LayerID, round uint32, committeeSize int, ...) (uint16, error)
  • func (o *Oracle) GetEpochBeacon(ctx context.Context, epoch types.EpochID) bool
  • func (o *Oracle) IsIdentityActiveOnConsensusView(ctx context.Context, edID string, layer types.LayerID) (bool, error)
  • func (o *Oracle) Proof(ctx context.Context, layer types.LayerID, round uint32) ([]byte, error)
  • func (o *Oracle) Validate(ctx context.Context, layer types.LayerID, round uint32, committeeSize int, ...) (bool, error)

Types

type Beacon

type Beacon struct {
	log.Log
	// contains filtered or unexported fields
}

Beacon provides the value that is under consensus as defined by the hare.

func NewBeacon

func NewBeacon(beaconGetter system.BeaconGetter, logger log.Log) *Beacon

NewBeacon returns a new beacon.

func (*Beacon) Value

func (b *Beacon) Value(ctx context.Context, epochID types.EpochID) (uint32, error)

Value returns the beacon value for an epoch.

type Oracle

type Oracle struct {
	log.Log
	// contains filtered or unexported fields
}

Oracle is the hare eligibility oracle.

func New

func New(
	beacon valueProvider,
	atxdb atxProvider,
	meshdb meshProvider,
	vrfVerifier verifierFunc,
	vrfSigner signer,
	layersPerEpoch uint32,
	cfg eCfg.Config,
	logger log.Log) *Oracle

New returns a new eligibility oracle instance.

func (*Oracle) CalcEligibility

func (o *Oracle) CalcEligibility(ctx context.Context, layer types.LayerID, round uint32, committeeSize int,
	id types.NodeID, vrfSig []byte) (uint16, error)

CalcEligibility calculates the number of eligibilities of ID on the given Layer where msg is the VRF message, sig is the role proof and assuming commSize as the expected committee size.

func (*Oracle) GetEpochBeacon

func (o *Oracle) GetEpochBeacon(ctx context.Context, epoch types.EpochID) bool

GetEpochBeacon returns the beacon for the specified epoch.

func (*Oracle) IsIdentityActiveOnConsensusView

func (o *Oracle) IsIdentityActiveOnConsensusView(ctx context.Context, edID string, layer types.LayerID) (bool, error)

IsIdentityActiveOnConsensusView returns true if the provided identity is active on the consensus view derived from the specified layer, false otherwise.

func (*Oracle) Proof

func (o *Oracle) Proof(ctx context.Context, layer types.LayerID, round uint32) ([]byte, error)

Proof returns the role proof for the current Layer & Round.

func (*Oracle) Validate

func (o *Oracle) Validate(ctx context.Context, layer types.LayerID, round uint32, committeeSize int, id types.NodeID, sig []byte, eligibilityCount uint16) (bool, error)

Validate validates the number of eligibilities of ID on the given Layer where msg is the VRF message, sig is the role proof and assuming commSize as the expected committee size.