IPositionBurnerJob

Git Source

Inherits: IKeep3rJob

Runs the job handling the position burning in WETH/TOKEN pools

Functions

POOL_MANAGER_FACTORY

Returns the pool manager factory

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

Returns

NameTypeDescription
_poolManagerFactoryIPoolManagerFactoryThe pool manager factory

work

Burn the position in the lock manager and reward the keeper for doing so

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

function work(IPoolManager _poolManager, IStrategy.Position memory _position) external;

Parameters

NameTypeDescription
_poolManagerIPoolManagerThe address of the target pool manager
_positionPosition.IStrategyThe position to be burned

isWorkable

Return true if the specified position can be burned

function isWorkable(IPoolManager _poolManager, IStrategy.Position memory _position) external returns (bool _workable);

Parameters

NameTypeDescription
_poolManagerIPoolManagerThe address of the target pool manager
_positionPosition.IStrategyThe position to burn

Returns

NameTypeDescription
_workableboolTrue if the position can be burned

isWorkable

Return true if the specified pool manager can be worked by the specified keeper

function isWorkable(IPoolManager _poolManager, IStrategy.Position memory _position, address _keeper)
    external
    returns (bool _workable);

Parameters

NameTypeDescription
_poolManagerIPoolManagerThe address of the target pool manager
_positionPosition.IStrategyThe position to burn
_keeperaddressThe address of the keeper

Returns

NameTypeDescription
_workableboolTrue if the position can be burned

Events

Worked

Emitted when a position was burned

event Worked(ILockManager _lockManager, IStrategy.Position _position);

Errors

PositionBurnerJob_InvalidPoolManager

Thrown when we can't verify the pool manager

error PositionBurnerJob_InvalidPoolManager(IPoolManager _poolManager);