offchainreporting

Jan 25, 2022

Changes in this version

+ type Config interface

+ ChainType func() chains.ChainType

+ DefaultChainID func() *big.Int

+ Dev func() bool

+ EvmGasLimitDefault func() uint64

+ FlagsContractAddress func() string

+ JobPipelineResultWriteQueueDepth func() uint64

+ LogSQL func() bool

+ OCRBlockchainTimeout func() time.Duration

+ OCRContractConfirmations func() uint16

+ OCRContractPollInterval func() time.Duration

+ OCRContractSubscribeInterval func() time.Duration

+ OCRContractTransmitterTransmitTimeout func() time.Duration

+ OCRDatabaseTimeout func() time.Duration

+ OCRDefaultTransactionQueueDepth func() uint32

+ OCRKeyBundleID func() (string, error)

+ OCRObservationGracePeriod func() time.Duration

+ OCRObservationTimeout func() time.Duration

+ OCRTraceLogging func() bool

+ OCRTransmitterAddress func() (ethkey.EIP55Address, error)

+ P2PBootstrapPeers func() ([]string, error)

+ P2PPeerID func() p2pkey.PeerID

+ P2PV2Bootstrappers func() []ocrtypes.BootstrapperLocator

type NetworkingConfig

+ LogSQL func() bool

type ValidationConfig

+ ChainID func() *big.Int

+ ChainType func() chains.ChainType

+ OCRKeyBundleID func() (string, error)

+ OCRTransmitterAddress func() (ethkey.EIP55Address, error)

+ P2PPeerID func() p2pkey.PeerID

Oct 19, 2021

Changes in this version

+ func NewLocalConfig(cfg ValidationConfig, spec job.OffchainReportingOracleSpec) types.LocalConfig

type DelegateConfig

+ EvmGasLimitDefault func() uint64

type ValidationConfig

+ Chain func() *chains.Chain

Sep 7, 2021

Changes in this version

+ const ConfigOverriderPollInterval

+ const InitialHibernationStatus

+ type ConfigOverriderImpl struct

+ DeltaCFromAddress time.Duration

+ func NewConfigOverriderImpl(logger *logger.Logger, contractAddress ethkey.EIP55Address, ...) (*ConfigOverriderImpl, error)

+ func (c *ConfigOverriderImpl) Close() error

+ func (c *ConfigOverriderImpl) ConfigOverride() *ocrtypes.ConfigOverride

+ func (c *ConfigOverriderImpl) Start() error

+ type ContractFlags struct

+ func NewFlags(addrHex string, ethClient eth.Client) (*ContractFlags, error)

+ func (f *ContractFlags) Contract() flags_wrapper.FlagsInterface

+ func (f *ContractFlags) ContractExists() bool

+ func (f *ContractFlags) IsLowered(contractAddr common.Address) (bool, error)

type DelegateConfig

+ FlagsContractAddress func() string

Aug 9, 2021

Changes in this version

type Delegate

+ func (Delegate) AfterJobCreated(spec job.Job)

+ func (Delegate) BeforeJobDeleted(spec job.Job)

+ type DelegateConfig interface

+ Chain func() *chains.Chain

+ ChainID func() *big.Int

+ Dev func() bool

+ EthGasLimitDefault func() uint64

+ JobPipelineResultWriteQueueDepth func() uint64

+ OCRBlockchainTimeout func(time.Duration) time.Duration

+ OCRContractConfirmations func(uint16) uint16

+ OCRContractPollInterval func(time.Duration) time.Duration

+ OCRContractSubscribeInterval func(time.Duration) time.Duration

+ OCRContractTransmitterTransmitTimeout func() time.Duration

+ OCRDatabaseTimeout func() time.Duration

+ OCRDefaultTransactionQueueDepth func() uint32

+ OCRKeyBundleID func(*models.Sha256Hash) (models.Sha256Hash, error)

+ OCRObservationGracePeriod func() time.Duration

