sentinel

README

Sentinel

Sentinel is a centralized orchestrator that manages multiple blockchain poller services, each responsible for a specific blockchain network (e.g., Ethereum, Polygon, Arbitrum). It provides a unified interface for subscribing to blockchain events, ensuring efficient log polling and event broadcasting to subscribers.

Documentation

Overview

File: helper.go

File: log.go

File: sentinel.go

Index

• Constants
• func ConvertAPILogToTypesLog(log api.Log) (*types.Log, error)
• func GetLogger(t *testing.T, componentName string) zerolog.Logger
• type AddChainConfig
• type Sentinel
  • func NewSentinel(cfg SentinelConfig) *Sentinel
  • func (s *Sentinel) AddChain(acc AddChainConfig) error
  • func (s *Sentinel) Close()
  • func (s *Sentinel) RemoveChain(chainID int64) error
  • func (s *Sentinel) Subscribe(chainID int64, address common.Address, topic common.Hash) (chan api.Log, error)
  • func (s *Sentinel) Unsubscribe(chainID int64, address common.Address, topic common.Hash, ch chan api.Log) error
• type SentinelConfig

Constants

const (
	LogLevelEnvVar = "SENTINEL_LOG_LEVEL"
)

Functions

func ConvertAPILogToTypesLog

func ConvertAPILogToTypesLog(log api.Log) (*types.Log, error)

ConvertAPILogToTypesLog maps an api.Log to a types.Log. Returns a pointer to types.Log and an error if mapping fails.

func GetLogger

func GetLogger(t *testing.T, componentName string) zerolog.Logger

GetLogger instantiates a logger that takes into account the test context and the log level

Types

type AddChainConfig

type AddChainConfig struct {
	ChainID          int64
	PollInterval     time.Duration
	BlockchainClient api.BlockchainClient
}

type Sentinel

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

func NewSentinel

func NewSentinel(cfg SentinelConfig) *Sentinel

NewSentinel initializes and returns a new Sentinel instance.

func (*Sentinel) AddChain

func (s *Sentinel) AddChain(acc AddChainConfig) error

AddChain adds a new chain to Sentinel.

func (*Sentinel) Close

func (s *Sentinel) Close()

Close shuts down all chains and the global registry.

func (*Sentinel) RemoveChain

func (s *Sentinel) RemoveChain(chainID int64) error

RemoveChain removes a chain from Sentinel.

func (*Sentinel) Subscribe

func (s *Sentinel) Subscribe(chainID int64, address common.Address, topic common.Hash) (chan api.Log, error)

Subscribe subscribes to events for a specific chain.

func (*Sentinel) Unsubscribe

func (s *Sentinel) Unsubscribe(chainID int64, address common.Address, topic common.Hash, ch chan api.Log) error

Unsubscribe unsubscribes from events for a specific chain.

type SentinelConfig

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

SentinelConfig holds configuration for the Sentinel.