types

Documentation

Index

• func ComputeClusterIDHash(ownerAddress []byte, operatorIds []uint64) ([]byte, error)
• func DeserializeBLSPublicKey(b []byte) (bls.PublicKey, error)
• func GetDefaultDomain() spectypes.DomainType
• func ReconstructSignature(ps *specssv.PartialSigContainer, root [32]byte, validatorPubKey []byte) ([]byte, error)
• func SetDefaultDomain(d spectypes.DomainType)
• func VerifyByOperators(s spectypes.Signature, data spectypes.MessageSignature, ...) error
• func VerifyReconstructedSignature(sig *bls.Sign, validatorPubKey []byte, root [32]byte) error
• type EventMsg
  • func (msg *EventMsg) Decode(data []byte) error
  • func (msg *EventMsg) Encode() ([]byte, error)
  • func (m *EventMsg) GetExecuteDutyData() (*ExecuteDutyData, error)
  • func (m *EventMsg) GetTimeoutData() (*TimeoutData, error)
• type EventType
  • func (e EventType) String() string
• type ExecuteDutyData
• type Metadata
• type SSVShare
  • func (s *SSVShare) BelongsToOperator(operatorID spectypes.OperatorID) bool
  • func (s *SSVShare) Decode(data []byte) error
  • func (s *SSVShare) Encode() ([]byte, error)
  • func (s *SSVShare) HasBeaconMetadata() bool
  • func (s *SSVShare) SetFeeRecipient(feeRecipient bellatrix.ExecutionAddress)
• type State
  • func (s *State) Decode(data []byte) error
  • func (s *State) Encode() ([]byte, error)
  • func (s *State) GetRoot() ([]byte, error)
• type TimeoutData

Functions

func ComputeClusterIDHash

func ComputeClusterIDHash(ownerAddress []byte, operatorIds []uint64) ([]byte, error)

ComputeClusterIDHash will compute cluster ID hash with given owner address and operator ids

func DeserializeBLSPublicKey

func DeserializeBLSPublicKey(b []byte) (bls.PublicKey, error)

DeserializeBLSPublicKey deserializes a bls.PublicKey from bytes, caching the result to avoid repeated deserialization.

func GetDefaultDomain

func GetDefaultDomain() spectypes.DomainType

GetDefaultDomain returns the global domain used across the system

func ReconstructSignature

func ReconstructSignature(ps *specssv.PartialSigContainer, root [32]byte, validatorPubKey []byte) ([]byte, error)

func SetDefaultDomain

func SetDefaultDomain(d spectypes.DomainType)

SetDefaultDomain updates the global domain used across the system allows injecting domain for testnets

func VerifyByOperators

func VerifyByOperators(s spectypes.Signature, data spectypes.MessageSignature, domain spectypes.DomainType, sigType spectypes.SignatureType, operators []*spectypes.Operator) error

VerifyByOperators verifies signature by the provided operators This is a copy of a function with the same name from the spec, except for it's use of DeserializeBLSPublicKey function and bounded.CGO

TODO: rethink this function and consider moving/refactoring it.

func VerifyReconstructedSignature

func VerifyReconstructedSignature(sig *bls.Sign, validatorPubKey []byte, root [32]byte) error

Types

type EventMsg

type EventMsg struct {
	Type EventType
	Data []byte
}

func (*EventMsg) Decode

func (msg *EventMsg) Decode(data []byte) error

Decode returns error if decoding failed

func (*EventMsg) Encode

func (msg *EventMsg) Encode() ([]byte, error)

Encode returns a msg encoded bytes or error

func (*EventMsg) GetExecuteDutyData

func (m *EventMsg) GetExecuteDutyData() (*ExecuteDutyData, error)

func (*EventMsg) GetTimeoutData

func (m *EventMsg) GetTimeoutData() (*TimeoutData, error)

type EventType

type EventType int

const (
	// Timeout in order to run timeoutData process
	Timeout EventType = iota
	// ExecuteDuty for when to start duty runner
	ExecuteDuty
)

func (EventType) String

func (e EventType) String() string

type ExecuteDutyData

type ExecuteDutyData struct {
	Duty *types.Duty
}

type Metadata

type Metadata struct {
	BeaconMetadata *beaconprotocol.ValidatorMetadata
	OwnerAddress   common.Address
	Liquidated     bool
	FeeRecipient   bellatrix.ExecutionAddress
}

Metadata represents metadata of SSVShare.

type SSVShare

type SSVShare struct {
	spectypes.Share
	Metadata
}

SSVShare is a combination of spectypes.Share and its Metadata.

func (*SSVShare) BelongsToOperator

func (s *SSVShare) BelongsToOperator(operatorID spectypes.OperatorID) bool

BelongsToOperator checks whether the share belongs to operator.

func (*SSVShare) Decode

func (s *SSVShare) Decode(data []byte) error

Decode decodes SSVShare using gob.

func (*SSVShare) Encode

func (s *SSVShare) Encode() ([]byte, error)

Encode encodes SSVShare using gob.

func (*SSVShare) HasBeaconMetadata

func (s *SSVShare) HasBeaconMetadata() bool

HasBeaconMetadata checks whether the BeaconMetadata field is not nil.

func (*SSVShare) SetFeeRecipient

func (s *SSVShare) SetFeeRecipient(feeRecipient bellatrix.ExecutionAddress)

type State

type State struct {
	Share                           *spectypes.Share
	ID                              []byte // instance Identifier
	Round                           specqbft.Round
	Height                          specqbft.Height
	LastPreparedRound               specqbft.Round
	LastPreparedValue               []byte
	ProposalAcceptedForCurrentRound *specqbft.SignedMessage
	Decided                         bool
	DecidedValue                    []byte

	ProposeContainer     *specqbft.MsgContainer
	PrepareContainer     *specqbft.MsgContainer
	CommitContainer      *specqbft.MsgContainer
	RoundChangeContainer *specqbft.MsgContainer
}

func (*State) Decode

func (s *State) Decode(data []byte) error

Decode returns error if decoding failed

func (*State) Encode

func (s *State) Encode() ([]byte, error)

Encode returns a msg encoded bytes or error

func (*State) GetRoot

func (s *State) GetRoot() ([]byte, error)

GetRoot returns the state's deterministic root

type TimeoutData

type TimeoutData struct {
	Height qbft.Height
}