detection

Documentation

Overview

Package detection defines a service that reacts to incoming blocks/attestations by running slashing detection for double proposals, double votes, and surround votes according to the Ethereum Beacon Chain specification. As soon as slashing objects are found, they are sent over a feed for the beaconclient service to submit to a beacon node via gRPC.

Index

• type Config
• type Service
  • func NewService(ctx context.Context, cfg *Config) *Service
  • func (s *Service) DetectAttesterSlashings(ctx context.Context, att *ethpb.IndexedAttestation) ([]*ethpb.AttesterSlashing, error)
  • func (s *Service) DetectDoubleProposals(ctx context.Context, incomingBlock *ethpb.SignedBeaconBlockHeader) (*ethpb.ProposerSlashing, error)
  • func (s *Service) DetectDoubleProposeNoUpdate(ctx context.Context, incomingBlock *ethpb.BeaconBlockHeader) (bool, error)
  • func (s *Service) Start()
  • func (s *Service) Status() error
  • func (s *Service) Stop() error
  • func (s *Service) UpdateHighestAttestation(ctx context.Context, att *ethpb.IndexedAttestation) error
  • func (s *Service) UpdateSpans(ctx context.Context, att *ethpb.IndexedAttestation) error
• type Status
  • func (s Status) String() string

Types

type Config

type Config struct {
	Notifier              beaconclient.Notifier
	SlasherDB             db.Database
	ChainFetcher          beaconclient.ChainFetcher
	BeaconClient          *beaconclient.Service
	AttesterSlashingsFeed *event.Feed
	ProposerSlashingsFeed *event.Feed
	HistoricalDetection   bool
}

Config options for the detection service.

type Service

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

Service struct for the detection service of the slasher.

func NewService

func NewService(ctx context.Context, cfg *Config) *Service

NewService instantiation.

func (*Service) DetectAttesterSlashings

func (s *Service) DetectAttesterSlashings(
	ctx context.Context,
	att *ethpb.IndexedAttestation,
) ([]*ethpb.AttesterSlashing, error)

DetectAttesterSlashings detects double, surround and surrounding attestation offences given an attestation.

func (*Service) DetectDoubleProposals

func (s *Service) DetectDoubleProposals(ctx context.Context, incomingBlock *ethpb.SignedBeaconBlockHeader) (*ethpb.ProposerSlashing, error)

DetectDoubleProposals checks if the given signed beacon block is a slashable offense and returns the slashing.

func (*Service) DetectDoubleProposeNoUpdate

func (s *Service) DetectDoubleProposeNoUpdate(ctx context.Context, incomingBlock *ethpb.BeaconBlockHeader) (bool, error)

DetectDoubleProposeNoUpdate checks if the given beacon block header is a slashable offense.

func (*Service) Start

func (s *Service) Start()

Start the detection service runtime.

func (*Service) Status

func (s *Service) Status() error

Status returns an error if detection service is not ready yet.

func (*Service) Stop

func (s *Service) Stop() error

Stop the notifier service.

func (*Service) UpdateHighestAttestation

func (s *Service) UpdateHighestAttestation(ctx context.Context, att *ethpb.IndexedAttestation) error

UpdateHighestAttestation updates to the db the highest source and target attestations for a each validator.

func (*Service) UpdateSpans

func (s *Service) UpdateSpans(ctx context.Context, att *ethpb.IndexedAttestation) error

UpdateSpans passthrough function that updates span maps given an indexed attestation.

type Status

type Status int

Status detection statuses type.

const (
	// None slasher was not initialised.
	None Status = iota
	// Started service start has been called,
	Started
	// Syncing beacon client is still syncing.
	Syncing
	// HistoricalDetection slasher is replaying all attestations that
	// were included in the canonical chain.
	HistoricalDetection
	// Ready slasher is ready to detect requests.
	Ready
)

func (Status) String

func (s Status) String() string

String returns the string value of the status