IAlgebraEternalFarming
Algebra Eternal Farming Interface
Allows farming nonfungible liquidity tokens in exchange for reward tokens without locking NFT for incentive time
Events
IncentiveDeactivated
event IncentiveDeactivated(bytes32 incentiveId)
Event emitted when a liquidity mining incentive has been stopped from the outside
incentiveId
bytes32
The stopped incentive
FarmEntered
event FarmEntered(uint256 tokenId, bytes32 incentiveId, uint128 liquidity)
Event emitted when a Algebra LP token has been farmd
tokenId
uint256
The unique identifier of an Algebra LP token
incentiveId
bytes32
The incentive in which the token is farming
liquidity
uint128
The amount of liquidity farmd
FarmEnded
event FarmEnded(uint256 tokenId, bytes32 incentiveId, address rewardAddress, address bonusRewardToken, address owner, uint256 reward, uint256 bonusReward)
Event emitted when a Algebra LP token has been exitFarmingd
tokenId
uint256
The unique identifier of an Algebra LP token
incentiveId
bytes32
The incentive in which the token is farming
rewardAddress
address
The token being distributed as a reward
bonusRewardToken
address
The token being distributed as a bonus reward
owner
address
The address where claimed rewards were sent to
reward
uint256
The amount of reward tokens to be distributed
bonusReward
uint256
The amount of bonus reward tokens to be distributed
IncentiveMaker
event IncentiveMaker(address incentiveMaker)
Emitted when the incentive maker is changed
incentiveMaker
address
The incentive maker after the address was changed
FarmingCenter
event FarmingCenter(address farmingCenter)
Emitted when the farming center is changed
farmingCenter
address
The farming center after the address was changed
RewardsAdded
event RewardsAdded(uint256 rewardAmount, uint256 bonusRewardAmount, bytes32 incentiveId)
Event emitted when rewards were added
rewardAmount
uint256
The additional amount of main token
bonusRewardAmount
uint256
The additional amount of bonus token
incentiveId
bytes32
The ID of the incentive for which rewards were added
RewardAmountsDecreased
event RewardAmountsDecreased(uint256 reward, uint256 bonusReward, bytes32 incentiveId)
reward
uint256
bonusReward
uint256
incentiveId
bytes32
RewardClaimed
event RewardClaimed(address to, uint256 reward, address rewardAddress, address owner)
Event emitted when a reward token has been claimed
to
address
The address where claimed rewards were sent to
reward
uint256
The amount of reward tokens claimed
rewardAddress
address
The token reward address
owner
address
The address where claimed rewards were sent to
RewardsRatesChanged
event RewardsRatesChanged(uint128 rewardRate, uint128 bonusRewardRate, bytes32 incentiveId)
Event emitted when reward rates were changed
rewardRate
uint128
The new rate of main token distribution per sec
bonusRewardRate
uint128
The new rate of bonus token distribution per sec
incentiveId
bytes32
The ID of the incentive for which rates were changed
RewardsCollected
event RewardsCollected(uint256 tokenId, bytes32 incentiveId, uint256 rewardAmount, uint256 bonusRewardAmount)
Event emitted when rewards were collected
tokenId
uint256
The ID of the token for which rewards were collected
incentiveId
bytes32
The ID of the incentive for which rewards were collected
rewardAmount
uint256
Collected amount of reward
bonusRewardAmount
uint256
Collected amount of bonus reward
EternalFarmingCreated
event EternalFarmingCreated(contract IERC20Minimal rewardToken, contract IERC20Minimal bonusRewardToken, contract IAlgebraPool pool, address virtualPool, uint256 nonce, uint256 reward, uint256 bonusReward, uint24 minimalAllowedPositionWidth)
Event emitted when a liquidity mining incentive has been created
rewardToken
contract IERC20Minimal
The token being distributed as a reward
bonusRewardToken
contract IERC20Minimal
The token being distributed as a bonus reward
pool
contract IAlgebraPool
The Algebra pool
virtualPool
address
The virtual pool address
nonce
uint256
The nonce of new farming
reward
uint256
The amount of reward tokens to be distributed
bonusReward
uint256
The amount of bonus reward tokens to be distributed
minimalAllowedPositionWidth
uint24
The minimal allowed position width (tickUpper - tickLower)
Functions
nonfungiblePositionManager
function nonfungiblePositionManager() external view returns (contract INonfungiblePositionManager) view external
The nonfungible position manager with which this farming contract is compatible
Returns:
[0]
contract INonfungiblePositionManager
incentives
function incentives(bytes32 incentiveId) external view returns (uint128 totalReward, uint128 bonusReward, address virtualPoolAddress, uint24 minimalPositionWidth, bool deactivated) view external
Represents a farming incentive
incentiveId
bytes32
The ID of the incentive computed from its parameters
Returns:
totalReward
uint128
bonusReward
uint128
virtualPoolAddress
address
minimalPositionWidth
uint24
deactivated
bool
isIncentiveActiveInPool
function isIncentiveActiveInPool(bytes32 incentiveId, contract IAlgebraPool pool) external view returns (bool res) view external
Check if incentive is active in Algebra pool Developer note: Does not check that the pool is indeed an Algebra pool
incentiveId
bytes32
The ID of the incentive computed from its parameters
pool
contract IAlgebraPool
Corresponding Algebra pool
Returns:
res
bool
True if incentive is active in Algebra pool
deactivateIncentive
function deactivateIncentive(struct IncentiveKey key) external external
Detach incentive from the pool and deactivate it
key
struct IncentiveKey
The key of the incentive
addRewards
function addRewards(struct IncentiveKey key, uint128 rewardAmount, uint128 bonusRewardAmount) external external
key
struct IncentiveKey
rewardAmount
uint128
bonusRewardAmount
uint128
decreaseRewardsAmount
function decreaseRewardsAmount(struct IncentiveKey key, uint128 rewardAmount, uint128 bonusRewardAmount) external external
key
struct IncentiveKey
rewardAmount
uint128
bonusRewardAmount
uint128
rewards
function rewards(address owner, contract IERC20Minimal rewardToken) external view returns (uint256 rewardsOwed) view external
Returns amounts of reward tokens owed to a given address according to the last time all farms were updated
owner
address
The owner for which the rewards owed are checked
rewardToken
contract IERC20Minimal
The token for which to check rewards
Returns:
rewardsOwed
uint256
The amount of the reward token claimable by the owner
setFarmingCenterAddress
function setFarmingCenterAddress(address _farmingCenter) external external
Updates farming center address
_farmingCenter
address
The new farming center contract address
enterFarming
function enterFarming(struct IncentiveKey key, uint256 tokenId) external external
enter farming for Algebra LP token
key
struct IncentiveKey
The key of the incentive for which to enterFarming the NFT
tokenId
uint256
The ID of the token to exitFarming
exitFarming
function exitFarming(struct IncentiveKey key, uint256 tokenId, address _owner) external external
exitFarmings for Algebra LP token
key
struct IncentiveKey
The key of the incentive for which to exitFarming the NFT
tokenId
uint256
The ID of the token to exitFarming
_owner
address
Owner of the token
claimReward
function claimReward(contract IERC20Minimal rewardToken, address to, uint256 amountRequested) external returns (uint256 reward) external
Transfers `amountRequested` of accrued `rewardToken` rewards from the contract to the recipient `to`
rewardToken
contract IERC20Minimal
The token being distributed as a reward
to
address
The address where claimed rewards will be sent to
amountRequested
uint256
The amount of reward tokens to claim. Claims entire reward amount if set to 0.
Returns:
reward
uint256
The amount of reward tokens claimed
claimRewardFrom
function claimRewardFrom(contract IERC20Minimal rewardToken, address from, address to, uint256 amountRequested) external returns (uint256 reward) external
Transfers `amountRequested` of accrued `rewardToken` rewards from the contract to the recipient `to` only for FarmingCenter
rewardToken
contract IERC20Minimal
The token being distributed as a reward
from
address
The address of position owner
to
address
The address where claimed rewards will be sent to
amountRequested
uint256
The amount of reward tokens to claim. Claims entire reward amount if set to 0.
Returns:
reward
uint256
The amount of reward tokens claimed
getRewardInfo
function getRewardInfo(struct IncentiveKey key, uint256 tokenId) external returns (uint256 reward, uint256 bonusReward) external
Calculates the reward amount that will be received for the given farm
key
struct IncentiveKey
The key of the incentive
tokenId
uint256
The ID of the token
Returns:
reward
uint256
The reward accrued to the NFT for the given incentive thus far
bonusReward
uint256
The bonus reward accrued to the NFT for the given incentive thus far
farms
function farms(uint256 tokenId, bytes32 incentiveId) external view returns (uint128 liquidity, int24 tickLower, int24 tickUpper, uint256 innerRewardGrowth0, uint256 innerRewardGrowth1) view external
Returns information about a farmd liquidity NFT
tokenId
uint256
The ID of the farmd token
incentiveId
bytes32
The ID of the incentive for which the token is farmd
Returns:
liquidity
uint128
The amount of liquidity in the NFT as of the last time the rewards were computed, tickLower The lower tick of position, tickUpper The upper tick of position, innerRewardGrowth0 The last saved reward0 growth inside position, innerRewardGrowth1 The last saved reward1 growth inside position
tickLower
int24
tickUpper
int24
innerRewardGrowth0
uint256
innerRewardGrowth1
uint256
createEternalFarming
function createEternalFarming(struct IncentiveKey key, struct IAlgebraEternalFarming.IncentiveParams params) external returns (address virtualPool) external
Creates a new liquidity mining incentive program
key
struct IncentiveKey
Details of the incentive to create
params
struct IAlgebraEternalFarming.IncentiveParams
Params of incentive
Returns:
virtualPool
address
The virtual pool
setRates
function setRates(struct IncentiveKey key, uint128 rewardRate, uint128 bonusRewardRate) external external
key
struct IncentiveKey
rewardRate
uint128
bonusRewardRate
uint128
collectRewards
function collectRewards(struct IncentiveKey key, uint256 tokenId, address _owner) external returns (uint256 reward, uint256 bonusReward) external
key
struct IncentiveKey
tokenId
uint256
_owner
address
Returns:
reward
uint256
bonusReward
uint256
Errors
farmingAlreadyExists
error farmingAlreadyExists()
farmDoesNotExist
error farmDoesNotExist()
tokenAlreadyFarmed
error tokenAlreadyFarmed()
incentiveNotExist
error incentiveNotExist()
incentiveStopped
error incentiveStopped()
anotherFarmingIsActive
error anotherFarmingIsActive()
minimalPositionWidthTooWide
error minimalPositionWidthTooWide()
zeroRewardAmount
error zeroRewardAmount()
positionIsTooNarrow
error positionIsTooNarrow()
zeroLiquidity
error zeroLiquidity()
invalidPool
error invalidPool()
claimToZeroAddress
error claimToZeroAddress()