[KS-430] Provide an OracleFactory to StandardCapabilities #14305
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| package generic | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "fmt" | ||
|
|
||
| "github.com/pkg/errors" | ||
| "github.com/prometheus/client_golang/prometheus" | ||
| "github.com/smartcontractkit/libocr/commontypes" | ||
| ocr "github.com/smartcontractkit/libocr/offchainreporting2plus" | ||
| "github.com/smartcontractkit/libocr/offchainreporting2plus/ocr3types" | ||
|
|
||
| "github.com/smartcontractkit/chainlink/v2/core/logger" | ||
| "github.com/smartcontractkit/chainlink/v2/core/services/job" | ||
| "github.com/smartcontractkit/chainlink/v2/core/services/keystore/keys/ocr2key" | ||
| "github.com/smartcontractkit/chainlink/v2/core/services/ocrcommon" | ||
| "github.com/smartcontractkit/chainlink/v2/core/services/telemetry" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/types/core" | ||
| ) | ||
|
|
||
| type oracleFactoryConfig struct { | ||
| Enabled bool | ||
| TraceLogging bool | ||
| BootstrapPeers []commontypes.BootstrapperLocator | ||
| } | ||
|
|
||
| func NewOracleFactoryConfig(config job.JSONConfig) (*oracleFactoryConfig, error) { | ||
| var ofc struct { | ||
| Enabled bool `json:"enabled"` | ||
| TraceLogging bool `json:"traceLogging"` | ||
| BootstrapPeers []string `json:"bootstrapPeers"` | ||
| } | ||
| err := json.Unmarshal(config.Bytes(), &ofc) | ||
| if err != nil { | ||
| return nil, errors.Wrap(err, "failed to unmarshal oracle factory config") | ||
| } | ||
|
|
||
| if !ofc.Enabled { | ||
| return &oracleFactoryConfig{}, nil | ||
| } | ||
|
|
||
| // If Oracle Factory is enabled, it must have at least one bootstrap peer | ||
| if len(ofc.BootstrapPeers) == 0 { | ||
| return nil, errors.New("no bootstrap peers found") | ||
| } | ||
|
|
||
| bootstrapPeers, err := ocrcommon.ParseBootstrapPeers(ofc.BootstrapPeers) | ||
| if err != nil { | ||
| return nil, errors.Wrap(err, "failed to parse bootstrap peers") | ||
| } | ||
|
|
||
| return &oracleFactoryConfig{ | ||
| Enabled: true, | ||
| TraceLogging: ofc.TraceLogging, | ||
| BootstrapPeers: bootstrapPeers, | ||
| }, nil | ||
| } | ||
|
|
||
| type oracleFactory struct { | ||
| database ocr3types.Database | ||
| jobID int32 | ||
| jobName string | ||
| jobORM job.ORM | ||
| kb ocr2key.KeyBundle | ||
| lggr logger.Logger | ||
| config *oracleFactoryConfig | ||
| peerWrapper *ocrcommon.SingletonPeerWrapper | ||
| } | ||
|
|
||
| type OracleFactoryParams struct { | ||
| Database ocr3types.Database | ||
| JobID int32 | ||
| JobName string | ||
| JobORM job.ORM | ||
| Kb ocr2key.KeyBundle | ||
| Logger logger.Logger | ||
| Config *oracleFactoryConfig | ||
| PeerWrapper *ocrcommon.SingletonPeerWrapper | ||
| } | ||
|
|
||
| func NewOracleFactory(params OracleFactoryParams) (core.OracleFactory, error) { | ||
| return &oracleFactory{ | ||
| database: params.Database, | ||
| jobID: params.JobID, | ||
| jobName: params.JobName, | ||
| jobORM: params.JobORM, | ||
| kb: params.Kb, | ||
| lggr: params.Logger, | ||
| config: params.Config, | ||
| peerWrapper: params.PeerWrapper, | ||
| }, nil | ||
| } | ||
|
|
||
| func (of *oracleFactory) NewOracle(ctx context.Context, args core.OracleArgs) (core.Oracle, error) { | ||
| oracle, err := ocr.NewOracle(ocr.OCR3OracleArgs[[]byte]{ | ||
| LocalConfig: args.LocalConfig, | ||
| ContractConfigTracker: args.ContractConfigTracker, | ||
| ContractTransmitter: args.ContractTransmitter, | ||
| OffchainConfigDigester: args.OffchainConfigDigester, | ||
| ReportingPluginFactory: args.ReportingPluginFactoryService, | ||
| BinaryNetworkEndpointFactory: of.peerWrapper.Peer2, | ||
| V2Bootstrappers: of.config.BootstrapPeers, | ||
| Database: of.database, | ||
| Logger: ocrcommon.NewOCRWrapper(of.lggr, of.config.TraceLogging, func(ctx context.Context, msg string) { | ||
| logger.Sugared(of.lggr).ErrorIf(of.jobORM.RecordError(ctx, of.jobID, msg), "unable to record error") | ||
| }), | ||
| // TODO? | ||
| MonitoringEndpoint: &telemetry.NoopAgent{}, | ||
| OffchainKeyring: of.kb, | ||
| OnchainKeyring: ocrcommon.NewOCR3OnchainKeyringAdapter(of.kb), | ||
| MetricsRegisterer: prometheus.WrapRegistererWith(map[string]string{"job_name": of.jobName}, prometheus.DefaultRegisterer), | ||
| }) | ||
|
|
||
| if err != nil { | ||
| return nil, fmt.Errorf("%w: failed to create new OCR oracle", err) | ||
| } | ||
|
|
||
| return &adaptedOracle{oracle: oracle}, nil | ||
| } | ||
|
|
||
| type adaptedOracle struct { | ||
| oracle ocr.Oracle | ||
| } | ||
|
|
||
| func (a *adaptedOracle) Start(ctx context.Context) error { | ||
| return a.oracle.Start() | ||
| } | ||
|
|
||
| func (a *adaptedOracle) Close(ctx context.Context) error { | ||
| return a.oracle.Close() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@DeividasK OracleFactoryConfig?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we put a comment here to document where we define what's expected in OracleConfig?