IKeep3rSponsor

Git Source

Inherits: IOwnable

Functions

KEEP3R_V2

Returns the keep3rV2 contract

function KEEP3R_V2() external view returns (IKeep3rV2 _keep3rV2);

Returns

NameTypeDescription
_keep3rV2IKeep3rV2The address of the keep3rV2 contract

KEEP3R_HELPER

Returns the keep3r helper contract

function KEEP3R_HELPER() external view returns (IKeep3rHelper _keep3rHelper);

Returns

NameTypeDescription
_keep3rHelperIKeep3rHelperThe address of the keep3r helper contract

BASE

Returns the base

function BASE() external view returns (uint32 _base);

Returns

NameTypeDescription
_baseuint32The base

bonus

Returns the bonus

The bonus is in base 10_000

function bonus() external view returns (uint256 _bonus);

Returns

NameTypeDescription
_bonusuint256The bonus

openRelay

Returns the open relay

function openRelay() external view returns (IOpenRelay _openRelay);

Returns

NameTypeDescription
_openRelayIOpenRelayThe address of the open relay

feeRecipient

Returns the fee recipient address

function feeRecipient() external view returns (address _feeRecipient);

Returns

NameTypeDescription
_feeRecipientaddressThe address of the fee recipient

getSponsoredJobs

Returns the list of the sponsored jobs

function getSponsoredJobs() external returns (address[] memory _sponsoredJobsList);

Returns

NameTypeDescription
_sponsoredJobsListaddress[]The list of the sponsored jobs

setFeeRecipient

Sets the fee recipient who will receive the payment of the open relay

function setFeeRecipient(address _feeRecipient) external;

Parameters

NameTypeDescription
_feeRecipientaddressThe address of the fee recipient

setOpenRelay

Sets the open relay

function setOpenRelay(IOpenRelay _openRelay) external;

Parameters

NameTypeDescription
_openRelayIOpenRelayThe address of the open relay

setBonus

Sets the bonus

function setBonus(uint256 _bonus) external;

Parameters

NameTypeDescription
_bonusuint256The bonus

addSponsoredJobs

Adds a job to the sponsored list

function addSponsoredJobs(address[] calldata _jobs) external;

Parameters

NameTypeDescription
_jobsaddress[]List of jobs to add

deleteSponsoredJobs

Removes a job from the sponsored list

function deleteSponsoredJobs(address[] calldata _jobs) external;

Parameters

NameTypeDescription
_jobsaddress[]List of jobs to remove

exec

Execute an open relay which will execute the jobs and will manage the payment to the fee data receivers

function exec(IAutomationVault _automationVault, IAutomationVault.ExecData[] calldata _execData) external;

Parameters

NameTypeDescription
_automationVaultIAutomationVaultThe automation vault that will be executed
_execDataIAutomationVault.ExecData[]The array of exec data

Events

JobExecuted

Emitted when a job is executed

event JobExecuted(address _job);

Parameters

NameTypeDescription
_jobaddressThe address of the job

FeeRecipientSetted

Emitted when the fee recipient is setted

event FeeRecipientSetted(address indexed _feeRecipient);

Parameters

NameTypeDescription
_feeRecipientaddressThe address of the new fee recipient

OpenRelaySetted

Emitted when the open relay is setted

event OpenRelaySetted(IOpenRelay indexed _openRelay);

Parameters

NameTypeDescription
_openRelayIOpenRelayThe address of the new open relay

BonusSetted

Emitted when the bonus is setted

event BonusSetted(uint256 indexed _bonus);

Parameters

NameTypeDescription
_bonusuint256The sponsored bonus

ApproveSponsoredJob

Emitted when a sponsored job is approved

event ApproveSponsoredJob(address indexed _job);

Parameters

NameTypeDescription
_jobaddressThe address of the sponsored job

DeleteSponsoredJob

Emitted when a sponsored job is deleted

event DeleteSponsoredJob(address indexed _job);

Parameters

NameTypeDescription
_jobaddressjob The address of the sponsored job

Errors

Keep3rSponsor_JobNotSponsored

Thrown when the job executed is not in the list of sponsored jobs

error Keep3rSponsor_JobNotSponsored();

Keep3rSponsor_NotKeeper

Thrown when the caller is not a keeper

error Keep3rSponsor_NotKeeper();

Keep3rSponsor_NoJobs

Thrown when the exec data is empty

error Keep3rSponsor_NoJobs();

Keep3rSponsor_LowBonus

Thrown when the bonus is lower than the base

error Keep3rSponsor_LowBonus();