+ OCRObservationTimeout func(time.Duration) time.Duration

+ OCRTraceLogging func() bool

+ OCRTransmitterAddress func(*ethkey.EIP55Address) (ethkey.EIP55Address, error)

+ P2PBootstrapPeers func([]string) ([]string, error)

+ P2PPeerID func(*p2pkey.PeerID) (p2pkey.PeerID, error)

+ P2PV2Bootstrappers func() []ocrtypes.BootstrapperLocator

+ type NetworkingConfig interface

+ OCRBootstrapCheckInterval func() time.Duration

+ OCRDHTLookupInterval func() int

+ OCRIncomingMessageBufferSize func() int

+ OCRNewStreamTimeout func() time.Duration

+ OCROutgoingMessageBufferSize func() int

+ OCRTraceLogging func() bool

+ P2PAnnounceIP func() net.IP

+ P2PAnnouncePort func() uint16

+ P2PBootstrapPeers func([]string) ([]string, error)

+ P2PDHTAnnouncementCounterUserPrefix func() uint32

+ P2PListenIP func() net.IP

+ P2PListenPort func() uint16

+ P2PNetworkingStack func() ocrnetworking.NetworkingStack

+ P2PPeerID func(override *p2pkey.PeerID) (p2pkey.PeerID, error)

+ P2PPeerstoreWriteInterval func() time.Duration

+ P2PV2AnnounceAddresses func() []string

+ P2PV2Bootstrappers func() []ocrtypes.BootstrapperLocator

+ P2PV2DeltaDial func() models.Duration

+ P2PV2DeltaReconcile func() models.Duration

+ P2PV2ListenAddresses func() []string

+ type ValidationConfig interface

+ Dev func() bool

+ OCRBlockchainTimeout func(override time.Duration) time.Duration

+ OCRContractConfirmations func(override uint16) uint16

+ OCRContractPollInterval func(override time.Duration) time.Duration

+ OCRContractSubscribeInterval func(override time.Duration) time.Duration

+ OCRContractTransmitterTransmitTimeout func() time.Duration

+ OCRDatabaseTimeout func() time.Duration

+ OCRObservationGracePeriod func() time.Duration

+ OCRObservationTimeout func(override time.Duration) time.Duration

Jul 26, 2021

Changes in this version

+ type DiscovererDatabase struct

+ func NewDiscovererDatabase(db *sql.DB, peerID p2ppeer.ID) *DiscovererDatabase

+ func (d *DiscovererDatabase) ReadAnnouncements(ctx context.Context, peerIDs []string) (map[string][]byte, error)

+ func (d *DiscovererDatabase) StoreAnnouncement(ctx context.Context, peerID string, ann []byte) error

Jul 6, 2021

Changes in this version

+ type ArbitrumBlockTranslator struct

+ func NewArbitrumBlockTranslator(ethClient eth.Client) *ArbitrumBlockTranslator

+ func (a *ArbitrumBlockTranslator) BinarySearch(ctx context.Context, targetL1 int64) (l2lowerBound *big.Int, l2upperBound *big.Int, err error)

+ func (a *ArbitrumBlockTranslator) NumberToQueryRange(ctx context.Context, changedInL1Block uint64) (fromBlock *big.Int, toBlock *big.Int)

+ type BlockTranslator interface

+ NumberToQueryRange func(ctx context.Context, changedInL1Block uint64) (fromBlock *big.Int, toBlock *big.Int)

+ func NewBlockTranslator(chain *chains.Chain, client eth.Client) BlockTranslator

type OCRContractTracker

+ func (t *OCRContractTracker) Connect(*models.Head) error

+ func (t *OCRContractTracker) OnNewLongestChain(ctx context.Context, h models.Head)

Jun 21, 2021

Changes in this version

type Delegate

+ func (Delegate) OnJobCreated(spec job.Job)

+ func (Delegate) OnJobDeleted(spec job.Job)

type OCRContractTransmitter

