# README
Contracts
Contains all code to launch, and interact with smart contracts on a blockchain.
All contracts are generalized by interfaces in order to simplify test logic across different chains.
# Packages
No description provided by the author
# Functions
DefaultFluxAggregatorOptions produces some basic defaults for a flux aggregator contract.
DefaultOffChainAggregatorConfig returns some base defaults for configuring an OCR contract.
DefaultOffChainAggregatorOptions returns some base defaults for deploying an OCR contract.
NewContractDeployer returns an instance of a contract deployer based on the client type.
NewEthereumContractDeployer returns an instantiated instance of the ETH contract deployer.
NewFluxAggregatorRoundConfirmer provides a new instance of a FluxAggregatorRoundConfirmer.
NewKeeperConsumerRoundConfirmer provides a new instance of a KeeperConsumerRoundConfirmer.
NewOffchainAggregatorRoundConfirmer provides a new instance of a OffchainAggregatorRoundConfirmer.
NewRunlogRoundConfirmer provides a new instance of a RunlogRoundConfirmer.
NewVRFConsumerRoundConfirmer provides a new instance of a NewVRFConsumerRoundConfirmer.
# Structs
EthereumAPIConsumer API consumer for job type "directrequest" tests.
EthereumBlockhashStore represents a blockhash store for VRF contract.
EthereumContractDeployer provides the implementations for deploying ETH (EVM) based contracts.
EthereumDeviationFlaggingValidator represents deviation flagging validator contract.
EthereumFlags represents flags contract.
EthereumFluxAggregator represents the basic flux aggregation contract.
EthereumKeeperConsumer represents keeper consumer (upkeep) contract.
EthereumKeeperRegistry represents keeper registry contract.
EthereumLinkToken represents a LinkToken address.
EthereumMockETHLINKFeed represents mocked ETH/LINK feed contract.
EthereumMockGASFeed represents mocked Gas feed contract.
No description provided by the author
No description provided by the author
EthereumOffchainAggregator represents the offchain aggregation contract.
EthereumOracle oracle for "directrequest" job tests.
EthereumReadAccessController represents read access controller contract.
EthereumStorage acts as a conduit for the ethereum version of the storage contract.
EthereumUpkeepRegistrationRequests keeper contract to register upkeeps.
EthereumVRF represents a VRF contract.
EthereumVRFConsumer represents VRF consumer contract.
EthereumVRFCoordinator represents VRF coordinator contract.
No description provided by the author
No description provided by the author
FluxAggregatorRoundConfirmer is a header subscription that awaits for a certain flux round to be completed.
No description provided by the author
JobByInstance helper struct to match job + instance ID.
KeeperConsumerRoundConfirmer is a header subscription that awaits for a round of upkeeps.
KeeperInfo keeper status and balance info.
KeeperRegistryOpts opts to deploy keeper registry.
https://uploads-ssl.webflow.com/5f6b7190899f41fb70882d08/603651a1101106649eef6a53_chainlink-ocr-protocol-paper-02-24-20.pdf.
No description provided by the author
OffchainAggregatorRoundConfirmer is a header subscription that awaits for a certain OCR round to be completed.
No description provided by the author
No description provided by the author
PerfEvent is used to get some metrics for contracts, it contrains roundID for Keeper/OCR/Flux tests and request id for VRF/Runlog.
No description provided by the author
RunlogRoundConfirmer is a header subscription that awaits for a certain Runlog round to be completed.
No description provided by the author
UpkeepInfo keeper target info.
VRFConsumerRoundConfirmer is a header subscription that awaits for a certain VRF round to be completed.
# Interfaces
No description provided by the author
No description provided by the author
ContractDeployer is an interface for abstracting the contract deployment methods across network implementations.
DeviationFlaggingValidator contract used as an external validator, fox ex.
Flags flags contract interface.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OCRv2 main offchain reporting v2 instance.
OCRv2AccessController access controller.
OCRv2DeviationFlaggingValidator OCR deviation flagging validator.
No description provided by the author
No description provided by the author
ReadAccessController is read/write access controller, just named by interface.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author