IKeep3rBondedRelay

Git Source

Inherits: IKeep3rRelay

Functions

automationVaultRequirements

Get the automation vault bonded requirements

function automationVaultRequirements(IAutomationVault _automationVault)
  external
  view
  returns (address _bond, uint256 _minBond, uint256 _earned, uint256 _age);

Parameters

NameTypeDescription
_automationVaultIAutomationVaultThe automation vault

Returns

NameTypeDescription
_bondaddressThe bond token being evaluated
_minBonduint256The minimum amount of bonded tokens
_earneduint256The minimum funds earned in the keepers lifetime
_ageuint256The minimum keeper age required

setAutomationVaultRequirements

Set the automation vault requirements when bonded job is required

Only the owner of the automation vault can set the requirements

function setAutomationVaultRequirements(
  IAutomationVault _automationVault,
  IKeep3rBondedRelay.Requirements memory _requirements
) external;

Parameters

NameTypeDescription
_automationVaultIAutomationVaultThe automation vault that will be executed
_requirementsIKeep3rBondedRelay.RequirementsThe requirements needed when bonded job is required

Events

AutomationVaultRequirementsSetted

Emitted when the automation vault requirements are setted

event AutomationVaultRequirementsSetted(
  address indexed _automationVault, address _bond, uint256 _minBond, uint256 _earned, uint256 _age
);

Parameters

NameTypeDescription
_automationVaultaddressThe address of the automation vault
_bondaddressThe bond token being evaluated
_minBonduint256The minimum amount of bonded tokens
_earneduint256The minimum funds earned in the keepers lifetime
_ageuint256The minimum keeper age required

Errors

Keep3rBondedRelay_NotVaultOwner

Thrown when the caller is not the automation vault owner

error Keep3rBondedRelay_NotVaultOwner();

Keep3rBondedRelay_NotAutomationVaultRequirement

Thrown when the automation vault requirements are not setted

error Keep3rBondedRelay_NotAutomationVaultRequirement();

Keep3rBondedRelay_NotBondedKeeper

Thrown when the keeper doesn't meet the requirements set by the automation vault

error Keep3rBondedRelay_NotBondedKeeper();

Structs

Requirements

The requirements needed when bonded job is required

struct Requirements {
  address bond;
  uint256 minBond;
  uint256 earned;
  uint256 age;
}

Properties

NameTypeDescription
bondaddressThe bond token being evaluated
minBonduint256The minimum amount of bonded tokens
earneduint256The minimum funds earned in the keepers lifetime
ageuint256The minimum keeper age required