UpkeepController

A contract that manages upkeeps for the Chainlink automation system.

Solidity API

UpkeepController

This contract implements the UpkeepControllerInterface and provides functionality to register, cancel, pause, and unpause upkeeps, as well as update their check data, gas limits, and off-chain configurations.

contract LinkTokenInterface i_link

i_registrar

contract KeeperRegistrarInterface i_registrar

i_registry

contract AutomationRegistryWithMinANeededAmountInterface i_registry

constructor

constructor(contract LinkTokenInterface link, contract KeeperRegistrarInterface registrar, contract AutomationRegistryWithMinANeededAmountInterface registry) public

Constructs the UpkeepController contract.

Parameters

NameTypeDescription

link

contract LinkTokenInterface

The address of the LinkToken contract.

registrar

contract KeeperRegistrarInterface

The address of the KeeperRegistrar contract.

registry

contract AutomationRegistryWithMinANeededAmountInterface

The address of the AutomationRegistry contract.

registerAndPredictID

function registerAndPredictID(struct KeeperRegistrarInterface.RegistrationParams params) public

See {UpkeepControllerInterface}

cancelUpkeep

function cancelUpkeep(uint256 upkeepId) external

See {UpkeepControllerInterface}

pauseUpkeep

function pauseUpkeep(uint256 upkeepId) external

See {UpkeepControllerInterface}

unpauseUpkeep

function unpauseUpkeep(uint256 upkeepId) external

See {UpkeepControllerInterface}

updateCheckData

function updateCheckData(uint256 upkeepId, bytes newCheckData) external

See {UpkeepControllerInterface}

setUpkeepGasLimit

function setUpkeepGasLimit(uint256 upkeepId, uint32 gasLimit) external

See {UpkeepControllerInterface}

setUpkeepOffchainConfig

function setUpkeepOffchainConfig(uint256 upkeepId, bytes config) external

See {UpkeepControllerInterface}

addFunds

function addFunds(uint256 upkeepId, uint96 amount) external

See {UpkeepControllerInterface}

getUpkeep

function getUpkeep(uint256 upkeepId) external view returns (struct UpkeepInfo upkeepInfo)

See {UpkeepControllerInterface}

getActiveUpkeepIDs

function getActiveUpkeepIDs(uint256 offset, uint256 limit) public view returns (uint256[] upkeeps)

See {UpkeepControllerInterface}

getUpkeeps

function getUpkeeps(uint256 offset, uint256 limit) public view returns (struct UpkeepInfo[])

See {UpkeepControllerInterface}

getMinBalanceForUpkeep

function getMinBalanceForUpkeep(uint256 upkeepId) external view returns (uint96)

See {UpkeepControllerInterface}

getMinBalancesForUpkeeps

function getMinBalancesForUpkeeps(uint256 offset, uint256 limit) public view returns (uint96[])

See {UpkeepControllerInterface}

getDetailedUpkeeps

function getDetailedUpkeeps(uint256 offset, uint256 limit) external view returns (struct UpkeepControllerInterface.DetailedUpkeep[])

See {UpkeepControllerInterface}

getUpkeepsCount

function getUpkeepsCount() external view returns (uint256)

See {UpkeepControllerInterface}

getState

function getState() external view returns (struct State state, struct OnchainConfig config, address[] signers, address[] transmitters, uint8 f)

See {UpkeepControllerInterface}

isNewUpkeepNeeded

function isNewUpkeepNeeded() external view returns (bool isNeeded, uint256 newOffset, uint256 newLimit)

See {UpkeepControllerInterface}

checkUpkeep

function checkUpkeep(uint256 upkeepId) public returns (bool upkeepNeeded, bytes performData, enum UpkeepFailureReason upkeepFailureReason, uint256 gasUsed, uint256 fastGasWei, uint256 linkNative)

See {UpkeepControllerInterface}

Last updated