llo

Documentation

Index

• Constants
• Variables
• type ChannelDefinition
• type ChannelDefinitionCache
• type ChannelDefinitions
• type ChannelID
• type LifeCycleStage
• type ReportFormat
  • func ReportFormatFromString(s string) (ReportFormat, error)
  • func (rf ReportFormat) String() string
• type ReportInfo
• type StreamID
• type Transmitter

Constants

const (
	ReportFormatEVM      = 1
	ReportFormatJSON     = 2
	ReportFormatSolana   = 3
	ReportFormatCosmos   = 4
	ReportFormatStarknet = 5
	ReportFormatAptos    = 6
)

Variables

var ReportFormats = []ReportFormat{
	ReportFormatEVM,
	ReportFormatJSON,
	ReportFormatSolana,
	ReportFormatCosmos,
	ReportFormatStarknet,
	ReportFormatAptos,
}

Types

type ChannelDefinition

type ChannelDefinition struct {
	ReportFormat ReportFormat
	// Specifies the chain on which this channel can be verified. Currently uses
	// CCIP chain selectors.
	ChainSelector uint64
	// We assume that StreamIDs is always non-empty and that the 0-th stream
	// contains the verification price in LINK and the 1-st stream contains the
	// verification price in the native coin.
	StreamIDs []StreamID
}

QUESTION: Do we also want to include an (optional) designated verifier address, i.e. the only address allowed to verify reports from this channel https://smartcontract-it.atlassian.net/browse/MERC-3492

type ChannelDefinitionCache

type ChannelDefinitionCache interface {
	Definitions() ChannelDefinitions
	services.Service
}

type ChannelDefinitions

type ChannelDefinitions map[ChannelID]ChannelDefinition

type ChannelID

type ChannelID = uint32

type LifeCycleStage

type LifeCycleStage string

type ReportFormat

type ReportFormat uint32

ReportFormat represents different formats for different targets e.g. EVM, Solana, JSON, kalechain etc

func ReportFormatFromString

func ReportFormatFromString(s string) (ReportFormat, error)

func (ReportFormat) String

func (rf ReportFormat) String() string

type ReportInfo

type ReportInfo struct {
	LifeCycleStage LifeCycleStage
	ReportFormat   ReportFormat
}

type StreamID

type StreamID = uint32

Chose uint32 to represent StreamID and ChannelID for the following reasons: - 4 billion is more than enough to cover our conceivable channel/stream requirements - It is the most compatible, supported everywhere, can be serialized into JSON and used in Javascript without problems - It is the smallest reasonable data type that balances between a large set of possible identifiers and not using too much space - If randomly chosen, low chance of off-by-one ids being valid - Is not specific to any chain, e.g. [32]byte is not fully supported on starknet etc - Avoids any possible encoding/copypasta issues e.g. UUIDs which can convert to [32]byte in multiple different ways

type Transmitter

type Transmitter ocr3types.ContractTransmitter[ReportInfo]