+ func (oc *OCRContractTransmitter) ChainID() *big.Int

Mar 22, 2021

Changes in this version

+ var OCRContractLatestRoundRequested = getEventTopic("RoundRequested")

+ func IsLaterThan(incoming gethTypes.Log, existing gethTypes.Log) bool

+ type OCRContractTracker struct

+ func NewOCRContractTracker(contract *offchain_aggregator_wrapper.OffchainAggregator, ...) (o *OCRContractTracker, err error)

+ func (t *OCRContractTracker) Close() error

+ func (t *OCRContractTracker) ConfigFromLogs(ctx context.Context, changedInBlock uint64) (c ocrtypes.ContractConfig, err error)

+ func (t *OCRContractTracker) HandleLog(lb log.Broadcast)

+ func (t *OCRContractTracker) IsV2Job() bool

+ func (t *OCRContractTracker) JobID() models.JobID

+ func (t *OCRContractTracker) JobIDV2() int32

+ func (t *OCRContractTracker) LatestBlockHeight(ctx context.Context) (blockheight uint64, err error)

+ func (t *OCRContractTracker) LatestConfigDetails(ctx context.Context) (changedInBlock uint64, configDigest ocrtypes.ConfigDigest, err error)

+ func (t *OCRContractTracker) LatestRoundRequested(_ context.Context, lookback time.Duration) (configDigest ocrtypes.ConfigDigest, epoch uint32, round uint8, err error)

+ func (t *OCRContractTracker) OnConnect()

+ func (t *OCRContractTracker) OnDisconnect()

+ func (t *OCRContractTracker) Start() (err error)

+ func (t *OCRContractTracker) SubscribeToNewConfigs(context.Context) (ocrtypes.ContractConfigSubscription, error)

+ type OCRContractTrackerDB interface

+ LoadLatestRoundRequested func() (rr offchainaggregator.OffchainAggregatorRoundRequested, err error)

+ SaveLatestRoundRequested func(rr offchainaggregator.OffchainAggregatorRoundRequested) error

type OCRContractTransmitter

+ func (oc *OCRContractTransmitter) LatestRoundRequested(ctx context.Context, lookback time.Duration) (configDigest ocrtypes.ConfigDigest, epoch uint32, round uint8, err error)

+ type RunResultSaver struct

+ func NewResultRunSaver(runResults <-chan pipeline.RunWithResults, pipelineRunner pipeline.Runner, ...) *RunResultSaver

+ func (r *RunResultSaver) Close() error

+ func (r *RunResultSaver) Start() error

Feb 1, 2021

Changes in this version

+ func ValidatedOracleSpecToml(config *orm.Config, tomlString string) (job.SpecDB, error)

+ type Delegate struct

+ func NewDelegate(db *gorm.DB, jobORM job.ORM, config *orm.Config, keyStore *KeyStore, ...) *Delegate

+ func (d Delegate) JobType() job.Type

+ func (d Delegate) ServicesForSpec(jobSpec job.SpecDB) (services []job.Service, err error)

Jan 18, 2021

Changes in this version

type KeyStore

+ func (ks KeyStore) DecryptedP2PKeys() (keys []p2pkey.Key)

+ func (ks KeyStore) ExportOCRKeyBundle(id models.Sha256Hash, newPassword string) ([]byte, error)

+ func (ks KeyStore) ExportP2PKey(ID int32, newPassword string) ([]byte, error)

+ func (ks KeyStore) ImportOCRKeyBundle(keyJSON []byte, oldPassword string) (*ocrkey.EncryptedKeyBundle, error)

+ func (ks KeyStore) ImportP2PKey(keyJSON []byte, oldPassword string) (*p2pkey.EncryptedP2PKey, error)

+ func (ks KeyStore) UpsertEncryptedOCRKeyBundle(encryptedKey *ocrkey.EncryptedKeyBundle) error

type P2PPeer

+ PeerID string

+ type SingletonPeerWrapper struct

