contracts

package
v1.0.21 Latest Latest
Warning

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

 Go to latest Published: Jan 3, 2022 License: MIT Imports: 18 Imported by: 0

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.

Documentation

Overview

Package contracts handles deployment, management, and interactions of smart contracts on various chains

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type APIConsumer 

type APIConsumer interface {
	Address() string
	RoundID(ctx context.Context) (*big.Int, error)
	Fund(ethAmount *big.Float) error
	Data(ctx context.Context) (*big.Int, error)
	CreateRequestTo(
		oracleAddr string,
		jobID [32]byte,
		payment *big.Int,
		url string,
		path string,
		times *big.Int,
	) error
	WatchPerfEvents(ctx context.Context, eventChan chan<- *PerfEvent) error
}

type BlockHashStore 

type BlockHashStore interface {
	Address() string
}

type ContractDeployer 

type ContractDeployer interface {
	Balance() (*big.Float, error)
	DeployStorageContract() (Storage, error)
	DeployAPIConsumer(linkAddr string) (APIConsumer, error)
	DeployOracle(linkAddr string) (Oracle, error)
	DeployReadAccessController() (ReadAccessController, error)
	DeployFlags(rac string) (Flags, error)
	DeployDeviationFlaggingValidator(
		flags string,
		flaggingThreshold *big.Int,
	) (DeviationFlaggingValidator, error)
	DeployFluxAggregatorContract(linkAddr string, fluxOptions FluxAggregatorOptions) (FluxAggregator, error)
	DeployLinkTokenContract() (LinkToken, error)
	DeployOCRv2(
		paymentControllerAddr string,
		requesterControllerAddr string,
		linkTokenAddr string,
	) (OCRv2, error)
	DeployOCRv2AccessController() (OCRv2AccessController, error)
	DeployOCRv2Store(billingAC string) (OCRv2Store, error)
	DeployOffChainAggregator(linkAddr string, offchainOptions OffchainOptions) (OffchainAggregator, error)
	DeployVRFContract() (VRF, error)
	DeployMockETHLINKFeed(answer *big.Int) (MockETHLINKFeed, error)
	DeployMockGasFeed(answer *big.Int) (MockGasFeed, error)
	DeployUpkeepRegistrationRequests(linkAddr string, minLinkJuels *big.Int) (UpkeepRegistrar, error)
	DeployKeeperRegistry(opts *KeeperRegistryOpts) (KeeperRegistry, error)
	DeployKeeperConsumer(updateInterval *big.Int) (KeeperConsumer, error)
	DeployVRFConsumer(linkAddr string, coordinatorAddr string) (VRFConsumer, error)
	DeployVRFCoordinator(linkAddr string, bhsAddr string) (VRFCoordinator, error)
	DeployBlockhashStore() (BlockHashStore, error)
}

ContractDeployer is an interface for abstracting the contract deployment methods across network implementations

func NewContractDeployer 

func NewContractDeployer(bcClient client.BlockchainClient) (ContractDeployer, error)

NewContractDeployer returns an instance of a contract deployer based on the client type

type DeviationFlaggingValidator 

type DeviationFlaggingValidator interface {
	Address() string
}

DeviationFlaggingValidator contract used as an external validator, fox ex. in flux monitor rounds validation

type EthereumAPIConsumer 

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

EthereumAPIConsumer API consumer for job type "directrequest" tests

func (*EthereumAPIConsumer) Address 

func (e *EthereumAPIConsumer) Address() string

func (*EthereumAPIConsumer) CreateRequestTo 

func (e *EthereumAPIConsumer) CreateRequestTo(
	oracleAddr string,
	jobID [32]byte,
	payment *big.Int,
	url string,
	path string,
	times *big.Int,
) error

CreateRequestTo creates request to an oracle for particular jobID with params

func (*EthereumAPIConsumer) Data 

func (e *EthereumAPIConsumer) Data(ctx context.Context) (*big.Int, error)

func (*EthereumAPIConsumer) Fund 

func (e *EthereumAPIConsumer) Fund(ethAmount *big.Float) error

func (*EthereumAPIConsumer) RoundID added in v0.0.7 

func (e *EthereumAPIConsumer) RoundID(ctx context.Context) (*big.Int, error)

func (*EthereumAPIConsumer) WatchPerfEvents added in v0.0.7 

func (e *EthereumAPIConsumer) WatchPerfEvents(ctx context.Context, eventChan chan<- *PerfEvent) error

type EthereumBlockhashStore 

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

EthereumBlockhashStore represents a blockhash store for VRF contract

func (*EthereumBlockhashStore) Address 

func (v *EthereumBlockhashStore) Address() string

type EthereumContractDeployer 

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

EthereumContractDeployer provides the implementations for deploying ETH (EVM) based contracts

func NewEthereumContractDeployer 

func NewEthereumContractDeployer(ethClient *client.EthereumClient) *EthereumContractDeployer

NewEthereumContractDeployer returns an instantiated instance of the ETH contract deployer

func (*EthereumContractDeployer) Balance added in v0.0.5 

func (e *EthereumContractDeployer) Balance() (*big.Float, error)

Balance get deployer wallet balance

func (*EthereumContractDeployer) DeployAPIConsumer 

func (e *EthereumContractDeployer) DeployAPIConsumer(linkAddr string) (APIConsumer, error)

DeployAPIConsumer deploys api consumer for oracle

func (*EthereumContractDeployer) DeployBlockhashStore 

func (e *EthereumContractDeployer) DeployBlockhashStore() (BlockHashStore, error)

DeployBlockhashStore deploys blockhash store used with VRF contract

func (*EthereumContractDeployer) DeployDeviationFlaggingValidator 

