traces

Documentation

Index

• type Downloader
• type Engine
  • func NewTracesIngestionEngine(blocksPublisher *models.Publisher, blocks storage.BlockIndexer, ...) *Engine
  • func (e *Engine) Done() <-chan struct{}
  • func (e *Engine) Error() <-chan error
  • func (e *Engine) ID() uuid.UUID
  • func (e *Engine) Notify(data any)
  • func (e *Engine) Ready() <-chan struct{}
  • func (e *Engine) Run(ctx context.Context) error
  • func (e *Engine) Stop()
• type GCPDownloader
  • func NewGCPDownloader(bucketName string, logger zerolog.Logger) (*GCPDownloader, error)
  • func (g *GCPDownloader) Download(txID common.Hash, blockID flow.Identifier) (json.RawMessage, error)

Types

type Downloader

type Downloader interface {
	// Download traces or returning an error with the failure
	Download(txID common.Hash, blockIO flow.Identifier) (json.RawMessage, error)
}

type Engine

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

Engine is an implementation of the trace downloader engine.

Traces are ethereum transaction execution traces: https://geth.ethereum.org/docs/developers/evm-tracing Currently EVM gateway doesn't produce the traces since it doesn't execute the transactions and is thus relying on the execution node to produce and upload the traces during execution. This engine listens for new transaction events and then downloads and index the traces from the transaction execution.

func NewTracesIngestionEngine

func NewTracesIngestionEngine(
	blocksPublisher *models.Publisher,
	blocks storage.BlockIndexer,
	traces storage.TraceIndexer,
	downloader Downloader,
	logger zerolog.Logger,
	collector metrics.Collector,
) *Engine

NewTracesIngestionEngine creates a new instance of the engine.

func (*Engine) Done

func (e *Engine) Done() <-chan struct{}

func (*Engine) Error

func (e *Engine) Error() <-chan error

Error is required by the publisher, and we just return a nil, since the errors are handled gracefully in the indexBlockTraces

func (*Engine) ID

func (e *Engine) ID() uuid.UUID

ID is required by the publisher interface and we return a random uuid since the subscription will only happen once by this engine

func (*Engine) Notify

func (e *Engine) Notify(data any)

Notify is a handler that is being used to subscribe for new EVM block notifications. This method should be non-blocking.

func (*Engine) Ready

func (e *Engine) Ready() <-chan struct{}

func (*Engine) Run

func (e *Engine) Run(ctx context.Context) error

func (*Engine) Stop

func (e *Engine) Stop()

type GCPDownloader

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

func NewGCPDownloader

func NewGCPDownloader(bucketName string, logger zerolog.Logger) (*GCPDownloader, error)

func (*GCPDownloader) Download

func (g *GCPDownloader) Download(txID common.Hash, blockID flow.Identifier) (json.RawMessage, error)