IFeeCollectorJob

Git Source

Inherits: IKeep3rJob

Functions

collectMultiplier

Returns the collect multiplier

function collectMultiplier() external view returns (uint256 _collectMultiplier);

Returns

NameTypeDescription
_collectMultiplieruint256The collect multiplier

POOL_MANAGER_FACTORY

Returns the pool manager factory

function POOL_MANAGER_FACTORY() external view returns (IPoolManagerFactory _poolManagerFactory);

Returns

NameTypeDescription
_poolManagerFactoryIPoolManagerFactoryThe pool manager factory

work

Collects the fees from the given positions and rewards the keeper

Will revert if the job is paused or if the keeper is not valid

function work(IPoolManager _poolManager, IStrategy.Position[] calldata _positions) external;

Parameters

NameTypeDescription
_poolManagerIPoolManagerThe pool manager
_positionsPosition.IStrategy[]The list of positions to collect the fees from

work

Collects the fees from the full range and rewards the keeper

Will revert if the job is paused or if the keeper is not valid

function work(IPoolManager _poolManager) external;

Parameters

NameTypeDescription
_poolManagerIPoolManagerThe pool manager

setCollectMultiplier

Sets the collect multiplier

Only governance can change it

function setCollectMultiplier(uint256 _collectMultiplier) external;

Parameters

NameTypeDescription
_collectMultiplieruint256The collect multiplier

Events

WorkedLockManager

Emitted when the job is worked

event WorkedLockManager(ILockManager _lockManager, IStrategy.Position[] _positions);

WorkedPoolManager

Emitted when the job is worked

event WorkedPoolManager(IPoolManager _poolManager);

CollectMultiplierSet

Emitted when the collect multiplier has been set

event CollectMultiplierSet(uint256 _collectMultiplier);

Errors

FeeCollectorJob_InvalidPoolManager

Thrown when the pool manager cannot be verified

error FeeCollectorJob_InvalidPoolManager(IPoolManager _poolManager);