func (e *EthereumContractDeployer) DeployDeviationFlaggingValidator(
	flags string,
	flaggingThreshold *big.Int,
) (DeviationFlaggingValidator, error)

DeployDeviationFlaggingValidator deploys deviation flagging validator contract

func (*EthereumContractDeployer) DeployFlags 

func (e *EthereumContractDeployer) DeployFlags(
	rac string,
) (Flags, error)

DeployFlags deploys flags contract

func (*EthereumContractDeployer) DeployFluxAggregatorContract 

func (e *EthereumContractDeployer) DeployFluxAggregatorContract(
	linkAddr string,
	fluxOptions FluxAggregatorOptions,
) (FluxAggregator, error)

DeployFluxAggregatorContract deploys the Flux Aggregator Contract on an EVM chain

func (*EthereumContractDeployer) DeployKeeperConsumer 

func (e *EthereumContractDeployer) DeployKeeperConsumer(updateInterval *big.Int) (KeeperConsumer, error)

func (*EthereumContractDeployer) DeployKeeperRegistry 

func (e *EthereumContractDeployer) DeployKeeperRegistry(
	opts *KeeperRegistryOpts,
) (KeeperRegistry, error)

func (*EthereumContractDeployer) DeployLinkTokenContract 

func (e *EthereumContractDeployer) DeployLinkTokenContract() (LinkToken, error)

DeployLinkTokenContract deploys a Link Token contract to an EVM chain

func (*EthereumContractDeployer) DeployMockETHLINKFeed 

func (e *EthereumContractDeployer) DeployMockETHLINKFeed(answer *big.Int) (MockETHLINKFeed, error)

func (*EthereumContractDeployer) DeployMockGasFeed 

func (e *EthereumContractDeployer) DeployMockGasFeed(answer *big.Int) (MockGasFeed, error)

func (*EthereumContractDeployer) DeployOCRv2 added in v0.0.11 

func (e *EthereumContractDeployer) DeployOCRv2(
	paymentControllerAddr string,
	requesterControllerAddr string,
	linkTokenAddr string,
) (OCRv2, error)

func (*EthereumContractDeployer) DeployOCRv2AccessController added in v0.0.11 

func (e *EthereumContractDeployer) DeployOCRv2AccessController() (OCRv2AccessController, error)

func (*EthereumContractDeployer) DeployOCRv2Store added in v1.0.21 

func (e *EthereumContractDeployer) DeployOCRv2Store(billingAC string) (OCRv2Store, error)

func (*EthereumContractDeployer) DeployOffChainAggregator 

func (e *EthereumContractDeployer) DeployOffChainAggregator(
	linkAddr string,
	offchainOptions OffchainOptions,
) (OffchainAggregator, error)

DeployOffChainAggregator deploys the offchain aggregation contract to the EVM chain

func (*EthereumContractDeployer) DeployOracle 

func (e *EthereumContractDeployer) DeployOracle(linkAddr string) (Oracle, error)

DeployOracle deploys oracle for consumer test

func (*EthereumContractDeployer) DeployReadAccessController 

func (e *EthereumContractDeployer) DeployReadAccessController() (ReadAccessController, error)

DeployReadAccessController deploys read/write access controller contract

func (*EthereumContractDeployer) DeployStorageContract 

func (e *EthereumContractDeployer) DeployStorageContract() (Storage, error)

DeployStorageContract deploys a vanilla storage contract that is a value store

func (*EthereumContractDeployer) DeployUpkeepRegistrationRequests 

func (e *EthereumContractDeployer) DeployUpkeepRegistrationRequests(linkAddr string, minLinkJuels *big.Int) (UpkeepRegistrar, error)

func (*EthereumContractDeployer) DeployVRFConsumer 

func (e *EthereumContractDeployer) DeployVRFConsumer(linkAddr string, coordinatorAddr string) (VRFConsumer, error)

DeployVRFConsumer deploys VRF consumer contract

func (*EthereumContractDeployer) DeployVRFContract 

func (e *EthereumContractDeployer) DeployVRFContract() (VRF, error)

DeployVRFContract deploy VRF contract

func (*EthereumContractDeployer) DeployVRFCoordinator 

func (e *EthereumContractDeployer) DeployVRFCoordinator(linkAddr string, bhsAddr string) (VRFCoordinator, error)

DeployVRFCoordinator deploys VRF coordinator contract

type EthereumDeviationFlaggingValidator 

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

EthereumDeviationFlaggingValidator represents deviation flagging validator contract

func (*EthereumDeviationFlaggingValidator) Address 

func (e *EthereumDeviationFlaggingValidator) Address() string

type EthereumFlags 

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

EthereumFlags represents flags contract

func (*EthereumFlags) Address 

func (e *EthereumFlags) Address() string

func (*EthereumFlags) GetFlag 

func (e *EthereumFlags) GetFlag(ctx context.Context, addr string) (bool, error)

GetFlag returns boolean if a flag was set for particular address

type EthereumFluxAggregator 

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

EthereumFluxAggregator represents the basic flux aggregation contract

func (*EthereumFluxAggregator) Address 

func (f *EthereumFluxAggregator) Address() string

func (*EthereumFluxAggregator) Description 

func (f *EthereumFluxAggregator) Description(ctxt context.Context) (string, error)

Description returns the description of the flux aggregator contract

func (*EthereumFluxAggregator) Fund 

func (f *EthereumFluxAggregator) Fund(ethAmount *big.Float) error

Fund sends specified currencies to the contract

func (*EthereumFluxAggregator) GetContractData 

func (f *EthereumFluxAggregator) GetContractData(ctx context.Context) (*FluxAggregatorData, error)

GetContractData retrieves basic data for the flux aggregator contract

func (*EthereumFluxAggregator) GetOracles 

func (f *EthereumFluxAggregator) GetOracles(ctx context.Context) ([]string, error)

