actions

Documentation

Overview

Package actions enables common chainlink interactions

Index

• Constants
• func BuildNodeContractPairID(node client.Chainlink, ocrInstance contracts.OffchainAggregator) string
• func ChainlinkNodeAddresses(nodes []client.Chainlink) ([]common.Address, error)
• func CreateOCRJobs(ocrInstances []contracts.OffchainAggregator, chainlinkNodes []client.Chainlink, ...) func()
• func DeployOCRContracts(numberOfContracts int, linkTokenContract contracts.LinkToken, ...) []contracts.OffchainAggregator
• func EncodeOnChainExternalJobID(jobID uuid.UUID) [32]byte
• func EncodeOnChainVRFProvingKey(vrfKey client.VRFKey) ([2]*big.Int, error)
• func ExtractRequestIDFromJobRun(jobDecodeData client.RunsResponseData) ([]byte, error)
• func FundAddresses(blockchain client.BlockchainClient, amount *big.Float, addresses ...string) error
• func FundChainlinkNodes(nodes []client.Chainlink, blockchain client.BlockchainClient, ...) error
• func GetMockserverInitializerDataForOTPE(OCRInstances []contracts.OffchainAggregator, chainlinkNodes []client.Chainlink) (interface{}, error)
• func SetAdapterResponse(response int, ocrInstance contracts.OffchainAggregator, ...) func()
• func SetAllAdapterResponsesToDifferentValues(responses []int, ocrInstances []contracts.OffchainAggregator, ...) func()
• func SetAllAdapterResponsesToTheSameValue(response int, ocrInstances []contracts.OffchainAggregator, ...) func()
• func SetChainlinkAPIPageSize(nodes []client.Chainlink, pageSize int)
• func StartNewRound(roundNr int64, ocrInstances []contracts.OffchainAggregator, ...) func()
• func TeardownSuite(env *environment.Environment, nets *client.Networks, logsFolderPath string, ...) error

Constants

const (
	// DefaultArtifactsDir default artifacts dir
	DefaultArtifactsDir string = "logs"
)

Functions

func BuildNodeContractPairID

func BuildNodeContractPairID(node client.Chainlink, ocrInstance contracts.OffchainAggregator) string

func ChainlinkNodeAddresses

func ChainlinkNodeAddresses(nodes []client.Chainlink) ([]common.Address, error)

ChainlinkNodeAddresses will return all the on-chain wallet addresses for a set of Chainlink nodes

func CreateOCRJobs

func CreateOCRJobs(
	ocrInstances []contracts.OffchainAggregator,
	chainlinkNodes []client.Chainlink,
	mockserver *client.MockserverClient,
) func()

CreateOCRJobs bootstraps the first node and to the other nodes sends ocr jobs that read from different adapters, to be used in combination with SetAdapterResponses

func DeployOCRContracts

func DeployOCRContracts(
	numberOfContracts int,
	linkTokenContract contracts.LinkToken,
	contractDeployer contracts.ContractDeployer,
	chainlinkNodes []client.Chainlink,
	networks *client.Networks,
) []contracts.OffchainAggregator

DeployOCRContracts deploys and funds a certain number of offchain aggregator contracts

func EncodeOnChainExternalJobID

func EncodeOnChainExternalJobID(jobID uuid.UUID) [32]byte

EncodeOnChainExternalJobID encodes external job uuid to on-chain representation

func EncodeOnChainVRFProvingKey

func EncodeOnChainVRFProvingKey(vrfKey client.VRFKey) ([2]*big.Int, error)

EncodeOnChainVRFProvingKey encodes uncompressed public VRF key to on-chain representation

func ExtractRequestIDFromJobRun

func ExtractRequestIDFromJobRun(jobDecodeData client.RunsResponseData) ([]byte, error)

ExtractRequestIDFromJobRun extracts RequestID from job runs response

func FundAddresses

func FundAddresses(blockchain client.BlockchainClient, amount *big.Float, addresses ...string) error

FundAddresses will fund a list of addresses with an amount of native currency

func FundChainlinkNodes

func FundChainlinkNodes(
	nodes []client.Chainlink,
	blockchain client.BlockchainClient,
	amount *big.Float,
) error

FundChainlinkNodes will fund all of the provided Chainlink nodes with a set amount of native currency

func GetMockserverInitializerDataForOTPE

func GetMockserverInitializerDataForOTPE(
	OCRInstances []contracts.OffchainAggregator,
	chainlinkNodes []client.Chainlink,
) (interface{}, error)

GetMockserverInitializerDataForOTPE creates mocked weiwatchers data needed for otpe

func SetAdapterResponse

func SetAdapterResponse(
	response int,
	ocrInstance contracts.OffchainAggregator,
	chainlinkNode client.Chainlink,
	mockserver *client.MockserverClient,
) func()

SetAdapterResponse sets a single adapter response that correlates with an ocr contract and a chainlink node

func SetAllAdapterResponsesToDifferentValues

func SetAllAdapterResponsesToDifferentValues(
	responses []int,
	ocrInstances []contracts.OffchainAggregator,
	chainlinkNodes []client.Chainlink,
	mockserver *client.MockserverClient,
) func()

SetAllAdapterResponsesToDifferentValues sets the mock responses in mockserver that are read by chainlink nodes to simulate different adapters. This sets all adapter responses for each node and contract to different responses

func SetAllAdapterResponsesToTheSameValue

func SetAllAdapterResponsesToTheSameValue(
	response int,
	ocrInstances []contracts.OffchainAggregator,
	chainlinkNodes []client.Chainlink,
	mockserver *client.MockserverClient,
) func()

SetAllAdapterResponsesToTheSameValue sets the mock responses in mockserver that are read by chainlink nodes to simulate different adapters. This sets all adapter responses for each node and contract to the same response

func SetChainlinkAPIPageSize

func SetChainlinkAPIPageSize(nodes []client.Chainlink, pageSize int)

SetChainlinkAPIPageSize specifies the page size from the Chainlink API, useful for high volume testing

func StartNewRound

func StartNewRound(
	roundNr int64,
	ocrInstances []contracts.OffchainAggregator,
	networks *client.Networks,
) func()

StartNewRound requests a new round from the ocr contract and waits for confirmation

func TeardownSuite

func TeardownSuite(
	env *environment.Environment,
	nets *client.Networks,
	logsFolderPath string,
	optionalTestReporter testreporters.TestReporter,
) error

TeardownSuite tears down networks/clients and environment and creates a logs folder for failed tests in the specified path. Can also accept a testsetup (if one was used) to log results