storage

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

type Nonce uint16

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

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
}

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"`
}

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
}

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

	// 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
}

type SharesFilter func(*types.SSVShare) bool

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