func (*EthereumFluxAggregator) LatestRoundData 

func (f *EthereumFluxAggregator) LatestRoundData(ctx context.Context) (RoundData, error)

func (*EthereumFluxAggregator) LatestRoundID 

func (f *EthereumFluxAggregator) LatestRoundID(ctx context.Context) (*big.Int, error)

func (*EthereumFluxAggregator) PaymentAmount 

func (f *EthereumFluxAggregator) PaymentAmount(ctx context.Context) (*big.Int, error)

func (*EthereumFluxAggregator) RequestNewRound 

func (f *EthereumFluxAggregator) RequestNewRound(ctx context.Context) error

func (*EthereumFluxAggregator) SetOracles 

func (f *EthereumFluxAggregator) SetOracles(o FluxAggregatorSetOraclesOptions) error

SetOracles allows the ability to add and/or remove oracles from the contract, and to set admins

func (*EthereumFluxAggregator) SetRequesterPermissions 

func (f *EthereumFluxAggregator) SetRequesterPermissions(ctx context.Context, addr common.Address, authorized bool, roundsDelay uint32) error

func (*EthereumFluxAggregator) UpdateAvailableFunds 

func (f *EthereumFluxAggregator) UpdateAvailableFunds() error

func (*EthereumFluxAggregator) WatchSubmissionReceived 

func (f *EthereumFluxAggregator) WatchSubmissionReceived(ctx context.Context, eventChan chan<- *SubmissionEvent) error

WatchSubmissionReceived subscribes to any submissions on a flux feed

func (*EthereumFluxAggregator) WithdrawPayment 

func (f *EthereumFluxAggregator) WithdrawPayment(
	ctx context.Context,
	from common.Address,
	to common.Address,
	amount *big.Int) error

func (*EthereumFluxAggregator) WithdrawablePayment 

func (f *EthereumFluxAggregator) WithdrawablePayment(ctx context.Context, addr common.Address) (*big.Int, error)

type EthereumKeeperConsumer 

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

EthereumKeeperConsumer represents keeper consumer (upkeep) contract

func (*EthereumKeeperConsumer) Address 

func (v *EthereumKeeperConsumer) Address() string

func (*EthereumKeeperConsumer) Counter 

func (v *EthereumKeeperConsumer) Counter(ctx context.Context) (*big.Int, error)

func (*EthereumKeeperConsumer) Fund 

func (v *EthereumKeeperConsumer) Fund(ethAmount *big.Float) error

type EthereumKeeperRegistry 

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

EthereumKeeperRegistry represents keeper registry contract

func (*EthereumKeeperRegistry) AddUpkeepFunds 

func (v *EthereumKeeperRegistry) AddUpkeepFunds(id *big.Int, amount *big.Int) error

AddUpkeepFunds adds link for particular upkeep id

func (*EthereumKeeperRegistry) Address 

func (v *EthereumKeeperRegistry) Address() string

func (*EthereumKeeperRegistry) Fund 

func (v *EthereumKeeperRegistry) Fund(ethAmount *big.Float) error

func (*EthereumKeeperRegistry) GetKeeperInfo 

func (v *EthereumKeeperRegistry) GetKeeperInfo(ctx context.Context, keeperAddr string) (*KeeperInfo, error)

func (*EthereumKeeperRegistry) GetKeeperList 

func (v *EthereumKeeperRegistry) GetKeeperList(ctx context.Context) ([]string, error)

GetKeeperList get list of all registered keeper addresses

func (*EthereumKeeperRegistry) GetUpkeepInfo 

func (v *EthereumKeeperRegistry) GetUpkeepInfo(ctx context.Context, id *big.Int) (*UpkeepInfo, error)

GetUpkeepInfo gets upkeep info

func (*EthereumKeeperRegistry) RegisterUpkeep 

func (v *EthereumKeeperRegistry) RegisterUpkeep(target string, gasLimit uint32, admin string, checkData []byte) error

RegisterUpkeep registers contract to perform upkeep

func (*EthereumKeeperRegistry) SetKeepers 

func (v *EthereumKeeperRegistry) SetKeepers(keepers []string, payees []string) error

func (*EthereumKeeperRegistry) SetRegistrar 

func (v *EthereumKeeperRegistry) SetRegistrar(registrarAddr string) error

type EthereumLinkToken 

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

EthereumLinkToken represents a LinkToken address

func (*EthereumLinkToken) Address 

func (l *EthereumLinkToken) Address() string

func (*EthereumLinkToken) Approve 

func (l *EthereumLinkToken) Approve(to string, amount *big.Int) error

func (*EthereumLinkToken) BalanceOf 

func (l *EthereumLinkToken) BalanceOf(ctx context.Context, addr string) (*big.Int, error)

func (*EthereumLinkToken) Deploy added in v0.0.25 

func (l *EthereumLinkToken) Deploy() (LinkToken, error)

func (*EthereumLinkToken) Fund 

func (l *EthereumLinkToken) Fund(ethAmount *big.Float) error

Fund the LINK Token contract with ETH to distribute the token

func (*EthereumLinkToken) Name 

func (l *EthereumLinkToken) Name(ctxt context.Context) (string, error)

Name returns the name of the link token

func (*EthereumLinkToken) Transfer 

func (l *EthereumLinkToken) Transfer(to string, amount *big.Int) error

func (*EthereumLinkToken) TransferAndCall 

func (l *EthereumLinkToken) TransferAndCall(to string, amount *big.Int, data []byte) error

type EthereumMockETHLINKFeed 

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

EthereumMockETHLINKFeed represents mocked ETH/LINK feed contract

func (*EthereumMockETHLINKFeed) Address 

func (v *EthereumMockETHLINKFeed) Address() string

