pluginconfig

type Duration time.Duration

type PluginConfig struct {
	ChannelDefinitionsContractAddress   common.Address `json:"channelDefinitionsContractAddress" toml:"channelDefinitionsContractAddress"`
	ChannelDefinitionsContractFromBlock int64          `json:"channelDefinitionsContractFromBlock" toml:"channelDefinitionsContractFromBlock"`

	// NOTE: ChannelDefinitions is an override.
	// If ChannelDefinitions is specified, values for
	// ChannelDefinitionsContractAddress and
	// ChannelDefinitionsContractFromBlock will be ignored
	ChannelDefinitions string `json:"channelDefinitions" toml:"channelDefinitions"`

	// BenchmarkMode is a flag to enable benchmarking mode. In this mode, the
	// transmitter will not transmit anything at all and instead emit
	// logs/metrics.
	BenchmarkMode bool `json:"benchmarkMode" toml:"benchmarkMode"`

	// KeyBundleIDs maps supported keys to their respective bundle IDs
	// Key must match llo's ReportFormat
	KeyBundleIDs map[string]string `json:"keyBundleIDs" toml:"keyBundleIDs"`

	DonID uint32 `json:"donID" toml:"donID"`

	// Mercury servers
	Servers map[string]hex.PlainHexBytes `json:"servers" toml:"servers"`

	Transmitters []TransmitterConfig `json:"transmitters" toml:"transmitters"`

	// PluginVersion selects the LLO plugin the job runs on:
	//   "" or "v30" => llo/v30, on libocr OCR3.0
	//   "v31"       => llo/dev/v31, on libocr OCR3.1
	// NOTE: this names the plugin package, not the LLO offchain ProtocolVersion
	// (0/1/2) carried in the offchain config, nor the ocr2 job spec's own
	// OCRVersion.
	//
	// It applies to every protocol instance in the job. To run the instances on
	// different plugins, which is what a v30 -> v31 blue/green handover needs,
	// use PluginVersions instead.
	PluginVersion PluginVersion `json:"pluginVersion" toml:"pluginVersion"`

	// PluginVersions selects the plugin per protocol instance, positionally
	// aligned with the job's contract config trackers (index 0 is "Blue", index
	// 1 is "Green"). Entries take the same values as PluginVersion.
	//
	// This exists for the blue/green handover between the v30 and v31 plugins,
	// where the two instances of one job deliberately run different versions:
	//
	//	"pluginVersions": ["v30", "v31"]
	//
	// When empty, every instance falls back to the scalar PluginVersion, so job
	// specs predating this field are unaffected. When non-empty it takes
	// precedence, and its length must match the number of trackers: that check
	// belongs to the consumer, which is the only side that knows how many there
	// are. Validate here only bounds the length and checks each entry.
	PluginVersions []PluginVersion `json:"pluginVersions" toml:"pluginVersions"`

	// V31 carries the v31 plugin knobs. Only read when the job runs any v31
	// instance.
	V31 V31Config `json:"v31" toml:"v31"`
}

type PluginVersion string

type TransmitterConfig struct {
	Type TransmitterType `json:"type" toml:"type"`
	// each sub-transmitter can have its own specific configuration
	Opts json.RawMessage `json:"opts" toml:"opts"`
}

type TransmitterType int

type V31Config struct {
	// VerboseLogging enables additional, potentially expensive logging.
	VerboseLogging bool `json:"verboseLogging" toml:"verboseLogging"`

	// BlobLifetimeRounds bounds how long peers can still fetch a broadcast
	// blob, and so for how many rounds a snapshot can be offered. It does not
	// bound staleness, the state transition does.
	BlobLifetimeRounds uint64 `json:"blobLifetimeRounds" toml:"blobLifetimeRounds"`

	// MaxDurationBlobObservation is the blob pump's per-cycle observation
	// budget.
	MaxDurationBlobObservation Duration `json:"maxDurationBlobObservation" toml:"maxDurationBlobObservation"`

	// BlobInFlightWaitFactor divides MaxDurationObservation into how long Take
	// waits for a cycle already in flight to park, so a larger factor waits
	// less.
	BlobInFlightWaitFactor uint64 `json:"blobInFlightWaitFactor" toml:"blobInFlightWaitFactor"`

	// Plugin telemetry. Each is decided here for v31, independently of
	// the node CaptureEATelemetry parameter, which keeps driving data source telemetry.
	//
	// CaptureOutcomeTelemetry emits one outcome per StateTransition.
	CaptureOutcomeTelemetry bool `json:"captureOutcomeTelemetry" toml:"captureOutcomeTelemetry"`
	// CaptureReportTelemetry emits one telemetry per report.
	CaptureReportTelemetry bool `json:"captureReportTelemetry" toml:"captureReportTelemetry"`
	// CaptureAttributedObservationTelemetry emits the decoded oracle observations that made into
	// the state transition.
	CaptureAttributedObservationTelemetry bool `json:"captureAttributedObservationTelemetry" toml:"captureAttributedObservationTelemetry"`
	// CaptureStagingTelemetry makes a staging instance emit the plugin telemetry
	// enabled above. Off, only a production instance emits it.
	CaptureStagingTelemetry bool `json:"captureStagingTelemetry" toml:"captureStagingTelemetry"`
}