IPositionBurnerJob
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
Name | Type | Description |
---|---|---|
_poolManagerFactory | IPoolManagerFactory | The 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
Name | Type | Description |
---|---|---|
_poolManager | IPoolManager | The address of the target pool manager |
_position | Position.IStrategy | The 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
Name | Type | Description |
---|---|---|
_poolManager | IPoolManager | The address of the target pool manager |
_position | Position.IStrategy | The position to burn |
Returns
Name | Type | Description |
---|---|---|
_workable | bool | True 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
Name | Type | Description |
---|---|---|
_poolManager | IPoolManager | The address of the target pool manager |
_position | Position.IStrategy | The position to burn |
_keeper | address | The address of the keeper |
Returns
Name | Type | Description |
---|---|---|
_workable | bool | True 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);