type EthereumMockGASFeed 

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

EthereumMockGASFeed represents mocked Gas feed contract

func (*EthereumMockGASFeed) Address 

func (v *EthereumMockGASFeed) Address() string

type EthereumOCRv2 added in v0.0.30 

type EthereumOCRv2 struct{}

func (*EthereumOCRv2) Address added in v0.0.30 

func (e *EthereumOCRv2) Address() string

func (*EthereumOCRv2) AuthorityAddr added in v0.0.30 

func (e *EthereumOCRv2) AuthorityAddr(s string) (string, error)

func (*EthereumOCRv2) DumpState added in v0.0.33 

func (e *EthereumOCRv2) DumpState() error

func (*EthereumOCRv2) GetContractData added in v0.0.30 

func (e *EthereumOCRv2) GetContractData(ctx context.Context) (*OffchainAggregatorData, error)

func (*EthereumOCRv2) GetLatestConfigDetails added in v0.0.30 

func (e *EthereumOCRv2) GetLatestConfigDetails() (map[string]interface{}, error)

func (*EthereumOCRv2) GetOwedPayment added in v0.0.30 

func (e *EthereumOCRv2) GetOwedPayment(transmitterAddr string) (map[string]interface{}, error)

func (*EthereumOCRv2) ProgramAddress added in v0.10.13 

func (e *EthereumOCRv2) ProgramAddress() string

func (*EthereumOCRv2) RequestNewRound added in v0.0.30 

func (e *EthereumOCRv2) RequestNewRound() error

func (*EthereumOCRv2) SetBilling added in v0.0.30 

func (e *EthereumOCRv2) SetBilling(op uint32, tp uint32, controllerAddr string) error

func (*EthereumOCRv2) SetOffChainConfig added in v0.0.35 

func (e *EthereumOCRv2) SetOffChainConfig(_ OffChainAggregatorV2Config) error

func (*EthereumOCRv2) SetOracles added in v0.0.34 

func (e *EthereumOCRv2) SetOracles(cocParams OffChainAggregatorV2Config) error

func (*EthereumOCRv2) TransferOwnership added in v0.0.30 

func (e *EthereumOCRv2) TransferOwnership(to string) error

type EthereumOCRv2Store added in v1.0.21 

type EthereumOCRv2Store struct{}

func (*EthereumOCRv2Store) Address added in v1.0.21 

func (e *EthereumOCRv2Store) Address() string

func (*EthereumOCRv2Store) CreateFeed added in v1.0.21 

func (e *EthereumOCRv2Store) CreateFeed(granylarity int, liveLength int) error

func (*EthereumOCRv2Store) GetLatestRoundData added in v1.0.21 

func (e *EthereumOCRv2Store) GetLatestRoundData() (uint64, error)

func (*EthereumOCRv2Store) ProgramAddress added in v1.0.21 

func (e *EthereumOCRv2Store) ProgramAddress() string

func (*EthereumOCRv2Store) SetValidatorConfig added in v1.0.21 

func (e *EthereumOCRv2Store) SetValidatorConfig(flaggingThreshold uint32) error

func (*EthereumOCRv2Store) SetWriter added in v1.0.21 

func (e *EthereumOCRv2Store) SetWriter(writerAuthority string) error

func (*EthereumOCRv2Store) TransmissionsAddress added in v1.0.21 

func (e *EthereumOCRv2Store) TransmissionsAddress() string

type EthereumOffchainAggregator 

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

EthereumOffchainAggregator represents the offchain aggregation contract

func (*EthereumOffchainAggregator) Address 

func (o *EthereumOffchainAggregator) Address() string

func (*EthereumOffchainAggregator) Fund 

func (o *EthereumOffchainAggregator) Fund(ethAmount *big.Float) error

Fund sends specified currencies to the contract

func (*EthereumOffchainAggregator) GetContractData 

func (o *EthereumOffchainAggregator) GetContractData(ctxt context.Context) (*OffchainAggregatorData, error)

GetContractData retrieves basic data for the offchain aggregator contract

func (*EthereumOffchainAggregator) GetLatestAnswer 

func (o *EthereumOffchainAggregator) GetLatestAnswer(ctxt context.Context) (*big.Int, error)

GetLatestAnswer returns the latest answer from the OCR contract

func (*EthereumOffchainAggregator) GetLatestRound 

func (o *EthereumOffchainAggregator) GetLatestRound(ctxt context.Context) (*RoundData, error)

GetLatestRound returns data from the latest round

func (*EthereumOffchainAggregator) RequestNewRound 

func (o *EthereumOffchainAggregator) RequestNewRound() error

RequestNewRound requests the OCR contract to create a new round

func (*EthereumOffchainAggregator) SetConfig 

func (o *EthereumOffchainAggregator) SetConfig(
	chainlinkNodes []client.Chainlink,
	ocrConfig OffChainAggregatorConfig,
) error

SetConfig sets offchain reporting protocol configuration including participating oracles

func (*EthereumOffchainAggregator) SetPayees 

func (o *EthereumOffchainAggregator) SetPayees(
	transmitters, payees []string,
) error

SetPayees sets wallets for the contract to pay out to?

type EthereumOracle 

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

EthereumOracle oracle for "directrequest" job tests

func (*EthereumOracle) Address 

func (e *EthereumOracle) Address() string

func (*EthereumOracle) Fund 

func (e *EthereumOracle) Fund(ethAmount *big.Float) error

func (*EthereumOracle) SetFulfillmentPermission 

func (e *EthereumOracle) SetFulfillmentPermission(address string, allowed bool) error

SetFulfillmentPermission sets fulfillment permission for particular address

type EthereumReadAccessController 

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

EthereumReadAccessController represents read access controller contract

func (*EthereumReadAccessController) AddAccess 

