eligibility

Documentation

Overview

Package eligibility defines fixed size oracle used for node testing

Index

• type FixedRolacle
  • func New(logger log.Log) *FixedRolacle
  • func (fo *FixedRolacle) CalcEligibility(ctx context.Context, layer types.LayerID, round uint32, committeeSize int, ...) (uint16, error)
  • func (fo *FixedRolacle) Export(id types.Hash32, committeeSize int) map[types.NodeID]struct{}
  • func (fo *FixedRolacle) IsIdentityActiveOnConsensusView(ctx context.Context, edID types.NodeID, layer types.LayerID) (bool, error)
  • func (fo *FixedRolacle) Proof(ctx context.Context, _ *signing.VRFSigner, layer types.LayerID, round uint32) (types.VrfSignature, error)
  • func (fo *FixedRolacle) Register(isHonest bool, client types.NodeID)
  • func (fo *FixedRolacle) Unregister(isHonest bool, client types.NodeID)
  • func (fo *FixedRolacle) Validate(context.Context, types.LayerID, uint32, int, types.NodeID, types.VrfSignature, ...) (bool, error)

Types

type FixedRolacle

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

FixedRolacle is an eligibility simulator with pre-determined honest and faulty participants.

func New

func New(logger log.Log) *FixedRolacle

New initializes the oracle with no participants.

func (*FixedRolacle) CalcEligibility

func (fo *FixedRolacle) CalcEligibility(
	ctx context.Context,
	layer types.LayerID,
	round uint32,
	committeeSize int,
	id types.NodeID,
	sig types.VrfSignature,
) (uint16, error)

CalcEligibility returns 1 if the miner is eligible in given layer, and 0 otherwise.

func (*FixedRolacle) Export

func (fo *FixedRolacle) Export(id types.Hash32, committeeSize int) map[types.NodeID]struct{}

Export creates a map with the eligible participants for id and committee size.

func (*FixedRolacle) IsIdentityActiveOnConsensusView

func (fo *FixedRolacle) IsIdentityActiveOnConsensusView(
	ctx context.Context,
	edID types.NodeID,
	layer types.LayerID,
) (bool, error)

IsIdentityActiveOnConsensusView is use to satisfy the API, currently always returns true.

func (*FixedRolacle) Proof

func (fo *FixedRolacle) Proof(
	ctx context.Context,
	_ *signing.VRFSigner,
	layer types.LayerID,
	round uint32,
) (types.VrfSignature, error)

Proof generates a proof for the round. used to satisfy interface.

func (*FixedRolacle) Register

func (fo *FixedRolacle) Register(isHonest bool, client types.NodeID)

Register adds a participant to the eligibility map. can be honest or faulty.

func (*FixedRolacle) Unregister

func (fo *FixedRolacle) Unregister(isHonest bool, client types.NodeID)

Unregister removes a participant from the eligibility map. can be honest or faulty. TODO: just remove from both instead of specifying.

func (*FixedRolacle) Validate

func (fo *FixedRolacle) Validate(
	context.Context,
	types.LayerID,
	uint32,
	int,
	types.NodeID,
	types.VrfSignature,
	uint16,
) (bool, error)

Validate is required to conform to the Rolacle interface, but should never be called.