types

Documentation

Overview

Package types includes important type definitions for slashable objects detected by slasher.

Index

• Variables
• type DetectionKind
• type DetectionResult
  • func (r *DetectionResult) Marshal() []byte
• type EpochStore
  • func EpochStoreFromMap(spanMap map[uint64]Span) (*EpochStore, error)
  • func NewEpochStore(spans []byte) (*EpochStore, error)
  • func (es *EpochStore) Bytes() []byte
  • func (es *EpochStore) GetValidatorSpan(idx uint64) (Span, error)
  • func (es *EpochStore) HighestObservedIdx() uint64
  • func (es *EpochStore) SetValidatorSpan(idx uint64, newSpan Span) (*EpochStore, error)
  • func (es *EpochStore) ToMap() (map[uint64]Span, error)
• type Span
  • func UnmarshalSpan(enc []byte) (Span, error)
  • func (s Span) Marshal() []byte

Variables

var ErrWrongSize = errors.New("wrong data length for min max span byte array")

ErrWrongSize appears when attempting to use epoch store byte array with size that is not a multiple of spanner encoded length.

var SpannerEncodedLength = uint64(7)

SpannerEncodedLength the byte length of validator span data structure.

Types

type DetectionKind

type DetectionKind uint8

DetectionKind defines an enum type that gives us information on the type of slashable offense found when analyzing validator min-max spans.

const (
	// DoubleVote denotes a slashable offense in which
	// a validator cast two conflicting attestations within
	// the same target epoch.
	DoubleVote DetectionKind = iota
	// SurroundVote denotes a slashable offense in which
	// a validator surrounded or was surrounded by a previous
	// attestation created by the same validator.
	SurroundVote
)

type DetectionResult

type DetectionResult struct {
	ValidatorIndex uint64
	SlashableEpoch types.Epoch
	Kind           DetectionKind
	SigBytes       [2]byte
}

DetectionResult tells us the kind of slashable offense found from detecting on min-max spans + the slashable epoch for the offense. Also includes the signature bytes for assistance in finding the attestation for the slashing proof.

func (*DetectionResult) Marshal

func (r *DetectionResult) Marshal() []byte

Marshal the result into bytes, used for removing duplicates.

type EpochStore

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

EpochStore defines an implementation of the slasher data access interface using byte array as data source to extract and put validator spans into.

func EpochStoreFromMap

func EpochStoreFromMap(spanMap map[uint64]Span) (*EpochStore, error)

EpochStoreFromMap is a helper function to turn a map into a epoch store, mainly used for testing.

func NewEpochStore

func NewEpochStore(spans []byte) (*EpochStore, error)

NewEpochStore initialize epoch store from a byte array returns error if byte length is not a multiple of encoded spanner length.

func (*EpochStore) Bytes

func (es *EpochStore) Bytes() []byte

Bytes returns the underlying bytes of an EpochStore.

func (*EpochStore) GetValidatorSpan

func (es *EpochStore) GetValidatorSpan(idx uint64) (Span, error)

GetValidatorSpan unmarshal a span from an encoded, flattened array.

func (*EpochStore) HighestObservedIdx

func (es *EpochStore) HighestObservedIdx() uint64

HighestObservedIdx returns the highest idx the EpochStore has been used for.

func (*EpochStore) SetValidatorSpan

func (es *EpochStore) SetValidatorSpan(idx uint64, newSpan Span) (*EpochStore, error)

SetValidatorSpan marshal a validator span into an encoded, flattened array.

func (*EpochStore) ToMap

func (es *EpochStore) ToMap() (map[uint64]Span, error)

ToMap is a helper function to convert an epoch store to a map, mainly used for testing.

type Span

type Span struct {
	MinSpan     uint16
	MaxSpan     uint16
	SigBytes    [2]byte
	HasAttested bool
}

Span defines the structure used for detecting surround and double votes.

func UnmarshalSpan

func UnmarshalSpan(enc []byte) (Span, error)

UnmarshalSpan returns a span from an encoded, flattened byte array. Note: This is a very often used function, so it is as optimized as possible.

func (Span) Marshal

func (s Span) Marshal() []byte

Marshal converts the span struct into a flattened byte array. Note: This is a very often used function, so it is as optimized as possible.