func (e *EthereumReadAccessController) AddAccess(addr string) error

AddAccess grants access to particular address to raise a flag

func (*EthereumReadAccessController) Address 

func (e *EthereumReadAccessController) Address() string

func (*EthereumReadAccessController) DisableAccessCheck 

func (e *EthereumReadAccessController) DisableAccessCheck() error

DisableAccessCheck disables all access checks

type EthereumStorage 

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

EthereumStorage acts as a conduit for the ethereum version of the storage contract

func (*EthereumStorage) Get 

func (e *EthereumStorage) Get(ctxt context.Context) (*big.Int, error)

Get retrieves a set value from the storage contract

func (*EthereumStorage) Set 

func (e *EthereumStorage) Set(value *big.Int) error

Set sets a value in the storage contract

type EthereumUpkeepRegistrationRequests 

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

EthereumUpkeepRegistrationRequests keeper contract to register upkeeps

func (*EthereumUpkeepRegistrationRequests) Address 

func (v *EthereumUpkeepRegistrationRequests) Address() string

func (*EthereumUpkeepRegistrationRequests) EncodeRegisterRequest 

func (v *EthereumUpkeepRegistrationRequests) EncodeRegisterRequest(
	name string,
	email []byte,
	upkeepAddr string,
	gasLimit uint32,
	adminAddr string,
	checkData []byte,
	amount *big.Int,
	source uint8,
) ([]byte, error)

EncodeRegisterRequest encodes register request to call it through link token TransferAndCall

func (*EthereumUpkeepRegistrationRequests) Fund 

func (v *EthereumUpkeepRegistrationRequests) Fund(ethAmount *big.Float) error

func (*EthereumUpkeepRegistrationRequests) SetRegistrarConfig 

func (v *EthereumUpkeepRegistrationRequests) SetRegistrarConfig(
	autoRegister bool,
	windowSizeBlocks uint32,
	allowedPerWindow uint16,
	registryAddr string,
	minLinkJuels *big.Int,
) error

SetRegistrarConfig sets registrar config, allowing auto register or pending requests for manual registration

type EthereumVRF 

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

EthereumVRF represents a VRF contract

func (*EthereumVRF) Fund 

func (v *EthereumVRF) Fund(ethAmount *big.Float) error

Fund sends specified currencies to the contract

func (*EthereumVRF) ProofLength 

func (v *EthereumVRF) ProofLength(ctxt context.Context) (*big.Int, error)

ProofLength returns the PROOFLENGTH call from the VRF contract

type EthereumVRFConsumer 

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

EthereumVRFConsumer represents VRF consumer contract

func (*EthereumVRFConsumer) Address 

func (v *EthereumVRFConsumer) Address() string

func (*EthereumVRFConsumer) CurrentRoundID added in v0.0.5 

func (v *EthereumVRFConsumer) CurrentRoundID(ctx context.Context) (*big.Int, error)

CurrentRoundID helper roundID counter in consumer to check when all randomness requests are finished

func (*EthereumVRFConsumer) Fund 

func (v *EthereumVRFConsumer) Fund(ethAmount *big.Float) error

func (*EthereumVRFConsumer) RandomnessOutput 

func (v *EthereumVRFConsumer) RandomnessOutput(ctx context.Context) (*big.Int, error)

func (*EthereumVRFConsumer) RequestRandomness 

func (v *EthereumVRFConsumer) RequestRandomness(hash [32]byte, fee *big.Int) error

func (*EthereumVRFConsumer) WatchPerfEvents added in v0.0.7 

func (v *EthereumVRFConsumer) WatchPerfEvents(ctx context.Context, eventChan chan<- *PerfEvent) error

type EthereumVRFCoordinator 

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

EthereumVRFCoordinator represents VRF coordinator contract

func (*EthereumVRFCoordinator) Address 

func (v *EthereumVRFCoordinator) Address() string

func (*EthereumVRFCoordinator) HashOfKey 

func (v *EthereumVRFCoordinator) HashOfKey(ctx context.Context, pubKey [2]*big.Int) ([32]byte, error)

func (*EthereumVRFCoordinator) RegisterProvingKey 

func (v *EthereumVRFCoordinator) RegisterProvingKey(
	fee *big.Int,
	oracleAddr string,
	publicProvingKey [2]*big.Int,
	jobID [32]byte,
) error

type Flags 

type Flags interface {
	Address() string
	GetFlag(ctx context.Context, addr string) (bool, error)
}

Flags flags contract interface

type FluxAggregator 

type FluxAggregator interface {
	Address() string
	Fund(ethAmount *big.Float) error
	LatestRoundID(ctx context.Context) (*big.Int, error)
	LatestRoundData(ctx context.Context) (RoundData, error)
	GetContractData(ctxt context.Context) (*FluxAggregatorData, error)
	UpdateAvailableFunds() error
	PaymentAmount(ctx context.Context) (*big.Int, error)
	RequestNewRound(ctx context.Context) error
	WithdrawPayment(ctx context.Context, from common.Address, to common.Address, amount *big.Int) error
	WithdrawablePayment(ctx context.Context, addr common.Address) (*big.Int, error)
	GetOracles(ctx context.Context) ([]string, error)
	SetOracles(opts FluxAggregatorSetOraclesOptions) error
	Description(ctxt context.Context) (string, error)
	SetRequesterPermissions(ctx context.Context, addr common.Address, authorized bool, roundsDelay uint32) error
	WatchSubmissionReceived(ctx context.Context, eventChan chan<- *SubmissionEvent) error
}

type FluxAggregatorData 

type FluxAggregatorData struct {
	AllocatedFunds  *big.Int         // The amount of payment yet to be withdrawn by oracles
	AvailableFunds  *big.Int         // The amount of future funding available to oracles
	LatestRoundData RoundData        // Data about the latest round
	Oracles         []common.Address // Addresses of oracles on the contract
}

