All pages
Powered by GitBook
1 of 5

E721 Farms

E721 farms include all the farms built for pools in which the liquidity provider has an NFT (ERC721) position.

E721Farm

Git Source

Inherits: Farm, IERC721Receiver

Author: Sperax Foundation.

This contract contains the core logic for E721 farms.

State Variables

nftContract

address public nftContract;

depositToTokenId

mapping(uint256 => uint256) public depositToTokenId;

Functions

onERC721Received

Function is called when user transfers the NFT to this farm.

function onERC721Received(address, address _from, uint256 _tokenId, bytes calldata _data)
    external
    override
    returns (bytes4);

Parameters

Name
Type
Description

<none>

address

_from

address

The address of the owner.

_tokenId

uint256

NFT Id generated by other protocol (e.g. Camelot or Uniswap).

_data

bytes

The data should be the lockup flag (bool).

Returns

Name
Type
Description

<none>

bytes4

bytes4 The onERC721Received selector.

withdraw

Function to withdraw a deposit from the farm.

function withdraw(uint256 _depositId) external override nonReentrant;

Parameters

Name
Type
Description

_depositId

uint256

The id of the deposit to be withdrawn.

_getLiquidity

Function to get the liquidity. Must be defined by the farm.

This function should be overridden to add the respective logic.

function _getLiquidity(uint256 _tokenId) internal view virtual returns (uint256);

Parameters

Name
Type
Description

_tokenId

uint256

The nft tokenId.

Returns

Name
Type
Description

<none>

uint256

The liquidity of the nft position.

Errors

UnauthorisedNFTContract

error UnauthorisedNFTContract();

NoData

error NoData();

Camelot V3

Pools in camelot V3 are very similar to Uniswap V3. When a liquidity provider supplies assets to the pool, the LP receives an NFT position in return.

Next, you can see the specification for Camelot V3 farm and Camelot V3 farm deployer.

CamelotV3FarmDeployer

Git Source

Inherits: FarmDeployer

Author: Sperax Foundation.

This contract allows anyone to calculate fees, pay fees and create farms.

State Variables

CAMELOT_V3_FACTORY

address public immutable CAMELOT_V3_FACTORY;

NFPM

address public immutable NFPM;

CAMELOT_UTILS

address public immutable CAMELOT_UTILS;

CAMELOT_NFPM_UTILS

address public immutable CAMELOT_NFPM_UTILS;

Functions

constructor

Constructor of the contract.

constructor(
    address _farmRegistry,
    string memory _farmId,
    address _camelotV3Factory,
    address _nfpm,
    address _camelotUtils,
    address _nfpmUtils
) FarmDeployer(_farmRegistry, _farmId);

Parameters

Name
Type
Description

_farmRegistry

address

Address of the Demeter Farm Registry.

_farmId

string

Id of the farm.

_camelotV3Factory

address

Address of CamelotV3 factory.

_nfpm

address

Address of Camelot NonfungiblePositionManager contract.

_camelotUtils

address

Address of CamelotUtils (Camelot helper) contract.

_nfpmUtils

address

Address of Camelot INonfungiblePositionManagerUtils (NonfungiblePositionManager helper) contract.

createFarm

Deploys a new CamelotV3 farm.

The caller of this function should approve feeAmount to this contract before calling this function.

function createFarm(FarmData memory _data) external nonReentrant returns (address);

Parameters

Name
Type
Description

_data

FarmData

Data for deployment.

Returns

Name
Type
Description

<none>

address

Address of the deployed farm.

Structs

FarmData

struct FarmData {
    address farmAdmin;
    uint256 farmStartTime;
    uint256 cooldownPeriod;
    CamelotPoolData camelotPoolData;
    RewardTokenData[] rewardData;
}

CamelotV3Farm

Git Source

Inherits: E721Farm, OperableDeposit, ClaimableFee

Author: Sperax Foundation.

This contract is the implementation of the Camelot V3 farm.

State Variables

tickLowerAllowed

int24 public tickLowerAllowed;

tickUpperAllowed

int24 public tickUpperAllowed;

camelotPool

address public camelotPool;

camelotV3Factory

address public camelotV3Factory;

camelotUtils

address public camelotUtils;

nfpmUtils

address public nfpmUtils;

MIN_TICK

int256 internal constant MIN_TICK = -887272;

MAX_TICK

int256 internal constant MAX_TICK = 887272;

Functions

initialize

Initializer function of this farm.

function initialize(InitializeInput calldata _input) external;

Parameters

Name
Type
Description

_input

InitializeInput

A struct having all the input params.

increaseDeposit

Allow user to increase liquidity for a deposit.

function increaseDeposit(uint256 _depositId, uint256[2] calldata _amounts, uint256[2] calldata _minAmounts)
    external
    nonReentrant;

Parameters

Name
Type
Description

_depositId

uint256

The id of the deposit to be increased.

_amounts

uint256[2]

Desired amount of tokens to be increased.

_minAmounts

uint256[2]

Minimum amount of tokens to be added as liquidity.

decreaseDeposit

Withdraw liquidity partially from an existing deposit.

function decreaseDeposit(uint256 _depositId, uint128 _liquidityToWithdraw, uint256[2] calldata _minAmounts)
    external
    nonReentrant;

Parameters

Name
Type
Description

_depositId

uint256

Deposit index for the user.

_liquidityToWithdraw

uint128

Amount to be withdrawn.

_minAmounts

uint256[2]

Minimum amount of tokens to be received.

getTokenAmounts

Function to be called by Demeter Rewarder to get tokens and amounts associated with the farm's liquidity.

function getTokenAmounts() external view override returns (address[] memory, uint256[] memory);

Returns

Name
Type
Description

<none>

address[]

tokens An array of token addresses.

<none>

uint256[]

amounts An array of token amounts.

_claimPoolFee

Claim pool fee implementation from ClaimableFee feature.

function _claimPoolFee(uint256 _depositId)
    internal
    override
    returns (uint256 tokenId, uint256 amt0Recv, uint256 amt1Recv);

Parameters

Name
Type
Description

_depositId

uint256

Deposit ID of the deposit in the farm.

_getLiquidity

Validate the position for the pool and get Liquidity.

The position must adhere to the price ranges.

Only allow specific pool token to be staked.

function _getLiquidity(uint256 _tokenId) internal view override returns (uint256);

Parameters

Name
Type
Description

_tokenId

uint256

The tokenId of the position.

Returns

Name
Type
Description

<none>

uint256

The liquidity of the position.

_validateTickRange

Validate the ticks (upper and lower).

Get the info of the required token.

Check if the token belongs to correct pool.

Check if the token adheres to the tick range.

The ticks must be within the max range and must be multiple of tickSpacing.

function _validateTickRange(int24 _tickLower, int24 _tickUpper) private view;

Parameters

Name
Type
Description

_tickLower

int24

The lower tick of the range.

_tickUpper

int24

The upper tick of the range.

Errors

InvalidCamelotPoolConfig

error InvalidCamelotPoolConfig();

IncorrectPoolToken

error IncorrectPoolToken();

IncorrectTickRange

error IncorrectTickRange();

InvalidTickRange

error InvalidTickRange();

InvalidAmount

error InvalidAmount();