// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol)pragmasolidity ^0.8.1;/**
* @dev Collection of functions related to the address type
*/libraryAddress{
/**
* @dev Returns true if `account` is a contract.
*
* [IMPORTANT]
* ====
* It is unsafe to assume that an address for which this function returns
* false is an externally-owned account (EOA) and not a contract.
*
* Among others, `isContract` will return false for the following
* types of addresses:
*
* - an externally-owned account
* - a contract in construction
* - an address where a contract will be created
* - an address where a contract lived, but was destroyed
* ====
*
* [IMPORTANT]
* ====
* You shouldn't rely on `isContract` to protect against flash loan attacks!
*
* Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets
* like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract
* constructor.
* ====
*/functionisContract(address account) internalviewreturns (bool) {
// This method relies on extcodesize/address.code.length, which returns 0// for contracts in construction, since the code is only stored at the end// of the constructor execution.return account.code.length>0;
}
/**
* @dev Replacement for Solidity's `transfer`: sends `amount` wei to
* `recipient`, forwarding all available gas and reverting on errors.
*
* https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost
* of certain opcodes, possibly making contracts go over the 2300 gas limit
* imposed by `transfer`, making them unable to receive funds via
* `transfer`. {sendValue} removes this limitation.
*
* https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].
*
* IMPORTANT: because control is transferred to `recipient`, care must be
* taken to not create reentrancy vulnerabilities. Consider using
* {ReentrancyGuard} or the
* https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].
*/functionsendValue(addresspayable recipient, uint256 amount) internal{
require(address(this).balance>= amount, "Address: insufficient balance");
(bool success, ) = recipient.call{value: amount}("");
require(success, "Address: unable to send value, recipient may have reverted");
}
/**
* @dev Performs a Solidity function call using a low level `call`. A
* plain `call` is an unsafe replacement for a function call: use this
* function instead.
*
* If `target` reverts with a revert reason, it is bubbled up by this
* function (like regular Solidity function calls).
*
* Returns the raw returned data. To convert to the expected return value,
* use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].
*
* Requirements:
*
* - `target` must be a contract.
* - calling `target` with `data` must not revert.
*
* _Available since v3.1._
*/functionfunctionCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, 0, "Address: low-level call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with
* `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, 0, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but also transferring `value` wei to `target`.
*
* Requirements:
*
* - the calling contract must have an ETH balance of at least `value`.
* - the called Solidity function must be `payable`.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value
) internalreturns (bytesmemory) {
return functionCallWithValue(target, data, value, "Address: low-level call with value failed");
}
/**
* @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but
* with `errorMessage` as a fallback revert reason when `target` reverts.
*
* _Available since v3.1._
*/functionfunctionCallWithValue(address target,
bytesmemory data,
uint256 value,
stringmemory errorMessage
) internalreturns (bytesmemory) {
require(address(this).balance>= value, "Address: insufficient balance for call");
(bool success, bytesmemory returndata) = target.call{value: value}(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target, bytesmemory data) internalviewreturns (bytesmemory) {
return functionStaticCall(target, data, "Address: low-level static call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a static call.
*
* _Available since v3.3._
*/functionfunctionStaticCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalviewreturns (bytesmemory) {
(bool success, bytesmemory returndata) = target.staticcall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target, bytesmemory data) internalreturns (bytesmemory) {
return functionDelegateCall(target, data, "Address: low-level delegate call failed");
}
/**
* @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],
* but performing a delegate call.
*
* _Available since v3.4._
*/functionfunctionDelegateCall(address target,
bytesmemory data,
stringmemory errorMessage
) internalreturns (bytesmemory) {
(bool success, bytesmemory returndata) = target.delegatecall(data);
return verifyCallResultFromTarget(target, success, returndata, errorMessage);
}
/**
* @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling
* the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract.
*
* _Available since v4.8._
*/functionverifyCallResultFromTarget(address target,
bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalviewreturns (bytesmemory) {
if (success) {
if (returndata.length==0) {
// only check isContract if the call was successful and the return data is empty// otherwise we already know that it was a contractrequire(isContract(target), "Address: call to non-contract");
}
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
/**
* @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the
* revert reason or using the provided one.
*
* _Available since v4.3._
*/functionverifyCallResult(bool success,
bytesmemory returndata,
stringmemory errorMessage
) internalpurereturns (bytesmemory) {
if (success) {
return returndata;
} else {
_revert(returndata, errorMessage);
}
}
function_revert(bytesmemory returndata, stringmemory errorMessage) privatepure{
// Look for revert reason and bubble it up if presentif (returndata.length>0) {
// The easiest way to bubble the revert reason is using memory via assembly/// @solidity memory-safe-assemblyassembly {
let returndata_size :=mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
Contract Source Code
File 2 of 21: Context.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/Context.sol)pragmasolidity ^0.8.0;/**
* @dev Provides information about the current execution context, including the
* sender of the transaction and its data. While these are generally available
* via msg.sender and msg.data, they should not be accessed in such a direct
* manner, since when dealing with meta-transactions the account sending and
* paying for execution may not be the actual sender (as far as an application
* is concerned).
*
* This contract is only required for intermediate, library-like contracts.
*/abstractcontractContext{
function_msgSender() internalviewvirtualreturns (address) {
returnmsg.sender;
}
function_msgData() internalviewvirtualreturns (bytescalldata) {
returnmsg.data;
}
}
Contract Source Code
File 3 of 21: Enumerable.sol
// SPDX-License-Identifier: GPL-2.0-or-laterpragmasolidity ^0.8.10;/**
* @notice This codes were copied from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/token/ERC721/extensions/ERC721Enumerable.sol, and did some changes.
* @dev This implements an optional extension of defined in the EIP that adds
* enumerability of all the token ids in the contract as well as all token ids owned by each
* account.
*/abstractcontractEnumerable{
// Mapping owner address to token countmapping(address=>uint256) private _balances;
// Mapping from owner to list of owned token IDsmapping(address=>mapping(uint256=>uint256)) private _ownedTokens;
// Mapping from token ID to index of the owner tokens listmapping(uint256=>uint256) private _ownedTokensIndex;
functiontokenOfOwnerByIndex(address owner, uint256 index) publicviewreturns (uint256) {
require(index < _balances[owner], "Enumerable: owner index out of bounds");
return _ownedTokens[owner][index];
}
functionbalanceOf(address owner) publicviewreturns (uint256) {
require(owner !=address(0), "Enumerable: address zero is not a valid owner");
return _balances[owner];
}
functionaddToken(addressfrom, uint256 tokenId) internal{
_addTokenToOwnerEnumeration(from, tokenId);
unchecked {
_balances[from] +=1;
}
}
functionremoveToken(addressfrom, uint256 tokenId) internal{
_removeTokenFromOwnerEnumeration(from, tokenId);
unchecked {
_balances[from] -=1;
}
}
/**
* @dev Private function to add a token to this extension's ownership-tracking data structures.
* @param to address representing the new owner of the given token ID
* @param tokenId uint256 ID of the token to be added to the tokens list of the given address
*/function_addTokenToOwnerEnumeration(address to, uint256 tokenId) private{
uint256 length = _balances[to];
_ownedTokens[to][length] = tokenId;
_ownedTokensIndex[tokenId] = length;
}
/**
* @dev Private function to remove a token from this extension's ownership-tracking data structures. Note that
* while the token is not assigned a new owner, the `_ownedTokensIndex` mapping is _not_ updated: this allows for
* gas optimizations e.g. when performing a transfer operation (avoiding double writes).
* This has O(1) time complexity, but alters the order of the _ownedTokens array.
* @param from address representing the previous owner of the given token ID
* @param tokenId uint256 ID of the token to be removed from the tokens list of the given address
*/function_removeTokenFromOwnerEnumeration(addressfrom, uint256 tokenId) private{
// To prevent a gap in from's tokens array, we store the last token in the index of the token to delete, and// then delete the last slot (swap and pop).uint256 lastTokenIndex = _balances[from] -1;
uint256 tokenIndex = _ownedTokensIndex[tokenId];
require(tokenId == _ownedTokens[from][tokenIndex], "Invalid tokenId");
// When the token to delete is the last token, the swap operation is unnecessaryif (tokenIndex != lastTokenIndex) {
uint256 lastTokenId = _ownedTokens[from][lastTokenIndex];
_ownedTokens[from][tokenIndex] = lastTokenId; // Move the last token to the slot of the to-delete token
_ownedTokensIndex[lastTokenId] = tokenIndex; // Update the moved token's index
}
// This also deletes the contents at the last position of the arraydelete _ownedTokensIndex[tokenId];
delete _ownedTokens[from][lastTokenIndex];
}
}
Contract Source Code
File 4 of 21: IERC165.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol)pragmasolidity ^0.8.0;/**
* @dev Interface of the ERC165 standard, as defined in the
* https://eips.ethereum.org/EIPS/eip-165[EIP].
*
* Implementers can declare support of contract interfaces, which can then be
* queried by others ({ERC165Checker}).
*
* For an implementation, see {ERC165}.
*/interfaceIERC165{
/**
* @dev Returns true if this contract implements the interface defined by
* `interfaceId`. See the corresponding
* https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section]
* to learn more about how these ids are created.
*
* This function call must use less than 30 000 gas.
*/functionsupportsInterface(bytes4 interfaceId) externalviewreturns (bool);
}
Contract Source Code
File 5 of 21: IERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol)pragmasolidity ^0.8.0;/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/interfaceIERC20{
/**
* @dev Emitted when `value` tokens are moved from one account (`from`) to
* another (`to`).
*
* Note that `value` may be zero.
*/eventTransfer(addressindexedfrom, addressindexed to, uint256 value);
/**
* @dev Emitted when the allowance of a `spender` for an `owner` is set by
* a call to {approve}. `value` is the new allowance.
*/eventApproval(addressindexed owner, addressindexed spender, uint256 value);
/**
* @dev Returns the amount of tokens in existence.
*/functiontotalSupply() externalviewreturns (uint256);
/**
* @dev Returns the amount of tokens owned by `account`.
*/functionbalanceOf(address account) externalviewreturns (uint256);
/**
* @dev Moves `amount` tokens from the caller's account to `to`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/functiontransfer(address to, uint256 amount) externalreturns (bool);
/**
* @dev Returns the remaining number of tokens that `spender` will be
* allowed to spend on behalf of `owner` through {transferFrom}. This is
* zero by default.
*
* This value changes when {approve} or {transferFrom} are called.
*/functionallowance(address owner, address spender) externalviewreturns (uint256);
/**
* @dev Sets `amount` as the allowance of `spender` over the caller's tokens.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* IMPORTANT: Beware that changing an allowance with this method brings the risk
* that someone may use both the old and the new allowance by unfortunate
* transaction ordering. One possible solution to mitigate this race
* condition is to first reduce the spender's allowance to 0 and set the
* desired value afterwards:
* https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729
*
* Emits an {Approval} event.
*/functionapprove(address spender, uint256 amount) externalreturns (bool);
/**
* @dev Moves `amount` tokens from `from` to `to` using the
* allowance mechanism. `amount` is then deducted from the caller's
* allowance.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/functiontransferFrom(addressfrom,
address to,
uint256 amount
) externalreturns (bool);
}
Contract Source Code
File 6 of 21: IERC721.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC721/IERC721.sol)pragmasolidity ^0.8.0;import"../../utils/introspection/IERC165.sol";
/**
* @dev Required interface of an ERC721 compliant contract.
*/interfaceIERC721isIERC165{
/**
* @dev Emitted when `tokenId` token is transferred from `from` to `to`.
*/eventTransfer(addressindexedfrom, addressindexed to, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables `approved` to manage the `tokenId` token.
*/eventApproval(addressindexed owner, addressindexed approved, uint256indexed tokenId);
/**
* @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets.
*/eventApprovalForAll(addressindexed owner, addressindexed operator, bool approved);
/**
* @dev Returns the number of tokens in ``owner``'s account.
*/functionbalanceOf(address owner) externalviewreturns (uint256 balance);
/**
* @dev Returns the owner of the `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functionownerOf(uint256 tokenId) externalviewreturns (address owner);
/**
* @dev Safely transfers `tokenId` token from `from` to `to`.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId,
bytescalldata data
) external;
/**
* @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients
* are aware of the ERC721 protocol to prevent tokens from being forever locked.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must exist and be owned by `from`.
* - If the caller is not `from`, it must have been allowed to move this token by either {approve} or {setApprovalForAll}.
* - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer.
*
* Emits a {Transfer} event.
*/functionsafeTransferFrom(addressfrom,
address to,
uint256 tokenId
) external;
/**
* @dev Transfers `tokenId` token from `from` to `to`.
*
* WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721
* or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must
* understand this adds an external call which potentially creates a reentrancy vulnerability.
*
* Requirements:
*
* - `from` cannot be the zero address.
* - `to` cannot be the zero address.
* - `tokenId` token must be owned by `from`.
* - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}.
*
* Emits a {Transfer} event.
*/functiontransferFrom(addressfrom,
address to,
uint256 tokenId
) external;
/**
* @dev Gives permission to `to` to transfer `tokenId` token to another account.
* The approval is cleared when the token is transferred.
*
* Only a single account can be approved at a time, so approving the zero address clears previous approvals.
*
* Requirements:
*
* - The caller must own the token or be an approved operator.
* - `tokenId` must exist.
*
* Emits an {Approval} event.
*/functionapprove(address to, uint256 tokenId) external;
/**
* @dev Approve or remove `operator` as an operator for the caller.
* Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller.
*
* Requirements:
*
* - The `operator` cannot be the caller.
*
* Emits an {ApprovalForAll} event.
*/functionsetApprovalForAll(address operator, bool _approved) external;
/**
* @dev Returns the account approved for `tokenId` token.
*
* Requirements:
*
* - `tokenId` must exist.
*/functiongetApproved(uint256 tokenId) externalviewreturns (address operator);
/**
* @dev Returns if the `operator` is allowed to manage all of the assets of `owner`.
*
* See {setApprovalForAll}
*/functionisApprovedForAll(address owner, address operator) externalviewreturns (bool);
}
// SPDX-License-Identifier: GPL-2.0-or-laterpragmasolidity ^0.8.10;import"@openzeppelin/contracts/token/ERC721/IERC721.sol";
import"./INonfungiblePositionManagerStruct.sol";
interfaceINonfungiblePositionManagerisINonfungiblePositionManagerStruct, IERC721{
/// @notice Returns the position information associated with a given token ID./// @dev Throws if the token ID is not valid./// @param tokenId The ID of the token that represents the position/// @return nonce The nonce for permits/// @return operator The address that is approved for spending/// @return token0 The address of the token0 for a specific pool/// @return token1 The address of the token1 for a specific pool/// @return fee The fee associated with the pool/// @return tickLower The lower end of the tick range for the position/// @return tickUpper The higher end of the tick range for the position/// @return liquidity The liquidity of the position/// @return feeGrowthInside0LastX128 The fee growth of token0 as of the last action on the individual position/// @return feeGrowthInside1LastX128 The fee growth of token1 as of the last action on the individual position/// @return tokensOwed0 The uncollected amount of token0 owed to the position as of the last computation/// @return tokensOwed1 The uncollected amount of token1 owed to the position as of the last computationfunctionpositions(uint256 tokenId
)
externalviewreturns (uint96 nonce,
address operator,
address token0,
address token1,
uint24 fee,
int24 tickLower,
int24 tickUpper,
uint128 liquidity,
uint256 feeGrowthInside0LastX128,
uint256 feeGrowthInside1LastX128,
uint128 tokensOwed0,
uint128 tokensOwed1
);
/// @notice Increases the amount of liquidity in a position, with tokens paid by the `msg.sender`/// @param params tokenId The ID of the token for which liquidity is being increased,/// amount0Desired The desired amount of token0 to be spent,/// amount1Desired The desired amount of token1 to be spent,/// amount0Min The minimum amount of token0 to spend, which serves as a slippage check,/// amount1Min The minimum amount of token1 to spend, which serves as a slippage check,/// deadline The time by which the transaction must be included to effect the change/// @return liquidity The new liquidity amount as a result of the increase/// @return amount0 The amount of token0 to acheive resulting liquidity/// @return amount1 The amount of token1 to acheive resulting liquidityfunctionincreaseLiquidity(
IncreaseLiquidityParams calldata params
) externalpayablereturns (uint128 liquidity, uint256 amount0, uint256 amount1);
/// @notice Decreases the amount of liquidity in a position and accounts it to the position/// @param params tokenId The ID of the token for which liquidity is being decreased,/// amount The amount by which liquidity will be decreased,/// amount0Min The minimum amount of token0 that should be accounted for the burned liquidity,/// amount1Min The minimum amount of token1 that should be accounted for the burned liquidity,/// deadline The time by which the transaction must be included to effect the change/// @return amount0 The amount of token0 accounted to the position's tokens owed/// @return amount1 The amount of token1 accounted to the position's tokens owedfunctiondecreaseLiquidity(
DecreaseLiquidityParams calldata params
) externalpayablereturns (uint256 amount0, uint256 amount1);
/// @notice Collects up to a maximum amount of fees owed to a specific position to the recipient/// @param params tokenId The ID of the NFT for which tokens are being collected,/// recipient The account that should receive the tokens,/// amount0Max The maximum amount of token0 to collect,/// amount1Max The maximum amount of token1 to collect/// @return amount0 The amount of fees collected in token0/// @return amount1 The amount of fees collected in token1functioncollect(CollectParams calldata params) externalpayablereturns (uint256 amount0, uint256 amount1);
/// @notice Burns a token ID, which deletes it from the NFT contract. The token must have 0 liquidity and all tokens/// must be collected first./// @param tokenId The ID of the token that is being burnedfunctionburn(uint256 tokenId) externalpayable;
functionrefundETH() externalpayable;
}
Contract Source Code
File 12 of 21: INonfungiblePositionManagerStruct.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.10;import"@openzeppelin/contracts/token/ERC20/IERC20.sol";
/// @title Interface for WETH9interfaceIWETHisIERC20{
/// @notice Deposit ether to get wrapped etherfunctiondeposit() externalpayable;
/// @notice Withdraw wrapped ether to get etherfunctionwithdraw(uint256) external;
}
Contract Source Code
File 15 of 21: MasterChefV3.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.10;import"@openzeppelin/contracts/access/Ownable.sol";
import"@openzeppelin/contracts/security/ReentrancyGuard.sol";
import"@openzeppelin/contracts/token/ERC20/IERC20.sol";
import"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import"./libraries/SafeCast.sol";
import"./interfaces/INonfungiblePositionManager.sol";
import"./interfaces/INonfungiblePositionManagerStruct.sol";
import"./interfaces/IPancakeV3Pool.sol";
import"./interfaces/IMasterChefV2.sol";
import"./interfaces/ILMPool.sol";
import"./interfaces/ILMPoolDeployer.sol";
import"./interfaces/IFarmBooster.sol";
import"./interfaces/IWETH.sol";
import"./utils/Multicall.sol";
import"./Enumerable.sol";
contractMasterChefV3isINonfungiblePositionManagerStruct, Multicall, Ownable, ReentrancyGuard, Enumerable{
usingSafeERC20forIERC20;
usingSafeCastforuint256;
structPoolInfo {
uint256 allocPoint;
// V3 pool address
IPancakeV3Pool v3Pool;
// V3 pool token0 addressaddress token0;
// V3 pool token1 addressaddress token1;
// V3 pool feeuint24 fee;
// total liquidity staking in the pooluint256 totalLiquidity;
// total boost liquidity staking in the pooluint256 totalBoostLiquidity;
}
structUserPositionInfo {
uint128 liquidity;
uint128 boostLiquidity;
int24 tickLower;
int24 tickUpper;
uint256 rewardGrowthInside;
uint256 reward;
address user;
uint256 pid;
uint256 boostMultiplier;
}
uint256public poolLength;
/// @notice Info of each MCV3 pool.mapping(uint256=> PoolInfo) public poolInfo;
/// @notice userPositionInfos[tokenId] => UserPositionInfo/// @dev TokenId is unique, and we can query the pid by tokenId.mapping(uint256=> UserPositionInfo) public userPositionInfos;
/// @notice v3PoolPid[token0][token1][fee] => pidmapping(address=>mapping(address=>mapping(uint24=>uint256))) v3PoolPid;
/// @notice v3PoolAddressPid[v3PoolAddress] => pidmapping(address=>uint256) public v3PoolAddressPid;
/// @notice Address of CAKE contract.
IERC20 publicimmutable CAKE;
/// @notice Address of WETH contract.addresspublicimmutable WETH;
/// @notice Address of Receiver contract.addresspublic receiver;
INonfungiblePositionManager publicimmutable nonfungiblePositionManager;
/// @notice Address of liquidity mining pool deployer contract.
ILMPoolDeployer public LMPoolDeployer;
/// @notice Address of farm booster contract.
IFarmBooster public FARM_BOOSTER;
/// @notice Only use for emergency situations.boolpublic emergency;
/// @notice Total allocation points. Must be the sum of all pools' allocation points.uint256public totalAllocPoint;
uint256public latestPeriodNumber;
uint256public latestPeriodStartTime;
uint256public latestPeriodEndTime;
uint256public latestPeriodCakePerSecond;
/// @notice Address of the operator.addresspublic operatorAddress;
/// @notice Default period duration.uint256public PERIOD_DURATION =1days;
uint256publicconstant MAX_DURATION =30days;
uint256publicconstant MIN_DURATION =1days;
uint256publicconstant PRECISION =1e12;
/// @notice Basic boost factor, none boosted user's boost factoruint256publicconstant BOOST_PRECISION =100*1e10;
/// @notice Hard limit for maxmium boost factor, it must greater than BOOST_PRECISIONuint256publicconstant MAX_BOOST_PRECISION =200*1e10;
uint256constant Q128 =0x100000000000000000000000000000000;
uint256constant MAX_U256 =type(uint256).max;
/// @notice Record the cake amount belong to MasterChefV3.uint256public cakeAmountBelongToMC;
errorZeroAddress();
errorNotOwnerOrOperator();
errorNoBalance();
errorNotPancakeNFT();
errorInvalidNFT();
errorNotOwner();
errorNoLiquidity();
errorInvalidPeriodDuration();
errorNoLMPool();
errorInvalidPid();
errorDuplicatedPool(uint256 pid);
errorNotEmpty();
errorWrongReceiver();
errorInconsistentAmount();
errorInsufficientAmount();
eventAddPool(uint256indexed pid, uint256 allocPoint, IPancakeV3Pool indexed v3Pool, ILMPool indexed lmPool);
eventSetPool(uint256indexed pid, uint256 allocPoint);
eventDeposit(addressindexedfrom,
uint256indexed pid,
uint256indexed tokenId,
uint256 liquidity,
int24 tickLower,
int24 tickUpper
);
eventWithdraw(addressindexedfrom, address to, uint256indexed pid, uint256indexed tokenId);
eventUpdateLiquidity(addressindexedfrom,
uint256indexed pid,
uint256indexed tokenId,
int128 liquidity,
int24 tickLower,
int24 tickUpper
);
eventNewOperatorAddress(address operator);
eventNewLMPoolDeployerAddress(address deployer);
eventNewReceiver(address receiver);
eventNewPeriodDuration(uint256 periodDuration);
eventHarvest(addressindexed sender, address to, uint256indexed pid, uint256indexed tokenId, uint256 reward);
eventNewUpkeepPeriod(uint256indexed periodNumber,
uint256 startTime,
uint256 endTime,
uint256 cakePerSecond,
uint256 cakeAmount
);
eventUpdateUpkeepPeriod(uint256indexed periodNumber,
uint256 oldEndTime,
uint256 newEndTime,
uint256 remainingCake
);
eventUpdateFarmBoostContract(addressindexed farmBoostContract);
eventSetEmergency(bool emergency);
modifieronlyOwnerOrOperator() {
if (msg.sender!= operatorAddress &&msg.sender!= owner()) revert NotOwnerOrOperator();
_;
}
modifieronlyValidPid(uint256 _pid) {
if (_pid ==0|| _pid > poolLength) revert InvalidPid();
_;
}
modifieronlyReceiver() {
require(receiver ==msg.sender, "Not receiver");
_;
}
/**
* @dev Throws if caller is not the boost contract.
*/modifieronlyBoostContract() {
require(address(FARM_BOOSTER) ==msg.sender, "Not farm boost contract");
_;
}
/// @param _CAKE The CAKE token contract address./// @param _nonfungiblePositionManager the NFT position manager contract address.constructor(IERC20 _CAKE, INonfungiblePositionManager _nonfungiblePositionManager, address _WETH) {
CAKE = _CAKE;
nonfungiblePositionManager = _nonfungiblePositionManager;
WETH = _WETH;
}
/// @notice Returns the cake per second , period end time./// @param _pid The pool pid./// @return cakePerSecond Cake reward per second./// @return endTime Period end time.functiongetLatestPeriodInfoByPid(uint256 _pid) publicviewreturns (uint256 cakePerSecond, uint256 endTime) {
if (totalAllocPoint >0) {
cakePerSecond = (latestPeriodCakePerSecond * poolInfo[_pid].allocPoint) / totalAllocPoint;
}
endTime = latestPeriodEndTime;
}
/// @notice Returns the cake per second , period end time. This is for liquidity mining pool./// @param _v3Pool Address of the V3 pool./// @return cakePerSecond Cake reward per second./// @return endTime Period end time.functiongetLatestPeriodInfo(address _v3Pool) publicviewreturns (uint256 cakePerSecond, uint256 endTime) {
if (totalAllocPoint >0) {
cakePerSecond =
(latestPeriodCakePerSecond * poolInfo[v3PoolAddressPid[_v3Pool]].allocPoint) /
totalAllocPoint;
}
endTime = latestPeriodEndTime;
}
/// @notice View function for checking pending CAKE rewards./// @dev The pending cake amount is based on the last state in LMPool. The actual amount will happen whenever liquidity changes or harvest./// @param _tokenId Token Id of NFT./// @return reward Pending reward.functionpendingCake(uint256 _tokenId) externalviewreturns (uint256 reward) {
UserPositionInfo memory positionInfo = userPositionInfos[_tokenId];
if (positionInfo.pid !=0) {
PoolInfo memory pool = poolInfo[positionInfo.pid];
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (address(LMPool) !=address(0)) {
uint256 rewardGrowthInside = LMPool.getRewardGrowthInside(
positionInfo.tickLower,
positionInfo.tickUpper
);
if (
rewardGrowthInside > positionInfo.rewardGrowthInside &&
MAX_U256 / (rewardGrowthInside - positionInfo.rewardGrowthInside) > positionInfo.boostLiquidity
)
reward =
((rewardGrowthInside - positionInfo.rewardGrowthInside) * positionInfo.boostLiquidity) /
Q128;
}
reward += positionInfo.reward;
}
}
/// @notice For emergency use only.functionsetEmergency(bool _emergency) externalonlyOwner{
emergency = _emergency;
emit SetEmergency(emergency);
}
functionsetReceiver(address _receiver) externalonlyOwner{
if (_receiver ==address(0)) revert ZeroAddress();
if (CAKE.allowance(_receiver, address(this)) !=type(uint256).max) revert();
receiver = _receiver;
emit NewReceiver(_receiver);
}
functionsetLMPoolDeployer(ILMPoolDeployer _LMPoolDeployer) externalonlyOwner{
if (address(_LMPoolDeployer) ==address(0)) revert ZeroAddress();
LMPoolDeployer = _LMPoolDeployer;
emit NewLMPoolDeployerAddress(address(_LMPoolDeployer));
}
/// @notice Add a new pool. Can only be called by the owner./// @notice One v3 pool can only create one pool./// @param _allocPoint Number of allocation points for the new pool./// @param _v3Pool Address of the V3 pool./// @param _withUpdate Whether call "massUpdatePools" operation.functionadd(uint256 _allocPoint, IPancakeV3Pool _v3Pool, bool _withUpdate) externalonlyOwner{
if (_withUpdate) massUpdatePools();
ILMPool lmPool = LMPoolDeployer.deploy(_v3Pool);
totalAllocPoint += _allocPoint;
address token0 = _v3Pool.token0();
address token1 = _v3Pool.token1();
uint24 fee = _v3Pool.fee();
if (v3PoolPid[token0][token1][fee] !=0) revert DuplicatedPool(v3PoolPid[token0][token1][fee]);
if (IERC20(token0).allowance(address(this), address(nonfungiblePositionManager)) ==0)
IERC20(token0).safeApprove(address(nonfungiblePositionManager), type(uint256).max);
if (IERC20(token1).allowance(address(this), address(nonfungiblePositionManager)) ==0)
IERC20(token1).safeApprove(address(nonfungiblePositionManager), type(uint256).max);
unchecked {
poolLength++;
}
poolInfo[poolLength] = PoolInfo({
allocPoint: _allocPoint,
v3Pool: _v3Pool,
token0: token0,
token1: token1,
fee: fee,
totalLiquidity: 0,
totalBoostLiquidity: 0
});
v3PoolPid[token0][token1][fee] = poolLength;
v3PoolAddressPid[address(_v3Pool)] = poolLength;
emit AddPool(poolLength, _allocPoint, _v3Pool, lmPool);
}
/// @notice Update the given pool's CAKE allocation point. Can only be called by the owner./// @param _pid The id of the pool. See `poolInfo`./// @param _allocPoint New number of allocation points for the pool./// @param _withUpdate Whether call "massUpdatePools" operation.functionset(uint256 _pid, uint256 _allocPoint, bool _withUpdate) externalonlyOwneronlyValidPid(_pid) {
uint32 currentTime =uint32(block.timestamp);
PoolInfo storage pool = poolInfo[_pid];
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (address(LMPool) !=address(0)) {
LMPool.accumulateReward(currentTime);
}
if (_withUpdate) massUpdatePools();
totalAllocPoint = totalAllocPoint - pool.allocPoint + _allocPoint;
pool.allocPoint = _allocPoint;
emit SetPool(_pid, _allocPoint);
}
structDepositCache {
address token0;
address token1;
uint24 fee;
int24 tickLower;
int24 tickUpper;
uint128 liquidity;
}
/// @notice Upon receiving a ERC721functiononERC721Received(address,
address _from,
uint256 _tokenId,
bytescalldata) externalnonReentrantreturns (bytes4) {
if (msg.sender!=address(nonfungiblePositionManager)) revert NotPancakeNFT();
DepositCache memory cache;
(
,
,
cache.token0,
cache.token1,
cache.fee,
cache.tickLower,
cache.tickUpper,
cache.liquidity,
,
,
,
) = nonfungiblePositionManager.positions(_tokenId);
if (cache.liquidity ==0) revert NoLiquidity();
uint256 pid = v3PoolPid[cache.token0][cache.token1][cache.fee];
if (pid ==0) revert InvalidNFT();
PoolInfo memory pool = poolInfo[pid];
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (address(LMPool) ==address(0)) revert NoLMPool();
UserPositionInfo storage positionInfo = userPositionInfos[_tokenId];
positionInfo.tickLower = cache.tickLower;
positionInfo.tickUpper = cache.tickUpper;
positionInfo.user = _from;
positionInfo.pid = pid;
// Need to update LMPool.
LMPool.accumulateReward(uint32(block.timestamp));
updateLiquidityOperation(positionInfo, _tokenId, 0);
positionInfo.rewardGrowthInside = LMPool.getRewardGrowthInside(cache.tickLower, cache.tickUpper);
// Update Enumerable
addToken(_from, _tokenId);
emit Deposit(_from, pid, _tokenId, cache.liquidity, cache.tickLower, cache.tickUpper);
returnthis.onERC721Received.selector;
}
/// @notice harvest cake from pool./// @param _tokenId Token Id of NFT./// @param _to Address to./// @return reward Cake reward.functionharvest(uint256 _tokenId, address _to) externalnonReentrantreturns (uint256 reward) {
UserPositionInfo storage positionInfo = userPositionInfos[_tokenId];
if (positionInfo.user !=msg.sender) revert NotOwner();
if (positionInfo.liquidity ==0&& positionInfo.reward ==0) revert NoLiquidity();
reward = harvestOperation(positionInfo, _tokenId, _to);
}
functionharvestOperation(
UserPositionInfo storage positionInfo,
uint256 _tokenId,
address _to
) internalreturns (uint256 reward) {
PoolInfo memory pool = poolInfo[positionInfo.pid];
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (address(LMPool) !=address(0) &&!emergency) {
// Update rewardGrowthInside
LMPool.accumulateReward(uint32(block.timestamp));
uint256 rewardGrowthInside = LMPool.getRewardGrowthInside(positionInfo.tickLower, positionInfo.tickUpper);
// Check overflowif (
rewardGrowthInside > positionInfo.rewardGrowthInside &&
MAX_U256 / (rewardGrowthInside - positionInfo.rewardGrowthInside) > positionInfo.boostLiquidity
) reward = ((rewardGrowthInside - positionInfo.rewardGrowthInside) * positionInfo.boostLiquidity) / Q128;
positionInfo.rewardGrowthInside = rewardGrowthInside;
}
reward += positionInfo.reward;
if (reward >0) {
if (_to !=address(0)) {
positionInfo.reward =0;
_safeTransfer(_to, reward);
emit Harvest(msg.sender, _to, positionInfo.pid, _tokenId, reward);
} else {
positionInfo.reward = reward;
}
}
}
/// @notice Withdraw LP tokens from pool./// @param _tokenId Token Id of NFT to deposit./// @param _to Address to which NFT token to withdraw./// @return reward Cake reward.functionwithdraw(uint256 _tokenId, address _to) externalnonReentrantreturns (uint256 reward) {
if (_to ==address(this) || _to ==address(0)) revert WrongReceiver();
UserPositionInfo storage positionInfo = userPositionInfos[_tokenId];
if (positionInfo.user !=msg.sender) revert NotOwner();
reward = harvestOperation(positionInfo, _tokenId, _to);
uint256 pid = positionInfo.pid;
PoolInfo storage pool = poolInfo[pid];
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (address(LMPool) !=address(0) &&!emergency) {
// Remove all liquidity from liquidity mining pool.int128 liquidityDelta =-int128(positionInfo.boostLiquidity);
LMPool.updatePosition(positionInfo.tickLower, positionInfo.tickUpper, liquidityDelta);
emit UpdateLiquidity(
msg.sender,
pid,
_tokenId,
liquidityDelta,
positionInfo.tickLower,
positionInfo.tickUpper
);
}
pool.totalLiquidity -= positionInfo.liquidity;
pool.totalBoostLiquidity -= positionInfo.boostLiquidity;
delete userPositionInfos[_tokenId];
// Update Enumerable
removeToken(msg.sender, _tokenId);
// Remove boosted token id in farm booster.if (address(FARM_BOOSTER) !=address(0)) FARM_BOOSTER.removeBoostMultiplier(msg.sender, _tokenId, pid);
nonfungiblePositionManager.safeTransferFrom(address(this), _to, _tokenId);
emit Withdraw(msg.sender, _to, pid, _tokenId);
}
/// @notice Update liquidity for the NFT position./// @param _tokenId Token Id of NFT to update.functionupdateLiquidity(uint256 _tokenId) externalnonReentrant{
UserPositionInfo storage positionInfo = userPositionInfos[_tokenId];
if (positionInfo.pid ==0) revert InvalidNFT();
harvestOperation(positionInfo, _tokenId, address(0));
updateLiquidityOperation(positionInfo, _tokenId, 0);
}
/// @notice Update farm boost multiplier for the NFT position./// @param _tokenId Token Id of NFT to update./// @param _newMultiplier New boost multiplier.functionupdateBoostMultiplier(uint256 _tokenId, uint256 _newMultiplier) externalonlyBoostContract{
UserPositionInfo storage positionInfo = userPositionInfos[_tokenId];
if (positionInfo.pid ==0) revert InvalidNFT();
harvestOperation(positionInfo, _tokenId, address(0));
updateLiquidityOperation(positionInfo, _tokenId, _newMultiplier);
}
functionupdateLiquidityOperation(
UserPositionInfo storage positionInfo,
uint256 _tokenId,
uint256 _newMultiplier
) internal{
(, , , , , int24 tickLower, int24 tickUpper, uint128 liquidity, , , , ) = nonfungiblePositionManager.positions(
_tokenId
);
PoolInfo storage pool = poolInfo[positionInfo.pid];
if (positionInfo.liquidity != liquidity) {
pool.totalLiquidity = pool.totalLiquidity - positionInfo.liquidity + liquidity;
positionInfo.liquidity = liquidity;
}
uint256 boostMultiplier = BOOST_PRECISION;
if (address(FARM_BOOSTER) !=address(0) && _newMultiplier ==0) {
// Get the latest boostMultiplier and update boostMultiplier in farm booster.
boostMultiplier = FARM_BOOSTER.updatePositionBoostMultiplier(_tokenId);
} elseif (_newMultiplier !=0) {
// Update boostMultiplier from farm booster call.
boostMultiplier = _newMultiplier;
}
if (boostMultiplier < BOOST_PRECISION) {
boostMultiplier = BOOST_PRECISION;
} elseif (boostMultiplier > MAX_BOOST_PRECISION) {
boostMultiplier = MAX_BOOST_PRECISION;
}
positionInfo.boostMultiplier = boostMultiplier;
uint128 boostLiquidity = ((uint256(liquidity) * boostMultiplier) / BOOST_PRECISION).toUint128();
int128 liquidityDelta =int128(boostLiquidity) -int128(positionInfo.boostLiquidity);
if (liquidityDelta !=0) {
pool.totalBoostLiquidity = pool.totalBoostLiquidity - positionInfo.boostLiquidity + boostLiquidity;
positionInfo.boostLiquidity = boostLiquidity;
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (address(LMPool) ==address(0)) revert NoLMPool();
LMPool.updatePosition(tickLower, tickUpper, liquidityDelta);
emit UpdateLiquidity(msg.sender, positionInfo.pid, _tokenId, liquidityDelta, tickLower, tickUpper);
}
}
/// @notice Increases the amount of liquidity in a position, with tokens paid by the `msg.sender`/// @param params tokenId The ID of the token for which liquidity is being increased,/// amount0Desired The desired amount of token0 to be spent,/// amount1Desired The desired amount of token1 to be spent,/// amount0Min The minimum amount of token0 to spend, which serves as a slippage check,/// amount1Min The minimum amount of token1 to spend, which serves as a slippage check,/// deadline The time by which the transaction must be included to effect the change/// @return liquidity The new liquidity amount as a result of the increase/// @return amount0 The amount of token0 to acheive resulting liquidity/// @return amount1 The amount of token1 to acheive resulting liquidityfunctionincreaseLiquidity(
IncreaseLiquidityParams memory params
) externalpayablenonReentrantreturns (uint128 liquidity, uint256 amount0, uint256 amount1) {
UserPositionInfo storage positionInfo = userPositionInfos[params.tokenId];
if (positionInfo.pid ==0) revert InvalidNFT();
PoolInfo memory pool = poolInfo[positionInfo.pid];
pay(pool.token0, params.amount0Desired);
pay(pool.token1, params.amount1Desired);
if (pool.token0 != WETH && pool.token1 != WETH &&msg.value>0) revert();
(liquidity, amount0, amount1) = nonfungiblePositionManager.increaseLiquidity{value: msg.value}(params);
uint256 token0Left = params.amount0Desired - amount0;
uint256 token1Left = params.amount1Desired - amount1;
if (token0Left >0) {
refund(pool.token0, token0Left);
}
if (token1Left >0) {
refund(pool.token1, token1Left);
}
harvestOperation(positionInfo, params.tokenId, address(0));
updateLiquidityOperation(positionInfo, params.tokenId, 0);
}
/// @notice Pay./// @param _token The token to pay/// @param _amount The amount to payfunctionpay(address _token, uint256 _amount) internal{
if (_token == WETH &&msg.value>0) {
if (msg.value!= _amount) revert InconsistentAmount();
} else {
IERC20(_token).safeTransferFrom(msg.sender, address(this), _amount);
}
}
/// @notice Refund./// @param _token The token to refund/// @param _amount The amount to refundfunctionrefund(address _token, uint256 _amount) internal{
if (_token == WETH &&msg.value>0) {
nonfungiblePositionManager.refundETH();
safeTransferETH(msg.sender, address(this).balance);
} else {
IERC20(_token).safeTransfer(msg.sender, _amount);
}
}
/// @notice Decreases the amount of liquidity in a position and accounts it to the position/// @param params tokenId The ID of the token for which liquidity is being decreased,/// amount The amount by which liquidity will be decreased,/// amount0Min The minimum amount of token0 that should be accounted for the burned liquidity,/// amount1Min The minimum amount of token1 that should be accounted for the burned liquidity,/// deadline The time by which the transaction must be included to effect the change/// @return amount0 The amount of token0 accounted to the position's tokens owed/// @return amount1 The amount of token1 accounted to the position's tokens owedfunctiondecreaseLiquidity(
DecreaseLiquidityParams memory params
) externalnonReentrantreturns (uint256 amount0, uint256 amount1) {
UserPositionInfo storage positionInfo = userPositionInfos[params.tokenId];
if (positionInfo.user !=msg.sender) revert NotOwner();
(amount0, amount1) = nonfungiblePositionManager.decreaseLiquidity(params);
harvestOperation(positionInfo, params.tokenId, address(0));
updateLiquidityOperation(positionInfo, params.tokenId, 0);
}
/// @notice Collects up to a maximum amount of fees owed to a specific position to the recipient/// @param params tokenId The ID of the NFT for which tokens are being collected,/// recipient The account that should receive the tokens,/// @dev Warning!!! Please make sure to use multicall to call unwrapWETH9 or sweepToken when set recipient address(0), or you will lose your funds./// amount0Max The maximum amount of token0 to collect,/// amount1Max The maximum amount of token1 to collect/// @return amount0 The amount of fees collected in token0/// @return amount1 The amount of fees collected in token1functioncollect(CollectParams memory params) externalnonReentrantreturns (uint256 amount0, uint256 amount1) {
UserPositionInfo memory positionInfo = userPositionInfos[params.tokenId];
if (positionInfo.user !=msg.sender) revert NotOwner();
if (params.recipient ==address(0)) params.recipient =address(this);
(amount0, amount1) = nonfungiblePositionManager.collect(params);
}
/// @notice Collects up to a maximum amount of fees owed to a specific position to the recipient, then refund./// @param params CollectParams./// @param to Refund recipent./// @return amount0 The amount of fees collected in token0/// @return amount1 The amount of fees collected in token1functioncollectTo(
CollectParams memory params,
address to
) externalnonReentrantreturns (uint256 amount0, uint256 amount1) {
UserPositionInfo memory positionInfo = userPositionInfos[params.tokenId];
if (positionInfo.user !=msg.sender) revert NotOwner();
if (params.recipient ==address(0)) params.recipient =address(this);
(amount0, amount1) = nonfungiblePositionManager.collect(params);
// Need to refund token to user when recipient is zero addressif (params.recipient ==address(this)) {
PoolInfo memory pool = poolInfo[positionInfo.pid];
if (to ==address(0)) to =msg.sender;
transferToken(pool.token0, to);
transferToken(pool.token1, to);
}
}
/// @notice Transfer token from MasterChef V3./// @param _token The token to transfer./// @param _to The to address.functiontransferToken(address _token, address _to) internal{
uint256 balance = IERC20(_token).balanceOf(address(this));
// Need to reduce cakeAmountBelongToMC.if (_token ==address(CAKE)) {
unchecked {
// In fact balance should always be greater than or equal to cakeAmountBelongToMC, but in order to avoid any unknown issue, we added this check.if (balance >= cakeAmountBelongToMC) {
balance -= cakeAmountBelongToMC;
} else {
// This should never happend.
cakeAmountBelongToMC = balance;
balance =0;
}
}
}
if (balance >0) {
if (_token == WETH) {
IWETH(WETH).withdraw(balance);
safeTransferETH(_to, balance);
} else {
IERC20(_token).safeTransfer(_to, balance);
}
}
}
/// @notice Unwraps the contract's WETH9 balance and sends it to recipient as ETH./// @dev The amountMinimum parameter prevents malicious contracts from stealing WETH9 from users./// @param amountMinimum The minimum amount of WETH9 to unwrap/// @param recipient The address receiving ETHfunctionunwrapWETH9(uint256 amountMinimum, address recipient) externalnonReentrant{
uint256 balanceWETH = IWETH(WETH).balanceOf(address(this));
if (balanceWETH < amountMinimum) revert InsufficientAmount();
if (balanceWETH >0) {
IWETH(WETH).withdraw(balanceWETH);
safeTransferETH(recipient, balanceWETH);
}
}
/// @notice Transfers the full amount of a token held by this contract to recipient/// @dev The amountMinimum parameter prevents malicious contracts from stealing the token from users/// @param token The contract address of the token which will be transferred to `recipient`/// @param amountMinimum The minimum amount of token required for a transfer/// @param recipient The destination address of the tokenfunctionsweepToken(address token, uint256 amountMinimum, address recipient) externalnonReentrant{
uint256 balanceToken = IERC20(token).balanceOf(address(this));
// Need to reduce cakeAmountBelongToMC.if (token ==address(CAKE)) {
unchecked {
// In fact balance should always be greater than or equal to cakeAmountBelongToMC, but in order to avoid any unknown issue, we added this check.if (balanceToken >= cakeAmountBelongToMC) {
balanceToken -= cakeAmountBelongToMC;
} else {
// This should never happend.
cakeAmountBelongToMC = balanceToken;
balanceToken =0;
}
}
}
if (balanceToken < amountMinimum) revert InsufficientAmount();
if (balanceToken >0) {
IERC20(token).safeTransfer(recipient, balanceToken);
}
}
/// @notice Burns a token ID, which deletes it from the NFT contract. The token must have 0 liquidity and all tokens/// must be collected first./// @param _tokenId The ID of the token that is being burnedfunctionburn(uint256 _tokenId) externalnonReentrant{
UserPositionInfo memory positionInfo = userPositionInfos[_tokenId];
if (positionInfo.user !=msg.sender) revert NotOwner();
if (positionInfo.reward >0|| positionInfo.liquidity >0) revert NotEmpty();
delete userPositionInfos[_tokenId];
// Update Enumerable
removeToken(msg.sender, _tokenId);
// Remove boosted token id in farm booster.if (address(FARM_BOOSTER) !=address(0))
FARM_BOOSTER.removeBoostMultiplier(msg.sender, _tokenId, positionInfo.pid);
nonfungiblePositionManager.burn(_tokenId);
emit Withdraw(msg.sender, address(0), positionInfo.pid, _tokenId);
}
/// @notice Upkeep period./// @param _amount The amount of cake injected./// @param _duration The period duration./// @param _withUpdate Whether call "massUpdatePools" operation.functionupkeep(uint256 _amount, uint256 _duration, bool _withUpdate) externalonlyReceiver{
// Transfer cake token from receiver.
CAKE.safeTransferFrom(receiver, address(this), _amount);
// Update cakeAmountBelongToMCunchecked {
cakeAmountBelongToMC += _amount;
}
if (_withUpdate) massUpdatePools();
uint256 duration = PERIOD_DURATION;
// Only use the _duration when _duration is between MIN_DURATION and MAX_DURATION.if (_duration >= MIN_DURATION && _duration <= MAX_DURATION) duration = _duration;
uint256 currentTime =block.timestamp;
uint256 endTime = currentTime + duration;
uint256 cakePerSecond;
uint256 cakeAmount = _amount;
if (latestPeriodEndTime > currentTime) {
uint256 remainingCake = ((latestPeriodEndTime - currentTime) * latestPeriodCakePerSecond) / PRECISION;
emit UpdateUpkeepPeriod(latestPeriodNumber, latestPeriodEndTime, currentTime, remainingCake);
cakeAmount += remainingCake;
}
cakePerSecond = (cakeAmount * PRECISION) / duration;
unchecked {
latestPeriodNumber++;
latestPeriodStartTime = currentTime +1;
latestPeriodEndTime = endTime;
latestPeriodCakePerSecond = cakePerSecond;
}
emit NewUpkeepPeriod(latestPeriodNumber, currentTime +1, endTime, cakePerSecond, cakeAmount);
}
/// @notice Update cake reward for all the liquidity mining pool.functionmassUpdatePools() internal{
uint32 currentTime =uint32(block.timestamp);
for (uint256 pid =1; pid <= poolLength; pid++) {
PoolInfo memory pool = poolInfo[pid];
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (pool.allocPoint !=0&&address(LMPool) !=address(0)) {
LMPool.accumulateReward(currentTime);
}
}
}
/// @notice Update cake reward for the liquidity mining pool./// @dev Avoid too many pools, and a single transaction cannot be fully executed for all pools.functionupdatePools(uint256[] calldata pids) externalonlyOwnerOrOperator{
uint32 currentTime =uint32(block.timestamp);
for (uint256 i =0; i < pids.length; i++) {
PoolInfo memory pool = poolInfo[pids[i]];
ILMPool LMPool = ILMPool(pool.v3Pool.lmPool());
if (pool.allocPoint !=0&&address(LMPool) !=address(0)) {
LMPool.accumulateReward(currentTime);
}
}
}
/// @notice Set operator address./// @dev Callable by owner/// @param _operatorAddress New operator address.functionsetOperator(address _operatorAddress) externalonlyOwner{
if (_operatorAddress ==address(0)) revert ZeroAddress();
operatorAddress = _operatorAddress;
emit NewOperatorAddress(_operatorAddress);
}
/// @notice Set period duration./// @dev Callable by owner/// @param _periodDuration New period duration.functionsetPeriodDuration(uint256 _periodDuration) externalonlyOwner{
if (_periodDuration < MIN_DURATION || _periodDuration > MAX_DURATION) revert InvalidPeriodDuration();
PERIOD_DURATION = _periodDuration;
emit NewPeriodDuration(_periodDuration);
}
/// @notice Update farm boost contract address./// @param _newFarmBoostContract The new farm booster address.functionupdateFarmBoostContract(address _newFarmBoostContract) externalonlyOwner{
// farm booster can be zero address when need to remove farm booster
FARM_BOOSTER = IFarmBooster(_newFarmBoostContract);
emit UpdateFarmBoostContract(_newFarmBoostContract);
}
/**
* @notice Transfer ETH in a safe way
* @param to: address to transfer ETH to
* @param value: ETH amount to transfer (in wei)
*/functionsafeTransferETH(address to, uint256 value) internal{
(bool success, ) = to.call{value: value}("");
if (!success) revert();
}
/// @notice Safe Transfer CAKE./// @param _to The CAKE receiver address./// @param _amount Transfer CAKE amounts.function_safeTransfer(address _to, uint256 _amount) internal{
if (_amount >0) {
uint256 balance = CAKE.balanceOf(address(this));
if (balance < _amount) {
_amount = balance;
}
// Update cakeAmountBelongToMCunchecked {
if (cakeAmountBelongToMC >= _amount) {
cakeAmountBelongToMC -= _amount;
} else {
cakeAmountBelongToMC = balance - _amount;
}
}
CAKE.safeTransfer(_to, _amount);
}
}
receive() externalpayable{
if (msg.sender!=address(nonfungiblePositionManager) &&msg.sender!= WETH) revert();
}
}
Contract Source Code
File 16 of 21: Multicall.sol
// SPDX-License-Identifier: GPL-2.0-or-laterpragmasolidity ^0.8.10;/// @title Multicall/// @notice Enables calling multiple methods in a single call to the contractcontractMulticall{
functionmulticall(bytes[] calldata data) publicpayablereturns (bytes[] memory results) {
results =newbytes[](data.length);
for (uint256 i =0; i < data.length; i++) {
(bool success, bytesmemory result) =address(this).delegatecall(data[i]);
if (!success) {
// Next 5 lines from https://ethereum.stackexchange.com/a/83577if (result.length<68) revert();
assembly {
result :=add(result, 0x04)
}
revert(abi.decode(result, (string)));
}
results[i] = result;
}
}
}
Contract Source Code
File 17 of 21: Ownable.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol)pragmasolidity ^0.8.0;import"../utils/Context.sol";
/**
* @dev Contract module which provides a basic access control mechanism, where
* there is an account (an owner) that can be granted exclusive access to
* specific functions.
*
* By default, the owner account will be the one that deploys the contract. This
* can later be changed with {transferOwnership}.
*
* This module is used through inheritance. It will make available the modifier
* `onlyOwner`, which can be applied to your functions to restrict their use to
* the owner.
*/abstractcontractOwnableisContext{
addressprivate _owner;
eventOwnershipTransferred(addressindexed previousOwner, addressindexed newOwner);
/**
* @dev Initializes the contract setting the deployer as the initial owner.
*/constructor() {
_transferOwnership(_msgSender());
}
/**
* @dev Throws if called by any account other than the owner.
*/modifieronlyOwner() {
_checkOwner();
_;
}
/**
* @dev Returns the address of the current owner.
*/functionowner() publicviewvirtualreturns (address) {
return _owner;
}
/**
* @dev Throws if the sender is not the owner.
*/function_checkOwner() internalviewvirtual{
require(owner() == _msgSender(), "Ownable: caller is not the owner");
}
/**
* @dev Leaves the contract without owner. It will not be possible to call
* `onlyOwner` functions anymore. Can only be called by the current owner.
*
* NOTE: Renouncing ownership will leave the contract without an owner,
* thereby removing any functionality that is only available to the owner.
*/functionrenounceOwnership() publicvirtualonlyOwner{
_transferOwnership(address(0));
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Can only be called by the current owner.
*/functiontransferOwnership(address newOwner) publicvirtualonlyOwner{
require(newOwner !=address(0), "Ownable: new owner is the zero address");
_transferOwnership(newOwner);
}
/**
* @dev Transfers ownership of the contract to a new account (`newOwner`).
* Internal function without access restriction.
*/function_transferOwnership(address newOwner) internalvirtual{
address oldOwner = _owner;
_owner = newOwner;
emit OwnershipTransferred(oldOwner, newOwner);
}
}
Contract Source Code
File 18 of 21: ReentrancyGuard.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol)pragmasolidity ^0.8.0;/**
* @dev Contract module that helps prevent reentrant calls to a function.
*
* Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier
* available, which can be applied to functions to make sure there are no nested
* (reentrant) calls to them.
*
* Note that because there is a single `nonReentrant` guard, functions marked as
* `nonReentrant` may not call one another. This can be worked around by making
* those functions `private`, and then adding `external` `nonReentrant` entry
* points to them.
*
* TIP: If you would like to learn more about reentrancy and alternative ways
* to protect against it, check out our blog post
* https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul].
*/abstractcontractReentrancyGuard{
// Booleans are more expensive than uint256 or any type that takes up a full// word because each write operation emits an extra SLOAD to first read the// slot's contents, replace the bits taken up by the boolean, and then write// back. This is the compiler's defense against contract upgrades and// pointer aliasing, and it cannot be disabled.// The values being non-zero value makes deployment a bit more expensive,// but in exchange the refund on every call to nonReentrant will be lower in// amount. Since refunds are capped to a percentage of the total// transaction's gas, it is best to keep them low in cases like this one, to// increase the likelihood of the full refund coming into effect.uint256privateconstant _NOT_ENTERED =1;
uint256privateconstant _ENTERED =2;
uint256private _status;
constructor() {
_status = _NOT_ENTERED;
}
/**
* @dev Prevents a contract from calling itself, directly or indirectly.
* Calling a `nonReentrant` function from another `nonReentrant`
* function is not supported. It is possible to prevent this from happening
* by making the `nonReentrant` function external, and making it call a
* `private` function that does the actual work.
*/modifiernonReentrant() {
_nonReentrantBefore();
_;
_nonReentrantAfter();
}
function_nonReentrantBefore() private{
// On the first call to nonReentrant, _status will be _NOT_ENTEREDrequire(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
}
function_nonReentrantAfter() private{
// By storing the original value once again, a refund is triggered (see// https://eips.ethereum.org/EIPS/eip-2200)
_status = _NOT_ENTERED;
}
}
Contract Source Code
File 19 of 21: SafeCast.sol
// SPDX-License-Identifier: MITpragmasolidity ^0.8.10;/**
* @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow
* checks.
*
* Downcasting from uint256/int256 in Solidity does not revert on overflow. This can
* easily result in undesired exploitation or bugs, since developers usually
* assume that overflows raise errors. `SafeCast` restores this intuition by
* reverting the transaction when such an operation overflows.
*
* Using this library instead of the unchecked operations eliminates an entire
* class of bugs, so it's recommended to use it always.
*
* Can be combined with {SafeMath} and {SignedSafeMath} to extend it to smaller types, by performing
* all math on `uint256` and `int256` and then downcasting.
*/librarySafeCast{
/**
* @dev Returns the downcasted uint128 from uint256, reverting on
* overflow (when the input is greater than largest uint128).
*
* Counterpart to Solidity's `uint128` operator.
*
* Requirements:
*
* - input must fit into 128 bits
*/functiontoUint128(uint256 value) internalpurereturns (uint128) {
require(value <2**128, "SafeCast: value doesn't fit in 128 bits");
returnuint128(value);
}
}
Contract Source Code
File 20 of 21: SafeERC20.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol)pragmasolidity ^0.8.0;import"../IERC20.sol";
import"../extensions/draft-IERC20Permit.sol";
import"../../../utils/Address.sol";
/**
* @title SafeERC20
* @dev Wrappers around ERC20 operations that throw on failure (when the token
* contract returns false). Tokens that return no value (and instead revert or
* throw on failure) are also supported, non-reverting calls are assumed to be
* successful.
* To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,
* which allows you to call the safe operations as `token.safeTransfer(...)`, etc.
*/librarySafeERC20{
usingAddressforaddress;
functionsafeTransfer(
IERC20 token,
address to,
uint256 value
) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));
}
functionsafeTransferFrom(
IERC20 token,
addressfrom,
address to,
uint256 value
) internal{
_callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));
}
/**
* @dev Deprecated. This function has issues similar to the ones found in
* {IERC20-approve}, and its usage is discouraged.
*
* Whenever possible, use {safeIncreaseAllowance} and
* {safeDecreaseAllowance} instead.
*/functionsafeApprove(
IERC20 token,
address spender,
uint256 value
) internal{
// safeApprove should only be called when setting an initial allowance,// or when resetting it to zero. To increase and decrease it, use// 'safeIncreaseAllowance' and 'safeDecreaseAllowance'require(
(value ==0) || (token.allowance(address(this), spender) ==0),
"SafeERC20: approve from non-zero to non-zero allowance"
);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));
}
functionsafeIncreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal{
uint256 newAllowance = token.allowance(address(this), spender) + value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
functionsafeDecreaseAllowance(
IERC20 token,
address spender,
uint256 value
) internal{
unchecked {
uint256 oldAllowance = token.allowance(address(this), spender);
require(oldAllowance >= value, "SafeERC20: decreased allowance below zero");
uint256 newAllowance = oldAllowance - value;
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
}
functionsafePermit(
IERC20Permit token,
address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) internal{
uint256 nonceBefore = token.nonces(owner);
token.permit(owner, spender, value, deadline, v, r, s);
uint256 nonceAfter = token.nonces(owner);
require(nonceAfter == nonceBefore +1, "SafeERC20: permit did not succeed");
}
/**
* @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement
* on the return value: the return value is optional (but if data is returned, it must not be false).
* @param token The token targeted by the call.
* @param data The call data (encoded using abi.encode or one of its variants).
*/function_callOptionalReturn(IERC20 token, bytesmemory data) private{
// We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since// we're implementing it ourselves. We use {Address-functionCall} to perform this call, which verifies that// the target address contains contract code and also asserts for success in the low-level call.bytesmemory returndata =address(token).functionCall(data, "SafeERC20: low-level call failed");
if (returndata.length>0) {
// Return data is optionalrequire(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
Contract Source Code
File 21 of 21: draft-IERC20Permit.sol
// SPDX-License-Identifier: MIT// OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol)pragmasolidity ^0.8.0;/**
* @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in
* https://eips.ethereum.org/EIPS/eip-2612[EIP-2612].
*
* Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by
* presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't
* need to send a transaction, and thus is not required to hold Ether at all.
*/interfaceIERC20Permit{
/**
* @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens,
* given ``owner``'s signed approval.
*
* IMPORTANT: The same issues {IERC20-approve} has related to transaction
* ordering also apply here.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `deadline` must be a timestamp in the future.
* - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner`
* over the EIP712-formatted function arguments.
* - the signature must use ``owner``'s current nonce (see {nonces}).
*
* For more information on the signature format, see the
* https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP
* section].
*/functionpermit(address owner,
address spender,
uint256 value,
uint256 deadline,
uint8 v,
bytes32 r,
bytes32 s
) external;
/**
* @dev Returns the current nonce for `owner`. This value must be
* included whenever a signature is generated for {permit}.
*
* Every successful call to {permit} increases ``owner``'s nonce by one. This
* prevents a signature from being used multiple times.
*/functionnonces(address owner) externalviewreturns (uint256);
/**
* @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}.
*/// solhint-disable-next-line func-name-mixedcasefunctionDOMAIN_SEPARATOR() externalviewreturns (bytes32);
}