type FluxAggregatorOptions 

type FluxAggregatorOptions struct {
	PaymentAmount *big.Int       // The amount of LINK paid to each oracle per submission, in wei (units of 10⁻¹⁸ LINK)
	Timeout       uint32         // The number of seconds after the previous round that are allowed to lapse before allowing an oracle to skip an unfinished round
	Validator     common.Address // An optional contract address for validating external validation of answers
	MinSubValue   *big.Int       // An immutable check for a lower bound of what submission values are accepted from an oracle
	MaxSubValue   *big.Int       // An immutable check for an upper bound of what submission values are accepted from an oracle
	Decimals      uint8          // The number of decimals to offset the answer by
	Description   string         // A short description of what is being reported
}

func DefaultFluxAggregatorOptions 

func DefaultFluxAggregatorOptions() FluxAggregatorOptions

DefaultFluxAggregatorOptions produces some basic defaults for a flux aggregator contract

type FluxAggregatorRoundConfirmer 

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

FluxAggregatorRoundConfirmer is a header subscription that awaits for a certain flux round to be completed

func NewFluxAggregatorRoundConfirmer 

func NewFluxAggregatorRoundConfirmer(
	contract FluxAggregator,
	roundID *big.Int,
	timeout time.Duration,
) *FluxAggregatorRoundConfirmer

NewFluxAggregatorRoundConfirmer provides a new instance of a FluxAggregatorRoundConfirmer

func (*FluxAggregatorRoundConfirmer) ReceiveBlock 

func (f *FluxAggregatorRoundConfirmer) ReceiveBlock(block client.NodeBlock) error

ReceiveBlock will query the latest FluxAggregator round and check to see whether the round has confirmed

func (*FluxAggregatorRoundConfirmer) Wait 

func (f *FluxAggregatorRoundConfirmer) Wait() error

Wait is a blocking function that will wait until the round has confirmed, and timeout if the deadline has passed

type FluxAggregatorSetOraclesOptions 

type FluxAggregatorSetOraclesOptions struct {
	AddList            []common.Address // oracle addresses to add
	RemoveList         []common.Address // oracle addresses to remove
	AdminList          []common.Address // oracle addresses to become admin
	MinSubmissions     uint32           // min amount of submissions in round
	MaxSubmissions     uint32           // max amount of submissions in round
	RestartDelayRounds uint32           // rounds to wait after oracles has changed
}

type JobByInstance 

type JobByInstance struct {
	ID       string
	Instance string
}

JobByInstance helper struct to match job + instance ID

type KeeperConsumer 

type KeeperConsumer interface {
	Address() string
	Fund(ethAmount *big.Float) error
	Counter(ctx context.Context) (*big.Int, error)
}

type KeeperConsumerRoundConfirmer added in v0.0.5 

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

KeeperConsumerRoundConfirmer is a header subscription that awaits for a round of upkeeps

func NewKeeperConsumerRoundConfirmer added in v0.0.5 

func NewKeeperConsumerRoundConfirmer(
	contract KeeperConsumer,
	counterValue int,
	timeout time.Duration,
) *KeeperConsumerRoundConfirmer

NewKeeperConsumerRoundConfirmer provides a new instance of a KeeperConsumerRoundConfirmer

func (*KeeperConsumerRoundConfirmer) ReceiveBlock added in v0.0.5 

func (o *KeeperConsumerRoundConfirmer) ReceiveBlock(_ client.NodeBlock) error

ReceiveBlock will query the latest Keeper round and check to see whether the round has confirmed

func (*KeeperConsumerRoundConfirmer) Wait added in v0.0.5 

func (o *KeeperConsumerRoundConfirmer) Wait() error

Wait is a blocking function that will wait until the round has confirmed, and timeout if the deadline has passed

type KeeperInfo 

type KeeperInfo struct {
	Payee   string
	Active  bool
	Balance *big.Int
}

KeeperInfo keeper status and balance info

type KeeperRegistry 

type KeeperRegistry interface {
	Address() string
	Fund(ethAmount *big.Float) error
	SetRegistrar(registrarAddr string) error
	AddUpkeepFunds(id *big.Int, amount *big.Int) error
	GetUpkeepInfo(ctx context.Context, id *big.Int) (*UpkeepInfo, error)
	GetKeeperInfo(ctx context.Context, keeperAddr string) (*KeeperInfo, error)
	SetKeepers(keepers []string, payees []string) error
	GetKeeperList(ctx context.Context) ([]string, error)
	RegisterUpkeep(target string, gasLimit uint32, admin string, checkData []byte) error
}

type KeeperRegistryOpts 

type KeeperRegistryOpts struct {
	LinkAddr             string
	ETHFeedAddr          string
	GasFeedAddr          string
	PaymentPremiumPPB    uint32
	BlockCountPerTurn    *big.Int
	CheckGasLimit        uint32
	StalenessSeconds     *big.Int
	GasCeilingMultiplier uint16
	FallbackGasPrice     *big.Int
	FallbackLinkPrice    *big.Int
}

KeeperRegistryOpts opts to deploy keeper registry

type LinkToken 

type LinkToken interface {
	Address() string
	Approve(to string, amount *big.Int) error
	Transfer(to string, amount *big.Int) error
	BalanceOf(ctx context.Context, addr string) (*big.Int, error)
	TransferAndCall(to string, amount *big.Int, data []byte) error
	Name(context.Context) (string, error)
}

type MockETHLINKFeed 

type MockETHLINKFeed interface {
	Address() string
}

type MockGasFeed 

type MockGasFeed interface {
	Address() string
}

type OCRv2 added in v0.0.11 

