cre

Documentation

Index

• type LLOStreamID
• type LLOTriggerConfig
• type ReportCodecCapabilityTrigger
  • func NewReportCodecCapabilityTrigger(lggr logger.Logger, donID uint32) ReportCodecCapabilityTrigger
  • func (r ReportCodecCapabilityTrigger) Encode(report llocommon.Report, cd llotypes.ChannelDefinition, ...) ([]byte, error)
  • func (r ReportCodecCapabilityTrigger) EventID(report llocommon.Report) string
  • func (r ReportCodecCapabilityTrigger) ParseOpts(opts []byte) (any, error)
  • func (r ReportCodecCapabilityTrigger) Verify(cd llotypes.ChannelDefinition) error
• type ReportCodecCapabilityTriggerMultiplier
• type ReportCodecCapabilityTriggerOpts
  • func (r *ReportCodecCapabilityTriggerOpts) Decode(opts []byte) error
  • func (r *ReportCodecCapabilityTriggerOpts) Encode() ([]byte, error)
• type Transmitter
• type TransmitterConfig
  • func (c TransmitterConfig) NewTransmitter() (*transmitter, error)

Types

type LLOStreamID

type LLOStreamID uint32

type LLOTriggerConfig

type LLOTriggerConfig struct {
	// The IDs of the data feeds (LLO streams) that will be included in the trigger event.
	StreamIDs []LLOStreamID `json:"streamIds" yaml:"streamIds" mapstructure:"streamIds"`

	// The interval in seconds after which a new trigger event is generated.
	MaxFrequencyMs uint64 `json:"maxFrequencyMs" yaml:"maxFrequencyMs" mapstructure:"maxFrequencyMs"`
}

type ReportCodecCapabilityTrigger

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

func NewReportCodecCapabilityTrigger

func NewReportCodecCapabilityTrigger(lggr logger.Logger, donID uint32) ReportCodecCapabilityTrigger

func (ReportCodecCapabilityTrigger) Encode

func (r ReportCodecCapabilityTrigger) Encode(report llocommon.Report, cd llotypes.ChannelDefinition, optsCache *llocommon.OptsCache) ([]byte, error)

Encode a report into a capability trigger report the returned byte slice is the marshaled protobuf of capabilitiespb.OCRTriggerReport

func (ReportCodecCapabilityTrigger) EventID

func (r ReportCodecCapabilityTrigger) EventID(report llocommon.Report) string

EventID is expected to uniquely identify a (don, round)

func (ReportCodecCapabilityTrigger) ParseOpts

func (r ReportCodecCapabilityTrigger) ParseOpts(opts []byte) (any, error)

func (ReportCodecCapabilityTrigger) Verify

func (r ReportCodecCapabilityTrigger) Verify(cd llotypes.ChannelDefinition) error

type ReportCodecCapabilityTriggerMultiplier

type ReportCodecCapabilityTriggerMultiplier struct {
	Multiplier decimal.Decimal   `json:"multiplier"`
	StreamID   llotypes.StreamID `json:"streamID"`
}

type ReportCodecCapabilityTriggerOpts

type ReportCodecCapabilityTriggerOpts struct {
	// EXAMPLE
	//
	// [{streamID: 1000000001, "multiplier":"10000"}, ...]
	//
	// The total number of streams must be n, where n is the number of
	// top-level elements in this ReportCodecCapabilityTriggerMultipliers array
	Multipliers []ReportCodecCapabilityTriggerMultiplier `json:"multipliers"`
}

Opts format remains unchanged

func (*ReportCodecCapabilityTriggerOpts) Decode

func (r *ReportCodecCapabilityTriggerOpts) Decode(opts []byte) error

func (*ReportCodecCapabilityTriggerOpts) Encode

func (r *ReportCodecCapabilityTriggerOpts) Encode() ([]byte, error)

type Transmitter

type Transmitter interface {
	llotypes.Transmitter
	services.Service
}

type TransmitterConfig

type TransmitterConfig struct {
	Logger               logger.Logger                  `json:"-"`
	CapabilitiesRegistry coretypes.CapabilitiesRegistry `json:"-"`
	DonID                uint32                         `json:"-"`

	TriggerCapabilityName        string `json:"triggerCapabilityName"`
	TriggerCapabilityVersion     string `json:"triggerCapabilityVersion"`
	TriggerTickerMinResolutionMs int    `json:"triggerTickerMinResolutionMs"`
	TriggerSendChannelBufferSize int    `json:"triggerSendChannelBufferSize"`
}

func (TransmitterConfig) NewTransmitter

func (c TransmitterConfig) NewTransmitter() (*transmitter, error)