titlerequest

Documentation

Overview

titlerequest is a small example reporting plugin that requests website titles and puts them onchain. This is not production code.

Index

• type TitleRequestPlugin
  • func (trp *TitleRequestPlugin) Close() error
  • func (trp *TitleRequestPlugin) Observation(ctx context.Context, _ types.ReportTimestamp, _ types.Query) (types.Observation, error)
  • func (trp *TitleRequestPlugin) Query(context.Context, types.ReportTimestamp) (types.Query, error)
  • func (trp *TitleRequestPlugin) Report(_ context.Context, _ types.ReportTimestamp, _ types.Query, ...) (bool, types.Report, error)
  • func (trp *TitleRequestPlugin) ShouldAcceptFinalizedReport(_ context.Context, _ types.ReportTimestamp, report types.Report) (bool, error)
  • func (trp *TitleRequestPlugin) ShouldTransmitAcceptedReport(ctx context.Context, _ types.ReportTimestamp, report types.Report) (bool, error)
• type TitleRequestPluginFactory
  • func (fac *TitleRequestPluginFactory) NewReportingPlugin(_ context.Context, config types.ReportingPluginConfig) (types.ReportingPlugin, types.ReportingPluginInfo, error)

Types

type TitleRequestPlugin

type TitleRequestPlugin struct {
	F int
	// contains filtered or unexported fields
}

func (*TitleRequestPlugin) Close

func (trp *TitleRequestPlugin) Close() error

func (*TitleRequestPlugin) Observation

func (trp *TitleRequestPlugin) Observation(ctx context.Context, _ types.ReportTimestamp, _ types.Query) (types.Observation, error)

func (*TitleRequestPlugin) Query

func (trp *TitleRequestPlugin) Query(context.Context, types.ReportTimestamp) (types.Query, error)

func (*TitleRequestPlugin) Report

func (trp *TitleRequestPlugin) Report(_ context.Context, _ types.ReportTimestamp, _ types.Query, aos []types.AttributedObservation) (bool, types.Report, error)

func (*TitleRequestPlugin) ShouldAcceptFinalizedReport

func (trp *TitleRequestPlugin) ShouldAcceptFinalizedReport(_ context.Context, _ types.ReportTimestamp, report types.Report) (bool, error)

func (*TitleRequestPlugin) ShouldTransmitAcceptedReport

func (trp *TitleRequestPlugin) ShouldTransmitAcceptedReport(ctx context.Context, _ types.ReportTimestamp, report types.Report) (bool, error)

type TitleRequestPluginFactory

type TitleRequestPluginFactory struct {
	Client   *ethclient.Client
	Contract *ocr2titlerequest.OCR2TitleRequest
}

func (*TitleRequestPluginFactory) NewReportingPlugin

func (fac *TitleRequestPluginFactory) NewReportingPlugin(_ context.Context, config types.ReportingPluginConfig) (types.ReportingPlugin, types.ReportingPluginInfo, error)