type OCRv2 interface {
	ProgramAddress() string
	Address() string
	DumpState() error
	GetContractData(ctx context.Context) (*OffchainAggregatorData, error)
	AuthorityAddr(string) (string, error)
	TransferOwnership(to string) error

	SetBilling(op uint32, tp uint32, controllerAddr string) error
	SetOracles(ocParams OffChainAggregatorV2Config) error
	SetOffChainConfig(ocParams OffChainAggregatorV2Config) error

	RequestNewRound() error
	GetLatestConfigDetails() (map[string]interface{}, error)
	GetOwedPayment(transmitterAddr string) (map[string]interface{}, error)
}

OCRv2 main offchain reporting v2 instance

type OCRv2AccessController added in v0.0.11 

type OCRv2AccessController interface {
	Address() string
	AddAccess(addr string) error
	RemoveAccess(addr string) error
	HasAccess(to string) (bool, error)
}

OCRv2AccessController access controller

type OCRv2Store added in v1.0.21 

type OCRv2Store interface {
	Address() string
	TransmissionsAddress() string
	ProgramAddress() string
	SetValidatorConfig(flaggingThreshold uint32) error
	SetWriter(writerAuthority string) error
	CreateFeed(granylarity int, liveLength int) error
	GetLatestRoundData() (uint64, error)
}

OCRv2Store OCR feed store

type OffChainAggregatorConfig 

type OffChainAggregatorConfig struct {
	DeltaProgress    time.Duration // The duration in which a leader must achieve progress or be replaced
	DeltaResend      time.Duration // The interval at which nodes resend NEWEPOCH messages
	DeltaRound       time.Duration // The duration after which a new round is started
	DeltaGrace       time.Duration // The duration of the grace period during which delayed oracles can still submit observations
	DeltaC           time.Duration // Limits how often updates are transmitted to the contract as long as the median isn’t changing by more then AlphaPPB
	AlphaPPB         uint64        // Allows larger changes of the median to be reported immediately, bypassing DeltaC
	DeltaStage       time.Duration // Used to stagger stages of the transmission protocol. Multiple Ethereum blocks must be mineable in this period
	RMax             uint8         // The maximum number of rounds in an epoch
	S                []int         // Transmission Schedule
	F                int           // The allowed number of "bad" oracles
	N                int           // The number of oracles
	OracleIdentities []ocrConfigHelper.OracleIdentityExtra
}

https://uploads-ssl.webflow.com/5f6b7190899f41fb70882d08/603651a1101106649eef6a53_chainlink-ocr-protocol-paper-02-24-20.pdf

func DefaultOffChainAggregatorConfig 

func DefaultOffChainAggregatorConfig(numberNodes int) OffChainAggregatorConfig

DefaultOffChainAggregatorConfig returns some base defaults for configuring an OCR contract

type OffChainAggregatorV2Config added in v0.0.36 

type OffChainAggregatorV2Config struct {
	DeltaProgress                           time.Duration
	DeltaResend                             time.Duration
	DeltaRound                              time.Duration
	DeltaGrace                              time.Duration
	DeltaStage                              time.Duration
	RMax                                    uint8
	S                                       []int
	Oracles                                 []ocrConfigHelper2.OracleIdentityExtra
	ReportingPluginConfig                   []byte
	MaxDurationQuery                        time.Duration
	MaxDurationObservation                  time.Duration
	MaxDurationReport                       time.Duration
	MaxDurationShouldAcceptFinalizedReport  time.Duration
	MaxDurationShouldTransmitAcceptedReport time.Duration
	F                                       int
	OnchainConfig                           []byte
}

type OffchainAggregator 

type OffchainAggregator interface {
	Address() string
	Fund(nativeAmount *big.Float) error
	GetContractData(ctxt context.Context) (*OffchainAggregatorData, error)
	SetConfig(chainlinkNodes []client.Chainlink, ocrConfig OffChainAggregatorConfig) error
	SetPayees([]string, []string) error
	RequestNewRound() error
	GetLatestAnswer(ctxt context.Context) (*big.Int, error)
	GetLatestRound(ctxt context.Context) (*RoundData, error)
}

type OffchainAggregatorData 

type OffchainAggregatorData struct {
	LatestRoundData RoundData // Data about the latest round
}

type OffchainAggregatorRoundConfirmer 

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

OffchainAggregatorRoundConfirmer is a header subscription that awaits for a certain OCR round to be completed

func NewOffchainAggregatorRoundConfirmer 

func NewOffchainAggregatorRoundConfirmer(
	contract OffchainAggregator,
	roundID *big.Int,
	timeout time.Duration,
) *OffchainAggregatorRoundConfirmer

NewOffchainAggregatorRoundConfirmer provides a new instance of a OffchainAggregatorRoundConfirmer

func (*OffchainAggregatorRoundConfirmer) ReceiveBlock 

func (o *OffchainAggregatorRoundConfirmer) ReceiveBlock(_ client.NodeBlock) error

ReceiveBlock will query the latest OffchainAggregator round and check to see whether the round has confirmed

func (*OffchainAggregatorRoundConfirmer) Wait 

func (o *OffchainAggregatorRoundConfirmer) Wait() error

Wait is a blocking function that will wait until the round has confirmed, and timeout if the deadline has passed

type OffchainOptions 

