eth1

Documentation

Index

• Variables
• func ContractABI(abiVersion Version) string
• func LoadABI(abiFilePath string) error
• func SyncEth1Events(logger *zap.Logger, client Client, storage SyncOffsetStorage, ...) error
• type AbiParser
  • func NewParser(logger *zap.Logger, version Version) AbiParser
  • func (ap AbiParser) ParseOperatorAddedEvent(operatorPubKey string, data []byte, topics []common.Hash, contractAbi abi.ABI) (*abiparser.OperatorAddedEvent, bool, bool, error)
  • func (ap AbiParser) ParseValidatorAddedEvent(operatorPrivateKey *rsa.PrivateKey, data []byte, contractAbi abi.ABI) (*abiparser.ValidatorAddedEvent, bool, bool, error)
• type AbiVersion
• type Client
• type ClientMock
  • func (ec *ClientMock) EventsFeed() *event.Feed
  • func (ec *ClientMock) Start() error
  • func (ec *ClientMock) Sync(fromBlock *big.Int) error
• type Event
• type Options
• type ShareEncryptionKeyProvider
• type SyncEndedEvent
• type SyncEventHandler
• type SyncOffset
  • func DefaultSyncOffset() *SyncOffset
  • func HexStringToSyncOffset(shex string) *SyncOffset
• type SyncOffsetStorage
• type Version
  • func (v Version) String() string

Variables

var (
	V2ContractABI = `` /* 12082-byte string literal not displayed */
)

Abi's to use

Functions

func ContractABI

func ContractABI(abiVersion Version) string

ContractABI abi of the ssv-network contract

func LoadABI

func LoadABI(abiFilePath string) error

LoadABI enables to load a custom abi json

func SyncEth1Events

func SyncEth1Events(logger *zap.Logger, client Client, storage SyncOffsetStorage, syncOffset *SyncOffset, handler SyncEventHandler) error

SyncEth1Events sync past events

Types

type AbiParser

type AbiParser struct {
	Logger  *zap.Logger
	Version AbiVersion
}

AbiParser serves as a parsing client for events from contract

func NewParser

func NewParser(logger *zap.Logger, version Version) AbiParser

NewParser return parser client based on the contract version

func (AbiParser) ParseOperatorAddedEvent

func (ap AbiParser) ParseOperatorAddedEvent(operatorPubKey string, data []byte, topics []common.Hash, contractAbi abi.ABI) (*abiparser.OperatorAddedEvent, bool, bool, error)

ParseOperatorAddedEvent parses an OperatorAddedEvent

func (AbiParser) ParseValidatorAddedEvent

func (ap AbiParser) ParseValidatorAddedEvent(operatorPrivateKey *rsa.PrivateKey, data []byte, contractAbi abi.ABI) (*abiparser.ValidatorAddedEvent, bool, bool, error)

ParseValidatorAddedEvent parses ValidatorAddedEvent

type AbiVersion

type AbiVersion interface {
	ParseOperatorAddedEvent(logger *zap.Logger, operatorPubKey string, data []byte, topics []common.Hash, contractAbi abi.ABI) (*abiparser.OperatorAddedEvent, bool, bool, error)
	ParseValidatorAddedEvent(logger *zap.Logger, operatorPrivateKey *rsa.PrivateKey, data []byte, contractAbi abi.ABI) (*abiparser.ValidatorAddedEvent, bool, bool, error)
}

AbiVersion serves as the parser client interface

type Client

type Client interface {
	EventsFeed() *event.Feed
	Start() error
	Sync(fromBlock *big.Int) error
}

Client represents the required interface for eth1 client

type ClientMock

type ClientMock struct {
	Feed *event.Feed

	SyncTimeout  time.Duration
	SyncResponse error
}

ClientMock implements eth1.Client interface

func (*ClientMock) EventsFeed

func (ec *ClientMock) EventsFeed() *event.Feed

EventsFeed returns the contract events feed

func (*ClientMock) Start

func (ec *ClientMock) Start() error

Start mocking client init

func (*ClientMock) Sync

func (ec *ClientMock) Sync(fromBlock *big.Int) error

Sync mocking events sync

type Event

type Event struct {
	// Log is the raw event log
	Log types.Log
	// Data is the parsed event
	Data interface{}
	// IsOperatorEvent indicates whether the event belongs to operator
	IsOperatorEvent bool
}

Event represents an eth1 event log in the system

type Options

type Options struct {
	ETH1Addr              string        `yaml:"ETH1Addr" env:"ETH_1_ADDR" env-required:"true" env-description:"ETH1 node WebSocket address"`
	ETH1SyncOffset        string        `yaml:"ETH1SyncOffset" env:"ETH_1_SYNC_OFFSET" env-description:"block number to start the sync from"`
	ETH1ConnectionTimeout time.Duration `yaml:"ETH1ConnectionTimeout" env:"ETH_1_CONNECTION_TIMEOUT" env-default:"10s" env-description:"eth1 node connection timeout"`
	RegistryContractAddr  string        `` /* 161-byte string literal not displayed */
	RegistryContractABI   string        `yaml:"RegistryContractABI" env:"REGISTRY_CONTRACT_ABI" env-description:"registry contract abi json file"`
	CleanRegistryData     bool          `` /* 156-byte string literal not displayed */
	AbiVersion            Version       `yaml:"AbiVersion" env:"ABI_VERSION" env-default:"0" env-description:"smart contract abi version (format)"`
}

Options configurations related to eth1

type ShareEncryptionKeyProvider

type ShareEncryptionKeyProvider = func() (*rsa.PrivateKey, bool, error)

ShareEncryptionKeyProvider is a function that returns the operator private key

type SyncEndedEvent

type SyncEndedEvent struct {
	// Success returns true if the sync went well (all events were parsed)
	Success bool
	// Logs is the actual logs that we got from eth1
	Logs []types.Log
}

SyncEndedEvent meant to notify an observer that the sync is over

type SyncEventHandler

type SyncEventHandler func(Event) error

SyncEventHandler handles a given event

type SyncOffset

type SyncOffset = big.Int

SyncOffset is the type of variable used for passing around the offset

func DefaultSyncOffset

func DefaultSyncOffset() *SyncOffset

DefaultSyncOffset returns the default value (block number of the first event from the contract)

func HexStringToSyncOffset

func HexStringToSyncOffset(shex string) *SyncOffset

HexStringToSyncOffset converts an hex string to SyncOffset

type SyncOffsetStorage

type SyncOffsetStorage interface {
	// SaveSyncOffset saves the offset (block number)
	SaveSyncOffset(offset *SyncOffset) error
	// GetSyncOffset returns the sync offset
	GetSyncOffset() (*SyncOffset, bool, error)
}

SyncOffsetStorage represents the interface for compatible storage

type Version

type Version int64

Version enum to support more than one abi format

const (
	Legacy Version = iota
	V2
)

Version types

func (Version) String

func (v Version) String() string