FarmingCenter
Algebra main farming contract
Developer note: Manages farmings and performs entry, exit and other actions.
Modifiers
nonReentrant
modifier nonReentrant()
internal
Variables
contract IAlgebraLimitFarming limitFarming immutable
contract IAlgebraEternalFarming eternalFarming immutable
contract INonfungiblePositionManager nonfungiblePositionManager immutable
The nonfungible position manager with which this farming contract is compatible
contract IFarmingCenterVault farmingCenterVault immutable
mapping(uint256 => struct FarmingCenter.Deposit) deposits
Developer note: deposits[tokenId] => Deposit
mapping(uint256 => struct FarmingCenter.L2Nft) l2Nfts
Functions
constructor
constructor(contract IAlgebraLimitFarming _limitFarming, contract IAlgebraEternalFarming _eternalFarming, contract INonfungiblePositionManager _nonfungiblePositionManager, contract IFarmingCenterVault _farmingCenterVault) public
public
onERC721Received
function onERC721Received(address, address from, uint256 tokenId, bytes) external returns (bytes4)
external
Upon receiving a Algebra ERC721, creates the token deposit setting owner to `from`. *Developer note: Whenever an {IERC721} `tokenId` token is transferred to this contract via {IERC721-safeTransferFrom} by `operator` from `from`, this function is called.
It must return its Solidity selector to confirm the token transfer. If any other value is returned or the interface is not implemented by the recipient, the transfer will be reverted.
The selector can be obtained in Solidity with `IERC721.onERC721Received.selector`.*
Returns:
enterFarming
function enterFarming(struct IIncentiveKey.IncentiveKey key, uint256 tokenId, uint256 tokensLocked, bool isLimit) external
external
Enters in incentive (time-limited or eternal farming) with NFT-position token Developer note: token must be deposited in FarmingCenter
exitFarming
function exitFarming(struct IIncentiveKey.IncentiveKey key, uint256 tokenId, bool isLimit) external
external
Exits from incentive (time-limited or eternal farming) with NFT-position token
collect
function collect(struct INonfungiblePositionManager.CollectParams params) external returns (uint256 amount0, uint256 amount1)
external
Collects up to a maximum amount of fees owed to a specific position to the recipient Developer note: "proxies" to NonfungiblePositionManager
Returns:
collectRewards
function collectRewards(struct IIncentiveKey.IncentiveKey key, uint256 tokenId) external returns (uint256 reward, uint256 bonusReward)
external
Used to collect reward from eternal farming. Then reward can be claimed.
Returns:
claimReward
function claimReward(contract IERC20Minimal rewardToken, address to, uint256 amountRequestedIncentive, uint256 amountRequestedEternal) external returns (uint256 reward)
external
Used to claim and send rewards from farming(s) Developer note: can be used via static call to get current rewards for user
Returns:
isIncentiveActiveInPool
function isIncentiveActiveInPool(contract IAlgebraPool pool, address virtualPool) external view returns (bool)
view external
Is virtualPool connected to pool or not
Returns:
connectVirtualPool
function connectVirtualPool(contract IAlgebraPool pool, address newVirtualPool) external
external
Updates activeIncentive in AlgebraPool Developer note: only farming can do it
withdrawToken
function withdrawToken(uint256 tokenId, address to, bytes data) external
external
Withdraw Algebra NFT-position token Developer note: can be used via static call to get current rewards for user
cross
function cross(int24 nextTick, bool zeroToOne) external
external
Developer note: This function is called by the main pool when an initialized tick is crossed and two farmings are active at same time.
increaseCumulative
function increaseCumulative(uint32 blockTimestamp) external returns (enum IAlgebraVirtualPool.Status status)
external
Developer note: This function is called by the main pool at start of the swap if two farmings are active at same time.
Returns:
virtualPoolAddresses
function virtualPoolAddresses(address pool) external view returns (address limitVP, address eternalVP)
view external
Returns:
getApproved
function getApproved(uint256 tokenId) public view returns (address)
view public
*Developer note: Returns the account approved for `tokenId` token.
Requirements:
`tokenId` must exist.*
Returns: