offchainreporting

package
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 19, 2021 License: MIT Imports: 45 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	OCRContractConfigSet            = getEventTopic("ConfigSet")
	OCRContractLatestRoundRequested = getEventTopic("RoundRequested")
)

Functions

func IsLaterThan 

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

IsLaterThan returns true if the first log was emitted "after" the second log from the blockchain's point of view

func NewDB 

func NewDB(sqldb *sql.DB, oracleSpecID int32) *db

NewDB returns a new DB scoped to this oracleSpecID

func NewLogger 

func NewLogger(l *logger.Logger, trace bool, saveError func(string)) ocrtypes.Logger

func ValidatedOracleSpecToml 

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

ValidatedOracleSpecToml validates an oracle spec that came from TOML

Types

type Delegate 

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

func NewDelegate 

func NewDelegate(
	db *gorm.DB,
	jobORM job.ORM,
	config *orm.Config,
	keyStore *KeyStore,
	pipelineRunner pipeline.Runner,
	ethClient eth.Client,
	logBroadcaster log.Broadcaster,
	peerWrapper *SingletonPeerWrapper,
	monitoringEndpoint ocrtypes.MonitoringEndpoint,
) *Delegate

func (Delegate) JobType 

func (d Delegate) JobType() job.Type

func (Delegate) ServicesForSpec 

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

type KeyStore 

type KeyStore struct {
	*gorm.DB
	// contains filtered or unexported fields
}

func NewKeyStore 

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

func (KeyStore) ArchiveEncryptedOCRKeyBundle 

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

ArchiveEncryptedOCRKeyBundle deletes the provided encrypted OCR key bundle

func (KeyStore) ArchiveEncryptedP2PKey 

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

func (KeyStore) CreateEncryptedOCRKeyBundle 

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

CreateEncryptedOCRKeyBundle creates an encrypted OCR private key record

func (KeyStore) DecryptedOCRKey 

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

func (KeyStore) DecryptedP2PKey 

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

func (KeyStore) DecryptedP2PKeys 

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

func (KeyStore) DeleteEncryptedOCRKeyBundle 

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

DeleteEncryptedOCRKeyBundle deletes the provided encrypted OCR key bundle

func (KeyStore) DeleteEncryptedP2PKey 

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

func (KeyStore) ExportOCRKeyBundle 

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

ExportOCRKeyBundle exports an OCR key bundle from the database

func (KeyStore) ExportP2PKey 

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

ExportP2PKey exports a p2p key from the database

func (KeyStore) FindEncryptedOCRKeyBundleByID 

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

FindEncryptedOCRKeyBundleByID finds an EncryptedKeyBundle bundle by its ID

func (KeyStore) FindEncryptedOCRKeyBundles 

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

FindEncryptedOCRKeyBundles finds all the encrypted OCR key records

func (KeyStore) FindEncryptedP2PKeyByID 

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

func (KeyStore) FindEncryptedP2PKeys 

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

func (KeyStore) GenerateEncryptedOCRKeyBundle 

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

func (KeyStore) GenerateEncryptedP2PKey 

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

func (KeyStore) ImportOCRKeyBundle 

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

ImportOCRKeyBundle imports an OCR key bundle to the database

func (KeyStore) ImportP2PKey 

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

ImportP2PKey imports a p2p key to the database

func (*KeyStore) Unlock 

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

func (KeyStore) UpsertEncryptedOCRKeyBundle 

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

func (KeyStore) UpsertEncryptedP2PKey 

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

type OCRContractConfigSubscription 

type OCRContractConfigSubscription OCRContractTracker

OCRContractConfigSubscription only exists to comply with the ContractConfigSubscription interface, it's just a simple shell around OCRContractTracker that defines two methods

func (*OCRContractConfigSubscription) Close 

func (sub *OCRContractConfigSubscription) Close()

Close is a no-op since Subscribing/Unsubscribing is handled in the Start/Close methods of the OCRContractTracker

func (*OCRContractConfigSubscription) Configs 

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

Configs complies with ContractConfigSubscription interface

type OCRContractTracker 

type OCRContractTracker struct {
	utils.StartStopOnce
	// contains filtered or unexported fields
}

OCRContractTracker complies with ContractConfigTracker interface and handles log events related to the contract more generally

func NewOCRContractTracker 

func NewOCRContractTracker(
	contract *offchain_aggregator_wrapper.OffchainAggregator,
	contractFilterer *offchainaggregator.OffchainAggregatorFilterer,
	contractCaller *offchainaggregator.OffchainAggregatorCaller,
	ethClient eth.Client,
	logBroadcaster log.Broadcaster,
	jobID int32,
	logger logger.Logger,
	db OCRContractTrackerDB,
) (o *OCRContractTracker, err error)

NewOCRContractTracker makes a new OCRContractTracker

func (*OCRContractTracker) Close 

func (t *OCRContractTracker) Close() error

Close should be called after teardown of the OCR job relying on this tracker

func (*OCRContractTracker) ConfigFromLogs 

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

ConfigFromLogs queries the eth node for logs for this contract

func (*OCRContractTracker) HandleLog 

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

HandleLog complies with LogListener interface It is not thread safe

func (*OCRContractTracker) IsV2Job 

func (t *OCRContractTracker) IsV2Job() bool

IsV2Job complies with LogListener interface

func (*OCRContractTracker) JobID 

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

JobID complies with LogListener interface

func (*OCRContractTracker) JobIDV2 

func (t *OCRContractTracker) JobIDV2() int32

JobIDV2 complies with LogListener interface

func (*OCRContractTracker) LatestBlockHeight 

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

LatestBlockHeight queries the eth node for the most recent header TODO(sam): This could (should?) be optimised to use the head tracker https://www.pivotaltracker.com/story/show/177006717

func (*OCRContractTracker) LatestConfigDetails 

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

LatestConfigDetails queries the eth node

func (*OCRContractTracker) LatestRoundRequested 

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

LatestRoundRequested returns the configDigest, epoch, and round from the latest RoundRequested event emitted by the contract. LatestRoundRequested may or may not return a result if the latest such event was emitted in a block b such that b.timestamp < tip.timestamp - lookback.

If no event is found, LatestRoundRequested should return zero values, not an error. An error should only be returned if an actual error occurred during execution, e.g. because there was an error querying the blockchain or the database.

As an optimization, this function may also return zero values, if no RoundRequested event has been emitted after the latest NewTransmission event.

func (*OCRContractTracker) OnConnect 

func (t *OCRContractTracker) OnConnect()

OnConnect complies with LogListener interface

func (*OCRContractTracker) OnDisconnect 

func (t *OCRContractTracker) OnDisconnect()

OnDisconnect complies with LogListener interface

func (*OCRContractTracker) Start 

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

Start must be called before logs can be delivered It ought to be called before starting OCR

func (*OCRContractTracker) SubscribeToNewConfigs 

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

SubscribeToNewConfigs returns the tracker aliased as a ContractConfigSubscription

type OCRContractTrackerDB 

type OCRContractTrackerDB interface {
	SaveLatestRoundRequested(rr offchainaggregator.OffchainAggregatorRoundRequested) error
	LoadLatestRoundRequested() (rr offchainaggregator.OffchainAggregatorRoundRequested, err error)
}

type OCRContractTransmitter 

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

func NewOCRContractTransmitter 

func NewOCRContractTransmitter(
	address gethCommon.Address,
	contractCaller *offchainaggregator.OffchainAggregatorCaller,
	contractABI abi.ABI,
	transmitter Transmitter,
	logBroadcaster log.Broadcaster,
	tracker *OCRContractTracker,
) *OCRContractTransmitter

func (*OCRContractTransmitter) FromAddress 

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

func (*OCRContractTransmitter) LatestRoundRequested 

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

LatestRoundRequested returns the configDigest, epoch, and round from the latest RoundRequested event emitted by the contract. LatestRoundRequested may or may not return a result if the latest such event was emitted in a block b such that b.timestamp < tip.timestamp - lookback.

If no event is found, LatestRoundRequested should return zero values, not an error. An error should only be returned if an actual error occurred during execution, e.g. because there was an error querying the blockchain or the database.

As an optimization, this function may also return zero values, if no RoundRequested event has been emitted after the latest NewTransmission event.

func (*OCRContractTransmitter) LatestTransmissionDetails 

func (oc *OCRContractTransmitter) LatestTransmissionDetails(ctx context.Context) (configDigest ocrtypes.ConfigDigest, epoch uint32, round uint8, latestAnswer ocrtypes.Observation, latestTimestamp time.Time, err error)

func (*OCRContractTransmitter) Transmit 

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

type P2PPeer 

type P2PPeer struct {
	ID        string
	Addr      string
	PeerID    string
	CreatedAt time.Time
	UpdatedAt time.Time
}

func (P2PPeer) TableName 

func (P2PPeer) TableName() string

type Pstorewrapper 

type Pstorewrapper struct {
	utils.StartStopOnce
	Peerstore p2ppeerstore.Peerstore
	// contains filtered or unexported fields
}

func NewPeerstoreWrapper 

func NewPeerstoreWrapper(db *gorm.DB, writeInterval time.Duration, peerID models.PeerID) (*Pstorewrapper, error)

NewPeerstoreWrapper creates a new database-backed peerstore wrapper scoped to the given jobID Multiple peerstore wrappers should not be instantiated with the same jobID

func (*Pstorewrapper) Close 

func (p *Pstorewrapper) Close() error

func (*Pstorewrapper) Start 

func (p *Pstorewrapper) Start() error

func (*Pstorewrapper) WriteToDB 

func (p *Pstorewrapper) WriteToDB() error

type RunResultSaver 

type RunResultSaver struct {
	utils.StartStopOnce
	// contains filtered or unexported fields
}

func NewResultRunSaver 

func NewResultRunSaver(runResults <-chan pipeline.RunWithResults, pipelineRunner pipeline.Runner, done chan struct{}, jobID int32) *RunResultSaver

func (*RunResultSaver) Close 

func (r *RunResultSaver) Close() error

func (*RunResultSaver) Start 

func (r *RunResultSaver) Start() error

type SingletonPeerWrapper 

type SingletonPeerWrapper struct {
	PeerID models.PeerID
	Peer   peer
	// contains filtered or unexported fields
}

SingletonPeerWrapper manages all libocr peers for the application

func NewSingletonPeerWrapper 

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

NewSingletonPeerWrapper creates a new peer based on the p2p keys in the keystore It currently only supports one peerID/key It should be fairly easy to modify it to support multiple peerIDs/keys using e.g. a map

func (SingletonPeerWrapper) Close 

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

Close closes the peer and peerstore

func (*SingletonPeerWrapper) IsStarted 

func (p *SingletonPeerWrapper) IsStarted() bool

func (*SingletonPeerWrapper) Start 

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

type Transmitter 

type Transmitter interface {
	CreateEthTransaction(ctx context.Context, toAddress gethCommon.Address, payload []byte) error
	FromAddress() gethCommon.Address
}

func NewTransmitter 

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

NewTransmitter creates a new eth transmitter

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.