storage

Documentation

Index

• type GetOperatorData
• type Nonce
• type OperatorData
• type Operators
  • func NewOperatorsStorage(logger *zap.Logger, db basedb.Database, prefix []byte) Operators
• type RecipientData
  • func (r *RecipientData) MarshalJSON() ([]byte, error)
  • func (r *RecipientData) UnmarshalJSON(input []byte) error
• type Recipients
  • func NewRecipientsStorage(logger *zap.Logger, db basedb.Database, prefix []byte) Recipients
• type Shares
  • func NewSharesStorage(logger *zap.Logger, db basedb.Database, prefix []byte) (Shares, error)
• type SharesFilter
  • func ByActiveValidator() SharesFilter
  • func ByAttesting(epoch phase0.Epoch) SharesFilter
  • func ByClusterID(clusterID []byte) SharesFilter
  • func ByNotLiquidated() SharesFilter
  • func ByOperatorID(operatorID spectypes.OperatorID) SharesFilter
• type SharesListFunc

Types

type GetOperatorData

type GetOperatorData = func(index uint64) (*OperatorData, bool, error)

GetOperatorData is a function that returns the operator data

type Nonce

type Nonce uint16

type OperatorData

type OperatorData struct {
	ID           spectypes.OperatorID `json:"id"`
	PublicKey    []byte               `json:"publicKey"`
	OwnerAddress common.Address       `json:"ownerAddress"`
}

OperatorData the public data of an operator

type Operators

type Operators interface {
	GetOperatorDataByPubKey(r basedb.Reader, operatorPubKey []byte) (*OperatorData, bool, error)
	GetOperatorData(r basedb.Reader, id spectypes.OperatorID) (*OperatorData, bool, error)
	OperatorsExist(r basedb.Reader, ids []spectypes.OperatorID) (bool, error)
	SaveOperatorData(rw basedb.ReadWriter, operatorData *OperatorData) (bool, error)
	DeleteOperatorData(rw basedb.ReadWriter, id spectypes.OperatorID) error
	ListOperators(r basedb.Reader, from uint64, to uint64) ([]OperatorData, error)
	GetOperatorsPrefix() []byte
	DropOperators() error
}

Operators is the interface for managing operators data

func NewOperatorsStorage

func NewOperatorsStorage(logger *zap.Logger, db basedb.Database, prefix []byte) Operators

NewOperatorsStorage creates a new instance of Storage

type RecipientData

type RecipientData struct {
	Owner        common.Address             `json:"ownerAddress"`
	FeeRecipient bellatrix.ExecutionAddress `json:"feeRecipientAddress"`

	// Nonce: This field represents the 'ValidatorAdded Event' nonce.
	// It serves a crucial role in protecting against replay attacks.
	// Each time a new validator added event is triggered, regardless of whether the event is malformed or not,
	// we increment this nonce by 1.
	// ** The Nonce field can be nil because the 'FeeRecipientAddressUpdatedEvent'
	// might occur before the addition of a validator to the network, and this event does not increment the nonce.
	Nonce *Nonce `json:"nonce"`
}

RecipientData the public data of a recipient

func (*RecipientData) MarshalJSON

func (r *RecipientData) MarshalJSON() ([]byte, error)

func (*RecipientData) UnmarshalJSON

func (r *RecipientData) UnmarshalJSON(input []byte) error

type Recipients

type Recipients interface {
	GetRecipientData(r basedb.Reader, owner common.Address) (*RecipientData, bool, error)
	GetRecipientDataMany(r basedb.Reader, owners []common.Address) (map[common.Address]bellatrix.ExecutionAddress, error)
	GetNextNonce(r basedb.Reader, owner common.Address) (Nonce, error)
	BumpNonce(rw basedb.ReadWriter, owner common.Address) error
	SaveRecipientData(rw basedb.ReadWriter, recipientData *RecipientData) (*RecipientData, error)
	DeleteRecipientData(rw basedb.ReadWriter, owner common.Address) error
	DropRecipients() error
	GetRecipientsPrefix() []byte
}

Recipients is the interface for managing recipients data

func NewRecipientsStorage

func NewRecipientsStorage(logger *zap.Logger, db basedb.Database, prefix []byte) Recipients

NewRecipientsStorage creates a new instance of Storage

type Shares

type Shares interface {
	// Get returns the share for the given public key, or nil if not found.
	Get(txn basedb.Reader, pubKey []byte) *types.SSVShare

	// List returns a list of shares, filtered by the given filters (if any).
	List(txn basedb.Reader, filters ...SharesFilter) []*types.SSVShare

	// Range calls the given function over each share.
	// If the function returns false, the iteration stops.
	Range(txn basedb.Reader, fn func(*types.SSVShare) bool)

	// Save saves the given shares.
	Save(txn basedb.ReadWriter, shares ...*types.SSVShare) error

	// Delete deletes the share for the given public key.
	Delete(txn basedb.ReadWriter, pubKey []byte) error

	// Drop deletes all shares.
	Drop() error

	// UpdateValidatorMetadata updates validator metadata.
	UpdateValidatorMetadata(pk string, metadata *beaconprotocol.ValidatorMetadata) error
}

Shares is the interface for managing shares.

func NewSharesStorage

func NewSharesStorage(logger *zap.Logger, db basedb.Database, prefix []byte) (Shares, error)

type SharesFilter

type SharesFilter func(*types.SSVShare) bool

SharesFilter is a function that filters shares.

func ByActiveValidator

func ByActiveValidator() SharesFilter

ByActiveValidator filters for active validators.

func ByAttesting

func ByAttesting(epoch phase0.Epoch) SharesFilter

ByAttesting filters for attesting validators.

func ByClusterID

func ByClusterID(clusterID []byte) SharesFilter

ByClusterID filters by cluster id.

func ByNotLiquidated

func ByNotLiquidated() SharesFilter

ByNotLiquidated filters for not liquidated.

func ByOperatorID

func ByOperatorID(operatorID spectypes.OperatorID) SharesFilter

ByOperatorID filters by operator ID.

type SharesListFunc

type SharesListFunc = func(filters ...SharesFilter) []*types.SSVShare

SharesListFunc is a function that returns a filtered list of shares.