+ Peer peer

+ PeerID models.PeerID

+ func NewSingletonPeerWrapper(keyStore *KeyStore, config *orm.Config, db *gorm.DB) *SingletonPeerWrapper

+ func (p *SingletonPeerWrapper) IsStarted() bool

+ func (p *SingletonPeerWrapper) Start() (err error)

+ func (p SingletonPeerWrapper) Close() (err error)

Dec 14, 2020

Changes in this version

type OracleSpec

+ MaxTaskDuration models.Interval

+ Name null.String

Nov 23, 2020

Changes in this version

+ type OCRContractConfigTracker struct

+ func NewOCRContractConfigTracker(address gethCommon.Address, ...) (o *OCRContractConfigTracker, err error)

+ func (oc *OCRContractConfigTracker) ConfigFromLogs(ctx context.Context, changedInBlock uint64) (c ocrtypes.ContractConfig, err error)

+ func (oc *OCRContractConfigTracker) LatestBlockHeight(ctx context.Context) (blockheight uint64, err error)

+ func (oc *OCRContractConfigTracker) LatestConfigDetails(ctx context.Context) (changedInBlock uint64, configDigest ocrtypes.ConfigDigest, err error)

+ func (oc *OCRContractConfigTracker) SubscribeToNewConfigs(context.Context) (ocrtypes.ContractConfigSubscription, error)

+ type OCRContractTransmitter struct

+ func NewOCRContractTransmitter(address gethCommon.Address, ...) *OCRContractTransmitter

+ func (oc *OCRContractTransmitter) FromAddress() gethCommon.Address

+ func (oc *OCRContractTransmitter) LatestTransmissionDetails(ctx context.Context) (configDigest ocrtypes.ConfigDigest, epoch uint32, round uint8, ...)

+ func (oc *OCRContractTransmitter) Transmit(ctx context.Context, report []byte, rs, ss [][32]byte, vs [32]byte) error

+ type P2PPeer struct

+ Addr string

+ CreatedAt time.Time

+ ID string

+ JobID int32

+ UpdatedAt time.Time

+ func (P2PPeer) TableName() string

+ type Pstorewrapper struct

+ Peerstore p2ppeerstore.Peerstore

+ func NewPeerstoreWrapper(db *gorm.DB, writeInterval time.Duration, jobID int32) (*Pstorewrapper, error)

+ func (p *Pstorewrapper) Close() error

+ func (p *Pstorewrapper) Start() error

+ func (p *Pstorewrapper) WriteToDB() error

Nov 2, 2020

Changes in this version

+ const JobType

+ func NewJobSpawnerDelegate(db *gorm.DB, config *orm.Config, keyStore *KeyStore, ...) *jobSpawnerDelegate

+ func NewLogger(internal *logger.Logger, trace bool) ocrtypes.Logger

+ func NewPeerstore(ctx context.Context, db *sql.DB) (p2ppeerstore.Peerstore, error)

+ func RegisterJobType(db *gorm.DB, config *orm.Config, keyStore *KeyStore, jobSpawner job.Spawner, ...)

+ type KeyStore struct

+ func NewKeyStore(db *gorm.DB, scryptParams utils.ScryptParams) *KeyStore

+ func (ks *KeyStore) Unlock(password string) error

+ func (ks KeyStore) ArchiveEncryptedOCRKeyBundle(key *ocrkey.EncryptedKeyBundle) error

+ func (ks KeyStore) ArchiveEncryptedP2PKey(key *p2pkey.EncryptedP2PKey) error

+ func (ks KeyStore) CreateEncryptedOCRKeyBundle(encryptedKey *ocrkey.EncryptedKeyBundle) error

+ func (ks KeyStore) DecryptedOCRKey(hash models.Sha256Hash) (ocrkey.KeyBundle, bool)

+ func (ks KeyStore) DecryptedP2PKey(peerID peer.ID) (p2pkey.Key, bool)