type OffchainOptions struct {
	MaximumGasPrice           uint32         // The highest gas price for which transmitter will be compensated
	ReasonableGasPrice        uint32         // The transmitter will receive reward for gas prices under this value
	MicroLinkPerEth           uint32         // The reimbursement per ETH of gas cost, in 1e-6LINK units
	LinkGweiPerObservation    uint32         // The reward to the oracle for contributing an observation to a successfully transmitted report, in 1e-9LINK units
	LinkGweiPerTransmission   uint32         // The reward to the transmitter of a successful report, in 1e-9LINK units
	MinimumAnswer             *big.Int       // The lowest answer the median of a report is allowed to be
	MaximumAnswer             *big.Int       // The highest answer the median of a report is allowed to be
	BillingAccessController   common.Address // The access controller for billing admin functions
	RequesterAccessController common.Address // The access controller for requesting new rounds
	Decimals                  uint8          // Answers are stored in fixed-point format, with this many digits of precision
	Description               string         // A short description of what is being reported
}

func DefaultOffChainAggregatorOptions 

func DefaultOffChainAggregatorOptions() OffchainOptions

DefaultOffChainAggregatorOptions returns some base defaults for deploying an OCR contract

type Oracle 

type Oracle interface {
	Address() string
	Fund(ethAmount *big.Float) error
	SetFulfillmentPermission(address string, allowed bool) error
}

type PerfEvent added in v0.0.7 

type PerfEvent struct {
	Contract       DeviationFlaggingValidator
	Round          *big.Int
	RequestID      [32]byte
	BlockTimestamp *big.Int
}

PerfEvent is used to get some metrics for contracts, it contrains roundID for Keeper/OCR/Flux tests and request id for VRF/Runlog

type ReadAccessController 

type ReadAccessController interface {
	Address() string
	AddAccess(addr string) error
	DisableAccessCheck() error
}

ReadAccessController is read/write access controller, just named by interface

type RoundData 

type RoundData struct {
	RoundId         *big.Int
	Answer          *big.Int
	StartedAt       *big.Int
	UpdatedAt       *big.Int
	AnsweredInRound *big.Int
}

type RunlogRoundConfirmer added in v0.0.7 

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

RunlogRoundConfirmer is a header subscription that awaits for a certain Runlog round to be completed

func NewRunlogRoundConfirmer added in v0.0.7 

func NewRunlogRoundConfirmer(
	contract APIConsumer,
	roundID *big.Int,
	timeout time.Duration,
) *RunlogRoundConfirmer

NewRunlogRoundConfirmer provides a new instance of a RunlogRoundConfirmer

func (*RunlogRoundConfirmer) ReceiveBlock added in v0.0.7 

func (o *RunlogRoundConfirmer) ReceiveBlock(_ client.NodeBlock) error

ReceiveBlock will query the latest Runlog round and check to see whether the round has confirmed

func (*RunlogRoundConfirmer) Wait added in v0.0.7 

func (o *RunlogRoundConfirmer) Wait() error

Wait is a blocking function that will wait until the round has confirmed, and timeout if the deadline has passed

type Storage 

type Storage interface {
	Get(ctxt context.Context) (*big.Int, error)
	Set(*big.Int) error
}

type SubmissionEvent 

type SubmissionEvent struct {
	Contract    common.Address
	Submission  *big.Int
	Round       uint32
	BlockNumber uint64
	Oracle      common.Address
}

type UpkeepInfo 

type UpkeepInfo struct {
	Target              string
	ExecuteGas          uint32
	CheckData           []byte
	Balance             *big.Int
	LastKeeper          string
	Admin               string
	MaxValidBlocknumber uint64
}

UpkeepInfo keeper target info

type UpkeepRegistrar 

type UpkeepRegistrar interface {
	Address() string
	SetRegistrarConfig(
		autoRegister bool,
		windowSizeBlocks uint32,
		allowedPerWindow uint16,
		registryAddr string,
		minLinkJuels *big.Int,
	) error
	EncodeRegisterRequest(
		name string,
		email []byte,
		upkeepAddr string,
		gasLimit uint32,
		adminAddr string,
		checkData []byte,
		amount *big.Int,
		source uint8,
	) ([]byte, error)
	Fund(ethAmount *big.Float) error
}

type VRF 

type VRF interface {
	Fund(ethAmount *big.Float) error
	ProofLength(context.Context) (*big.Int, error)
}

type VRFConsumer 

type VRFConsumer interface {
	Address() string
	RequestRandomness(hash [32]byte, fee *big.Int) error
	CurrentRoundID(ctx context.Context) (*big.Int, error)
	RandomnessOutput(ctx context.Context) (*big.Int, error)
	WatchPerfEvents(ctx context.Context, eventChan chan<- *PerfEvent) error
	Fund(ethAmount *big.Float) error
}

type VRFConsumerRoundConfirmer added in v0.0.5 

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

VRFConsumerRoundConfirmer is a header subscription that awaits for a certain VRF round to be completed

func NewVRFConsumerRoundConfirmer added in v0.0.5 

func NewVRFConsumerRoundConfirmer(
	contract VRFConsumer,
	roundID *big.Int,
	timeout time.Duration,
) *VRFConsumerRoundConfirmer

NewVRFConsumerRoundConfirmer provides a new instance of a NewVRFConsumerRoundConfirmer

func (*VRFConsumerRoundConfirmer) ReceiveBlock added in v0.0.5 

func (f *VRFConsumerRoundConfirmer) ReceiveBlock(block client.NodeBlock) error

ReceiveBlock will query the latest VRFConsumer round and check to see whether the round has confirmed

func (*VRFConsumerRoundConfirmer) Wait added in v0.0.5 

func (f *VRFConsumerRoundConfirmer) Wait() error

Wait is a blocking function that will wait until the round has confirmed, and timeout if the deadline has passed

type VRFCoordinator 

type VRFCoordinator interface {
	RegisterProvingKey(
		fee *big.Int,
		oracleAddr string,
		publicProvingKey [2]*big.Int,
		jobID [32]byte,
	) error
	HashOfKey(ctx context.Context, pubKey [2]*big.Int) ([32]byte, error)
	Address() string
}

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.