sync

Documentation

Index

• Constants
• Variables
• func UnhaltIfAffectedRows(halted *bool, haltedReason *string, mu *sync.RWMutex, rowsAffected int64)
• type Block
• type EVMBlock
• type EVMBlockHeader
• type EVMBlocks
  • func (e EVMBlocks) Len() int
• type EVMDownloader
  • func NewEVMDownloader(syncerID string, ethClient EthClienter, syncBlockChunkSize uint64, ...) (*EVMDownloader, error)
  • func (d *EVMDownloader) Download(ctx context.Context, fromBlock uint64, downloadedCh chan EVMBlock)
• type EVMDownloaderImplementation
  • func NewEVMDownloaderImplementation(syncerID string, ethClient EthClienter, blockFinality *big.Int, ...) *EVMDownloaderImplementation
  • func (d *EVMDownloaderImplementation) GetBlockHeader(ctx context.Context, blockNum uint64) (EVMBlockHeader, bool)
  • func (d *EVMDownloaderImplementation) GetEventsByBlockRange(ctx context.Context, fromBlock, toBlock uint64) EVMBlocks
  • func (d *EVMDownloaderImplementation) GetLastFinalizedBlock(ctx context.Context) (*types.Header, error)
  • func (d *EVMDownloaderImplementation) GetLogs(ctx context.Context, fromBlock, toBlock uint64) []types.Log
  • func (d *EVMDownloaderImplementation) WaitForNewBlocks(ctx context.Context, lastBlockSeen uint64) (newLastBlock uint64)
• type EVMDownloaderInterface
• type EVMDriver
  • func NewEVMDriver(reorgDetector ReorgDetector, processor processorInterface, ...) (*EVMDriver, error)
  • func (d *EVMDriver) Sync(ctx context.Context)
• type EthClienter
• type LogAppenderMap
• type ProcessorInterface
• type ReorgDetector
• type RetryHandler
  • func (h *RetryHandler) Handle(funcName string, attempts int)

Constants

const (
	DefaultWaitPeriodBlockNotFound = time.Millisecond * 100
)

Variables

var ErrInconsistentState = errors.New("state is inconsistent, try again later once the state is consolidated")

Functions

func UnhaltIfAffectedRows

func UnhaltIfAffectedRows(halted *bool, haltedReason *string, mu *sync.RWMutex, rowsAffected int64)

Types

type Block

type Block struct {
	Num    uint64
	Events []interface{}
	Hash   common.Hash
}

type EVMBlock

type EVMBlock struct {
	EVMBlockHeader
	IsFinalizedBlock bool
	Events           []interface{}
}

type EVMBlockHeader

type EVMBlockHeader struct {
	Num        uint64
	Hash       common.Hash
	ParentHash common.Hash
	Timestamp  uint64
}

type EVMBlocks

type EVMBlocks []*EVMBlock

func (EVMBlocks) Len

func (e EVMBlocks) Len() int

type EVMDownloader

type EVMDownloader struct {
	EVMDownloaderInterface
	// contains filtered or unexported fields
}

func NewEVMDownloader

func NewEVMDownloader(
	syncerID string,
	ethClient EthClienter,
	syncBlockChunkSize uint64,
	blockFinalityType etherman.BlockNumberFinality,
	waitForNewBlocksPeriod time.Duration,
	appender LogAppenderMap,
	adressessToQuery []common.Address,
	rh *RetryHandler,
	finalizedBlockType etherman.BlockNumberFinality,
) (*EVMDownloader, error)

func (*EVMDownloader) Download

func (d *EVMDownloader) Download(ctx context.Context, fromBlock uint64, downloadedCh chan EVMBlock)

type EVMDownloaderImplementation

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

func NewEVMDownloaderImplementation

func NewEVMDownloaderImplementation(
	syncerID string,
	ethClient EthClienter,
	blockFinality *big.Int,
	waitForNewBlocksPeriod time.Duration,
	appender LogAppenderMap,
	topicsToQuery []common.Hash,
	adressessToQuery []common.Address,
	rh *RetryHandler,
) *EVMDownloaderImplementation

func (*EVMDownloaderImplementation) GetBlockHeader

func (d *EVMDownloaderImplementation) GetBlockHeader(ctx context.Context, blockNum uint64) (EVMBlockHeader, bool)

func (*EVMDownloaderImplementation) GetEventsByBlockRange

func (d *EVMDownloaderImplementation) GetEventsByBlockRange(ctx context.Context, fromBlock, toBlock uint64) EVMBlocks

func (*EVMDownloaderImplementation) GetLastFinalizedBlock

func (d *EVMDownloaderImplementation) GetLastFinalizedBlock(ctx context.Context) (*types.Header, error)

func (*EVMDownloaderImplementation) GetLogs

func (d *EVMDownloaderImplementation) GetLogs(ctx context.Context, fromBlock, toBlock uint64) []types.Log

func (*EVMDownloaderImplementation) WaitForNewBlocks

func (d *EVMDownloaderImplementation) WaitForNewBlocks(
	ctx context.Context, lastBlockSeen uint64,
) (newLastBlock uint64)

type EVMDownloaderInterface

type EVMDownloaderInterface interface {
	WaitForNewBlocks(ctx context.Context, lastBlockSeen uint64) (newLastBlock uint64)
	GetEventsByBlockRange(ctx context.Context, fromBlock, toBlock uint64) EVMBlocks
	GetLogs(ctx context.Context, fromBlock, toBlock uint64) []types.Log
	GetBlockHeader(ctx context.Context, blockNum uint64) (EVMBlockHeader, bool)
	GetLastFinalizedBlock(ctx context.Context) (*types.Header, error)
}

type EVMDriver

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

func NewEVMDriver

func NewEVMDriver(
	reorgDetector ReorgDetector,
	processor processorInterface,
	downloader downloader,
	reorgDetectorID string,
	downloadBufferSize int,
	rh *RetryHandler,
) (*EVMDriver, error)

func (*EVMDriver) Sync

func (d *EVMDriver) Sync(ctx context.Context)

type EthClienter

type EthClienter interface {
	ethereum.LogFilterer
	ethereum.BlockNumberReader
	ethereum.ChainReader
	bind.ContractBackend
}

type LogAppenderMap

type LogAppenderMap map[common.Hash]func(b *EVMBlock, l types.Log) error

type ProcessorInterface

type ProcessorInterface interface {
	GetLastProcessedBlock(ctx context.Context) (uint64, error)
	ProcessBlock(block Block) error
	Reorg(firstReorgedBlock uint64) error
}

type ReorgDetector

type ReorgDetector interface {
	Subscribe(id string) (*reorgdetector.Subscription, error)
	AddBlockToTrack(ctx context.Context, id string, blockNum uint64, blockHash common.Hash) error
}

type RetryHandler

type RetryHandler struct {
	RetryAfterErrorPeriod      time.Duration
	MaxRetryAttemptsAfterError int
}

func (*RetryHandler) Handle

func (h *RetryHandler) Handle(funcName string, attempts int)