+ func (ks KeyStore) DeleteEncryptedOCRKeyBundle(key *ocrkey.EncryptedKeyBundle) error

+ func (ks KeyStore) DeleteEncryptedP2PKey(key *p2pkey.EncryptedP2PKey) error

+ func (ks KeyStore) FindEncryptedOCRKeyBundleByID(id models.Sha256Hash) (ocrkey.EncryptedKeyBundle, error)

+ func (ks KeyStore) FindEncryptedOCRKeyBundles() (keys []ocrkey.EncryptedKeyBundle, err error)

+ func (ks KeyStore) FindEncryptedP2PKeyByID(id int32) (*p2pkey.EncryptedP2PKey, error)

+ func (ks KeyStore) FindEncryptedP2PKeys() (keys []p2pkey.EncryptedP2PKey, err error)

+ func (ks KeyStore) GenerateEncryptedOCRKeyBundle() (ocrkey.KeyBundle, ocrkey.EncryptedKeyBundle, error)

+ func (ks KeyStore) GenerateEncryptedP2PKey() (p2pkey.Key, p2pkey.EncryptedP2PKey, error)

+ func (ks KeyStore) UpsertEncryptedP2PKey(k *p2pkey.EncryptedP2PKey) error

type OCRContractConfigSubscription

+ func (sub *OCRContractConfigSubscription) IsV2Job() bool

+ func (sub *OCRContractConfigSubscription) JobIDV2() int32

+ type OracleSpec struct

+ Pipeline pipeline.TaskDAG

+ SchemaVersion uint32

+ Type string

+ func (spec OracleSpec) JobID() int32

+ func (spec OracleSpec) JobType() job.Type

+ func (spec OracleSpec) TaskDAG() pipeline.TaskDAG

Oct 12, 2020

Changes in this version

+ const OCRContractConfigSubscriptionHandleLogTimeout

+ var OCRContractConfigSet = getConfigSetHash()

+ func NewDB(sqldb *sql.DB, oracleSpecID int) ocrtypes.Database

+ type OCRContract struct

+ func NewOCRContract(address gethCommon.Address, ethClient eth.Client, ...) (o *OCRContract, err error)

+ func (oc *OCRContract) ConfigFromLogs(ctx context.Context, changedInBlock uint64) (c ocrtypes.ContractConfig, err error)

+ func (oc *OCRContract) FromAddress() gethCommon.Address

+ func (oc *OCRContract) LatestBlockHeight(ctx context.Context) (blockheight uint64, err error)

+ func (oc *OCRContract) LatestConfigDetails(ctx context.Context) (changedInBlock uint64, configDigest ocrtypes.ConfigDigest, err error)

+ func (oc *OCRContract) LatestTransmissionDetails(ctx context.Context) (configDigest ocrtypes.ConfigDigest, epoch uint32, round uint8, ...)

+ func (oc *OCRContract) SubscribeToNewConfigs(context.Context) (ocrtypes.ContractConfigSubscription, error)

+ func (oc *OCRContract) Transmit(ctx context.Context, report []byte, rs, ss [][32]byte, vs [32]byte) error

+ type OCRContractConfigSubscription struct

+ func (sub *OCRContractConfigSubscription) Close()

+ func (sub *OCRContractConfigSubscription) Configs() <-chan ocrtypes.ContractConfig

+ func (sub *OCRContractConfigSubscription) HandleLog(lb eth.LogBroadcast, err error)

+ func (sub *OCRContractConfigSubscription) JobID() *models.ID

+ func (sub *OCRContractConfigSubscription) OnConnect()

+ func (sub *OCRContractConfigSubscription) OnDisconnect()

+ type Transmitter interface

+ CreateEthTransaction func(ctx context.Context, toAddress gethCommon.Address, payload []byte) error

+ FromAddress func() gethCommon.Address

+ func NewTransmitter(sqldb *sql.DB, fromAddress gethCommon.Address, gasLimit uint64) Transmitter