Overview
S Balance
0 S
S Value
-More Info
Private Name Tags
ContractCreator
Loading...
Loading
Contract Name:
LBHooksLens
Compiler Version
v0.8.20+commit.a1b79de6
Optimization Enabled:
Yes with 600 runs
Other Settings:
paris EvmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol"; import {ILBPair} from "@lb-protocol/src/interfaces/ILBPair.sol"; import {Hooks, ILBHooks} from "@lb-protocol/src/libraries/Hooks.sol"; import {ILBHooksManager} from "lb-rewarder/interfaces/ILBHooksManager.sol"; import {ILBHooksBaseParentRewarder} from "lb-rewarder/interfaces/ILBHooksBaseParentRewarder.sol"; import {ILBHooksBaseRewarder} from "lb-rewarder/interfaces/ILBHooksBaseRewarder.sol"; import {ILBHooksExtraRewarder} from "lb-rewarder/interfaces/ILBHooksExtraRewarder.sol"; import {IMasterChef, IMasterChefRewarder} from "./interfaces/IMasterChef_flat.sol"; import {ILBHooksMCRewarder} from "./interfaces/ILBHooksMCRewarder.sol"; contract LBHooksLens { struct HooksRewarderData { Hooks.Parameters hooksParameters; Parameters parameters; uint256 activeId; } struct Parameters { ILBHooksManager.LBHooksType hooksType; Token rewardToken; uint256 pid; uint256 moePerSecond; uint256 activeId; uint256 rangeStart; uint256 rangeEnd; uint256 pendingRewards; uint256 rewardPerSecond; uint256 lastUpdateTimestamp; uint256 endTimestamp; uint256 remainingRewards; bool isStarted; bool isEnded; } struct Token { address token; uint256 decimals; string symbol; } ILBHooksManager internal immutable _lbHooksManager; IMasterChef internal immutable _masterChef; constructor(address lbHooksManager, address masterChef) { _lbHooksManager = ILBHooksManager(lbHooksManager); _masterChef = IMasterChef(masterChef); } function getHooks(address pair) public view returns (Hooks.Parameters memory) { if (msg.sender == address(this)) { bytes32 hooksParameters = ILBPair(pair).getLBHooksParameters(); return Hooks.decode(hooksParameters); } else { try this.getHooks(pair) returns (Hooks.Parameters memory hooksParameters) { return hooksParameters; } catch { return Hooks.Parameters(address(0), false, false, false, false, false, false, false, false, false, false); } } } function getExtraHooks(address rewarder) public view returns (Hooks.Parameters memory) { if (msg.sender == address(this)) { bytes32 hooksParameters = ILBHooksBaseParentRewarder(rewarder).getExtraHooksParameters(); return Hooks.decode(hooksParameters); } else { try this.getExtraHooks(rewarder) returns (Hooks.Parameters memory hooksParameters) { return hooksParameters; } catch { return Hooks.Parameters(address(0), false, false, false, false, false, false, false, false, false, false); } } } function getRewardToken(address rewarder) public view returns (Token memory rewardToken) { if (msg.sender == address(this)) { address token = address(ILBHooksBaseParentRewarder(rewarder).getRewardToken()); rewardToken.token = token; if (token != address(0)) { rewardToken.decimals = IERC20Metadata(token).decimals(); rewardToken.symbol = IERC20Metadata(token).symbol(); } else { rewardToken.decimals = 18; rewardToken.symbol = "S"; } } else { try this.getRewardToken(rewarder) returns (Token memory r) { return r; } catch { return Token(address(0), 0, ""); } } } function getPid(address rewarder) public view returns (uint256) { if (msg.sender == address(this)) { return ILBHooksMCRewarder(rewarder).getPid(); } else { try this.getPid(rewarder) returns (uint256 pid) { return pid; } catch { return 0; } } } function getRewardedRange(address rewarder) public view returns (uint256, uint256) { if (msg.sender == address(this)) { return ILBHooksBaseParentRewarder(rewarder).getRewardedRange(); } else { try this.getRewardedRange(rewarder) returns (uint256 rangeStart, uint256 rangeEnd) { return (rangeStart, rangeEnd); } catch { return (0, 0); } } } function getActiveId(address pair) public view returns (uint256) { if (msg.sender == address(this)) { return ILBPair(pair).getActiveId(); } else { try this.getActiveId(pair) returns (uint256 activeId) { return activeId; } catch { return 0; } } } function getPendingRewards(address rewarder, address account, uint256[] calldata ids) public view returns (uint256) { if (msg.sender == address(this)) { return ILBHooksBaseRewarder(rewarder).getPendingRewards(account, ids); } else { try this.getPendingRewards(rewarder, account, ids) returns (uint256 pendingReward) { return pendingReward; } catch { return 0; } } } function getLBHooksType(address rewarder) public view returns (ILBHooksManager.LBHooksType) { return _lbHooksManager.getLBHooksType(ILBHooks(rewarder)); } function getMetroPerSecond(uint256 pid) public view returns (uint256) { return _masterChef.getMetroPerSecondForPid(pid); } function getRewarderParameter(address extraRewarder) public view returns (uint256, uint256, uint256) { if (msg.sender == address(this)) { return ILBHooksExtraRewarder(extraRewarder).getRewarderParameter(); } else { try this.getRewarderParameter(extraRewarder) returns ( uint256 rewardPerSecond, uint256 lastUpdateTimestamp, uint256 endTimestamp ) { return (rewardPerSecond, lastUpdateTimestamp, endTimestamp); } catch { return (0, 0, 0); } } } function getRemainingRewards(address extraRewarder) public view returns (uint256) { if (msg.sender == address(this)) { return ILBHooksExtraRewarder(extraRewarder).getRemainingRewards(); } else { try this.getRemainingRewards(extraRewarder) returns (uint256 remainingRewards) { return remainingRewards; } catch { return 0; } } } function getParametersOf(address hooks, address user, uint256[] calldata ids) public view returns (Parameters memory parameters) { if (hooks != address(0)) { parameters.hooksType = getLBHooksType(hooks); parameters.rewardToken = getRewardToken(hooks); (parameters.rangeStart, parameters.rangeEnd) = getRewardedRange(hooks); if (parameters.hooksType == ILBHooksManager.LBHooksType.MCRewarder) { parameters.pid = getPid(hooks); parameters.moePerSecond = getMetroPerSecond(parameters.pid); } else { (parameters.rewardPerSecond, parameters.lastUpdateTimestamp, parameters.endTimestamp) = getRewarderParameter(hooks); parameters.remainingRewards = getRemainingRewards(hooks); parameters.isStarted = block.timestamp >= parameters.lastUpdateTimestamp; parameters.isEnded = block.timestamp >= parameters.endTimestamp; } if (user != address(0)) parameters.pendingRewards = getPendingRewards(hooks, user, ids); } } function getHooksData(address pair, address user, uint256[] calldata ids) public view returns (HooksRewarderData memory rewarderData, HooksRewarderData memory extraRewarderData) { rewarderData.hooksParameters = getHooks(pair); rewarderData.parameters = getParametersOf(rewarderData.hooksParameters.hooks, user, ids); rewarderData.activeId = getActiveId(pair); extraRewarderData.hooksParameters = getExtraHooks(rewarderData.hooksParameters.hooks); extraRewarderData.parameters = getParametersOf(extraRewarderData.hooksParameters.hooks, user, ids); extraRewarderData.activeId = rewarderData.activeId; } function getBatchHooksData(address[] calldata pairs, address user, uint256[][] calldata ids) public view returns (HooksRewarderData[] memory rewarderData, HooksRewarderData[] memory extraRewarderData) { rewarderData = new HooksRewarderData[](pairs.length); extraRewarderData = new HooksRewarderData[](pairs.length); for (uint256 i = 0; i < pairs.length; i++) { (rewarderData[i], extraRewarderData[i]) = getHooksData(pairs[i], user, ids[i]); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/extensions/IERC20Metadata.sol) pragma solidity ^0.8.20; import {IERC20} from "../IERC20.sol"; /** * @dev Interface for the optional metadata functions from the ERC-20 standard. */ interface IERC20Metadata is IERC20 { /** * @dev Returns the name of the token. */ function name() external view returns (string memory); /** * @dev Returns the symbol of the token. */ function symbol() external view returns (string memory); /** * @dev Returns the decimals places of the token. */ function decimals() external view returns (uint8); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import {Hooks} from "../libraries/Hooks.sol"; import {ILBFactory} from "./ILBFactory.sol"; import {ILBFlashLoanCallback} from "./ILBFlashLoanCallback.sol"; import {ILBToken} from "./ILBToken.sol"; interface ILBPair is ILBToken { error LBPair__ZeroBorrowAmount(); error LBPair__AddressZero(); error LBPair__EmptyMarketConfigs(); error LBPair__FlashLoanCallbackFailed(); error LBPair__FlashLoanInsufficientAmount(); error LBPair__InsufficientAmountIn(); error LBPair__InsufficientAmountOut(); error LBPair__InvalidInput(); error LBPair__InvalidStaticFeeParameters(); error LBPair__OnlyFactory(); error LBPair__OnlyProtocolFeeRecipient(); error LBPair__OutOfLiquidity(); error LBPair__TokenNotSupported(); error LBPair__ZeroAmount(uint24 id); error LBPair__ZeroAmountsOut(uint24 id); error LBPair__ZeroShares(uint24 id); error LBPair__MaxTotalFeeExceeded(); error LBPair__InvalidHooks(); struct MintArrays { uint256[] ids; bytes32[] amounts; uint256[] liquidityMinted; } event DepositedToBins(address indexed sender, address indexed to, uint256[] ids, bytes32[] amounts); event WithdrawnFromBins(address indexed sender, address indexed to, uint256[] ids, bytes32[] amounts); event CompositionFees(address indexed sender, uint24 id, bytes32 totalFees, bytes32 protocolFees); event CollectedProtocolFees(address indexed feeRecipient, bytes32 protocolFees); event Swap( address indexed sender, address indexed to, uint24 id, bytes32 amountsIn, bytes32 amountsOut, uint24 volatilityAccumulator, bytes32 totalFees, bytes32 protocolFees ); event StaticFeeParametersSet( address indexed sender, uint16 baseFactor, uint16 filterPeriod, uint16 decayPeriod, uint16 reductionFactor, uint24 variableFeeControl, uint16 protocolShare, uint24 maxVolatilityAccumulator ); event HooksParametersSet(address indexed sender, bytes32 hooksParameters); event FlashLoan( address indexed sender, ILBFlashLoanCallback indexed receiver, uint24 activeId, bytes32 amounts, bytes32 totalFees, bytes32 protocolFees ); event OracleLengthIncreased(address indexed sender, uint16 oracleLength); event ForcedDecay(address indexed sender, uint24 idReference, uint24 volatilityReference); function initialize( uint16 baseFactor, uint16 filterPeriod, uint16 decayPeriod, uint16 reductionFactor, uint24 variableFeeControl, uint16 protocolShare, uint24 maxVolatilityAccumulator, uint24 activeId ) external; function implementation() external view returns (address); function getFactory() external view returns (ILBFactory factory); function getTokenX() external view returns (IERC20 tokenX); function getTokenY() external view returns (IERC20 tokenY); function getBinStep() external view returns (uint16 binStep); function getReserves() external view returns (uint128 reserveX, uint128 reserveY); function getActiveId() external view returns (uint24 activeId); function getBin(uint24 id) external view returns (uint128 binReserveX, uint128 binReserveY); function getNextNonEmptyBin(bool swapForY, uint24 id) external view returns (uint24 nextId); function getProtocolFees() external view returns (uint128 protocolFeeX, uint128 protocolFeeY); function getStaticFeeParameters() external view returns ( uint16 baseFactor, uint16 filterPeriod, uint16 decayPeriod, uint16 reductionFactor, uint24 variableFeeControl, uint16 protocolShare, uint24 maxVolatilityAccumulator ); function getLBHooksParameters() external view returns (bytes32 hooksParameters); function getVariableFeeParameters() external view returns (uint24 volatilityAccumulator, uint24 volatilityReference, uint24 idReference, uint40 timeOfLastUpdate); function getOracleParameters() external view returns (uint8 sampleLifetime, uint16 size, uint16 activeSize, uint40 lastUpdated, uint40 firstTimestamp); function getOracleSampleAt(uint40 lookupTimestamp) external view returns (uint64 cumulativeId, uint64 cumulativeVolatility, uint64 cumulativeBinCrossed); function getPriceFromId(uint24 id) external view returns (uint256 price); function getIdFromPrice(uint256 price) external view returns (uint24 id); function getSwapIn(uint128 amountOut, bool swapForY) external view returns (uint128 amountIn, uint128 amountOutLeft, uint128 fee); function getSwapOut(uint128 amountIn, bool swapForY) external view returns (uint128 amountInLeft, uint128 amountOut, uint128 fee); function swap(bool swapForY, address to) external returns (bytes32 amountsOut); function flashLoan(ILBFlashLoanCallback receiver, bytes32 amounts, bytes calldata data) external; function mint(address to, bytes32[] calldata liquidityConfigs, address refundTo) external returns (bytes32 amountsReceived, bytes32 amountsLeft, uint256[] memory liquidityMinted); function burn(address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn) external returns (bytes32[] memory amounts); function collectProtocolFees() external returns (bytes32 collectedProtocolFees); function increaseOracleLength(uint16 newLength) external; function setStaticFeeParameters( uint16 baseFactor, uint16 filterPeriod, uint16 decayPeriod, uint16 reductionFactor, uint24 variableFeeControl, uint16 protocolShare, uint24 maxVolatilityAccumulator ) external; function setHooksParameters(bytes32 hooksParameters, bytes calldata onHooksSetData) external; function forceDecay() external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {ILBHooks} from "../interfaces/ILBHooks.sol"; /** * @title Hooks library * @notice This library contains functions that should be used to interact with hooks */ library Hooks { error Hooks__CallFailed(); bytes32 internal constant BEFORE_SWAP_FLAG = bytes32(uint256(1 << 160)); bytes32 internal constant AFTER_SWAP_FLAG = bytes32(uint256(1 << 161)); bytes32 internal constant BEFORE_FLASH_LOAN_FLAG = bytes32(uint256(1 << 162)); bytes32 internal constant AFTER_FLASH_LOAN_FLAG = bytes32(uint256(1 << 163)); bytes32 internal constant BEFORE_MINT_FLAG = bytes32(uint256(1 << 164)); bytes32 internal constant AFTER_MINT_FLAG = bytes32(uint256(1 << 165)); bytes32 internal constant BEFORE_BURN_FLAG = bytes32(uint256(1 << 166)); bytes32 internal constant AFTER_BURN_FLAG = bytes32(uint256(1 << 167)); bytes32 internal constant BEFORE_TRANSFER_FLAG = bytes32(uint256(1 << 168)); bytes32 internal constant AFTER_TRANSFER_FLAG = bytes32(uint256(1 << 169)); struct Parameters { address hooks; bool beforeSwap; bool afterSwap; bool beforeFlashLoan; bool afterFlashLoan; bool beforeMint; bool afterMint; bool beforeBurn; bool afterBurn; bool beforeBatchTransferFrom; bool afterBatchTransferFrom; } /** * @dev Helper function to encode the hooks parameters to a single bytes32 value * @param parameters The hooks parameters * @return hooksParameters The encoded hooks parameters */ function encode(Parameters memory parameters) internal pure returns (bytes32 hooksParameters) { hooksParameters = bytes32(uint256(uint160(address(parameters.hooks)))); if (parameters.beforeSwap) hooksParameters |= BEFORE_SWAP_FLAG; if (parameters.afterSwap) hooksParameters |= AFTER_SWAP_FLAG; if (parameters.beforeFlashLoan) hooksParameters |= BEFORE_FLASH_LOAN_FLAG; if (parameters.afterFlashLoan) hooksParameters |= AFTER_FLASH_LOAN_FLAG; if (parameters.beforeMint) hooksParameters |= BEFORE_MINT_FLAG; if (parameters.afterMint) hooksParameters |= AFTER_MINT_FLAG; if (parameters.beforeBurn) hooksParameters |= BEFORE_BURN_FLAG; if (parameters.afterBurn) hooksParameters |= AFTER_BURN_FLAG; if (parameters.beforeBatchTransferFrom) hooksParameters |= BEFORE_TRANSFER_FLAG; if (parameters.afterBatchTransferFrom) hooksParameters |= AFTER_TRANSFER_FLAG; } /** * @dev Helper function to decode the hooks parameters from a single bytes32 value * @param hooksParameters The encoded hooks parameters * @return parameters The hooks parameters */ function decode(bytes32 hooksParameters) internal pure returns (Parameters memory parameters) { parameters.hooks = getHooks(hooksParameters); parameters.beforeSwap = (hooksParameters & BEFORE_SWAP_FLAG) != 0; parameters.afterSwap = (hooksParameters & AFTER_SWAP_FLAG) != 0; parameters.beforeFlashLoan = (hooksParameters & BEFORE_FLASH_LOAN_FLAG) != 0; parameters.afterFlashLoan = (hooksParameters & AFTER_FLASH_LOAN_FLAG) != 0; parameters.beforeMint = (hooksParameters & BEFORE_MINT_FLAG) != 0; parameters.afterMint = (hooksParameters & AFTER_MINT_FLAG) != 0; parameters.beforeBurn = (hooksParameters & BEFORE_BURN_FLAG) != 0; parameters.afterBurn = (hooksParameters & AFTER_BURN_FLAG) != 0; parameters.beforeBatchTransferFrom = (hooksParameters & BEFORE_TRANSFER_FLAG) != 0; parameters.afterBatchTransferFrom = (hooksParameters & AFTER_TRANSFER_FLAG) != 0; } /** * @dev Helper function to get the hooks address from the encoded hooks parameters * @param hooksParameters The encoded hooks parameters * @return hooks The hooks address */ function getHooks(bytes32 hooksParameters) internal pure returns (address hooks) { hooks = address(uint160(uint256(hooksParameters))); } /** * @dev Helper function to set the hooks address in the encoded hooks parameters * @param hooksParameters The encoded hooks parameters * @param newHooks The new hooks address * @return hooksParameters The updated hooks parameters */ function setHooks(bytes32 hooksParameters, address newHooks) internal pure returns (bytes32) { return bytes32(bytes12(hooksParameters)) | bytes32(uint256(uint160(newHooks))); } /** * @dev Helper function to get the flags from the encoded hooks parameters * @param hooksParameters The encoded hooks parameters * @return flags The flags */ function getFlags(bytes32 hooksParameters) internal pure returns (bytes12 flags) { flags = bytes12(hooksParameters); } /** * @dev Helper function call the onHooksSet function on the hooks contract, only if the * hooksParameters is not 0 * @param hooksParameters The encoded hooks parameters * @param onHooksSetData The data to pass to the onHooksSet function */ function onHooksSet(bytes32 hooksParameters, bytes calldata onHooksSetData) internal { if (hooksParameters != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.onHooksSet.selector, hooksParameters, onHooksSetData) ); } } /** * @dev Helper function to call the beforeSwap function on the hooks contract, only if the * BEFORE_SWAP_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param to The recipient * @param swapForY Whether the swap is for Y * @param amountsIn The amounts in */ function beforeSwap(bytes32 hooksParameters, address sender, address to, bool swapForY, bytes32 amountsIn) internal { if ((hooksParameters & BEFORE_SWAP_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.beforeSwap.selector, sender, to, swapForY, amountsIn) ); } } /** * @dev Helper function to call the afterSwap function on the hooks contract, only if the * AFTER_SWAP_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param to The recipient * @param swapForY Whether the swap is for Y * @param amountsOut The amounts out */ function afterSwap(bytes32 hooksParameters, address sender, address to, bool swapForY, bytes32 amountsOut) internal { if ((hooksParameters & AFTER_SWAP_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.afterSwap.selector, sender, to, swapForY, amountsOut) ); } } /** * @dev Helper function to call the beforeFlashLoan function on the hooks contract, only if the * BEFORE_FLASH_LOAN_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param to The recipient * @param amounts The amounts */ function beforeFlashLoan(bytes32 hooksParameters, address sender, address to, bytes32 amounts) internal { if ((hooksParameters & BEFORE_FLASH_LOAN_FLAG) != 0) { _safeCall(hooksParameters, abi.encodeWithSelector(ILBHooks.beforeFlashLoan.selector, sender, to, amounts)); } } /** * @dev Helper function to call the afterFlashLoan function on the hooks contract, only if the * AFTER_FLASH_LOAN_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param to The recipient * @param fees The fees * @param feesReceived The fees received */ function afterFlashLoan(bytes32 hooksParameters, address sender, address to, bytes32 fees, bytes32 feesReceived) internal { if ((hooksParameters & AFTER_FLASH_LOAN_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.afterFlashLoan.selector, sender, to, fees, feesReceived) ); } } /** * @dev Helper function to call the beforeMint function on the hooks contract, only if the * BEFORE_MINT_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param to The recipient * @param liquidityConfigs The liquidity configs * @param amountsReceived The amounts received */ function beforeMint( bytes32 hooksParameters, address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsReceived ) internal { if ((hooksParameters & BEFORE_MINT_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.beforeMint.selector, sender, to, liquidityConfigs, amountsReceived) ); } } /** * @dev Helper function to call the afterMint function on the hooks contract, only if the * AFTER_MINT_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param to The recipient * @param liquidityConfigs The liquidity configs * @param amountsIn The amounts in */ function afterMint( bytes32 hooksParameters, address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsIn ) internal { if ((hooksParameters & AFTER_MINT_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.afterMint.selector, sender, to, liquidityConfigs, amountsIn) ); } } /** * @dev Helper function to call the beforeBurn function on the hooks contract, only if the * BEFORE_BURN_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param from The sender * @param to The recipient * @param ids The ids * @param amountsToBurn The amounts to burn */ function beforeBurn( bytes32 hooksParameters, address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) internal { if ((hooksParameters & BEFORE_BURN_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.beforeBurn.selector, sender, from, to, ids, amountsToBurn) ); } } /** * @dev Helper function to call the afterBurn function on the hooks contract, only if the * AFTER_BURN_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param from The sender * @param to The recipient * @param ids The ids * @param amountsToBurn The amounts to burn */ function afterBurn( bytes32 hooksParameters, address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) internal { if ((hooksParameters & AFTER_BURN_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.afterBurn.selector, sender, from, to, ids, amountsToBurn) ); } } /** * @dev Helper function to call the beforeTransferFrom function on the hooks contract, only if the * BEFORE_TRANSFER_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param from The sender * @param to The recipient * @param ids The list of ids * @param amounts The list of amounts */ function beforeBatchTransferFrom( bytes32 hooksParameters, address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) internal { if ((hooksParameters & BEFORE_TRANSFER_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.beforeBatchTransferFrom.selector, sender, from, to, ids, amounts) ); } } /** * @dev Helper function to call the afterTransferFrom function on the hooks contract, only if the * AFTER_TRANSFER_FLAG is set in the hooksParameters * @param hooksParameters The encoded hooks parameters * @param sender The sender * @param from The sender * @param to The recipient * @param ids The list of ids * @param amounts The list of amounts */ function afterBatchTransferFrom( bytes32 hooksParameters, address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) internal { if ((hooksParameters & AFTER_TRANSFER_FLAG) != 0) { _safeCall( hooksParameters, abi.encodeWithSelector(ILBHooks.afterBatchTransferFrom.selector, sender, from, to, ids, amounts) ); } } /** * @dev Helper function to call the hooks contract and verify the call was successful * by matching the expected selector with the returned data * @param hooksParameters The encoded hooks parameters * @param data The data to pass to the hooks contract */ function _safeCall(bytes32 hooksParameters, bytes memory data) private { bool success; address hooks = getHooks(hooksParameters); assembly { let expectedSelector := shr(224, mload(add(data, 0x20))) success := call(gas(), hooks, 0, add(data, 0x20), mload(data), 0, 0x20) if and(iszero(success), iszero(iszero(returndatasize()))) { returndatacopy(0, 0, returndatasize()) revert(0, returndatasize()) } success := and(success, and(gt(returndatasize(), 0x1f), eq(shr(224, mload(0)), expectedSelector))) } if (!success) revert Hooks__CallFailed(); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import {ILBHooks} from "@lb-protocol/src/interfaces/ILBHooks.sol"; /** * @title LB Hooks Manager Interface * @dev Interface for the LB Hooks Manager */ interface ILBHooksManager { error LBHooksManager__InvalidLBHooksType(); error LBHooksManager__LBHooksParametersNotSet(); error LBHooksManager__LBPairNotFound(); error LBHooksManager__LBHooksNotSetOnPair(); error LBHooksManager__UnorderedTokens(); enum LBHooksType { Invalid, MCRewarder, ExtraRewarder, SimpleRewarder } event HooksParametersSet(LBHooksType lbHooksType, bytes32 hooksParameters); event HooksCreated(LBHooksType lbHooksType, uint256 id, ILBHooks hooks); function getLBHooksParameters(LBHooksType lbHooksType) external view returns (bytes32 hooksParameters); function getHooksAt(LBHooksType lbHooksType, uint256 index) external view returns (ILBHooks hooks); function getHooksLength(LBHooksType lbHooksType) external view returns (uint256 length); function getLBHooksType(ILBHooks hooks) external view returns (LBHooksType lbHooksType); function setLBHooksParameters(LBHooksType lbHooksType, bytes32 hooksParameters) external; function createLBHooksMCRewarder(IERC20 tokenX, IERC20 tokenY, uint16 binStep, address initialOwner) external returns (address); function createLBHooksSimpleRewarder( IERC20 tokenX, IERC20 tokenY, uint16 binStep, IERC20 rewardToken, address initialOwner ) external returns (address); function createLBHooksExtraRewarder( IERC20 tokenX, IERC20 tokenY, uint16 binStep, IERC20 rewardToken, address initialOwner ) external returns (address); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {ILBHooksBaseRewarder} from "./ILBHooksBaseRewarder.sol"; /** * @title LB Hooks Parent Rewarder Interface * @dev Interface for the LB Hooks Parent Rewarder */ interface ILBHooksBaseParentRewarder is ILBHooksBaseRewarder { error LBHooksRewarder__InvalidLBHooksExtraRewarder(); event LBHooksExtraRewarderSet(address lbHooksExtraRewarder); function getExtraHooksParameters() external view returns (bytes32 extraHooksParameters); function setLBHooksExtraRewarder(address lbHooksExtraRewarder, bytes calldata extraRewarderData) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {ILBHooks} from "@lb-protocol/src/interfaces/ILBHooks.sol"; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; /** * @title LB Hooks Base Rewarder Interface * @dev Interface for the LB Hooks Base Rewarder */ interface ILBHooksBaseRewarder is ILBHooks { error LBHooksBaseRewarder__InvalidDeltaBins(); error LBHooksBaseRewarder__Overflow(); error LBHooksBaseRewarder__NativeTransferFailed(); error LBHooksBaseRewarder__UnlinkedHooks(); error LBHooksBaseRewarder__InvalidHooksParameters(); error LBHooksBaseRewarder__ZeroBalance(); error LBHooksBaseRewarder__LockedRewardToken(); error LBHooksBaseRewarder__NotNativeRewarder(); error LBHooksBaseRewarder__NotImplemented(); error LBHooksBaseRewarder__UnauthorizedCaller(); error LBHooksBaseRewarder__ExceedsMaxNumberOfBins(); event DeltaBinsSet(int24 deltaBinA, int24 deltaBinB); event Claim(address indexed user, uint256 amount); struct Bin { uint256 accRewardsPerShareX64; mapping(address => uint256) userAccRewardsPerShareX64; } function getRewardToken() external view returns (IERC20); function getLBHooksManager() external view returns (address); function isStopped() external view returns (bool); function getRewardedRange() external view returns (uint256 binStart, uint256 binEnd); function getPendingRewards(address user, uint256[] calldata ids) external view returns (uint256 pendingRewards); function claim(address user, uint256[] calldata ids) external; function setDeltaBins(int24 deltaBinA, int24 deltaBinB) external; function sweep(IERC20 token, address to) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {ILBHooksBaseSimpleRewarder} from "./ILBHooksBaseSimpleRewarder.sol"; import {ILBHooksBaseParentRewarder} from "./ILBHooksBaseParentRewarder.sol"; /** * @title LB Hooks Extra Rewarder Interface * @dev Interface for the LB Hooks Extra Rewarder */ interface ILBHooksExtraRewarder is ILBHooksBaseSimpleRewarder { error LBHooksExtraRewarder__UnauthorizedCaller(); error LBHooksExtraRewarder__ParentRewarderNotLinked(); function getParentRewarder() external view returns (ILBHooksBaseParentRewarder); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; // src/libraries/Constants.sol /** * @title Constants Library * @dev A library that defines various constants used throughout the codebase. */ library Constants { uint256 internal constant ACC_PRECISION_BITS = 64; uint256 internal constant PRECISION = 1e18; uint256 internal constant MAX_NUMBER_OF_FARMS = 32; uint256 internal constant MAX_NUMBER_OF_REWARDS = 32; uint256 internal constant MAX_LUM_PER_SECOND = 10e18; uint256 internal constant MAX_BRIBES_PER_POOL = 5; } // src/libraries/Math.sol /** * @title Math * @dev Library for mathematical operations with overflow and underflow checks. */ library Math { error Math__UnderOverflow(); uint256 internal constant MAX_INT256 = 0x7fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff; /** * @dev Adds a signed integer to an unsigned integer with overflow check. * The result must be greater than or equal to 0 and less than or equal to MAX_INT256. * @param x Unsigned integer to add to. * @param delta Signed integer to add. * @return y The result of the addition. */ function addDelta(uint256 x, int256 delta) internal pure returns (uint256 y) { uint256 success; assembly { y := add(x, delta) success := iszero(or(gt(x, MAX_INT256), gt(y, MAX_INT256))) } if (success == 0) revert Math__UnderOverflow(); } /** * @dev Safely converts an unsigned integer to a signed integer. * @param x Unsigned integer to convert. * @return y Signed integer result. */ function toInt256(uint256 x) internal pure returns (int256 y) { if (x > MAX_INT256) revert Math__UnderOverflow(); return int256(x); } } // src/interfaces/IMetro.sol interface IMetro is IERC20 { function mint(address account, uint256 amount) external returns (uint256); } // src/interfaces/IRewarder.sol interface IRewarder { function getToken() external view returns (IERC20); function getCaller() external view returns (address); function initialize(address initialOwner) external; } // src/libraries/Amounts.sol /** * @title Amounts Library * @dev A library that defines various functions for manipulating amounts of a key and a total. * The key can be bytes32, address, or uint256. */ library Amounts { using Math for uint256; struct Parameter { uint256 totalAmount; mapping(bytes32 => uint256) amounts; } /** * @dev Returns the amount of a key. * @param amounts The storage pointer to the amounts. * @param key The key of the amount. * @return The amount of the key. */ function getAmountOf(Parameter storage amounts, bytes32 key) internal view returns (uint256) { return amounts.amounts[key]; } /** * @dev Returns the amount of an address. * @param amounts The storage pointer to the amounts. * @param account The address of the amount. * @return The amount of the address. */ function getAmountOf(Parameter storage amounts, address account) internal view returns (uint256) { return getAmountOf(amounts, bytes32(uint256(uint160(account)))); } /** * @dev Returns the amount of an id. * @param amounts The storage pointer to the amounts. * @param id The id of the amount. * @return The amount of the id. */ function getAmountOf(Parameter storage amounts, uint256 id) internal view returns (uint256) { return getAmountOf(amounts, bytes32(id)); } /** * @dev Returns the total amount. * @param amounts The storage pointer to the amounts. * @return The total amount. */ function getTotalAmount(Parameter storage amounts) internal view returns (uint256) { return amounts.totalAmount; } /** * @dev Updates the amount of a key. The delta is added to the key amount and the total amount. * @param amounts The storage pointer to the amounts. * @param key The key of the amount. * @param deltaAmount The delta amount to update. * @return oldAmount The old amount of the key. * @return newAmount The new amount of the key. * @return oldTotalAmount The old total amount. * @return newTotalAmount The new total amount. */ function update(Parameter storage amounts, bytes32 key, int256 deltaAmount) internal returns (uint256 oldAmount, uint256 newAmount, uint256 oldTotalAmount, uint256 newTotalAmount) { oldAmount = amounts.amounts[key]; oldTotalAmount = amounts.totalAmount; if (deltaAmount == 0) { newAmount = oldAmount; newTotalAmount = oldTotalAmount; } else { newAmount = oldAmount.addDelta(deltaAmount); newTotalAmount = oldTotalAmount.addDelta(deltaAmount); amounts.amounts[key] = newAmount; amounts.totalAmount = newTotalAmount; } } /** * @dev Updates the amount of an address. The delta is added to the address amount and the total amount. * @param amounts The storage pointer to the amounts. * @param account The address of the amount. * @param deltaAmount The delta amount to update. * @return oldAmount The old amount of the key. * @return newAmount The new amount of the key. * @return oldTotalAmount The old total amount. * @return newTotalAmount The new total amount. */ function update(Parameter storage amounts, address account, int256 deltaAmount) internal returns (uint256 oldAmount, uint256 newAmount, uint256 oldTotalAmount, uint256 newTotalAmount) { return update(amounts, bytes32(uint256(uint160(account))), deltaAmount); } /** * @dev Updates the amount of an id. The delta is added to the id amount and the total amount. * @param amounts The storage pointer to the amounts. * @param id The id of the amount. * @param deltaAmount The delta amount to update. * @return oldAmount The old amount of the key. * @return newAmount The new amount of the key. * @return oldTotalAmount The old total amount. * @return newTotalAmount The new total amount. */ function update(Parameter storage amounts, uint256 id, int256 deltaAmount) internal returns (uint256 oldAmount, uint256 newAmount, uint256 oldTotalAmount, uint256 newTotalAmount) { return update(amounts, bytes32(id), deltaAmount); } } // src/interfaces/IBaseRewarder.sol interface IBaseRewarder is IRewarder { error BaseRewarder__NativeTransferFailed(); error BaseRewarder__InvalidCaller(); error BaseRewarder__Stopped(); error BaseRewarder__AlreadyStopped(); error BaseRewarder__NotNativeRewarder(); error BaseRewarder__ZeroAmount(); error BaseRewarder__ZeroReward(); error BaseRewarder__InvalidDuration(); error BaseRewarder__InvalidPid(uint256 pid); error BaseRewarder__InvalidStartTimestamp(uint256 startTimestamp); error BaseRewarder__CannotRenounceOwnership(); event Claim(address indexed account, IERC20 indexed token, uint256 reward); event RewardParameterUpdated(uint256 rewardPerSecond, uint256 startTimestamp, uint256 endTimestamp); event Stopped(); event Swept(IERC20 indexed token, address indexed account, uint256 amount); function getToken() external view returns (IERC20); function getCaller() external view returns (address); function getPid() external view returns (uint256); function getRewarderParameter() external view returns (IERC20 token, uint256 rewardPerSecond, uint256 lastUpdateTimestamp, uint256 endTimestamp); function getRemainingReward() external view returns (uint256); function getPendingReward(address account, uint256 balance, uint256 totalSupply) external view returns (IERC20 token, uint256 pendingReward); function isStopped() external view returns (bool); function initialize(address initialOwner) external; function setRewardPerSecond(uint256 maxRewardPerSecond, uint256 expectedDuration) external returns (uint256 rewardPerSecond); function setRewarderParameters(uint256 maxRewardPerSecond, uint256 startTimestamp, uint256 expectedDuration) external returns (uint256 rewardPerSecond); function stop() external; function sweep(IERC20 token, address account) external; function onModify(address account, uint256 pid, uint256 oldBalance, uint256 newBalance, uint256 totalSupply) external returns (uint256); } // src/interfaces/IBribeRewarder.sol interface IBribeRewarder is IRewarder { error BribeRewarder__OnlyVoter(); error BribeRewarder__InsufficientFunds(); error BribeRewarder__WrongStartId(); error BribeRewarder__WrongEndId(); error BribeRewarder__ZeroReward(); error BribeRewarder__NativeTransferFailed(); error BribeRewarder__NotOwner(); error BribeRewarder__CannotRenounceOwnership(); error BribeRewarder__NotNativeRewarder(); error BribeRewarder__AlreadyInitialized(); error BribeRewarder__PeriodNotFound(); event Claimed(uint256 indexed tokenId, address indexed pool, uint256 amount); event Deposited(uint256 indexed periodId, uint256 indexed tokenId, address indexed pool, uint256 amount); event BribeInit(uint256 indexed startId, uint256 indexed lastId, uint256 amountPerPeriod); function bribe(uint256 startId, uint256 lastId, uint256 amountPerPeriod) external; function claim(uint256 tokenId) external; function deposit(uint256 periodId, uint256 tokenId, uint256 deltaAmount) external; function getPool() external view returns (address); function getPendingReward(uint256 tokenId) external view returns (uint256); function getBribePeriods() external view returns (address pool, uint256[] memory); function getStartVotingPeriodId() external view returns (uint256); function getLastVotingPeriodId() external view returns (uint256); function getAmountPerPeriod() external view returns (uint256); } // src/interfaces/IMasterChefRewarder.sol interface IMasterChefRewarder is IBaseRewarder { error MasterChefRewarder__AlreadyLinked(); error MasterChefRewarder__NotLinked(); error MasterChefRewarder__UseUnlink(); enum Status { Unlinked, Linked, Stopped } function link(uint256 pid) external; function unlink(uint256 pid) external; } // src/libraries/Rewarder.sol /** * @title Rewarder Library * @dev A library that defines various functions for calculating rewards. * It takes care about the reward debt and the accumulated debt per share. */ library Rewarder { using Amounts for Amounts.Parameter; struct Parameter { uint256 lastUpdateTimestamp; uint256 accDebtPerShare; mapping(address => uint256) debt; } /** * @dev Returns the debt associated with an amount. * @param accDebtPerShare The accumulated debt per share. * @param deposit The amount. * @return The debt associated with the amount. */ function getDebt(uint256 accDebtPerShare, uint256 deposit) internal pure returns (uint256) { return (deposit * accDebtPerShare) >> Constants.ACC_PRECISION_BITS; } /** * @dev Returns the debt per share associated with a total deposit and total rewards. * @param totalDeposit The total deposit. * @param totalRewards The total rewards. * @return The debt per share associated with the total deposit and total rewards. */ function getDebtPerShare(uint256 totalDeposit, uint256 totalRewards) internal pure returns (uint256) { return totalDeposit == 0 ? 0 : (totalRewards << Constants.ACC_PRECISION_BITS) / totalDeposit; } /** * @dev Returns the total rewards to emit. * If the end timestamp is in the past, the rewards are calculated up to the end timestamp. * If the last update timestamp is in the future, it will return 0. * @param rewarder The storage pointer to the rewarder. * @param rewardPerSecond The reward per second. * @param endTimestamp The end timestamp. * @param totalSupply The total supply. * @return The total rewards. */ function getTotalRewards( Parameter storage rewarder, uint256 rewardPerSecond, uint256 endTimestamp, uint256 totalSupply ) internal view returns (uint256) { if (totalSupply == 0) return 0; uint256 lastUpdateTimestamp = rewarder.lastUpdateTimestamp; uint256 timestamp = block.timestamp > endTimestamp ? endTimestamp : block.timestamp; return timestamp > lastUpdateTimestamp ? (timestamp - lastUpdateTimestamp) * rewardPerSecond : 0; } /** * @dev Returns the total rewards to emit. * @param rewarder The storage pointer to the rewarder. * @param rewardPerSecond The reward per second. * @param totalSupply The total supply. * @return The total rewards. */ function getTotalRewards(Parameter storage rewarder, uint256 rewardPerSecond, uint256 totalSupply) internal view returns (uint256) { return getTotalRewards(rewarder, rewardPerSecond, block.timestamp, totalSupply); } /** * @dev Returns the pending reward of an account. * @param rewarder The storage pointer to the rewarder. * @param amounts The storage pointer to the amounts. * @param account The address of the account. * @param totalRewards The total rewards. * @return The pending reward of the account. */ function getPendingReward( Parameter storage rewarder, Amounts.Parameter storage amounts, address account, uint256 totalRewards ) internal view returns (uint256) { return getPendingReward(rewarder, account, amounts.getAmountOf(account), amounts.getTotalAmount(), totalRewards); } /** * @dev Returns the pending reward of an account. * If the balance of the account is 0, it will always return 0. * @param rewarder The storage pointer to the rewarder. * @param account The address of the account. * @param balance The balance of the account. * @param totalSupply The total supply. * @param totalRewards The total rewards. * @return The pending reward of the account. */ function getPendingReward( Parameter storage rewarder, address account, uint256 balance, uint256 totalSupply, uint256 totalRewards ) internal view returns (uint256) { uint256 accDebtPerShare = rewarder.accDebtPerShare + getDebtPerShare(totalSupply, totalRewards); return balance == 0 ? 0 : getDebt(accDebtPerShare, balance) - rewarder.debt[account]; } /** * @dev Updates the rewarder. * If the balance of the account is 0, it will always return 0. * @param rewarder The storage pointer to the rewarder. * @param account The address of the account. * @param oldBalance The old balance of the account. * @param newBalance The new balance of the account. * @param totalSupply The total supply. * @param totalRewards The total rewards. * @return rewards The rewards of the account. */ function update( Parameter storage rewarder, address account, uint256 oldBalance, uint256 newBalance, uint256 totalSupply, uint256 totalRewards ) internal returns (uint256 rewards) { uint256 accDebtPerShare = updateAccDebtPerShare(rewarder, totalSupply, totalRewards); rewards = oldBalance == 0 ? 0 : getDebt(accDebtPerShare, oldBalance) - rewarder.debt[account]; rewarder.debt[account] = getDebt(accDebtPerShare, newBalance); } /** * @dev Updates the accumulated debt per share. * If the last update timestamp is in the future, it will not update the last update timestamp. * @param rewarder The storage pointer to the rewarder. * @param totalSupply The total supply. * @param totalRewards The total rewards. * @return The accumulated debt per share. */ function updateAccDebtPerShare(Parameter storage rewarder, uint256 totalSupply, uint256 totalRewards) internal returns (uint256) { uint256 debtPerShare = getDebtPerShare(totalSupply, totalRewards); if (block.timestamp > rewarder.lastUpdateTimestamp) rewarder.lastUpdateTimestamp = block.timestamp; return debtPerShare == 0 ? rewarder.accDebtPerShare : rewarder.accDebtPerShare += debtPerShare; } } // src/interfaces/IRewarderFactory.sol interface IRewarderFactory { error RewarderFactory__ZeroAddress(); error RewarderFactory__InvalidRewarderType(); error RewarderFactory__InvalidPid(); enum RewarderType { InvalidRewarder, MasterChefRewarder, VeMoeRewarder, JoeStakingRewarder, BribeRewarder } event RewarderCreated( RewarderType indexed rewarderType, IERC20 indexed token, uint256 indexed pid, IBaseRewarder rewarder ); event BribeRewarderCreated( RewarderType indexed rewarderType, IERC20 indexed token, address indexed pool, IBribeRewarder rewarder ); event RewarderImplementationSet(RewarderType indexed rewarderType, IRewarder indexed implementation); function getRewarderImplementation(RewarderType rewarderType) external view returns (IRewarder); function getRewarderCount(RewarderType rewarderType) external view returns (uint256); function getRewarderAt(RewarderType rewarderType, uint256 index) external view returns (IRewarder); function getRewarderType(IRewarder rewarder) external view returns (RewarderType); function setRewarderImplementation(RewarderType rewarderType, IRewarder implementation) external; function createRewarder(RewarderType rewarderType, IERC20 token, uint256 pid) external returns (IBaseRewarder); function createBribeRewarder(IERC20 token, address pool) external returns (IBribeRewarder); } // src/interfaces/IVoter.sol interface IVoter { error IVoter__InvalidLength(); error IVoter_VotingPeriodNotStarted(); error IVoter_VotingPeriodEnded(); error IVoter__AlreadyVoted(); error IVoter__NotOwner(); error IVoter__InsufficientVotingPower(); error IVoter__TooManyPoolIds(); error IVoter__DuplicatePoolId(uint256 pid); error IVoter__InsufficientLockTime(); error Voter__InvalidRegisterCaller(); error Voter__PoolNotVotable(); error IVoter__NoFinishedPeriod(); error IVoter_ZeroValue(); event VotingPeriodStarted(); event Voted(uint256 indexed tokenId, uint256 votingPeriod, address[] votedPools, uint256[] votesDeltaAmounts); event TopPoolIdsWithWeightsSet(uint256[] poolIds, uint256[] pidWeights); event VoterPoolValidatorUpdated(address indexed validator); event VotingDurationUpdated(uint256 duration); event MinimumLockTimeUpdated(uint256 lockTime); event MinimumVotesPerPoolUpdated(uint256 minimum); event OperatorUpdated(address indexed operator); struct VotingPeriod { uint256 startTime; uint256 endTime; } function getMasterChef() external view returns (IMasterChef); function getTotalWeight() external view returns (uint256); function getTopPoolIds() external view returns (uint256[] memory); function getWeight(uint256 pid) external view returns (uint256); function hasVoted(uint256 period, uint256 tokenId) external view returns (bool); function getCurrentVotingPeriod() external view returns (uint256); function getLatestFinishedPeriod() external view returns (uint256); function getPeriodStartTime() external view returns (uint256); function getPeriodStartEndtime(uint256 periodId) external view returns (uint256, uint256); function getVotesPerPeriod(uint256 periodId, address pool) external view returns (uint256); function getVotedPools() external view returns (address[] memory); function getVotedPoolsLength() external view returns (uint256); function getVotedPoolsAtIndex(uint256 index) external view returns (address, uint256); function getTotalVotes() external view returns (uint256); function getUserVotes(uint256 tokenId, address pool) external view returns (uint256); function getPoolVotesPerPeriod(uint256 periodId, address pool) external view returns (uint256); function getUserBribeRewaderAt(uint256 period, uint256 tokenId, uint256 index) external view returns (IBribeRewarder); function getUserBribeRewarderLength(uint256 period, uint256 tokenId) external view returns (uint256); function getBribeRewarderAt(uint256 period, address pool, uint256 index) external view returns (IBribeRewarder); function getBribeRewarderLength(uint256 period, address pool) external view returns (uint256); function ownerOf(uint256 tokenId, address account) external view returns (bool); function onRegister() external; } // src/interfaces/IMasterChef.sol interface IMasterChef { error MasterChef__InvalidShares(); error MasterChef__InvalidMetroPerSecond(); error MasterChef__ZeroAddress(); error MasterChef__NotMasterchefRewarder(); error MasterChef__CannotRenounceOwnership(); error MasterChef__MintFailed(); error MasterChef__TrusteeNotSet(); error MasterChef__NotTrustedCaller(); struct Farm { Amounts.Parameter amounts; Rewarder.Parameter rewarder; IERC20 token; IMasterChefRewarder extraRewarder; } // bool depositOnBehalf; // true if v2 pool zap in should be possible // uint256 startTime; event PositionModified(uint256 indexed pid, address indexed account, int256 deltaAmount, uint256 metroReward); event MetroPerSecondSet(uint256 metroPerSecond); event FarmAdded(uint256 indexed pid, IERC20 indexed token); event ExtraRewarderSet(uint256 indexed pid, IMasterChefRewarder extraRewarder); event TreasurySet(address indexed treasury); event VoterSet(IVoter indexed newVoter); event TrusteeSet(address indexed trustee); event MintMetroSet(bool mintMetro); event OperatorUpdated(address indexed operator); function add(IERC20 token, IMasterChefRewarder extraRewarder) external; function claim(uint256[] memory pids) external; function deposit(uint256 pid, uint256 amount) external; function depositOnBehalf(uint256 pid, uint256 amount, address account) external; function emergencyWithdraw(uint256 pid) external; function getDeposit(uint256 pid, address account) external view returns (uint256); function getLastUpdateTimestamp(uint256 pid) external view returns (uint256); function getPendingRewards(address account, uint256[] memory pids) external view returns (uint256[] memory metroRewards, IERC20[] memory extraTokens, uint256[] memory extraRewards); function getExtraRewarder(uint256 pid) external view returns (IMasterChefRewarder); function getMetro() external view returns (IMetro); function getMetroPerSecond() external view returns (uint256); function getMetroPerSecondForPid(uint256 pid) external view returns (uint256); function getNumberOfFarms() external view returns (uint256); function getToken(uint256 pid) external view returns (IERC20); function getTotalDeposit(uint256 pid) external view returns (uint256); function getTreasury() external view returns (address); function getTreasuryShare() external view returns (uint256); function getRewarderFactory() external view returns (IRewarderFactory); function getLBHooksManager() external view returns (address); function getVoter() external view returns (IVoter); function setExtraRewarder(uint256 pid, IMasterChefRewarder extraRewarder) external; function setMetroPerSecond(uint96 metroPerSecond) external; function setTreasury(address treasury) external; function setVoter(IVoter voter) external; function setTrustee(address trustee) external; function updateAll(uint256[] calldata pids) external; function withdraw(uint256 pid, uint256 amount) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {IMasterChef} from "./IMasterChef_flat.sol"; import {LBHooksBaseParentRewarder, LBHooksBaseRewarder} from "lb-rewarder/LBHooksBaseParentRewarder.sol"; import {ILBHooksBaseRewarder} from "lb-rewarder/interfaces/ILBHooksBaseRewarder.sol"; import {ILBHooksExtraRewarder} from "lb-rewarder/interfaces/ILBHooksExtraRewarder.sol"; /** * @title LB Hooks Rewarder Interface * @dev Interface for the LB Hooks Rewarder */ interface ILBHooksMCRewarder is ILBHooksBaseRewarder { function getPid() external view returns (uint256 pid); function getMasterChef() external view returns (IMasterChef masterChef); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/IERC20.sol) pragma solidity ^0.8.20; /** * @dev Interface of the ERC-20 standard as defined in the ERC. */ interface IERC20 { /** * @dev Emitted when `value` tokens are moved from one account (`from`) to * another (`to`). * * Note that `value` may be zero. */ event Transfer(address indexed from, address indexed 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. */ event Approval(address indexed owner, address indexed spender, uint256 value); /** * @dev Returns the value of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the value of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves a `value` amount of tokens from the caller's account to `to`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address to, uint256 value) external returns (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. */ function allowance(address owner, address spender) external view returns (uint256); /** * @dev Sets a `value` amount of tokens 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. */ function approve(address spender, uint256 value) external returns (bool); /** * @dev Moves a `value` amount of tokens from `from` to `to` using the * allowance mechanism. `value` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom(address from, address to, uint256 value) external returns (bool); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import {ILBHooks} from "./ILBHooks.sol"; import {ILBPair} from "./ILBPair.sol"; /** * @title Liquidity Book Factory Interface * @author Trader Joe * @notice Required interface of LBFactory contract */ interface ILBFactory { error LBFactory__IdenticalAddresses(IERC20 token); error LBFactory__QuoteAssetNotWhitelisted(IERC20 quoteAsset); error LBFactory__QuoteAssetAlreadyWhitelisted(IERC20 quoteAsset); error LBFactory__AddressZero(); error LBFactory__LBPairAlreadyExists(IERC20 tokenX, IERC20 tokenY, uint256 _binStep); error LBFactory__LBPairDoesNotExist(IERC20 tokenX, IERC20 tokenY, uint256 binStep); error LBFactory__LBPairNotCreated(IERC20 tokenX, IERC20 tokenY, uint256 binStep); error LBFactory__FlashLoanFeeAboveMax(uint256 fees, uint256 maxFees); error LBFactory__BinStepTooLow(uint256 binStep); error LBFactory__PresetIsLockedForUsers(address user, uint256 binStep); error LBFactory__LBPairIgnoredIsAlreadyInTheSameState(); error LBFactory__BinStepHasNoPreset(uint256 binStep); error LBFactory__PresetOpenStateIsAlreadyInTheSameState(); error LBFactory__SameFeeRecipient(address feeRecipient); error LBFactory__SameFlashLoanFee(uint256 flashLoanFee); error LBFactory__LBPairSafetyCheckFailed(address LBPairImplementation); error LBFactory__SameImplementation(address LBPairImplementation); error LBFactory__ImplementationNotSet(); error LBFactory__SameHooksImplementation(address hooksImplementation); error LBFactory__SameHooksParameters(bytes32 hooksParameters); error LBFactory__InvalidHooksParameters(); error LBFactory__CannotGrantDefaultAdminRole(); /** * @dev Structure to store the LBPair information, such as: * binStep: The bin step of the LBPair * LBPair: The address of the LBPair * createdByOwner: Whether the pair was created by the owner of the factory * ignoredForRouting: Whether the pair is ignored for routing or not. An ignored pair will not be explored during routes finding */ struct LBPairInformation { uint16 binStep; ILBPair LBPair; bool createdByOwner; bool ignoredForRouting; } event LBPairCreated( IERC20 indexed tokenX, IERC20 indexed tokenY, uint256 indexed binStep, ILBPair LBPair, uint256 pid ); event FeeRecipientSet(address oldRecipient, address newRecipient); event FlashLoanFeeSet(uint256 oldFlashLoanFee, uint256 newFlashLoanFee); event LBPairImplementationSet(address oldLBPairImplementation, address LBPairImplementation); event LBPairIgnoredStateChanged(ILBPair indexed LBPair, bool ignored); event PresetSet( uint256 indexed binStep, uint256 baseFactor, uint256 filterPeriod, uint256 decayPeriod, uint256 reductionFactor, uint256 variableFeeControl, uint256 protocolShare, uint256 maxVolatilityAccumulator ); event PresetOpenStateChanged(uint256 indexed binStep, bool indexed isOpen); event PresetRemoved(uint256 indexed binStep); event QuoteAssetAdded(IERC20 indexed quoteAsset); event QuoteAssetRemoved(IERC20 indexed quoteAsset); function getMinBinStep() external pure returns (uint256); function getFeeRecipient() external view returns (address); function getMaxFlashLoanFee() external pure returns (uint256); function getFlashLoanFee() external view returns (uint256); function getLBPairImplementation() external view returns (address); function getNumberOfLBPairs() external view returns (uint256); function getLBPairAtIndex(uint256 id) external returns (ILBPair); function getNumberOfQuoteAssets() external view returns (uint256); function getQuoteAssetAtIndex(uint256 index) external view returns (IERC20); function isQuoteAsset(IERC20 token) external view returns (bool); function getLBPairInformation(IERC20 tokenX, IERC20 tokenY, uint256 binStep) external view returns (LBPairInformation memory); function getPreset(uint256 binStep) external view returns ( uint256 baseFactor, uint256 filterPeriod, uint256 decayPeriod, uint256 reductionFactor, uint256 variableFeeControl, uint256 protocolShare, uint256 maxAccumulator, bool isOpen ); function getAllBinSteps() external view returns (uint256[] memory presetsBinStep); function getOpenBinSteps() external view returns (uint256[] memory openBinStep); function getAllLBPairs(IERC20 tokenX, IERC20 tokenY) external view returns (LBPairInformation[] memory LBPairsBinStep); function setLBPairImplementation(address lbPairImplementation) external; function createLBPair(IERC20 tokenX, IERC20 tokenY, uint24 activeId, uint16 binStep) external returns (ILBPair pair); function setLBPairIgnored(IERC20 tokenX, IERC20 tokenY, uint16 binStep, bool ignored) external; function setPreset( uint16 binStep, uint16 baseFactor, uint16 filterPeriod, uint16 decayPeriod, uint16 reductionFactor, uint24 variableFeeControl, uint16 protocolShare, uint24 maxVolatilityAccumulator, bool isOpen ) external; function setPresetOpenState(uint16 binStep, bool isOpen) external; function removePreset(uint16 binStep) external; function setFeesParametersOnPair( IERC20 tokenX, IERC20 tokenY, uint16 binStep, uint16 baseFactor, uint16 filterPeriod, uint16 decayPeriod, uint16 reductionFactor, uint24 variableFeeControl, uint16 protocolShare, uint24 maxVolatilityAccumulator ) external; function setLBHooksParametersOnPair( IERC20 tokenX, IERC20 tokenY, uint16 binStep, bytes32 hooksParameters, bytes memory onHooksSetData ) external; function removeLBHooksOnPair(IERC20 tokenX, IERC20 tokenY, uint16 binStep) external; function setFeeRecipient(address feeRecipient) external; function setFlashLoanFee(uint256 flashLoanFee) external; function addQuoteAsset(IERC20 quoteAsset) external; function removeQuoteAsset(IERC20 quoteAsset) external; function forceDecay(ILBPair lbPair) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; /// @title Liquidity Book Flashloan Callback Interface /// @author Trader Joe /// @notice Required interface to interact with LB flash loans interface ILBFlashLoanCallback { function LBFlashLoanCallback( address sender, IERC20 tokenX, IERC20 tokenY, bytes32 amounts, bytes32 totalFees, bytes calldata data ) external returns (bytes32); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; /** * @title Liquidity Book Token Interface * @author Trader Joe * @notice Interface to interact with the LBToken. */ interface ILBToken { error LBToken__AddressThisOrZero(); error LBToken__InvalidLength(); error LBToken__SelfApproval(address owner); error LBToken__SpenderNotApproved(address from, address spender); error LBToken__TransferExceedsBalance(address from, uint256 id, uint256 amount); error LBToken__BurnExceedsBalance(address from, uint256 id, uint256 amount); event TransferBatch( address indexed sender, address indexed from, address indexed to, uint256[] ids, uint256[] amounts ); event ApprovalForAll(address indexed account, address indexed sender, bool approved); function name() external view returns (string memory); function symbol() external view returns (string memory); function totalSupply(uint256 id) external view returns (uint256); function balanceOf(address account, uint256 id) external view returns (uint256); function balanceOfBatch(address[] calldata accounts, uint256[] calldata ids) external view returns (uint256[] memory); function isApprovedForAll(address owner, address spender) external view returns (bool); function approveForAll(address spender, bool approved) external; function batchTransferFrom(address from, address to, uint256[] calldata ids, uint256[] calldata amounts) external; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {ILBPair} from "./ILBPair.sol"; import {Hooks} from "../libraries/Hooks.sol"; interface ILBHooks { function getLBPair() external view returns (ILBPair); function isLinked() external view returns (bool); function onHooksSet(bytes32 hooksParameters, bytes calldata onHooksSetData) external returns (bytes4); function beforeSwap(address sender, address to, bool swapForY, bytes32 amountsIn) external returns (bytes4); function afterSwap(address sender, address to, bool swapForY, bytes32 amountsOut) external returns (bytes4); function beforeFlashLoan(address sender, address to, bytes32 amounts) external returns (bytes4); function afterFlashLoan(address sender, address to, bytes32 fees, bytes32 feesReceived) external returns (bytes4); function beforeMint(address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsReceived) external returns (bytes4); function afterMint(address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsIn) external returns (bytes4); function beforeBurn( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) external returns (bytes4); function afterBurn( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) external returns (bytes4); function beforeBatchTransferFrom( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) external returns (bytes4); function afterBatchTransferFrom( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) external returns (bytes4); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {ILBHooksBaseRewarder} from "./ILBHooksBaseRewarder.sol"; /** * @title LB Hooks Simple Rewarder Interface * @dev Interface for the LB Hooks Simple Rewarder */ interface ILBHooksBaseSimpleRewarder is ILBHooksBaseRewarder { error LBHooksBaseSimpleRewarder__InvalidStartTimestamp(); error LBHooksBaseSimpleRewarder__InvalidDuration(); error LBHooksBaseSimpleRewarder__ZeroReward(); error LBHooksBaseSimpleRewarder__Stopped(); event RewardParameterUpdated(uint256 rewardPerSecond, uint256 startTimestamp, uint256 endTimestamp); function getRewarderParameter() external view returns (uint256 rewardPerSecond, uint256 lastUpdateTimestamp, uint256 endTimestamp); function getRemainingRewards() external view returns (uint256 remainingRewards); function setRewarderParameters(uint256 maxRewardPerSecond, uint256 startTimestamp, uint256 expectedDuration) external returns (uint256 rewardPerSecond); function setRewardPerSecond(uint256 maxRewardPerSecond, uint256 expectedDuration) external returns (uint256 rewardPerSecond); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {Hooks} from "@lb-protocol/src/libraries/Hooks.sol"; import {LBHooksBaseRewarder, ILBHooksBaseRewarder} from "./LBHooksBaseRewarder.sol"; import {ILBHooksBaseParentRewarder} from "./interfaces/ILBHooksBaseParentRewarder.sol"; import {ILBHooksExtraRewarder} from "./interfaces/ILBHooksExtraRewarder.sol"; /** * @title LB Hooks Base Parent Rewarder * @dev This contract allows to set a second rewarder that will be used to distribute a second token to the LPs */ abstract contract LBHooksBaseParentRewarder is LBHooksBaseRewarder, ILBHooksBaseParentRewarder { bytes32 internal _extraHooksParameters; /** * @dev Returns the extra hooks parameters * @return extraHooksParameters The extra hooks parameters */ function getExtraHooksParameters() external view virtual override returns (bytes32 extraHooksParameters) { return _extraHooksParameters; } /** * @dev Sets the LB Hooks Extra Rewarder * @param lbHooksExtraRewarder The address of the LB Hooks Extra Rewarder * @param extraRewarderData The data to be used on the LB Hooks Extra Rewarder */ function setLBHooksExtraRewarder(address lbHooksExtraRewarder, bytes calldata extraRewarderData) external virtual override { if (msg.sender != _lbHooksManager) _checkOwner(); if (lbHooksExtraRewarder != address(0)) { bytes32 extraHooksParameters = Hooks.setHooks(FLAGS, lbHooksExtraRewarder); _extraHooksParameters = extraHooksParameters; if ( ILBHooksExtraRewarder(lbHooksExtraRewarder).getLBPair() != _getLBPair() || address(ILBHooksExtraRewarder(lbHooksExtraRewarder).getParentRewarder()) != address(this) ) { revert LBHooksRewarder__InvalidLBHooksExtraRewarder(); } Hooks.onHooksSet(extraHooksParameters, extraRewarderData); } else { _extraHooksParameters = 0; } emit LBHooksExtraRewarderSet(lbHooksExtraRewarder); } /** * @dev Override the internal function that is called when the rewards are claimed * Will call the extra rewarder's claim function if the extra rewarder is set * @param user The address of the user * @param ids The ids of the LP tokens */ function _onClaim(address user, uint256[] memory ids) internal virtual override { bytes32 extraHooksParameters = _extraHooksParameters; if (extraHooksParameters != 0) ILBHooksBaseRewarder(Hooks.getHooks(extraHooksParameters)).claim(user, ids); } /** * @dev Override the internal function that is called before a swap on the LB pair * Will call the extra rewarder's beforeSwap function if the extra rewarder is set * @param sender The address of the sender * @param to The address of the receiver * @param swapForY Whether the swap is for token Y * @param amountsIn The amounts in */ function _beforeSwap(address sender, address to, bool swapForY, bytes32 amountsIn) internal virtual override { super._beforeSwap(sender, to, swapForY, amountsIn); Hooks.beforeSwap(_extraHooksParameters, sender, to, swapForY, amountsIn); } /** * @dev Override the internal function that is called before a mint on the LB pair * Will call the extra rewarder's beforeMint function if the extra rewarder is set * @param from The address of the sender * @param to The address of the receiver * @param liquidityConfigs The liquidity configs * @param amountsReceived The amounts received */ function _beforeMint(address from, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsReceived) internal virtual override { super._beforeMint(from, to, liquidityConfigs, amountsReceived); Hooks.beforeMint(_extraHooksParameters, from, to, liquidityConfigs, amountsReceived); } /** * @dev Override the internal function that is called before a burn on the LB pair * Will call the extra rewarder's beforeBurn function if the extra rewarder is set * @param sender The address of the sender * @param from The address of the sender * @param to The address of the receiver * @param ids The ids of the LP tokens * @param amountsToBurn The amounts to burn */ function _beforeBurn( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) internal virtual override { super._beforeBurn(sender, from, to, ids, amountsToBurn); Hooks.beforeBurn(_extraHooksParameters, sender, from, to, ids, amountsToBurn); } /** * @dev Override the internal function that is called before a transfer on the LB pair * Will call the extra rewarder's beforeBatchTransferFrom function if the extra rewarder is set * @param sender The address of the sender * @param from The address of the sender * @param to The address of the receiver * @param ids The list of ids * @param amounts The list of amounts */ function _beforeBatchTransferFrom( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) internal virtual override { super._beforeBatchTransferFrom(sender, from, to, ids, amounts); Hooks.beforeBatchTransferFrom(_extraHooksParameters, sender, from, to, ids, amounts); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import { Ownable2StepUpgradeable, OwnableUpgradeable } from "@openzeppelin/contracts-upgradeable/access/Ownable2StepUpgradeable.sol"; import {LBBaseHooks} from "@lb-protocol/src/LBBaseHooks.sol"; import {Uint256x256Math} from "@lb-protocol/src/libraries/math/Uint256x256Math.sol"; import {Clone} from "@lb-protocol/src/libraries/Clone.sol"; import {ILBPair} from "@lb-protocol/src/interfaces/ILBPair.sol"; import {PriceHelper} from "@lb-protocol/src/libraries/PriceHelper.sol"; import {BinHelper} from "@lb-protocol/src/libraries/BinHelper.sol"; import {Hooks} from "@lb-protocol/src/libraries/Hooks.sol"; import {SafeCast} from "@lb-protocol/src/libraries/math/SafeCast.sol"; import {ILBHooksBaseRewarder} from "./interfaces/ILBHooksBaseRewarder.sol"; import {TokenHelper, IERC20} from "./library/TokenHelper.sol"; /** * @title LB Hooks Base Rewarder * @dev Base contract for any LB Hooks Rewarder */ abstract contract LBHooksBaseRewarder is LBBaseHooks, Ownable2StepUpgradeable, Clone, ILBHooksBaseRewarder { using Uint256x256Math for uint256; using SafeCast for uint256; address public immutable implementation; int256 internal constant MAX_NUMBER_OF_BINS = 11; uint8 internal constant OFFSET_PRECISION = 128; bytes32 internal constant FLAGS = Hooks.BEFORE_SWAP_FLAG | Hooks.BEFORE_MINT_FLAG | Hooks.BEFORE_BURN_FLAG | Hooks.BEFORE_TRANSFER_FLAG; address internal immutable _lbHooksManager; int24 internal _deltaBinA; int24 internal _deltaBinB; uint256 internal _totalUnclaimedRewards; mapping(uint256 => Bin) internal _bins; mapping(address => uint256) internal _unclaimedRewards; /** * @dev Constructor of the contract * @param LBHooksManager The address of the LBHooksManager contract */ constructor(address LBHooksManager) { implementation = address(this); _lbHooksManager = LBHooksManager; _disableInitializers(); } /** * @dev Receive function called when the contract receives native tokens */ receive() external payable { _nativeReceived(); } /** * @dev Fallback function called when the contract receives native tokens */ fallback() external payable { _nativeReceived(); } /** * @dev Returns the reward token * @return rewardToken The reward token */ function getRewardToken() external view virtual override returns (IERC20) { return _getRewardToken(); } /** * @dev Returns the LB Hooks Manager * @return lbHooksManager The LB Hooks Manager */ function getLBHooksManager() external view virtual override returns (address) { return _lbHooksManager; } /** * @dev Returns whether the rewarder is stopped * @return isStopped Whether the rewarder is stopped */ function isStopped() external view virtual override returns (bool) { return !_isLinked(); } /** * @dev Returns the rewarded range from [binStart, binEnd[ (exclusive) * @return binStart The bin start to be rewarded * @return binEnd The bin end to be rewarded, exclusive */ function getRewardedRange() external view virtual override returns (uint256 binStart, uint256 binEnd) { (,, binStart, binEnd) = _getRewardedRange(); } /** * @dev Returns the pending rewards for the given user and ids * The ids are expected to be unique, if they are not, the rewards returned might be greater than expected * @param user The address of the user * @param ids The ids of the bins * @return pendingRewards The pending rewards */ function getPendingRewards(address user, uint256[] calldata ids) external view virtual override returns (uint256) { if (!_isLinked()) return 0; uint256[] calldata ids_ = ids; // Avoid stack too deep error ILBPair lbPair = _getLBPair(); (uint256[] memory rewardedIds, uint24 activeId, uint256 binStart, uint256 binEnd) = _getRewardedRange(); (uint256[] memory liquiditiesX128, uint256[] memory totalSuppliesX64, uint256 totalLiquiditiesX128) = _getLiquidityData(lbPair, activeId, rewardedIds); address user_ = user; // Avoid stack too deep error uint256 pendingTotalRewards = _getPendingTotalRewards(); uint256 pendingRewards; for (uint256 i; i < ids_.length; ++i) { uint24 id = ids_[i].safe24(); uint256 accRewardsPerShareX64; uint256 userAccRewardsPerShareX64; { Bin storage bin = _bins[id]; accRewardsPerShareX64 = bin.accRewardsPerShareX64; userAccRewardsPerShareX64 = bin.userAccRewardsPerShareX64[user_]; } if (id >= binStart && id < binEnd) { uint256 index = id - binStart; uint256 totalSupplyX64 = totalSuppliesX64[index]; if (totalSupplyX64 > 0 && totalLiquiditiesX128 > 0) { uint256 weightX128 = liquiditiesX128[index].shiftDivRoundDown(OFFSET_PRECISION, totalLiquiditiesX128); accRewardsPerShareX64 += pendingTotalRewards.mulDivRoundDown(weightX128, totalSupplyX64); } } uint256 balanceX64 = lbPair.balanceOf(user_, id); if (accRewardsPerShareX64 > userAccRewardsPerShareX64) { unchecked { pendingRewards += (accRewardsPerShareX64 - userAccRewardsPerShareX64).mulShiftRoundDown( balanceX64, OFFSET_PRECISION ); } } } return pendingRewards + _unclaimedRewards[user_]; } /** * @dev Claims the rewards for the given user and ids * @param user The address of the user * @param ids The ids of the bins */ function claim(address user, uint256[] calldata ids) external virtual override { if (!_isLinked()) revert LBHooksBaseRewarder__UnlinkedHooks(); if (!_isAuthorizedCaller(user)) revert LBHooksBaseRewarder__UnauthorizedCaller(); _updateAccruedRewardsPerShare(); _updateUser(user, ids); _claim(user, ids, _unclaimedRewards[user]); } /** * @dev Sets the delta bins * The delta bins are used to determine the range of bins to be rewarded, * from [activeId + deltaBinA, activeId + deltaBinB[ (exclusive). * @param deltaBinA The delta bin A * @param deltaBinB The delta bin B */ function setDeltaBins(int24 deltaBinA, int24 deltaBinB) external virtual override onlyOwner { if (deltaBinA > deltaBinB) revert LBHooksBaseRewarder__InvalidDeltaBins(); if (int256(deltaBinB) - deltaBinA > MAX_NUMBER_OF_BINS) revert LBHooksBaseRewarder__ExceedsMaxNumberOfBins(); _updateAccruedRewardsPerShare(); _deltaBinA = deltaBinA; _deltaBinB = deltaBinB; emit DeltaBinsSet(deltaBinA, deltaBinB); } /** * @dev Sweeps the given token to the given address * @param token The address of the token * @param to The address of the recipient */ function sweep(IERC20 token, address to) external virtual override onlyOwner { uint256 balance = TokenHelper.safeBalanceOf(token, address(this)); if (balance == 0) revert LBHooksBaseRewarder__ZeroBalance(); if (_isLinked() && token == _getRewardToken()) revert LBHooksBaseRewarder__LockedRewardToken(); TokenHelper.safeTransfer(token, to, balance); } /** * @dev Internal function to return the reward token * @return The reward token */ function _getRewardToken() internal view virtual returns (IERC20) { return IERC20(_getArgAddress(20)); } /** * @dev Internal function to return whether caller is the msg.sender * @param user The address of the user * @return Whether the caller is the msg.sender */ function _isAuthorizedCaller(address user) internal view virtual returns (bool) { return user == msg.sender; } /** * @dev Internal helper function to return the rewarded range * @return rewardedIds The list of the rewarded ids from binStart to binEnd * @return activeId The active id * @return binStart The bin start to be rewarded * @return binEnd The bin end to be rewarded */ function _getRewardedRange() internal view virtual returns (uint256[] memory rewardedIds, uint24 activeId, uint256 binStart, uint256 binEnd) { activeId = _getLBPair().getActiveId(); (int24 deltaBinA, int24 deltaBinB) = (_deltaBinA, _deltaBinB); binStart = uint256(int256(uint256(activeId)) + deltaBinA); binEnd = uint256(int256(uint256(activeId)) + deltaBinB); if (binStart > type(uint24).max || binEnd > type(uint24).max) revert LBHooksBaseRewarder__Overflow(); uint256 length = binEnd - binStart; rewardedIds = new uint256[](length); for (uint256 i; i < length; ++i) { unchecked { rewardedIds[i] = (binStart + i).safe24(); } } } /** * @dev Internal function to return the liquidity data for the given ids * @param lbPair The LB Pair * @param activeId The active id * @param ids The ids of the bins * @return liquiditiesX128 The liquidities for the given ids * @return totalSuppliesX64 The total supplies for the given ids * @return totalLiquiditiesX128 The total liquidities for the given ids */ function _getLiquidityData(ILBPair lbPair, uint24 activeId, uint256[] memory ids) internal view virtual returns (uint256[] memory liquiditiesX128, uint256[] memory totalSuppliesX64, uint256 totalLiquiditiesX128) { uint256 activePriceX128 = PriceHelper.getPriceFromId(activeId, lbPair.getBinStep()); uint256 length = ids.length; liquiditiesX128 = new uint256[](length); totalSuppliesX64 = new uint256[](length); for (uint256 i; i < length; ++i) { uint24 id = ids[i].safe24(); (uint128 binReserveX, uint128 binReserveY) = lbPair.getBin(id); uint256 totalSupplyX64 = lbPair.totalSupply(id); uint256 liquidityX128 = BinHelper.getLiquidity(binReserveX, binReserveY, activePriceX128); liquiditiesX128[i] = liquidityX128; totalSuppliesX64[i] = totalSupplyX64; totalLiquiditiesX128 += liquidityX128; } } /** * @dev Internal function to convert the liquidity configs to ids * @param liquidityConfigs The liquidity configs * @return ids The ids */ function _convertLiquidityConfigs(bytes32[] memory liquidityConfigs) internal pure virtual returns (uint256[] memory ids) { uint256 length = liquidityConfigs.length; ids = new uint256[](length); for (uint256 i; i < length; ++i) { ids[i] = uint24(uint256(liquidityConfigs[i])); } } /** * @dev Internal function that allows the rewarder to receive native tokens only * if the rewarded token is native, else it will revert */ function _nativeReceived() internal view virtual { if (_getImmutableArgsOffset() != 0) revert LBHooksBaseRewarder__NotImplemented(); if (address(_getRewardToken()) != address(0)) revert LBHooksBaseRewarder__NotNativeRewarder(); } /** * @dev Internal function to update the accrued rewards per share */ function _updateAccruedRewardsPerShare() internal virtual { uint256 pendingTotalRewards = _updateRewards(); if (pendingTotalRewards == 0) return; ILBPair lbPair = _getLBPair(); (uint256[] memory ids, uint24 activeId,,) = _getRewardedRange(); (uint256[] memory liquiditiesX128, uint256[] memory totalSuppliesX64, uint256 totalLiquiditiesX128) = _getLiquidityData(lbPair, activeId, ids); if (totalLiquiditiesX128 == 0) return; _totalUnclaimedRewards += pendingTotalRewards; uint256 length = ids.length; for (uint256 i; i < length; ++i) { uint256 totalSupplyX64 = totalSuppliesX64[i]; if (totalSupplyX64 > 0) { uint256 weightX128 = liquiditiesX128[i].shiftDivRoundDown(OFFSET_PRECISION, totalLiquiditiesX128); _bins[ids[i]].accRewardsPerShareX64 += pendingTotalRewards.mulDivRoundDown(weightX128, totalSupplyX64); } } } /** * @dev Internal function to update the user * @param to The address of the user * @param ids The ids of the bins */ function _updateUser(address to, uint256[] memory ids) internal virtual { ILBPair lbPair = _getLBPair(); uint256 length = ids.length; uint256 pendingRewards; for (uint256 i; i < length; ++i) { uint24 id = ids[i].safe24(); uint256 balanceX64 = lbPair.balanceOf(to, id); Bin storage bin = _bins[id]; uint256 accRewardsPerShareX64 = bin.accRewardsPerShareX64; uint256 userAccRewardsPerShareX64 = bin.userAccRewardsPerShareX64[to]; if (accRewardsPerShareX64 > userAccRewardsPerShareX64) { unchecked { pendingRewards += (accRewardsPerShareX64 - userAccRewardsPerShareX64).mulShiftRoundDown( balanceX64, OFFSET_PRECISION ); } bin.userAccRewardsPerShareX64[to] = accRewardsPerShareX64; } } if (pendingRewards > 0) _unclaimedRewards[to] += pendingRewards; } /** * @dev Internal function to claim the rewards for the given user * @param user The address of the user * @param ids The ids of the bins * @param rewards The rewards to claim */ function _claim(address user, uint256[] memory ids, uint256 rewards) internal virtual { if (rewards == 0) return; _totalUnclaimedRewards -= rewards; _unclaimedRewards[user] -= rewards; emit Claim(user, rewards); _onClaim(user, ids); TokenHelper.safeTransfer(_getRewardToken(), user, rewards); } /** * @dev Override the internal function to return the LB Pair * @return lbPair The LB Pair */ function _getLBPair() internal view virtual override returns (ILBPair) { return ILBPair(_getArgAddress(0)); } /** * @dev Override the internal function that is called when the rewarder is set * Will revert if the rewarder is already linked via the inializer modifier * Will revert if the hooks parameters are not the expected ones * @param hooksParameters The hooks parameters * @param data The data used to initialize the rewarder; should at least contain the ABI encoded address of the owner */ function _onHooksSet(bytes32 hooksParameters, bytes calldata data) internal override initializer { if (hooksParameters != Hooks.setHooks(FLAGS, address(this))) { revert LBHooksBaseRewarder__InvalidHooksParameters(); } address owner = abi.decode(data, (address)); __Ownable_init(owner); _onHooksSet(data); } /** * @dev Override the internal function that is called before a swap on the LB Pair * Will update the accrued rewards per share */ function _beforeSwap(address, address, bool, bytes32) internal virtual override { _updateAccruedRewardsPerShare(); } /** * @dev Override the internal function that is called before a mint on the LB Pair * Will update the accrued rewards per share and the user rewards * @param to The address of the recipient of the LB Pair tokens * @param liquidityConfigs The liquidity configs */ function _beforeMint(address, address to, bytes32[] calldata liquidityConfigs, bytes32) internal virtual override { _updateAccruedRewardsPerShare(); _updateUser(to, _convertLiquidityConfigs(liquidityConfigs)); } /** * @dev Override the internal function that is called before a burn on the LB Pair * Will update the accrued rewards per share and the user rewards * @param from The address of the sender of the LB Pair tokens * @param ids The ids of the bins */ function _beforeBurn(address, address from, address, uint256[] calldata ids, uint256[] calldata) internal virtual override { _updateAccruedRewardsPerShare(); _updateUser(from, ids); } /** * @dev Override the internal function that is called before a transfer on the LB Pair * Will update the accrued rewards per share and both the sender and recipient rewards * @param from The address of the sender of the LB Pair tokens * @param to The address of the recipient of the LB Pair tokens * @param ids The ids of the bins */ function _beforeBatchTransferFrom(address, address from, address to, uint256[] calldata ids, uint256[] calldata) internal virtual override { _updateAccruedRewardsPerShare(); _updateUser(from, ids); _updateUser(to, ids); } /** * @dev Internal function that can be overriden to add custom logic when the rewarder is set * @param data The data used to initialize the rewarder */ function _onHooksSet(bytes calldata data) internal virtual {} /** * @dev Internal function that can be overriden to add custom logic when the rewards are claimed * @param user The address of the user * @param ids The ids of the bins */ function _onClaim(address user, uint256[] memory ids) internal virtual {} /** * @dev Internal function that **MUST** be overriden to return the total pending rewards * @return pendingTotalRewards The total pending rewards */ function _getPendingTotalRewards() internal view virtual returns (uint256 pendingTotalRewards); /** * @dev Internal function that **MUST** be overriden to update and return the total pending rewards * @return pendingTotalRewards The total pending rewards */ function _updateRewards() internal virtual returns (uint256 pendingTotalRewards); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable2Step.sol) pragma solidity ^0.8.20; import {OwnableUpgradeable} from "./OwnableUpgradeable.sol"; import {Initializable} from "../proxy/utils/Initializable.sol"; /** * @dev Contract module which provides access control mechanism, where * there is an account (an owner) that can be granted exclusive access to * specific functions. * * This extension of the {Ownable} contract includes a two-step mechanism to transfer * ownership, where the new owner must call {acceptOwnership} in order to replace the * old one. This can help prevent common mistakes, such as transfers of ownership to * incorrect accounts, or to contracts that are unable to interact with the * permission system. * * The initial owner is specified at deployment time in the constructor for `Ownable`. This * can later be changed with {transferOwnership} and {acceptOwnership}. * * This module is used through inheritance. It will make available all functions * from parent (Ownable). */ abstract contract Ownable2StepUpgradeable is Initializable, OwnableUpgradeable { /// @custom:storage-location erc7201:openzeppelin.storage.Ownable2Step struct Ownable2StepStorage { address _pendingOwner; } // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable2Step")) - 1)) & ~bytes32(uint256(0xff)) bytes32 private constant Ownable2StepStorageLocation = 0x237e158222e3e6968b72b9db0d8043aacf074ad9f650f0d1606b4d82ee432c00; function _getOwnable2StepStorage() private pure returns (Ownable2StepStorage storage $) { assembly { $.slot := Ownable2StepStorageLocation } } event OwnershipTransferStarted(address indexed previousOwner, address indexed newOwner); function __Ownable2Step_init() internal onlyInitializing { } function __Ownable2Step_init_unchained() internal onlyInitializing { } /** * @dev Returns the address of the pending owner. */ function pendingOwner() public view virtual returns (address) { Ownable2StepStorage storage $ = _getOwnable2StepStorage(); return $._pendingOwner; } /** * @dev Starts the ownership transfer of the contract to a new account. Replaces the pending transfer if there is one. * Can only be called by the current owner. */ function transferOwnership(address newOwner) public virtual override onlyOwner { Ownable2StepStorage storage $ = _getOwnable2StepStorage(); $._pendingOwner = newOwner; emit OwnershipTransferStarted(owner(), newOwner); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`) and deletes any pending owner. * Internal function without access restriction. */ function _transferOwnership(address newOwner) internal virtual override { Ownable2StepStorage storage $ = _getOwnable2StepStorage(); delete $._pendingOwner; super._transferOwnership(newOwner); } /** * @dev The new owner accepts the ownership transfer. */ function acceptOwnership() public virtual { address sender = _msgSender(); if (pendingOwner() != sender) { revert OwnableUnauthorizedAccount(sender); } _transferOwnership(sender); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {Hooks} from "./libraries/Hooks.sol"; import {ILBHooks} from "./interfaces/ILBHooks.sol"; import {ILBPair} from "./interfaces/ILBPair.sol"; /** * @title Liquidity Book Base Hooks Contract * @notice Base contract for LBPair hooks * This contract is meant to be inherited by any contract that wants to implement LBPair hooks */ abstract contract LBBaseHooks is ILBHooks { error LBBaseHooks__InvalidCaller(address caller); error LBBaseHooks__NotLinked(); /** * @dev Modifier to check that the caller is the trusted caller */ modifier onlyTrustedCaller() { _checkTrustedCaller(); _; } /** * @dev Returns the LBPair contract * @return The LBPair contract */ function getLBPair() external view override returns (ILBPair) { return _getLBPair(); } /** * @dev Returns whether the contract is linked to the pair or not * @return Whether the contract is linked to the pair or not */ function isLinked() external view override returns (bool) { return _isLinked(); } /** * @notice Hook called by the pair when the hooks parameters are set * @dev Only callable by the pair * @param hooksParameters The hooks parameters * @param onHooksSetData The onHooksSet data * @return The function selector */ function onHooksSet(bytes32 hooksParameters, bytes calldata onHooksSetData) external override onlyTrustedCaller returns (bytes4) { if (!_isLinked()) revert LBBaseHooks__NotLinked(); _onHooksSet(hooksParameters, onHooksSetData); return this.onHooksSet.selector; } /** * @notice Hook called by the pair before a swap * @dev Only callable by the pair * @param sender The address that initiated the swap * @param to The address that will receive the swapped tokens * @param swapForY Whether the swap is for token Y * @param amountsIn The amounts in * @return The function selector */ function beforeSwap(address sender, address to, bool swapForY, bytes32 amountsIn) external override onlyTrustedCaller returns (bytes4) { _beforeSwap(sender, to, swapForY, amountsIn); return this.beforeSwap.selector; } /** * @notice Hook called by the pair after a swap * @dev Only callable by the pair * @param sender The address that initiated the swap * @param to The address that received the swapped tokens * @param swapForY Whether the swap was for token Y * @param amountsOut The amounts out * @return The function selector */ function afterSwap(address sender, address to, bool swapForY, bytes32 amountsOut) external override onlyTrustedCaller returns (bytes4) { _afterSwap(sender, to, swapForY, amountsOut); return this.afterSwap.selector; } /** * @notice Hook called by the pair before a flash loan * @dev Only callable by the pair * @param sender The address that initiated the flash loan * @param to The address that will receive the flash loaned tokens * @param amounts The amounts * @return The function selector */ function beforeFlashLoan(address sender, address to, bytes32 amounts) external override onlyTrustedCaller returns (bytes4) { _beforeFlashLoan(sender, to, amounts); return this.beforeFlashLoan.selector; } /** * @notice Hook called by the pair after a flash loan * @dev Only callable by the pair * @param sender The address that initiated the flash loan * @param to The address that received the flash loaned tokens * @param fees The flashloan fees * @param feesReceived The fees received * @return The function selector */ function afterFlashLoan(address sender, address to, bytes32 fees, bytes32 feesReceived) external override onlyTrustedCaller returns (bytes4) { _afterFlashLoan(sender, to, fees, feesReceived); return this.afterFlashLoan.selector; } /** * @notice Hook called by the pair before minting * @dev Only callable by the pair * @param sender The address that initiated the mint * @param to The address that will receive the minted tokens * @param liquidityConfigs The liquidity configurations * @param amountsReceived The amounts received * @return The function selector */ function beforeMint(address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsReceived) external override onlyTrustedCaller returns (bytes4) { _beforeMint(sender, to, liquidityConfigs, amountsReceived); return this.beforeMint.selector; } /** * @notice Hook called by the pair after minting * @dev Only callable by the pair * @param sender The address that initiated the mint * @param to The address that received the minted tokens * @param liquidityConfigs The liquidity configurations * @param amountsIn The amounts in * @return The function selector */ function afterMint(address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsIn) external override onlyTrustedCaller returns (bytes4) { _afterMint(sender, to, liquidityConfigs, amountsIn); return this.afterMint.selector; } /** * @notice Hook called by the pair before burning * @dev Only callable by the pair * @param sender The address that initiated the burn * @param from The address that will burn the tokens * @param to The address that will receive the burned tokens * @param ids The token ids * @param amountsToBurn The amounts to burn * @return The function selector */ function beforeBurn( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) external override onlyTrustedCaller returns (bytes4) { _beforeBurn(sender, from, to, ids, amountsToBurn); return this.beforeBurn.selector; } /** * @notice Hook called by the pair after burning * @dev Only callable by the pair * @param sender The address that initiated the burn * @param from The address that burned the tokens * @param to The address that received the burned tokens * @param ids The token ids * @param amountsToBurn The amounts to burn * @return The function selector */ function afterBurn( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) external override onlyTrustedCaller returns (bytes4) { _afterBurn(sender, from, to, ids, amountsToBurn); return this.afterBurn.selector; } /** * @notice Hook called by the pair before a batch transfer * @dev Only callable by the pair * @param sender The address that initiated the transfer * @param from The address that will transfer the tokens * @param to The address that will receive the tokens * @param ids The token ids * @param amounts The amounts * @return The function selector */ function beforeBatchTransferFrom( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) external override onlyTrustedCaller returns (bytes4) { _beforeBatchTransferFrom(sender, from, to, ids, amounts); return this.beforeBatchTransferFrom.selector; } /** * @notice Hook called by the pair after a batch transfer * @dev Only callable by the pair * @param sender The address that initiated the transfer * @param from The address that transferred the tokens * @param to The address that received the tokens * @param ids The token ids * @param amounts The amounts * @return The function selector */ function afterBatchTransferFrom( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) external override onlyTrustedCaller returns (bytes4) { _afterBatchTransferFrom(sender, from, to, ids, amounts); return this.afterBatchTransferFrom.selector; } /** * @dev Checks that the caller is the trusted caller, otherwise reverts */ function _checkTrustedCaller() internal view virtual { if (msg.sender != address(_getLBPair())) revert LBBaseHooks__InvalidCaller(msg.sender); } /** * @dev Checks if the contract is linked to the pair * @return Whether the contract is linked to the pair or not */ function _isLinked() internal view virtual returns (bool) { address hooks = Hooks.getHooks(_getLBPair().getLBHooksParameters()); return hooks == address(this); } /** * @dev Returns the LBPair contract */ function _getLBPair() internal view virtual returns (ILBPair); /** * @notice Internal function to be overridden that is called when the hooks parameters are set * @param hooksParameters The hooks parameters * @param onHooksSetData The onHooksSet data */ function _onHooksSet(bytes32 hooksParameters, bytes calldata onHooksSetData) internal virtual {} /** * @notice Internal function to be overridden that is called before a swap * @param sender The address that initiated the swap * @param to The address that will receive the swapped tokens * @param swapForY Whether the swap is for token Y * @param amountsIn The amounts in */ function _beforeSwap(address sender, address to, bool swapForY, bytes32 amountsIn) internal virtual {} /** * @notice Internal function to be overridden that is called after a swap * @param sender The address that initiated the swap * @param to The address that received the swapped tokens * @param swapForY Whether the swap was for token Y * @param amountsOut The amounts out */ function _afterSwap(address sender, address to, bool swapForY, bytes32 amountsOut) internal virtual {} /** * @notice Internal function to be overridden that is called before a flash loan * @param sender The address that initiated the flash loan * @param to The address that will receive the flash loaned tokens * @param amounts The amounts */ function _beforeFlashLoan(address sender, address to, bytes32 amounts) internal virtual {} /** * @notice Internal function to be overridden that is called after a flash loan * @param sender The address that initiated the flash loan * @param to The address that received the flash loaned tokens * @param fees The flashloan fees * @param feesReceived The fees received */ function _afterFlashLoan(address sender, address to, bytes32 fees, bytes32 feesReceived) internal virtual {} /** * @notice Internal function to be overridden that is called before minting * @param sender The address that initiated the mint * @param to The address that will receive the minted tokens * @param liquidityConfigs The liquidity configurations * @param amountsReceived The amounts received */ function _beforeMint(address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsReceived) internal virtual {} /** * @notice Internal function to be overridden that is called after minting * @param sender The address that initiated the mint * @param to The address that received the minted tokens * @param liquidityConfigs The liquidity configurations * @param amountsIn The amounts in */ function _afterMint(address sender, address to, bytes32[] calldata liquidityConfigs, bytes32 amountsIn) internal virtual {} /** * @notice Internal function to be overridden that is called before burning * @param sender The address that initiated the burn * @param from The address that will burn the tokens * @param to The address that will receive the burned tokens * @param ids The token ids * @param amountsToBurn The amounts to burn */ function _beforeBurn( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) internal virtual {} /** * @notice Internal function to be overridden that is called after burning * @param sender The address that initiated the burn * @param from The address that burned the tokens * @param to The address that received the burned tokens * @param ids The token ids * @param amountsToBurn The amounts to burn */ function _afterBurn( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amountsToBurn ) internal virtual {} /** * @notice Internal function to be overridden that is called before a batch transfer * @param sender The address that initiated the transfer * @param from The address that will transfer the tokens * @param to The address that will receive the tokens * @param ids The token ids * @param amounts The amounts */ function _beforeBatchTransferFrom( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) internal virtual {} /** * @notice Internal function to be overridden that is called after a batch transfer * @param sender The address that initiated the transfer * @param from The address that transferred the tokens * @param to The address that received the tokens * @param ids The token ids * @param amounts The amounts */ function _afterBatchTransferFrom( address sender, address from, address to, uint256[] calldata ids, uint256[] calldata amounts ) internal virtual {} }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {BitMath} from "./BitMath.sol"; /** * @title Liquidity Book Uint256x256 Math Library * @author Trader Joe * @notice Helper contract used for full precision calculations */ library Uint256x256Math { error Uint256x256Math__MulShiftOverflow(); error Uint256x256Math__MulDivOverflow(); /** * @notice Calculates floor(x*y/denominator) with full precision * The result will be rounded down * @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv * Requirements: * - The denominator cannot be zero * - The result must fit within uint256 * Caveats: * - This function does not work with fixed-point numbers * @param x The multiplicand as an uint256 * @param y The multiplier as an uint256 * @param denominator The divisor as an uint256 * @return result The result as an uint256 */ function mulDivRoundDown(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) { (uint256 prod0, uint256 prod1) = _getMulProds(x, y); return _getEndOfDivRoundDown(x, y, denominator, prod0, prod1); } /** * @notice Calculates ceil(x*y/denominator) with full precision * The result will be rounded up * @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv * Requirements: * - The denominator cannot be zero * - The result must fit within uint256 * Caveats: * - This function does not work with fixed-point numbers * @param x The multiplicand as an uint256 * @param y The multiplier as an uint256 * @param denominator The divisor as an uint256 * @return result The result as an uint256 */ function mulDivRoundUp(uint256 x, uint256 y, uint256 denominator) internal pure returns (uint256 result) { result = mulDivRoundDown(x, y, denominator); if (mulmod(x, y, denominator) != 0) result += 1; } /** * @notice Calculates floor(x * y / 2**offset) with full precision * The result will be rounded down * @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv * Requirements: * - The offset needs to be strictly lower than 256 * - The result must fit within uint256 * Caveats: * - This function does not work with fixed-point numbers * @param x The multiplicand as an uint256 * @param y The multiplier as an uint256 * @param offset The offset as an uint256, can't be greater than 256 * @return result The result as an uint256 */ function mulShiftRoundDown(uint256 x, uint256 y, uint8 offset) internal pure returns (uint256 result) { (uint256 prod0, uint256 prod1) = _getMulProds(x, y); if (prod0 != 0) result = prod0 >> offset; if (prod1 != 0) { // Make sure the result is less than 2^256. if (prod1 >= 1 << offset) revert Uint256x256Math__MulShiftOverflow(); unchecked { result += prod1 << (256 - offset); } } } /** * @notice Calculates floor(x * y / 2**offset) with full precision * The result will be rounded down * @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv * Requirements: * - The offset needs to be strictly lower than 256 * - The result must fit within uint256 * Caveats: * - This function does not work with fixed-point numbers * @param x The multiplicand as an uint256 * @param y The multiplier as an uint256 * @param offset The offset as an uint256, can't be greater than 256 * @return result The result as an uint256 */ function mulShiftRoundUp(uint256 x, uint256 y, uint8 offset) internal pure returns (uint256 result) { result = mulShiftRoundDown(x, y, offset); if (mulmod(x, y, 1 << offset) != 0) result += 1; } /** * @notice Calculates floor(x << offset / y) with full precision * The result will be rounded down * @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv * Requirements: * - The offset needs to be strictly lower than 256 * - The result must fit within uint256 * Caveats: * - This function does not work with fixed-point numbers * @param x The multiplicand as an uint256 * @param offset The number of bit to shift x as an uint256 * @param denominator The divisor as an uint256 * @return result The result as an uint256 */ function shiftDivRoundDown(uint256 x, uint8 offset, uint256 denominator) internal pure returns (uint256 result) { uint256 prod0; uint256 prod1; prod0 = x << offset; // Least significant 256 bits of the product unchecked { prod1 = x >> (256 - offset); // Most significant 256 bits of the product } return _getEndOfDivRoundDown(x, 1 << offset, denominator, prod0, prod1); } /** * @notice Calculates ceil(x << offset / y) with full precision * The result will be rounded up * @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv * Requirements: * - The offset needs to be strictly lower than 256 * - The result must fit within uint256 * Caveats: * - This function does not work with fixed-point numbers * @param x The multiplicand as an uint256 * @param offset The number of bit to shift x as an uint256 * @param denominator The divisor as an uint256 * @return result The result as an uint256 */ function shiftDivRoundUp(uint256 x, uint8 offset, uint256 denominator) internal pure returns (uint256 result) { result = shiftDivRoundDown(x, offset, denominator); if (mulmod(x, 1 << offset, denominator) != 0) result += 1; } /** * @notice Helper function to return the result of `x * y` as 2 uint256 * @param x The multiplicand as an uint256 * @param y The multiplier as an uint256 * @return prod0 The least significant 256 bits of the product * @return prod1 The most significant 256 bits of the product */ function _getMulProds(uint256 x, uint256 y) private pure returns (uint256 prod0, uint256 prod1) { // 512-bit multiply [prod1 prod0] = x * y. Compute the product mod 2^256 and mod 2^256 - 1, then use // use the Chinese Remainder Theorem to reconstruct the 512 bit result. The result is stored in two 256 // variables such that product = prod1 * 2^256 + prod0. assembly { let mm := mulmod(x, y, not(0)) prod0 := mul(x, y) prod1 := sub(sub(mm, prod0), lt(mm, prod0)) } } /** * @notice Helper function to return the result of `x * y / denominator` with full precision * @param x The multiplicand as an uint256 * @param y The multiplier as an uint256 * @param denominator The divisor as an uint256 * @param prod0 The least significant 256 bits of the product * @param prod1 The most significant 256 bits of the product * @return result The result as an uint256 */ function _getEndOfDivRoundDown(uint256 x, uint256 y, uint256 denominator, uint256 prod0, uint256 prod1) private pure returns (uint256 result) { // Handle non-overflow cases, 256 by 256 division if (prod1 == 0) { unchecked { result = prod0 / denominator; } } else { // Make sure the result is less than 2^256. Also prevents denominator == 0 if (prod1 >= denominator) revert Uint256x256Math__MulDivOverflow(); // Make division exact by subtracting the remainder from [prod1 prod0]. uint256 remainder; assembly { // Compute remainder using mulmod. remainder := mulmod(x, y, denominator) // Subtract 256 bit number from 512 bit number. prod1 := sub(prod1, gt(remainder, prod0)) prod0 := sub(prod0, remainder) } // Factor powers of two out of denominator and compute largest power of two divisor of denominator. Always >= 1 // See https://cs.stackexchange.com/q/138556/92363 unchecked { // Does not overflow because the denominator cannot be zero at this stage in the function uint256 lpotdod = denominator & (~denominator + 1); assembly { // Divide denominator by lpotdod. denominator := div(denominator, lpotdod) // Divide [prod1 prod0] by lpotdod. prod0 := div(prod0, lpotdod) // Flip lpotdod such that it is 2^256 / lpotdod. If lpotdod is zero, then it becomes one lpotdod := add(div(sub(0, lpotdod), lpotdod), 1) } // Shift in bits from prod1 into prod0 prod0 |= prod1 * lpotdod; // Invert denominator mod 2^256. Now that denominator is an odd number, it has an inverse modulo 2^256 such // that denominator * inv = 1 mod 2^256. Compute the inverse by starting with a seed that is correct for // four bits. That is, denominator * inv = 1 mod 2^4 uint256 inverse = (3 * denominator) ^ 2; // Use the Newton-Raphson iteration to improve the precision. Thanks to Hensel's lifting lemma, this also works // in modular arithmetic, doubling the correct bits in each step inverse *= 2 - denominator * inverse; // inverse mod 2^8 inverse *= 2 - denominator * inverse; // inverse mod 2^16 inverse *= 2 - denominator * inverse; // inverse mod 2^32 inverse *= 2 - denominator * inverse; // inverse mod 2^64 inverse *= 2 - denominator * inverse; // inverse mod 2^128 inverse *= 2 - denominator * inverse; // inverse mod 2^256 // Because the division is now exact we can divide by multiplying with the modular inverse of denominator. // This will give us the correct result modulo 2^256. Since the preconditions guarantee that the outcome is // less than 2^256, this is the final result. We don't need to compute the high bits of the result and prod1 // is no longer required. result = prod0 * inverse; } } } /** * @notice Calculates the square root of x * @dev Credit to OpenZeppelin's Math library under MIT license */ function sqrt(uint256 x) internal pure returns (uint256 sqrtX) { if (x == 0) return 0; uint256 msb = BitMath.mostSignificantBit(x); assembly { sqrtX := shl(shr(1, msb), 1) sqrtX := shr(1, add(sqrtX, div(x, sqrtX))) sqrtX := shr(1, add(sqrtX, div(x, sqrtX))) sqrtX := shr(1, add(sqrtX, div(x, sqrtX))) sqrtX := shr(1, add(sqrtX, div(x, sqrtX))) sqrtX := shr(1, add(sqrtX, div(x, sqrtX))) sqrtX := shr(1, add(sqrtX, div(x, sqrtX))) sqrtX := shr(1, add(sqrtX, div(x, sqrtX))) x := div(x, sqrtX) } return sqrtX < x ? sqrtX : x; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; /** * @title Clone * @notice Class with helper read functions for clone with immutable args. * @author Trader Joe * @author Solady (https://github.com/vectorized/solady/blob/main/src/utils/Clone.sol) * @author Adapted from clones with immutable args by zefram.eth, Saw-mon & Natalie * (https://github.com/Saw-mon-and-Natalie/clones-with-immutable-args) */ abstract contract Clone { /** * @dev Reads an immutable arg with type bytes * @param argOffset The offset of the arg in the immutable args * @param length The length of the arg * @return arg The immutable bytes arg */ function _getArgBytes(uint256 argOffset, uint256 length) internal pure returns (bytes memory arg) { uint256 offset = _getImmutableArgsOffset(); /// @solidity memory-safe-assembly assembly { // Grab the free memory pointer. arg := mload(0x40) // Store the array length. mstore(arg, length) // Copy the array. calldatacopy(add(arg, 0x20), add(offset, argOffset), length) // Allocate the memory, rounded up to the next 32 byte boundary. mstore(0x40, and(add(add(arg, 0x3f), length), not(0x1f))) } } /** * @dev Reads an immutable arg with type address * @param argOffset The offset of the arg in the immutable args * @return arg The immutable address arg */ function _getArgAddress(uint256 argOffset) internal pure returns (address arg) { uint256 offset = _getImmutableArgsOffset(); /// @solidity memory-safe-assembly assembly { arg := shr(0x60, calldataload(add(offset, argOffset))) } } /** * @dev Reads an immutable arg with type uint256 * @param argOffset The offset of the arg in the immutable args * @return arg The immutable uint256 arg */ function _getArgUint256(uint256 argOffset) internal pure returns (uint256 arg) { uint256 offset = _getImmutableArgsOffset(); /// @solidity memory-safe-assembly assembly { arg := calldataload(add(offset, argOffset)) } } /** * @dev Reads a uint256 array stored in the immutable args. * @param argOffset The offset of the arg in the immutable args * @param length The length of the arg * @return arg The immutable uint256 array arg */ function _getArgUint256Array(uint256 argOffset, uint256 length) internal pure returns (uint256[] memory arg) { uint256 offset = _getImmutableArgsOffset(); /// @solidity memory-safe-assembly assembly { // Grab the free memory pointer. arg := mload(0x40) // Store the array length. mstore(arg, length) // Copy the array. calldatacopy(add(arg, 0x20), add(offset, argOffset), shl(5, length)) // Allocate the memory. mstore(0x40, add(add(arg, 0x20), shl(5, length))) } } /** * @dev Reads an immutable arg with type uint64 * @param argOffset The offset of the arg in the immutable args * @return arg The immutable uint64 arg */ function _getArgUint64(uint256 argOffset) internal pure returns (uint64 arg) { uint256 offset = _getImmutableArgsOffset(); /// @solidity memory-safe-assembly assembly { arg := shr(0xc0, calldataload(add(offset, argOffset))) } } /** * @dev Reads an immutable arg with type uint16 * @param argOffset The offset of the arg in the immutable args * @return arg The immutable uint16 arg */ function _getArgUint16(uint256 argOffset) internal pure returns (uint16 arg) { uint256 offset = _getImmutableArgsOffset(); /// @solidity memory-safe-assembly assembly { arg := shr(0xf0, calldataload(add(offset, argOffset))) } } /** * @dev Reads an immutable arg with type uint8 * @param argOffset The offset of the arg in the immutable args * @return arg The immutable uint8 arg */ function _getArgUint8(uint256 argOffset) internal pure returns (uint8 arg) { uint256 offset = _getImmutableArgsOffset(); /// @solidity memory-safe-assembly assembly { arg := shr(0xf8, calldataload(add(offset, argOffset))) } } /** * @dev Reads the offset of the packed immutable args in calldata. * @return offset The offset of the packed immutable args in calldata. */ function _getImmutableArgsOffset() internal pure returns (uint256 offset) { /// @solidity memory-safe-assembly assembly { offset := sub(calldatasize(), shr(0xf0, calldataload(sub(calldatasize(), 2)))) } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {Uint128x128Math} from "./math/Uint128x128Math.sol"; import {Uint256x256Math} from "./math/Uint256x256Math.sol"; import {SafeCast} from "./math/SafeCast.sol"; import {Constants} from "./Constants.sol"; /** * @title Liquidity Book Price Helper Library * @author Trader Joe * @notice This library contains functions to calculate prices */ library PriceHelper { using Uint128x128Math for uint256; using Uint256x256Math for uint256; using SafeCast for uint256; int256 private constant REAL_ID_SHIFT = 1 << 23; /** * @dev Calculates the price from the id and the bin step * @param id The id * @param binStep The bin step * @return price The price as a 128.128-binary fixed-point number */ function getPriceFromId(uint24 id, uint16 binStep) internal pure returns (uint256 price) { uint256 base = getBase(binStep); int256 exponent = getExponent(id); price = base.pow(exponent); } /** * @dev Calculates the id from the price and the bin step * @param price The price as a 128.128-binary fixed-point number * @param binStep The bin step * @return id The id */ function getIdFromPrice(uint256 price, uint16 binStep) internal pure returns (uint24 id) { uint256 base = getBase(binStep); int256 realId = price.log2() / base.log2(); unchecked { id = uint256(REAL_ID_SHIFT + realId).safe24(); } } /** * @dev Calculates the base from the bin step, which is `1 + binStep / BASIS_POINT_MAX` * @param binStep The bin step * @return base The base */ function getBase(uint16 binStep) internal pure returns (uint256) { unchecked { return Constants.SCALE + (uint256(binStep) << Constants.SCALE_OFFSET) / Constants.BASIS_POINT_MAX; } } /** * @dev Calculates the exponent from the id, which is `id - REAL_ID_SHIFT` * @param id The id * @return exponent The exponent */ function getExponent(uint24 id) internal pure returns (int256) { unchecked { return int256(uint256(id)) - REAL_ID_SHIFT; } } /** * @dev Converts a price with 18 decimals to a 128.128-binary fixed-point number * @param price The price with 18 decimals * @return price128x128 The 128.128-binary fixed-point number */ function convertDecimalPriceTo128x128(uint256 price) internal pure returns (uint256) { return price.shiftDivRoundDown(Constants.SCALE_OFFSET, Constants.PRECISION); } /** * @dev Converts a 128.128-binary fixed-point number to a price with 18 decimals * @param price128x128 The 128.128-binary fixed-point number * @return price The price with 18 decimals */ function convert128x128PriceToDecimal(uint256 price128x128) internal pure returns (uint256) { return price128x128.mulShiftRoundDown(Constants.PRECISION, Constants.SCALE_OFFSET); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {PackedUint128Math} from "./math/PackedUint128Math.sol"; import {Uint256x256Math} from "./math/Uint256x256Math.sol"; import {SafeCast} from "./math/SafeCast.sol"; import {Constants} from "./Constants.sol"; import {PairParameterHelper} from "./PairParameterHelper.sol"; import {FeeHelper} from "./FeeHelper.sol"; import {PriceHelper} from "./PriceHelper.sol"; import {TokenHelper, IERC20} from "./TokenHelper.sol"; /** * @title Liquidity Book Bin Helper Library * @author Trader Joe * @notice This library contains functions to help interaction with bins. */ library BinHelper { using PackedUint128Math for bytes32; using PackedUint128Math for uint128; using Uint256x256Math for uint256; using PriceHelper for uint24; using SafeCast for uint256; using PairParameterHelper for bytes32; using FeeHelper for uint128; using TokenHelper for IERC20; error BinHelper__CompositionFactorFlawed(uint24 id); error BinHelper__LiquidityOverflow(); error BinHelper__MaxLiquidityPerBinExceeded(); /** * @dev Returns the amount of tokens that will be received when burning the given amount of liquidity * @param binReserves The reserves of the bin * @param amountToBurn The amount of liquidity to burn * @param totalSupply The total supply of the liquidity book * @return amountsOut The encoded amount of tokens that will be received */ function getAmountOutOfBin(bytes32 binReserves, uint256 amountToBurn, uint256 totalSupply) internal pure returns (bytes32 amountsOut) { (uint128 binReserveX, uint128 binReserveY) = binReserves.decode(); uint128 amountXOutFromBin; uint128 amountYOutFromBin; if (binReserveX > 0) { amountXOutFromBin = (amountToBurn.mulDivRoundDown(binReserveX, totalSupply)).safe128(); } if (binReserveY > 0) { amountYOutFromBin = (amountToBurn.mulDivRoundDown(binReserveY, totalSupply)).safe128(); } amountsOut = amountXOutFromBin.encode(amountYOutFromBin); } /** * @dev Returns the share and the effective amounts in when adding liquidity * @param binReserves The reserves of the bin * @param amountsIn The amounts of tokens to add * @param price The price of the bin * @param totalSupply The total supply of the liquidity book * @return shares The share of the liquidity book that the user will receive * @return effectiveAmountsIn The encoded effective amounts of tokens that the user will add. * This is the amount of tokens that the user will actually add to the liquidity book, * and will always be less than or equal to the amountsIn. */ function getSharesAndEffectiveAmountsIn(bytes32 binReserves, bytes32 amountsIn, uint256 price, uint256 totalSupply) internal pure returns (uint256 shares, bytes32 effectiveAmountsIn) { (uint256 x, uint256 y) = amountsIn.decode(); uint256 userLiquidity = getLiquidity(x, y, price); if (userLiquidity == 0) return (0, 0); uint256 binLiquidity = getLiquidity(binReserves, price); if (binLiquidity == 0 || totalSupply == 0) return (userLiquidity.sqrt(), amountsIn); shares = userLiquidity.mulDivRoundDown(totalSupply, binLiquidity); uint256 effectiveLiquidity = shares.mulDivRoundUp(binLiquidity, totalSupply); if (userLiquidity > effectiveLiquidity) { uint256 deltaLiquidity = userLiquidity - effectiveLiquidity; // The other way might be more efficient, but as y is the quote asset, it is more valuable if (deltaLiquidity >= Constants.SCALE) { uint256 deltaY = deltaLiquidity >> Constants.SCALE_OFFSET; deltaY = deltaY > y ? y : deltaY; y -= deltaY; deltaLiquidity -= deltaY << Constants.SCALE_OFFSET; } if (deltaLiquidity >= price) { uint256 deltaX = deltaLiquidity / price; deltaX = deltaX > x ? x : deltaX; x -= deltaX; } amountsIn = uint128(x).encode(uint128(y)); } if (getLiquidity(binReserves.add(amountsIn), price) > Constants.MAX_LIQUIDITY_PER_BIN) { revert BinHelper__MaxLiquidityPerBinExceeded(); } return (shares, amountsIn); } /** * @dev Returns the amount of liquidity following the constant sum formula `L = price * x + y` * @param amounts The amounts of tokens * @param price The price of the bin * @return liquidity The amount of liquidity */ function getLiquidity(bytes32 amounts, uint256 price) internal pure returns (uint256 liquidity) { (uint256 x, uint256 y) = amounts.decode(); return getLiquidity(x, y, price); } /** * @dev Returns the amount of liquidity following the constant sum formula `L = price * x + y` * @param x The amount of the token X * @param y The amount of the token Y * @param price The price of the bin * @return liquidity The amount of liquidity */ function getLiquidity(uint256 x, uint256 y, uint256 price) internal pure returns (uint256 liquidity) { if (x > 0) { unchecked { liquidity = price * x; if (liquidity / x != price) revert BinHelper__LiquidityOverflow(); } } if (y > 0) { unchecked { y <<= Constants.SCALE_OFFSET; liquidity += y; if (liquidity < y) revert BinHelper__LiquidityOverflow(); } } return liquidity; } /** * @dev Verify that the amounts are correct and that the composition factor is not flawed * @param amounts The amounts of tokens * @param activeId The id of the active bin * @param id The id of the bin */ function verifyAmounts(bytes32 amounts, uint24 activeId, uint24 id) internal pure { if (id < activeId && (amounts << 128) > 0 || id > activeId && uint256(amounts) > type(uint128).max) { revert BinHelper__CompositionFactorFlawed(id); } } /** * @dev Returns the composition fees when adding liquidity to the active bin with a different * composition factor than the bin's one, as it does an implicit swap * @param binReserves The reserves of the bin * @param parameters The parameters of the liquidity book * @param binStep The step of the bin * @param amountsIn The amounts of tokens to add * @param totalSupply The total supply of the liquidity book * @param shares The share of the liquidity book that the user will receive * @return fees The encoded fees that will be charged */ function getCompositionFees( bytes32 binReserves, bytes32 parameters, uint16 binStep, bytes32 amountsIn, uint256 totalSupply, uint256 shares ) internal pure returns (bytes32 fees) { if (shares == 0) return 0; (uint128 amountX, uint128 amountY) = amountsIn.decode(); (uint128 receivedAmountX, uint128 receivedAmountY) = getAmountOutOfBin(binReserves.add(amountsIn), shares, totalSupply + shares).decode(); if (receivedAmountX > amountX) { uint128 feeY = (amountY - receivedAmountY).getCompositionFee(parameters.getTotalFee(binStep)); fees = feeY.encodeSecond(); } else if (receivedAmountY > amountY) { uint128 feeX = (amountX - receivedAmountX).getCompositionFee(parameters.getTotalFee(binStep)); fees = feeX.encodeFirst(); } } /** * @dev Returns whether the bin is empty (true) or not (false) * @param binReserves The reserves of the bin * @param isX Whether the reserve to check is the X reserve (true) or the Y reserve (false) * @return Whether the bin is empty (true) or not (false) */ function isEmpty(bytes32 binReserves, bool isX) internal pure returns (bool) { return isX ? binReserves.decodeX() == 0 : binReserves.decodeY() == 0; } /** * @dev Returns the amounts of tokens that will be added and removed from the bin during a swap * along with the fees that will be charged * @param binReserves The reserves of the bin * @param parameters The parameters of the liquidity book * @param binStep The step of the bin * @param swapForY Whether the swap is for Y (true) or for X (false) * @param activeId The id of the active bin * @param amountsInLeft The amounts of tokens left to swap * @return amountsInWithFees The encoded amounts of tokens that will be added to the bin, including fees * @return amountsOutOfBin The encoded amounts of tokens that will be removed from the bin * @return totalFees The encoded fees that will be charged */ function getAmounts( bytes32 binReserves, bytes32 parameters, uint16 binStep, bool swapForY, // swap `swapForY` and `activeId` to avoid stack too deep uint24 activeId, bytes32 amountsInLeft ) internal pure returns (bytes32 amountsInWithFees, bytes32 amountsOutOfBin, bytes32 totalFees) { uint256 price = activeId.getPriceFromId(binStep); { uint128 binReserveOut = binReserves.decode(!swapForY); uint128 maxAmountIn = swapForY ? uint256(binReserveOut).shiftDivRoundUp(Constants.SCALE_OFFSET, price).safe128() : uint256(binReserveOut).mulShiftRoundUp(price, Constants.SCALE_OFFSET).safe128(); uint128 totalFee = parameters.getTotalFee(binStep); uint128 maxFee = maxAmountIn.getFeeAmount(totalFee); maxAmountIn += maxFee; uint128 amountIn128 = amountsInLeft.decode(swapForY); uint128 fee128; uint128 amountOut128; if (amountIn128 >= maxAmountIn) { fee128 = maxFee; amountIn128 = maxAmountIn; amountOut128 = binReserveOut; } else { fee128 = amountIn128.getFeeAmountFrom(totalFee); uint256 amountIn = amountIn128 - fee128; amountOut128 = swapForY ? uint256(amountIn).mulShiftRoundDown(price, Constants.SCALE_OFFSET).safe128() : uint256(amountIn).shiftDivRoundDown(Constants.SCALE_OFFSET, price).safe128(); if (amountOut128 > binReserveOut) amountOut128 = binReserveOut; } (amountsInWithFees, amountsOutOfBin, totalFees) = swapForY ? (amountIn128.encodeFirst(), amountOut128.encodeSecond(), fee128.encodeFirst()) : (amountIn128.encodeSecond(), amountOut128.encodeFirst(), fee128.encodeSecond()); } if ( getLiquidity(binReserves.add(amountsInWithFees).sub(amountsOutOfBin), price) > Constants.MAX_LIQUIDITY_PER_BIN ) { revert BinHelper__MaxLiquidityPerBinExceeded(); } } /** * @dev Returns the encoded amounts that were transferred to the contract * @param reserves The reserves * @param tokenX The token X * @param tokenY The token Y * @return amounts The amounts, encoded as follows: * [0 - 128[: amountX * [128 - 256[: amountY */ function received(bytes32 reserves, IERC20 tokenX, IERC20 tokenY) internal view returns (bytes32 amounts) { amounts = _balanceOf(tokenX).encode(_balanceOf(tokenY)).sub(reserves); } /** * @dev Returns the encoded amounts that were transferred to the contract, only for token X * @param reserves The reserves * @param tokenX The token X * @return amounts The amounts, encoded as follows: * [0 - 128[: amountX * [128 - 256[: empty */ function receivedX(bytes32 reserves, IERC20 tokenX) internal view returns (bytes32) { uint128 reserveX = reserves.decodeX(); return (_balanceOf(tokenX) - reserveX).encodeFirst(); } /** * @dev Returns the encoded amounts that were transferred to the contract, only for token Y * @param reserves The reserves * @param tokenY The token Y * @return amounts The amounts, encoded as follows: * [0 - 128[: empty * [128 - 256[: amountY */ function receivedY(bytes32 reserves, IERC20 tokenY) internal view returns (bytes32) { uint128 reserveY = reserves.decodeY(); return (_balanceOf(tokenY) - reserveY).encodeSecond(); } /** * @dev Transfers the encoded amounts to the recipient * @param amounts The amounts, encoded as follows: * [0 - 128[: amountX * [128 - 256[: amountY * @param tokenX The token X * @param tokenY The token Y * @param recipient The recipient */ function transfer(bytes32 amounts, IERC20 tokenX, IERC20 tokenY, address recipient) internal { (uint128 amountX, uint128 amountY) = amounts.decode(); if (amountX > 0) tokenX.safeTransfer(recipient, amountX); if (amountY > 0) tokenY.safeTransfer(recipient, amountY); } /** * @dev Transfers the encoded amounts to the recipient, only for token X * @param amounts The amounts, encoded as follows: * [0 - 128[: amountX * [128 - 256[: empty * @param tokenX The token X * @param recipient The recipient */ function transferX(bytes32 amounts, IERC20 tokenX, address recipient) internal { uint128 amountX = amounts.decodeX(); if (amountX > 0) tokenX.safeTransfer(recipient, amountX); } /** * @dev Transfers the encoded amounts to the recipient, only for token Y * @param amounts The amounts, encoded as follows: * [0 - 128[: empty * [128 - 256[: amountY * @param tokenY The token Y * @param recipient The recipient */ function transferY(bytes32 amounts, IERC20 tokenY, address recipient) internal { uint128 amountY = amounts.decodeY(); if (amountY > 0) tokenY.safeTransfer(recipient, amountY); } function _balanceOf(IERC20 token) private view returns (uint128) { return token.balanceOf(address(this)).safe128(); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; /** * @title Liquidity Book Safe Cast Library * @author Trader Joe * @notice This library contains functions to safely cast uint256 to different uint types. */ library SafeCast { error SafeCast__Exceeds248Bits(); error SafeCast__Exceeds240Bits(); error SafeCast__Exceeds232Bits(); error SafeCast__Exceeds224Bits(); error SafeCast__Exceeds216Bits(); error SafeCast__Exceeds208Bits(); error SafeCast__Exceeds200Bits(); error SafeCast__Exceeds192Bits(); error SafeCast__Exceeds184Bits(); error SafeCast__Exceeds176Bits(); error SafeCast__Exceeds168Bits(); error SafeCast__Exceeds160Bits(); error SafeCast__Exceeds152Bits(); error SafeCast__Exceeds144Bits(); error SafeCast__Exceeds136Bits(); error SafeCast__Exceeds128Bits(); error SafeCast__Exceeds120Bits(); error SafeCast__Exceeds112Bits(); error SafeCast__Exceeds104Bits(); error SafeCast__Exceeds96Bits(); error SafeCast__Exceeds88Bits(); error SafeCast__Exceeds80Bits(); error SafeCast__Exceeds72Bits(); error SafeCast__Exceeds64Bits(); error SafeCast__Exceeds56Bits(); error SafeCast__Exceeds48Bits(); error SafeCast__Exceeds40Bits(); error SafeCast__Exceeds32Bits(); error SafeCast__Exceeds24Bits(); error SafeCast__Exceeds16Bits(); error SafeCast__Exceeds8Bits(); /** * @dev Returns x on uint248 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint248 */ function safe248(uint256 x) internal pure returns (uint248 y) { if ((y = uint248(x)) != x) revert SafeCast__Exceeds248Bits(); } /** * @dev Returns x on uint240 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint240 */ function safe240(uint256 x) internal pure returns (uint240 y) { if ((y = uint240(x)) != x) revert SafeCast__Exceeds240Bits(); } /** * @dev Returns x on uint232 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint232 */ function safe232(uint256 x) internal pure returns (uint232 y) { if ((y = uint232(x)) != x) revert SafeCast__Exceeds232Bits(); } /** * @dev Returns x on uint224 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint224 */ function safe224(uint256 x) internal pure returns (uint224 y) { if ((y = uint224(x)) != x) revert SafeCast__Exceeds224Bits(); } /** * @dev Returns x on uint216 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint216 */ function safe216(uint256 x) internal pure returns (uint216 y) { if ((y = uint216(x)) != x) revert SafeCast__Exceeds216Bits(); } /** * @dev Returns x on uint208 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint208 */ function safe208(uint256 x) internal pure returns (uint208 y) { if ((y = uint208(x)) != x) revert SafeCast__Exceeds208Bits(); } /** * @dev Returns x on uint200 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint200 */ function safe200(uint256 x) internal pure returns (uint200 y) { if ((y = uint200(x)) != x) revert SafeCast__Exceeds200Bits(); } /** * @dev Returns x on uint192 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint192 */ function safe192(uint256 x) internal pure returns (uint192 y) { if ((y = uint192(x)) != x) revert SafeCast__Exceeds192Bits(); } /** * @dev Returns x on uint184 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint184 */ function safe184(uint256 x) internal pure returns (uint184 y) { if ((y = uint184(x)) != x) revert SafeCast__Exceeds184Bits(); } /** * @dev Returns x on uint176 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint176 */ function safe176(uint256 x) internal pure returns (uint176 y) { if ((y = uint176(x)) != x) revert SafeCast__Exceeds176Bits(); } /** * @dev Returns x on uint168 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint168 */ function safe168(uint256 x) internal pure returns (uint168 y) { if ((y = uint168(x)) != x) revert SafeCast__Exceeds168Bits(); } /** * @dev Returns x on uint160 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint160 */ function safe160(uint256 x) internal pure returns (uint160 y) { if ((y = uint160(x)) != x) revert SafeCast__Exceeds160Bits(); } /** * @dev Returns x on uint152 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint152 */ function safe152(uint256 x) internal pure returns (uint152 y) { if ((y = uint152(x)) != x) revert SafeCast__Exceeds152Bits(); } /** * @dev Returns x on uint144 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint144 */ function safe144(uint256 x) internal pure returns (uint144 y) { if ((y = uint144(x)) != x) revert SafeCast__Exceeds144Bits(); } /** * @dev Returns x on uint136 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint136 */ function safe136(uint256 x) internal pure returns (uint136 y) { if ((y = uint136(x)) != x) revert SafeCast__Exceeds136Bits(); } /** * @dev Returns x on uint128 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint128 */ function safe128(uint256 x) internal pure returns (uint128 y) { if ((y = uint128(x)) != x) revert SafeCast__Exceeds128Bits(); } /** * @dev Returns x on uint120 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint120 */ function safe120(uint256 x) internal pure returns (uint120 y) { if ((y = uint120(x)) != x) revert SafeCast__Exceeds120Bits(); } /** * @dev Returns x on uint112 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint112 */ function safe112(uint256 x) internal pure returns (uint112 y) { if ((y = uint112(x)) != x) revert SafeCast__Exceeds112Bits(); } /** * @dev Returns x on uint104 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint104 */ function safe104(uint256 x) internal pure returns (uint104 y) { if ((y = uint104(x)) != x) revert SafeCast__Exceeds104Bits(); } /** * @dev Returns x on uint96 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint96 */ function safe96(uint256 x) internal pure returns (uint96 y) { if ((y = uint96(x)) != x) revert SafeCast__Exceeds96Bits(); } /** * @dev Returns x on uint88 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint88 */ function safe88(uint256 x) internal pure returns (uint88 y) { if ((y = uint88(x)) != x) revert SafeCast__Exceeds88Bits(); } /** * @dev Returns x on uint80 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint80 */ function safe80(uint256 x) internal pure returns (uint80 y) { if ((y = uint80(x)) != x) revert SafeCast__Exceeds80Bits(); } /** * @dev Returns x on uint72 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint72 */ function safe72(uint256 x) internal pure returns (uint72 y) { if ((y = uint72(x)) != x) revert SafeCast__Exceeds72Bits(); } /** * @dev Returns x on uint64 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint64 */ function safe64(uint256 x) internal pure returns (uint64 y) { if ((y = uint64(x)) != x) revert SafeCast__Exceeds64Bits(); } /** * @dev Returns x on uint56 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint56 */ function safe56(uint256 x) internal pure returns (uint56 y) { if ((y = uint56(x)) != x) revert SafeCast__Exceeds56Bits(); } /** * @dev Returns x on uint48 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint48 */ function safe48(uint256 x) internal pure returns (uint48 y) { if ((y = uint48(x)) != x) revert SafeCast__Exceeds48Bits(); } /** * @dev Returns x on uint40 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint40 */ function safe40(uint256 x) internal pure returns (uint40 y) { if ((y = uint40(x)) != x) revert SafeCast__Exceeds40Bits(); } /** * @dev Returns x on uint32 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint32 */ function safe32(uint256 x) internal pure returns (uint32 y) { if ((y = uint32(x)) != x) revert SafeCast__Exceeds32Bits(); } /** * @dev Returns x on uint24 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint24 */ function safe24(uint256 x) internal pure returns (uint24 y) { if ((y = uint24(x)) != x) revert SafeCast__Exceeds24Bits(); } /** * @dev Returns x on uint16 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint16 */ function safe16(uint256 x) internal pure returns (uint16 y) { if ((y = uint16(x)) != x) revert SafeCast__Exceeds16Bits(); } /** * @dev Returns x on uint8 and check that it does not overflow * @param x The value as an uint256 * @return y The value as an uint8 */ function safe8(uint256 x) internal pure returns (uint8 y) { if ((y = uint8(x)) != x) revert SafeCast__Exceeds8Bits(); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.20; import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; /** * @title Token Helper * @dev Helper library to handle ERC20 and native tokens */ library TokenHelper { using SafeERC20 for IERC20; error TokenHelper__NativeTransferFailed(); /** * @dev Helper function to return the balance of an account for the given token * address(0) is used for native tokens * @param token The address of the token * @param account The address of the account * @return The balance of this contract for the given token */ function safeBalanceOf(IERC20 token, address account) internal view returns (uint256) { return address(token) == address(0) ? address(account).balance : token.balanceOf(account); } /** * @dev Helper function to transfer the given amount of tokens to the given address * address(0) is used for native tokens * @param token The address of the token * @param to The address of the recipient * @param amount The amount of tokens */ function safeTransfer(IERC20 token, address to, uint256 amount) internal { if (amount > 0) { if (address(token) == address(0)) { (bool s,) = to.call{value: amount}(""); if (!s) revert TokenHelper__NativeTransferFailed(); } else { token.safeTransfer(to, amount); } } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (access/Ownable.sol) pragma solidity ^0.8.20; import {ContextUpgradeable} from "../utils/ContextUpgradeable.sol"; import {Initializable} from "../proxy/utils/Initializable.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. * * The initial owner is set to the address provided by the deployer. 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. */ abstract contract OwnableUpgradeable is Initializable, ContextUpgradeable { /// @custom:storage-location erc7201:openzeppelin.storage.Ownable struct OwnableStorage { address _owner; } // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Ownable")) - 1)) & ~bytes32(uint256(0xff)) bytes32 private constant OwnableStorageLocation = 0x9016d09d72d40fdae2fd8ceac6b6234c7706214fd39c1cd1e609a0528c199300; function _getOwnableStorage() private pure returns (OwnableStorage storage $) { assembly { $.slot := OwnableStorageLocation } } /** * @dev The caller account is not authorized to perform an operation. */ error OwnableUnauthorizedAccount(address account); /** * @dev The owner is not a valid owner account. (eg. `address(0)`) */ error OwnableInvalidOwner(address owner); event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); /** * @dev Initializes the contract setting the address provided by the deployer as the initial owner. */ function __Ownable_init(address initialOwner) internal onlyInitializing { __Ownable_init_unchained(initialOwner); } function __Ownable_init_unchained(address initialOwner) internal onlyInitializing { if (initialOwner == address(0)) { revert OwnableInvalidOwner(address(0)); } _transferOwnership(initialOwner); } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { _checkOwner(); _; } /** * @dev Returns the address of the current owner. */ function owner() public view virtual returns (address) { OwnableStorage storage $ = _getOwnableStorage(); return $._owner; } /** * @dev Throws if the sender is not the owner. */ function _checkOwner() internal view virtual { if (owner() != _msgSender()) { revert OwnableUnauthorizedAccount(_msgSender()); } } /** * @dev Leaves the contract without owner. It will not be possible to call * `onlyOwner` functions. Can only be called by the current owner. * * NOTE: Renouncing ownership will leave the contract without an owner, * thereby disabling any functionality that is only available to the owner. */ function renounceOwnership() public virtual onlyOwner { _transferOwnership(address(0)); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Can only be called by the current owner. */ function transferOwnership(address newOwner) public virtual onlyOwner { if (newOwner == address(0)) { revert OwnableInvalidOwner(address(0)); } _transferOwnership(newOwner); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Internal function without access restriction. */ function _transferOwnership(address newOwner) internal virtual { OwnableStorage storage $ = _getOwnableStorage(); address oldOwner = $._owner; $._owner = newOwner; emit OwnershipTransferred(oldOwner, newOwner); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol) pragma solidity ^0.8.20; /** * @dev This is a base contract to aid in writing upgradeable contracts, or any kind of contract that will be deployed * behind a proxy. Since proxied contracts do not make use of a constructor, it's common to move constructor logic to an * external initializer function, usually called `initialize`. It then becomes necessary to protect this initializer * function so it can only be called once. The {initializer} modifier provided by this contract will have this effect. * * The initialization functions use a version number. Once a version number is used, it is consumed and cannot be * reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in * case an upgrade adds a module that needs to be initialized. * * For example: * * [.hljs-theme-light.nopadding] * ```solidity * contract MyToken is ERC20Upgradeable { * function initialize() initializer public { * __ERC20_init("MyToken", "MTK"); * } * } * * contract MyTokenV2 is MyToken, ERC20PermitUpgradeable { * function initializeV2() reinitializer(2) public { * __ERC20Permit_init("MyToken"); * } * } * ``` * * TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as * possible by providing the encoded function call as the `_data` argument to {ERC1967Proxy-constructor}. * * CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure * that all initializers are idempotent. This is not verified automatically as constructors are by Solidity. * * [CAUTION] * ==== * Avoid leaving a contract uninitialized. * * An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation * contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke * the {_disableInitializers} function in the constructor to automatically lock it when it is deployed: * * [.hljs-theme-light.nopadding] * ``` * /// @custom:oz-upgrades-unsafe-allow constructor * constructor() { * _disableInitializers(); * } * ``` * ==== */ abstract contract Initializable { /** * @dev Storage of the initializable contract. * * It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions * when using with upgradeable contracts. * * @custom:storage-location erc7201:openzeppelin.storage.Initializable */ struct InitializableStorage { /** * @dev Indicates that the contract has been initialized. */ uint64 _initialized; /** * @dev Indicates that the contract is in the process of being initialized. */ bool _initializing; } // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.Initializable")) - 1)) & ~bytes32(uint256(0xff)) bytes32 private constant INITIALIZABLE_STORAGE = 0xf0c57e16840df040f15088dc2f81fe391c3923bec73e23a9662efc9c229c6a00; /** * @dev The contract is already initialized. */ error InvalidInitialization(); /** * @dev The contract is not initializing. */ error NotInitializing(); /** * @dev Triggered when the contract has been initialized or reinitialized. */ event Initialized(uint64 version); /** * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope, * `onlyInitializing` functions can be used to initialize parent contracts. * * Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any * number of times. This behavior in the constructor can be useful during testing and is not expected to be used in * production. * * Emits an {Initialized} event. */ modifier initializer() { // solhint-disable-next-line var-name-mixedcase InitializableStorage storage $ = _getInitializableStorage(); // Cache values to avoid duplicated sloads bool isTopLevelCall = !$._initializing; uint64 initialized = $._initialized; // Allowed calls: // - initialSetup: the contract is not in the initializing state and no previous version was // initialized // - construction: the contract is initialized at version 1 (no reininitialization) and the // current contract is just being deployed bool initialSetup = initialized == 0 && isTopLevelCall; bool construction = initialized == 1 && address(this).code.length == 0; if (!initialSetup && !construction) { revert InvalidInitialization(); } $._initialized = 1; if (isTopLevelCall) { $._initializing = true; } _; if (isTopLevelCall) { $._initializing = false; emit Initialized(1); } } /** * @dev A modifier that defines a protected reinitializer function that can be invoked at most once, and only if the * contract hasn't been initialized to a greater version before. In its scope, `onlyInitializing` functions can be * used to initialize parent contracts. * * A reinitializer may be used after the original initialization step. This is essential to configure modules that * are added through upgrades and that require initialization. * * When `version` is 1, this modifier is similar to `initializer`, except that functions marked with `reinitializer` * cannot be nested. If one is invoked in the context of another, execution will revert. * * Note that versions can jump in increments greater than 1; this implies that if multiple reinitializers coexist in * a contract, executing them in the right order is up to the developer or operator. * * WARNING: Setting the version to 2**64 - 1 will prevent any future reinitialization. * * Emits an {Initialized} event. */ modifier reinitializer(uint64 version) { // solhint-disable-next-line var-name-mixedcase InitializableStorage storage $ = _getInitializableStorage(); if ($._initializing || $._initialized >= version) { revert InvalidInitialization(); } $._initialized = version; $._initializing = true; _; $._initializing = false; emit Initialized(version); } /** * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the * {initializer} and {reinitializer} modifiers, directly or indirectly. */ modifier onlyInitializing() { _checkInitializing(); _; } /** * @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}. */ function _checkInitializing() internal view virtual { if (!_isInitializing()) { revert NotInitializing(); } } /** * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call. * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized * to any version. It is recommended to use this to lock implementation contracts that are designed to be called * through proxies. * * Emits an {Initialized} event the first time it is successfully executed. */ function _disableInitializers() internal virtual { // solhint-disable-next-line var-name-mixedcase InitializableStorage storage $ = _getInitializableStorage(); if ($._initializing) { revert InvalidInitialization(); } if ($._initialized != type(uint64).max) { $._initialized = type(uint64).max; emit Initialized(type(uint64).max); } } /** * @dev Returns the highest version that has been initialized. See {reinitializer}. */ function _getInitializedVersion() internal view returns (uint64) { return _getInitializableStorage()._initialized; } /** * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}. */ function _isInitializing() internal view returns (bool) { return _getInitializableStorage()._initializing; } /** * @dev Returns a pointer to the storage namespace. */ // solhint-disable-next-line var-name-mixedcase function _getInitializableStorage() private pure returns (InitializableStorage storage $) { assembly { $.slot := INITIALIZABLE_STORAGE } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; /** * @title Liquidity Book Bit Math Library * @author Trader Joe * @notice Helper contract used for bit calculations */ library BitMath { /** * @dev Returns the index of the closest bit on the right of x that is non null * @param x The value as a uint256 * @param bit The index of the bit to start searching at * @return id The index of the closest non null bit on the right of x. * If there is no closest bit, it returns max(uint256) */ function closestBitRight(uint256 x, uint8 bit) internal pure returns (uint256 id) { unchecked { uint256 shift = 255 - bit; x <<= shift; // can't overflow as it's non-zero and we shifted it by `_shift` return (x == 0) ? type(uint256).max : mostSignificantBit(x) - shift; } } /** * @dev Returns the index of the closest bit on the left of x that is non null * @param x The value as a uint256 * @param bit The index of the bit to start searching at * @return id The index of the closest non null bit on the left of x. * If there is no closest bit, it returns max(uint256) */ function closestBitLeft(uint256 x, uint8 bit) internal pure returns (uint256 id) { unchecked { x >>= bit; return (x == 0) ? type(uint256).max : leastSignificantBit(x) + bit; } } /** * @dev Returns the index of the most significant bit of x * This function returns 0 if x is 0 * @param x The value as a uint256 * @return msb The index of the most significant bit of x */ function mostSignificantBit(uint256 x) internal pure returns (uint8 msb) { assembly { if gt(x, 0xffffffffffffffffffffffffffffffff) { x := shr(128, x) msb := 128 } if gt(x, 0xffffffffffffffff) { x := shr(64, x) msb := add(msb, 64) } if gt(x, 0xffffffff) { x := shr(32, x) msb := add(msb, 32) } if gt(x, 0xffff) { x := shr(16, x) msb := add(msb, 16) } if gt(x, 0xff) { x := shr(8, x) msb := add(msb, 8) } if gt(x, 0xf) { x := shr(4, x) msb := add(msb, 4) } if gt(x, 0x3) { x := shr(2, x) msb := add(msb, 2) } if gt(x, 0x1) { msb := add(msb, 1) } } } /** * @dev Returns the index of the least significant bit of x * This function returns 255 if x is 0 * @param x The value as a uint256 * @return lsb The index of the least significant bit of x */ function leastSignificantBit(uint256 x) internal pure returns (uint8 lsb) { assembly { let sx := shl(128, x) if iszero(iszero(sx)) { lsb := 128 x := sx } sx := shl(64, x) if iszero(iszero(sx)) { x := sx lsb := add(lsb, 64) } sx := shl(32, x) if iszero(iszero(sx)) { x := sx lsb := add(lsb, 32) } sx := shl(16, x) if iszero(iszero(sx)) { x := sx lsb := add(lsb, 16) } sx := shl(8, x) if iszero(iszero(sx)) { x := sx lsb := add(lsb, 8) } sx := shl(4, x) if iszero(iszero(sx)) { x := sx lsb := add(lsb, 4) } sx := shl(2, x) if iszero(iszero(sx)) { x := sx lsb := add(lsb, 2) } if iszero(iszero(shl(1, x))) { lsb := add(lsb, 1) } lsb := sub(255, lsb) } } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {Constants} from "../Constants.sol"; import {BitMath} from "./BitMath.sol"; /** * @title Liquidity Book Uint128x128 Math Library * @author Trader Joe * @notice Helper contract used for power and log calculations */ library Uint128x128Math { using BitMath for uint256; error Uint128x128Math__LogUnderflow(); error Uint128x128Math__PowUnderflow(uint256 x, int256 y); uint256 constant LOG_SCALE_OFFSET = 127; uint256 constant LOG_SCALE = 1 << LOG_SCALE_OFFSET; uint256 constant LOG_SCALE_SQUARED = LOG_SCALE * LOG_SCALE; /** * @notice Calculates the binary logarithm of x. * @dev Based on the iterative approximation algorithm. * https://en.wikipedia.org/wiki/Binary_logarithm#Iterative_approximation * Requirements: * - x must be greater than zero. * Caveats: * - The results are not perfectly accurate to the last decimal, due to the lossy precision of the iterative approximation * Also because x is converted to an unsigned 129.127-binary fixed-point number during the operation to optimize the multiplication * @param x The unsigned 128.128-binary fixed-point number for which to calculate the binary logarithm. * @return result The binary logarithm as a signed 128.128-binary fixed-point number. */ function log2(uint256 x) internal pure returns (int256 result) { // Convert x to a unsigned 129.127-binary fixed-point number to optimize the multiplication. // If we use an offset of 128 bits, y would need 129 bits and y**2 would would overflow and we would have to // use mulDiv, by reducing x to 129.127-binary fixed-point number we assert that y will use 128 bits, and we // can use the regular multiplication if (x == 1) return -128; if (x == 0) revert Uint128x128Math__LogUnderflow(); x >>= 1; unchecked { // This works because log2(x) = -log2(1/x). int256 sign; if (x >= LOG_SCALE) { sign = 1; } else { sign = -1; // Do the fixed-point inversion inline to save gas x = LOG_SCALE_SQUARED / x; } // Calculate the integer part of the logarithm and add it to the result and finally calculate y = x * 2^(-n). uint256 n = (x >> LOG_SCALE_OFFSET).mostSignificantBit(); // The integer part of the logarithm as a signed 129.127-binary fixed-point number. The operation can't overflow // because n is maximum 255, LOG_SCALE_OFFSET is 127 bits and sign is either 1 or -1. result = int256(n) << LOG_SCALE_OFFSET; // This is y = x * 2^(-n). uint256 y = x >> n; // If y = 1, the fractional part is zero. if (y != LOG_SCALE) { // Calculate the fractional part via the iterative approximation. // The "delta >>= 1" part is equivalent to "delta /= 2", but shifting bits is faster. for (int256 delta = int256(1 << (LOG_SCALE_OFFSET - 1)); delta > 0; delta >>= 1) { y = (y * y) >> LOG_SCALE_OFFSET; // Is y^2 > 2 and so in the range [2,4)? if (y >= 1 << (LOG_SCALE_OFFSET + 1)) { // Add the 2^(-m) factor to the logarithm. result += delta; // Corresponds to z/2 on Wikipedia. y >>= 1; } } } // Convert x back to unsigned 128.128-binary fixed-point number result = (result * sign) << 1; } } /** * @notice Returns the value of x^y. It calculates `1 / x^abs(y)` if x is bigger than 2^128. * At the end of the operations, we invert the result if needed. * @param x The unsigned 128.128-binary fixed-point number for which to calculate the power * @param y A relative number without any decimals, needs to be between ]-2^21; 2^21[ */ function pow(uint256 x, int256 y) internal pure returns (uint256 result) { bool invert; uint256 absY; if (y == 0) return Constants.SCALE; assembly { absY := y if slt(absY, 0) { absY := sub(0, absY) invert := iszero(invert) } } if (absY < 0x100000) { result = Constants.SCALE; assembly { let squared := x if gt(x, 0xffffffffffffffffffffffffffffffff) { squared := div(not(0), squared) invert := iszero(invert) } if and(absY, 0x1) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x2) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x4) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x8) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x10) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x20) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x40) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x80) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x100) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x200) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x400) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x800) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x1000) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x2000) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x4000) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x8000) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x10000) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x20000) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x40000) { result := shr(128, mul(result, squared)) } squared := shr(128, mul(squared, squared)) if and(absY, 0x80000) { result := shr(128, mul(result, squared)) } } } // revert if y is too big or if x^y underflowed if (result == 0) revert Uint128x128Math__PowUnderflow(x, y); return invert ? type(uint256).max / result : result; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; /** * @title Liquidity Book Constants Library * @author Trader Joe * @notice Set of constants for Liquidity Book contracts */ library Constants { uint8 internal constant SCALE_OFFSET = 128; uint256 internal constant SCALE = 1 << SCALE_OFFSET; uint256 internal constant PRECISION = 1e18; uint256 internal constant SQUARED_PRECISION = PRECISION * PRECISION; uint256 internal constant MAX_FEE = 0.1e18; // 10% uint256 internal constant MAX_PROTOCOL_SHARE = 2_500; // 25% of the fee uint256 internal constant BASIS_POINT_MAX = 10_000; // (2^256 - 1) / (2 * log(2**128) / log(1.0001)) uint256 internal constant MAX_LIQUIDITY_PER_BIN = 65251743116719673010965625540244653191619923014385985379600384103134737; /// @dev The expected return after a successful flash loan bytes32 internal constant CALLBACK_SUCCESS = keccak256("LBPair.onFlashLoan"); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {Constants} from "../Constants.sol"; /** * @title Liquidity Book Packed Uint128 Math Library * @author Trader Joe * @notice This library contains functions to encode and decode two uint128 into a single bytes32 * and interact with the encoded bytes32. */ library PackedUint128Math { error PackedUint128Math__AddOverflow(); error PackedUint128Math__SubUnderflow(); error PackedUint128Math__MultiplierTooLarge(); uint256 private constant OFFSET = 128; uint256 private constant MASK_128 = 0xffffffffffffffffffffffffffffffff; uint256 private constant MASK_128_PLUS_ONE = MASK_128 + 1; /** * @dev Encodes two uint128 into a single bytes32 * @param x1 The first uint128 * @param x2 The second uint128 * @return z The encoded bytes32 as follows: * [0 - 128[: x1 * [128 - 256[: x2 */ function encode(uint128 x1, uint128 x2) internal pure returns (bytes32 z) { assembly { z := or(and(x1, MASK_128), shl(OFFSET, x2)) } } /** * @dev Encodes a uint128 into a single bytes32 as the first uint128 * @param x1 The uint128 * @return z The encoded bytes32 as follows: * [0 - 128[: x1 * [128 - 256[: empty */ function encodeFirst(uint128 x1) internal pure returns (bytes32 z) { assembly { z := and(x1, MASK_128) } } /** * @dev Encodes a uint128 into a single bytes32 as the second uint128 * @param x2 The uint128 * @return z The encoded bytes32 as follows: * [0 - 128[: empty * [128 - 256[: x2 */ function encodeSecond(uint128 x2) internal pure returns (bytes32 z) { assembly { z := shl(OFFSET, x2) } } /** * @dev Encodes a uint128 into a single bytes32 as the first or second uint128 * @param x The uint128 * @param first Whether to encode as the first or second uint128 * @return z The encoded bytes32 as follows: * if first: * [0 - 128[: x * [128 - 256[: empty * else: * [0 - 128[: empty * [128 - 256[: x */ function encode(uint128 x, bool first) internal pure returns (bytes32 z) { return first ? encodeFirst(x) : encodeSecond(x); } /** * @dev Decodes a bytes32 into two uint128 * @param z The encoded bytes32 as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @return x1 The first uint128 * @return x2 The second uint128 */ function decode(bytes32 z) internal pure returns (uint128 x1, uint128 x2) { assembly { x1 := and(z, MASK_128) x2 := shr(OFFSET, z) } } /** * @dev Decodes a bytes32 into a uint128 as the first uint128 * @param z The encoded bytes32 as follows: * [0 - 128[: x * [128 - 256[: any * @return x The first uint128 */ function decodeX(bytes32 z) internal pure returns (uint128 x) { assembly { x := and(z, MASK_128) } } /** * @dev Decodes a bytes32 into a uint128 as the second uint128 * @param z The encoded bytes32 as follows: * [0 - 128[: any * [128 - 256[: y * @return y The second uint128 */ function decodeY(bytes32 z) internal pure returns (uint128 y) { assembly { y := shr(OFFSET, z) } } /** * @dev Decodes a bytes32 into a uint128 as the first or second uint128 * @param z The encoded bytes32 as follows: * if first: * [0 - 128[: x1 * [128 - 256[: empty * else: * [0 - 128[: empty * [128 - 256[: x2 * @param first Whether to decode as the first or second uint128 * @return x The decoded uint128 */ function decode(bytes32 z, bool first) internal pure returns (uint128 x) { return first ? decodeX(z) : decodeY(z); } /** * @dev Adds two encoded bytes32, reverting on overflow on any of the uint128 * @param x The first bytes32 encoded as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @param y The second bytes32 encoded as follows: * [0 - 128[: y1 * [128 - 256[: y2 * @return z The sum of x and y encoded as follows: * [0 - 128[: x1 + y1 * [128 - 256[: x2 + y2 */ function add(bytes32 x, bytes32 y) internal pure returns (bytes32 z) { assembly { z := add(x, y) } if (z < x || uint128(uint256(z)) < uint128(uint256(x))) { revert PackedUint128Math__AddOverflow(); } } /** * @dev Adds an encoded bytes32 and two uint128, reverting on overflow on any of the uint128 * @param x The bytes32 encoded as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @param y1 The first uint128 * @param y2 The second uint128 * @return z The sum of x and y encoded as follows: * [0 - 128[: x1 + y1 * [128 - 256[: x2 + y2 */ function add(bytes32 x, uint128 y1, uint128 y2) internal pure returns (bytes32) { return add(x, encode(y1, y2)); } /** * @dev Subtracts two encoded bytes32, reverting on underflow on any of the uint128 * @param x The first bytes32 encoded as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @param y The second bytes32 encoded as follows: * [0 - 128[: y1 * [128 - 256[: y2 * @return z The difference of x and y encoded as follows: * [0 - 128[: x1 - y1 * [128 - 256[: x2 - y2 */ function sub(bytes32 x, bytes32 y) internal pure returns (bytes32 z) { assembly { z := sub(x, y) } if (z > x || uint128(uint256(z)) > uint128(uint256(x))) { revert PackedUint128Math__SubUnderflow(); } } /** * @dev Subtracts an encoded bytes32 and two uint128, reverting on underflow on any of the uint128 * @param x The bytes32 encoded as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @param y1 The first uint128 * @param y2 The second uint128 * @return z The difference of x and y encoded as follows: * [0 - 128[: x1 - y1 * [128 - 256[: x2 - y2 */ function sub(bytes32 x, uint128 y1, uint128 y2) internal pure returns (bytes32) { return sub(x, encode(y1, y2)); } /** * @dev Returns whether any of the uint128 of x is strictly greater than the corresponding uint128 of y * @param x The first bytes32 encoded as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @param y The second bytes32 encoded as follows: * [0 - 128[: y1 * [128 - 256[: y2 * @return x1 < y1 || x2 < y2 */ function lt(bytes32 x, bytes32 y) internal pure returns (bool) { (uint128 x1, uint128 x2) = decode(x); (uint128 y1, uint128 y2) = decode(y); return x1 < y1 || x2 < y2; } /** * @dev Returns whether any of the uint128 of x is strictly greater than the corresponding uint128 of y * @param x The first bytes32 encoded as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @param y The second bytes32 encoded as follows: * [0 - 128[: y1 * [128 - 256[: y2 * @return x1 < y1 || x2 < y2 */ function gt(bytes32 x, bytes32 y) internal pure returns (bool) { (uint128 x1, uint128 x2) = decode(x); (uint128 y1, uint128 y2) = decode(y); return x1 > y1 || x2 > y2; } /** * @dev Multiplies an encoded bytes32 by a uint128 then divides the result by 10_000, rounding down * The result can't overflow as the multiplier needs to be smaller or equal to 10_000 * @param x The bytes32 encoded as follows: * [0 - 128[: x1 * [128 - 256[: x2 * @param multiplier The uint128 to multiply by (must be smaller or equal to 10_000) * @return z The product of x and multiplier encoded as follows: * [0 - 128[: floor((x1 * multiplier) / 10_000) * [128 - 256[: floor((x2 * multiplier) / 10_000) */ function scalarMulDivBasisPointRoundDown(bytes32 x, uint128 multiplier) internal pure returns (bytes32 z) { if (multiplier == 0) return 0; uint256 BASIS_POINT_MAX = Constants.BASIS_POINT_MAX; if (multiplier > BASIS_POINT_MAX) revert PackedUint128Math__MultiplierTooLarge(); (uint128 x1, uint128 x2) = decode(x); assembly { x1 := div(mul(x1, multiplier), BASIS_POINT_MAX) x2 := div(mul(x2, multiplier), BASIS_POINT_MAX) } return encode(x1, x2); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {Constants} from "./Constants.sol"; import {SafeCast} from "./math/SafeCast.sol"; import {Encoded} from "./math/Encoded.sol"; /** * @title Liquidity Book Pair Parameter Helper Library * @author Trader Joe * @dev This library contains functions to get and set parameters of a pair * The parameters are stored in a single bytes32 variable in the following format: * [0 - 16[: base factor (16 bits) * [16 - 28[: filter period (12 bits) * [28 - 40[: decay period (12 bits) * [40 - 54[: reduction factor (14 bits) * [54 - 78[: variable fee control (24 bits) * [78 - 92[: protocol share (14 bits) * [92 - 112[: max volatility accumulator (20 bits) * [112 - 132[: volatility accumulator (20 bits) * [132 - 152[: volatility reference (20 bits) * [152 - 176[: index reference (24 bits) * [176 - 216[: time of last update (40 bits) * [216 - 232[: oracle index (16 bits) * [232 - 256[: active index (24 bits) */ library PairParameterHelper { using SafeCast for uint256; using Encoded for bytes32; error PairParametersHelper__InvalidParameter(); uint256 internal constant OFFSET_BASE_FACTOR = 0; uint256 internal constant OFFSET_FILTER_PERIOD = 16; uint256 internal constant OFFSET_DECAY_PERIOD = 28; uint256 internal constant OFFSET_REDUCTION_FACTOR = 40; uint256 internal constant OFFSET_VAR_FEE_CONTROL = 54; uint256 internal constant OFFSET_PROTOCOL_SHARE = 78; uint256 internal constant OFFSET_MAX_VOL_ACC = 92; uint256 internal constant OFFSET_VOL_ACC = 112; uint256 internal constant OFFSET_VOL_REF = 132; uint256 internal constant OFFSET_ID_REF = 152; uint256 internal constant OFFSET_TIME_LAST_UPDATE = 176; uint256 internal constant OFFSET_ORACLE_ID = 216; uint256 internal constant OFFSET_ACTIVE_ID = 232; uint256 internal constant MASK_STATIC_PARAMETER = 0xffffffffffffffffffffffffffff; /** * @dev Get the base factor from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 16[: base factor (16 bits) * [16 - 256[: other parameters * @return baseFactor The base factor */ function getBaseFactor(bytes32 params) internal pure returns (uint16 baseFactor) { baseFactor = params.decodeUint16(OFFSET_BASE_FACTOR); } /** * @dev Get the filter period from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 16[: other parameters * [16 - 28[: filter period (12 bits) * [28 - 256[: other parameters * @return filterPeriod The filter period */ function getFilterPeriod(bytes32 params) internal pure returns (uint16 filterPeriod) { filterPeriod = params.decodeUint12(OFFSET_FILTER_PERIOD); } /** * @dev Get the decay period from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 28[: other parameters * [28 - 40[: decay period (12 bits) * [40 - 256[: other parameters * @return decayPeriod The decay period */ function getDecayPeriod(bytes32 params) internal pure returns (uint16 decayPeriod) { decayPeriod = params.decodeUint12(OFFSET_DECAY_PERIOD); } /** * @dev Get the reduction factor from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 40[: other parameters * [40 - 54[: reduction factor (14 bits) * [54 - 256[: other parameters * @return reductionFactor The reduction factor */ function getReductionFactor(bytes32 params) internal pure returns (uint16 reductionFactor) { reductionFactor = params.decodeUint14(OFFSET_REDUCTION_FACTOR); } /** * @dev Get the variable fee control from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 54[: other parameters * [54 - 78[: variable fee control (24 bits) * [78 - 256[: other parameters * @return variableFeeControl The variable fee control */ function getVariableFeeControl(bytes32 params) internal pure returns (uint24 variableFeeControl) { variableFeeControl = params.decodeUint24(OFFSET_VAR_FEE_CONTROL); } /** * @dev Get the protocol share from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 78[: other parameters * [78 - 92[: protocol share (14 bits) * [92 - 256[: other parameters * @return protocolShare The protocol share */ function getProtocolShare(bytes32 params) internal pure returns (uint16 protocolShare) { protocolShare = params.decodeUint14(OFFSET_PROTOCOL_SHARE); } /** * @dev Get the max volatility accumulator from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 92[: other parameters * [92 - 112[: max volatility accumulator (20 bits) * [112 - 256[: other parameters * @return maxVolatilityAccumulator The max volatility accumulator */ function getMaxVolatilityAccumulator(bytes32 params) internal pure returns (uint24 maxVolatilityAccumulator) { maxVolatilityAccumulator = params.decodeUint20(OFFSET_MAX_VOL_ACC); } /** * @dev Get the volatility accumulator from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 112[: other parameters * [112 - 132[: volatility accumulator (20 bits) * [132 - 256[: other parameters * @return volatilityAccumulator The volatility accumulator */ function getVolatilityAccumulator(bytes32 params) internal pure returns (uint24 volatilityAccumulator) { volatilityAccumulator = params.decodeUint20(OFFSET_VOL_ACC); } /** * @dev Get the volatility reference from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 132[: other parameters * [132 - 152[: volatility reference (20 bits) * [152 - 256[: other parameters * @return volatilityReference The volatility reference */ function getVolatilityReference(bytes32 params) internal pure returns (uint24 volatilityReference) { volatilityReference = params.decodeUint20(OFFSET_VOL_REF); } /** * @dev Get the index reference from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 152[: other parameters * [152 - 176[: index reference (24 bits) * [176 - 256[: other parameters * @return idReference The index reference */ function getIdReference(bytes32 params) internal pure returns (uint24 idReference) { idReference = params.decodeUint24(OFFSET_ID_REF); } /** * @dev Get the time of last update from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 176[: other parameters * [176 - 216[: time of last update (40 bits) * [216 - 256[: other parameters * @return timeOflastUpdate The time of last update */ function getTimeOfLastUpdate(bytes32 params) internal pure returns (uint40 timeOflastUpdate) { timeOflastUpdate = params.decodeUint40(OFFSET_TIME_LAST_UPDATE); } /** * @dev Get the oracle id from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 216[: other parameters * [216 - 232[: oracle id (16 bits) * [232 - 256[: other parameters * @return oracleId The oracle id */ function getOracleId(bytes32 params) internal pure returns (uint16 oracleId) { oracleId = params.decodeUint16(OFFSET_ORACLE_ID); } /** * @dev Get the active index from the encoded pair parameters * @param params The encoded pair parameters, as follows: * [0 - 232[: other parameters * [232 - 256[: active index (24 bits) * @return activeId The active index */ function getActiveId(bytes32 params) internal pure returns (uint24 activeId) { activeId = params.decodeUint24(OFFSET_ACTIVE_ID); } /** * @dev Get the delta between the current active index and the cached active index * @param params The encoded pair parameters, as follows: * [0 - 232[: other parameters * [232 - 256[: active index (24 bits) * @param activeId The current active index * @return The delta */ function getDeltaId(bytes32 params, uint24 activeId) internal pure returns (uint24) { uint24 id = getActiveId(params); unchecked { return activeId > id ? activeId - id : id - activeId; } } /** * @dev Calculates the base fee, with 18 decimals * @param params The encoded pair parameters * @param binStep The bin step (in basis points) * @return baseFee The base fee */ function getBaseFee(bytes32 params, uint16 binStep) internal pure returns (uint256) { unchecked { // Base factor is in basis points, binStep is in basis points, so we multiply by 1e10 return uint256(getBaseFactor(params)) * binStep * 1e10; } } /** * @dev Calculates the variable fee * @param params The encoded pair parameters * @param binStep The bin step (in basis points) * @return variableFee The variable fee */ function getVariableFee(bytes32 params, uint16 binStep) internal pure returns (uint256 variableFee) { uint256 variableFeeControl = getVariableFeeControl(params); if (variableFeeControl != 0) { unchecked { // The volatility accumulator is in basis points, binStep is in basis points, // and the variable fee control is in basis points, so the result is in 100e18th uint256 prod = uint256(getVolatilityAccumulator(params)) * binStep; variableFee = (prod * prod * variableFeeControl + 99) / 100; } } } /** * @dev Calculates the total fee, which is the sum of the base fee and the variable fee * @param params The encoded pair parameters * @param binStep The bin step (in basis points) * @return totalFee The total fee */ function getTotalFee(bytes32 params, uint16 binStep) internal pure returns (uint128) { unchecked { return (getBaseFee(params, binStep) + getVariableFee(params, binStep)).safe128(); } } /** * @dev Set the oracle id in the encoded pair parameters * @param params The encoded pair parameters * @param oracleId The oracle id * @return The updated encoded pair parameters */ function setOracleId(bytes32 params, uint16 oracleId) internal pure returns (bytes32) { return params.set(oracleId, Encoded.MASK_UINT16, OFFSET_ORACLE_ID); } /** * @dev Set the volatility reference in the encoded pair parameters * @param params The encoded pair parameters * @param volRef The volatility reference * @return The updated encoded pair parameters */ function setVolatilityReference(bytes32 params, uint24 volRef) internal pure returns (bytes32) { if (volRef > Encoded.MASK_UINT20) revert PairParametersHelper__InvalidParameter(); return params.set(volRef, Encoded.MASK_UINT20, OFFSET_VOL_REF); } /** * @dev Set the volatility accumulator in the encoded pair parameters * @param params The encoded pair parameters * @param volAcc The volatility accumulator * @return The updated encoded pair parameters */ function setVolatilityAccumulator(bytes32 params, uint24 volAcc) internal pure returns (bytes32) { if (volAcc > Encoded.MASK_UINT20) revert PairParametersHelper__InvalidParameter(); return params.set(volAcc, Encoded.MASK_UINT20, OFFSET_VOL_ACC); } /** * @dev Set the active id in the encoded pair parameters * @param params The encoded pair parameters * @param activeId The active id * @return newParams The updated encoded pair parameters */ function setActiveId(bytes32 params, uint24 activeId) internal pure returns (bytes32 newParams) { return params.set(activeId, Encoded.MASK_UINT24, OFFSET_ACTIVE_ID); } /** * @dev Sets the static fee parameters in the encoded pair parameters * @param params The encoded pair parameters * @param baseFactor The base factor * @param filterPeriod The filter period * @param decayPeriod The decay period * @param reductionFactor The reduction factor * @param variableFeeControl The variable fee control * @param protocolShare The protocol share * @param maxVolatilityAccumulator The max volatility accumulator * @return newParams The updated encoded pair parameters */ function setStaticFeeParameters( bytes32 params, uint16 baseFactor, uint16 filterPeriod, uint16 decayPeriod, uint16 reductionFactor, uint24 variableFeeControl, uint16 protocolShare, uint24 maxVolatilityAccumulator ) internal pure returns (bytes32 newParams) { if ( filterPeriod > decayPeriod || decayPeriod > Encoded.MASK_UINT12 || reductionFactor > Constants.BASIS_POINT_MAX || protocolShare > Constants.MAX_PROTOCOL_SHARE || maxVolatilityAccumulator > Encoded.MASK_UINT20 ) revert PairParametersHelper__InvalidParameter(); newParams = newParams.set(baseFactor, Encoded.MASK_UINT16, OFFSET_BASE_FACTOR); newParams = newParams.set(filterPeriod, Encoded.MASK_UINT12, OFFSET_FILTER_PERIOD); newParams = newParams.set(decayPeriod, Encoded.MASK_UINT12, OFFSET_DECAY_PERIOD); newParams = newParams.set(reductionFactor, Encoded.MASK_UINT14, OFFSET_REDUCTION_FACTOR); newParams = newParams.set(variableFeeControl, Encoded.MASK_UINT24, OFFSET_VAR_FEE_CONTROL); newParams = newParams.set(protocolShare, Encoded.MASK_UINT14, OFFSET_PROTOCOL_SHARE); newParams = newParams.set(maxVolatilityAccumulator, Encoded.MASK_UINT20, OFFSET_MAX_VOL_ACC); return params.set(uint256(newParams), MASK_STATIC_PARAMETER, 0); } /** * @dev Updates the index reference in the encoded pair parameters * @param params The encoded pair parameters * @return newParams The updated encoded pair parameters */ function updateIdReference(bytes32 params) internal pure returns (bytes32 newParams) { uint24 activeId = getActiveId(params); return params.set(activeId, Encoded.MASK_UINT24, OFFSET_ID_REF); } /** * @dev Updates the time of last update in the encoded pair parameters * @param params The encoded pair parameters * @param timestamp The timestamp * @return newParams The updated encoded pair parameters */ function updateTimeOfLastUpdate(bytes32 params, uint256 timestamp) internal pure returns (bytes32 newParams) { uint40 currentTime = timestamp.safe40(); return params.set(currentTime, Encoded.MASK_UINT40, OFFSET_TIME_LAST_UPDATE); } /** * @dev Updates the volatility reference in the encoded pair parameters * @param params The encoded pair parameters * @return The updated encoded pair parameters */ function updateVolatilityReference(bytes32 params) internal pure returns (bytes32) { uint256 volAcc = getVolatilityAccumulator(params); uint256 reductionFactor = getReductionFactor(params); uint24 volRef; unchecked { volRef = uint24(volAcc * reductionFactor / Constants.BASIS_POINT_MAX); } return setVolatilityReference(params, volRef); } /** * @dev Updates the volatility accumulator in the encoded pair parameters * @param params The encoded pair parameters * @param activeId The active id * @return The updated encoded pair parameters */ function updateVolatilityAccumulator(bytes32 params, uint24 activeId) internal pure returns (bytes32) { uint256 idReference = getIdReference(params); uint256 deltaId; uint256 volAcc; unchecked { deltaId = activeId > idReference ? activeId - idReference : idReference - activeId; volAcc = (uint256(getVolatilityReference(params)) + deltaId * Constants.BASIS_POINT_MAX); } uint256 maxVolAcc = getMaxVolatilityAccumulator(params); volAcc = volAcc > maxVolAcc ? maxVolAcc : volAcc; return setVolatilityAccumulator(params, uint24(volAcc)); } /** * @dev Updates the volatility reference and the volatility accumulator in the encoded pair parameters * @param params The encoded pair parameters * @param timestamp The timestamp * @return The updated encoded pair parameters */ function updateReferences(bytes32 params, uint256 timestamp) internal pure returns (bytes32) { uint256 dt = timestamp - getTimeOfLastUpdate(params); if (dt >= getFilterPeriod(params)) { params = updateIdReference(params); params = dt < getDecayPeriod(params) ? updateVolatilityReference(params) : setVolatilityReference(params, 0); } return updateTimeOfLastUpdate(params, timestamp); } /** * @dev Updates the volatility reference and the volatility accumulator in the encoded pair parameters * @param params The encoded pair parameters * @param activeId The active id * @param timestamp The timestamp * @return The updated encoded pair parameters */ function updateVolatilityParameters(bytes32 params, uint24 activeId, uint256 timestamp) internal pure returns (bytes32) { params = updateReferences(params, timestamp); return updateVolatilityAccumulator(params, activeId); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {Constants} from "./Constants.sol"; /** * @title Liquidity Book Fee Helper Library * @author Trader Joe * @notice This library contains functions to calculate fees */ library FeeHelper { error FeeHelper__FeeTooLarge(); error FeeHelper__ProtocolShareTooLarge(); /** * @dev Modifier to check that the fee is not too large * @param fee The fee */ modifier verifyFee(uint128 fee) { _verifyFee(fee); _; } /** * @dev Modifier to check that the protocol share is not too large * @param protocolShare The protocol share */ modifier verifyProtocolShare(uint128 protocolShare) { if (protocolShare > Constants.MAX_PROTOCOL_SHARE) revert FeeHelper__ProtocolShareTooLarge(); _; } /** * @dev Calculates the fee amount from the amount with fees, rounding up * @param amountWithFees The amount with fees * @param totalFee The total fee * @return feeAmount The fee amount */ function getFeeAmountFrom(uint128 amountWithFees, uint128 totalFee) internal pure verifyFee(totalFee) returns (uint128) { unchecked { // Can't overflow, max(result) = (type(uint128).max * 0.1e18 + 1e18 - 1) / 1e18 < 2^128 return uint128((uint256(amountWithFees) * totalFee + Constants.PRECISION - 1) / Constants.PRECISION); } } /** * @dev Calculates the fee amount that will be charged, rounding up * @param amount The amount * @param totalFee The total fee * @return feeAmount The fee amount */ function getFeeAmount(uint128 amount, uint128 totalFee) internal pure verifyFee(totalFee) returns (uint128) { unchecked { uint256 denominator = Constants.PRECISION - totalFee; // Can't overflow, max(result) = (type(uint128).max * 0.1e18 + (1e18 - 1)) / 0.9e18 < 2^128 return uint128((uint256(amount) * totalFee + denominator - 1) / denominator); } } /** * @dev Calculates the composition fee amount from the amount with fees, rounding down * @param amountWithFees The amount with fees * @param totalFee The total fee * @return The amount with fees */ function getCompositionFee(uint128 amountWithFees, uint128 totalFee) internal pure verifyFee(totalFee) returns (uint128) { unchecked { uint256 denominator = Constants.SQUARED_PRECISION; // Can't overflow, max(result) = type(uint128).max * 0.1e18 * 1.1e18 / 1e36 <= 2^128 * 0.11e36 / 1e36 < 2^128 return uint128(uint256(amountWithFees) * totalFee * (uint256(totalFee) + Constants.PRECISION) / denominator); } } /** * @dev Calculates the protocol fee amount from the fee amount and the protocol share, rounding down * @param feeAmount The fee amount * @param protocolShare The protocol share * @return protocolFeeAmount The protocol fee amount */ function getProtocolFeeAmount(uint128 feeAmount, uint128 protocolShare) internal pure verifyProtocolShare(protocolShare) returns (uint128) { unchecked { return uint128(uint256(feeAmount) * protocolShare / Constants.BASIS_POINT_MAX); } } /** * @dev Internal function to check that the fee is not too large * @param fee The fee */ function _verifyFee(uint128 fee) private pure { if (fee > Constants.MAX_FEE) revert FeeHelper__FeeTooLarge(); } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; /** * @title Liquidity Book Token Helper Library * @author Trader Joe * @notice 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 TokenHelper for IERC20;` statement to your contract, * which allows you to call the safe operation as `token.safeTransfer(...)` */ library TokenHelper { error TokenHelper__TransferFailed(); /** * @notice Transfers token and reverts if the transfer fails * @param token The address of the token * @param owner The owner of the tokens * @param recipient The address of the recipient * @param amount The amount to send */ function safeTransferFrom(IERC20 token, address owner, address recipient, uint256 amount) internal { bytes memory data = abi.encodeWithSelector(token.transferFrom.selector, owner, recipient, amount); _callAndCatch(token, data); } /** * @notice Transfers token and reverts if the transfer fails * @param token The address of the token * @param recipient The address of the recipient * @param amount The amount to send */ function safeTransfer(IERC20 token, address recipient, uint256 amount) internal { bytes memory data = abi.encodeWithSelector(token.transfer.selector, recipient, amount); _callAndCatch(token, data); } function _callAndCatch(IERC20 token, bytes memory data) internal { bool success; assembly { mstore(0x00, 0) success := call(gas(), token, 0, add(data, 0x20), mload(data), 0x00, 0x20) switch success case 0 { if returndatasize() { returndatacopy(0x00, 0x00, returndatasize()) revert(0x00, returndatasize()) } } default { switch returndatasize() case 0 { success := iszero(iszero(extcodesize(token))) } default { success := and(success, eq(mload(0x00), 1)) } } } if (!success) revert TokenHelper__TransferFailed(); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (token/ERC20/utils/SafeERC20.sol) pragma solidity ^0.8.20; import {IERC20} from "../IERC20.sol"; import {IERC1363} from "../../../interfaces/IERC1363.sol"; import {Address} from "../../../utils/Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC-20 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. */ library SafeERC20 { using Address for address; /** * @dev An operation with an ERC-20 token failed. */ error SafeERC20FailedOperation(address token); /** * @dev Indicates a failed `decreaseAllowance` request. */ error SafeERC20FailedDecreaseAllowance(address spender, uint256 currentAllowance, uint256 requestedDecrease); /** * @dev Transfer `value` amount of `token` from the calling contract to `to`. If `token` returns no value, * non-reverting calls are assumed to be successful. */ function safeTransfer(IERC20 token, address to, uint256 value) internal { _callOptionalReturn(token, abi.encodeCall(token.transfer, (to, value))); } /** * @dev Transfer `value` amount of `token` from `from` to `to`, spending the approval given by `from` to the * calling contract. If `token` returns no value, non-reverting calls are assumed to be successful. */ function safeTransferFrom(IERC20 token, address from, address to, uint256 value) internal { _callOptionalReturn(token, abi.encodeCall(token.transferFrom, (from, to, value))); } /** * @dev Increase the calling contract's allowance toward `spender` by `value`. If `token` returns no value, * non-reverting calls are assumed to be successful. */ function safeIncreaseAllowance(IERC20 token, address spender, uint256 value) internal { uint256 oldAllowance = token.allowance(address(this), spender); forceApprove(token, spender, oldAllowance + value); } /** * @dev Decrease the calling contract's allowance toward `spender` by `requestedDecrease`. If `token` returns no * value, non-reverting calls are assumed to be successful. */ function safeDecreaseAllowance(IERC20 token, address spender, uint256 requestedDecrease) internal { unchecked { uint256 currentAllowance = token.allowance(address(this), spender); if (currentAllowance < requestedDecrease) { revert SafeERC20FailedDecreaseAllowance(spender, currentAllowance, requestedDecrease); } forceApprove(token, spender, currentAllowance - requestedDecrease); } } /** * @dev Set the calling contract's allowance toward `spender` to `value`. If `token` returns no value, * non-reverting calls are assumed to be successful. Meant to be used with tokens that require the approval * to be set to zero before setting it to a non-zero value, such as USDT. */ function forceApprove(IERC20 token, address spender, uint256 value) internal { bytes memory approvalCall = abi.encodeCall(token.approve, (spender, value)); if (!_callOptionalReturnBool(token, approvalCall)) { _callOptionalReturn(token, abi.encodeCall(token.approve, (spender, 0))); _callOptionalReturn(token, approvalCall); } } /** * @dev Performs an {ERC1363} transferAndCall, with a fallback to the simple {ERC20} transfer if the target has no * code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when * targeting contracts. * * Reverts if the returned value is other than `true`. */ function transferAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal { if (to.code.length == 0) { safeTransfer(token, to, value); } else if (!token.transferAndCall(to, value, data)) { revert SafeERC20FailedOperation(address(token)); } } /** * @dev Performs an {ERC1363} transferFromAndCall, with a fallback to the simple {ERC20} transferFrom if the target * has no code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when * targeting contracts. * * Reverts if the returned value is other than `true`. */ function transferFromAndCallRelaxed( IERC1363 token, address from, address to, uint256 value, bytes memory data ) internal { if (to.code.length == 0) { safeTransferFrom(token, from, to, value); } else if (!token.transferFromAndCall(from, to, value, data)) { revert SafeERC20FailedOperation(address(token)); } } /** * @dev Performs an {ERC1363} approveAndCall, with a fallback to the simple {ERC20} approve if the target has no * code. This can be used to implement an {ERC721}-like safe transfer that rely on {ERC1363} checks when * targeting contracts. * * NOTE: When the recipient address (`to`) has no code (i.e. is an EOA), this function behaves as {forceApprove}. * Opposedly, when the recipient address (`to`) has code, this function only attempts to call {ERC1363-approveAndCall} * once without retrying, and relies on the returned value to be true. * * Reverts if the returned value is other than `true`. */ function approveAndCallRelaxed(IERC1363 token, address to, uint256 value, bytes memory data) internal { if (to.code.length == 0) { forceApprove(token, to, value); } else if (!token.approveAndCall(to, value, data)) { revert SafeERC20FailedOperation(address(token)); } } /** * @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, bytes memory 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. bytes memory returndata = address(token).functionCall(data); if (returndata.length != 0 && !abi.decode(returndata, (bool))) { revert SafeERC20FailedOperation(address(token)); } } /** * @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). * * This is a variant of {_callOptionalReturn} that silents catches all reverts and returns a bool instead. */ function _callOptionalReturnBool(IERC20 token, bytes memory data) private returns (bool) { // 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 cannot use {Address-functionCall} here since this should return false // and not revert is the subcall reverts. (bool success, bytes memory returndata) = address(token).call(data); return success && (returndata.length == 0 || abi.decode(returndata, (bool))) && address(token).code.length > 0; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.1) (utils/Context.sol) pragma solidity ^0.8.20; import {Initializable} from "../proxy/utils/Initializable.sol"; /** * @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. */ abstract contract ContextUpgradeable is Initializable { function __Context_init() internal onlyInitializing { } function __Context_init_unchained() internal onlyInitializing { } function _msgSender() internal view virtual returns (address) { return msg.sender; } function _msgData() internal view virtual returns (bytes calldata) { return msg.data; } function _contextSuffixLength() internal view virtual returns (uint256) { return 0; } }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; /** * @title Liquidity Book Encoded Library * @author Trader Joe * @notice Helper contract used for decoding bytes32 sample */ library Encoded { uint256 internal constant MASK_UINT1 = 0x1; uint256 internal constant MASK_UINT8 = 0xff; uint256 internal constant MASK_UINT12 = 0xfff; uint256 internal constant MASK_UINT14 = 0x3fff; uint256 internal constant MASK_UINT16 = 0xffff; uint256 internal constant MASK_UINT20 = 0xfffff; uint256 internal constant MASK_UINT24 = 0xffffff; uint256 internal constant MASK_UINT40 = 0xffffffffff; uint256 internal constant MASK_UINT64 = 0xffffffffffffffff; uint256 internal constant MASK_UINT128 = 0xffffffffffffffffffffffffffffffff; /** * @notice Internal function to set a value in an encoded bytes32 using a mask and offset * @dev This function can overflow * @param encoded The previous encoded value * @param value The value to encode * @param mask The mask * @param offset The offset * @return newEncoded The new encoded value */ function set(bytes32 encoded, uint256 value, uint256 mask, uint256 offset) internal pure returns (bytes32 newEncoded) { assembly { newEncoded := and(encoded, not(shl(offset, mask))) newEncoded := or(newEncoded, shl(offset, and(value, mask))) } } /** * @notice Internal function to set a bool in an encoded bytes32 using an offset * @dev This function can overflow * @param encoded The previous encoded value * @param boolean The bool to encode * @param offset The offset * @return newEncoded The new encoded value */ function setBool(bytes32 encoded, bool boolean, uint256 offset) internal pure returns (bytes32 newEncoded) { return set(encoded, boolean ? 1 : 0, MASK_UINT1, offset); } /** * @notice Internal function to decode a bytes32 sample using a mask and offset * @dev This function can overflow * @param encoded The encoded value * @param mask The mask * @param offset The offset * @return value The decoded value */ function decode(bytes32 encoded, uint256 mask, uint256 offset) internal pure returns (uint256 value) { assembly { value := and(shr(offset, encoded), mask) } } /** * @notice Internal function to decode a bytes32 sample into a bool using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return boolean The decoded value as a bool */ function decodeBool(bytes32 encoded, uint256 offset) internal pure returns (bool boolean) { assembly { boolean := and(shr(offset, encoded), MASK_UINT1) } } /** * @notice Internal function to decode a bytes32 sample into a uint8 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value */ function decodeUint8(bytes32 encoded, uint256 offset) internal pure returns (uint8 value) { assembly { value := and(shr(offset, encoded), MASK_UINT8) } } /** * @notice Internal function to decode a bytes32 sample into a uint12 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value as a uint16, since uint12 is not supported */ function decodeUint12(bytes32 encoded, uint256 offset) internal pure returns (uint16 value) { assembly { value := and(shr(offset, encoded), MASK_UINT12) } } /** * @notice Internal function to decode a bytes32 sample into a uint14 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value as a uint16, since uint14 is not supported */ function decodeUint14(bytes32 encoded, uint256 offset) internal pure returns (uint16 value) { assembly { value := and(shr(offset, encoded), MASK_UINT14) } } /** * @notice Internal function to decode a bytes32 sample into a uint16 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value */ function decodeUint16(bytes32 encoded, uint256 offset) internal pure returns (uint16 value) { assembly { value := and(shr(offset, encoded), MASK_UINT16) } } /** * @notice Internal function to decode a bytes32 sample into a uint20 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value as a uint24, since uint20 is not supported */ function decodeUint20(bytes32 encoded, uint256 offset) internal pure returns (uint24 value) { assembly { value := and(shr(offset, encoded), MASK_UINT20) } } /** * @notice Internal function to decode a bytes32 sample into a uint24 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value */ function decodeUint24(bytes32 encoded, uint256 offset) internal pure returns (uint24 value) { assembly { value := and(shr(offset, encoded), MASK_UINT24) } } /** * @notice Internal function to decode a bytes32 sample into a uint40 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value */ function decodeUint40(bytes32 encoded, uint256 offset) internal pure returns (uint40 value) { assembly { value := and(shr(offset, encoded), MASK_UINT40) } } /** * @notice Internal function to decode a bytes32 sample into a uint64 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value */ function decodeUint64(bytes32 encoded, uint256 offset) internal pure returns (uint64 value) { assembly { value := and(shr(offset, encoded), MASK_UINT64) } } /** * @notice Internal function to decode a bytes32 sample into a uint128 using an offset * @dev This function can overflow * @param encoded The encoded value * @param offset The offset * @return value The decoded value */ function decodeUint128(bytes32 encoded, uint256 offset) internal pure returns (uint128 value) { assembly { value := and(shr(offset, encoded), MASK_UINT128) } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC1363.sol) pragma solidity ^0.8.20; import {IERC20} from "./IERC20.sol"; import {IERC165} from "./IERC165.sol"; /** * @title IERC1363 * @dev Interface of the ERC-1363 standard as defined in the https://eips.ethereum.org/EIPS/eip-1363[ERC-1363]. * * Defines an extension interface for ERC-20 tokens that supports executing code on a recipient contract * after `transfer` or `transferFrom`, or code on a spender contract after `approve`, in a single transaction. */ interface IERC1363 is IERC20, IERC165 { /* * Note: the ERC-165 identifier for this interface is 0xb0202a11. * 0xb0202a11 === * bytes4(keccak256('transferAndCall(address,uint256)')) ^ * bytes4(keccak256('transferAndCall(address,uint256,bytes)')) ^ * bytes4(keccak256('transferFromAndCall(address,address,uint256)')) ^ * bytes4(keccak256('transferFromAndCall(address,address,uint256,bytes)')) ^ * bytes4(keccak256('approveAndCall(address,uint256)')) ^ * bytes4(keccak256('approveAndCall(address,uint256,bytes)')) */ /** * @dev Moves a `value` amount of tokens from the caller's account to `to` * and then calls {IERC1363Receiver-onTransferReceived} on `to`. * @param to The address which you want to transfer to. * @param value The amount of tokens to be transferred. * @return A boolean value indicating whether the operation succeeded unless throwing. */ function transferAndCall(address to, uint256 value) external returns (bool); /** * @dev Moves a `value` amount of tokens from the caller's account to `to` * and then calls {IERC1363Receiver-onTransferReceived} on `to`. * @param to The address which you want to transfer to. * @param value The amount of tokens to be transferred. * @param data Additional data with no specified format, sent in call to `to`. * @return A boolean value indicating whether the operation succeeded unless throwing. */ function transferAndCall(address to, uint256 value, bytes calldata data) external returns (bool); /** * @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism * and then calls {IERC1363Receiver-onTransferReceived} on `to`. * @param from The address which you want to send tokens from. * @param to The address which you want to transfer to. * @param value The amount of tokens to be transferred. * @return A boolean value indicating whether the operation succeeded unless throwing. */ function transferFromAndCall(address from, address to, uint256 value) external returns (bool); /** * @dev Moves a `value` amount of tokens from `from` to `to` using the allowance mechanism * and then calls {IERC1363Receiver-onTransferReceived} on `to`. * @param from The address which you want to send tokens from. * @param to The address which you want to transfer to. * @param value The amount of tokens to be transferred. * @param data Additional data with no specified format, sent in call to `to`. * @return A boolean value indicating whether the operation succeeded unless throwing. */ function transferFromAndCall(address from, address to, uint256 value, bytes calldata data) external returns (bool); /** * @dev Sets a `value` amount of tokens as the allowance of `spender` over the * caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`. * @param spender The address which will spend the funds. * @param value The amount of tokens to be spent. * @return A boolean value indicating whether the operation succeeded unless throwing. */ function approveAndCall(address spender, uint256 value) external returns (bool); /** * @dev Sets a `value` amount of tokens as the allowance of `spender` over the * caller's tokens and then calls {IERC1363Spender-onApprovalReceived} on `spender`. * @param spender The address which will spend the funds. * @param value The amount of tokens to be spent. * @param data Additional data with no specified format, sent in call to `spender`. * @return A boolean value indicating whether the operation succeeded unless throwing. */ function approveAndCall(address spender, uint256 value, bytes calldata data) external returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (utils/Address.sol) pragma solidity ^0.8.20; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev The ETH balance of the account is not enough to perform the operation. */ error AddressInsufficientBalance(address account); /** * @dev There's no code at `target` (it is not a contract). */ error AddressEmptyCode(address target); /** * @dev A call to an address target failed. The target may have reverted. */ error FailedInnerCall(); /** * @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://consensys.net/diligence/blog/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.8.20/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { if (address(this).balance < amount) { revert AddressInsufficientBalance(address(this)); } (bool success, ) = recipient.call{value: amount}(""); if (!success) { revert FailedInnerCall(); } } /** * @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 or custom error, it is bubbled * up by this function (like regular Solidity function calls). However, if * the call reverted with no returned reason, this function reverts with a * {FailedInnerCall} error. * * 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. */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCallWithValue(target, data, 0); } /** * @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`. */ function functionCallWithValue(address target, bytes memory data, uint256 value) internal returns (bytes memory) { if (address(this).balance < value) { revert AddressInsufficientBalance(address(this)); } (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResultFromTarget(target, success, returndata); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResultFromTarget(target, success, returndata); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResultFromTarget(target, success, returndata); } /** * @dev Tool to verify that a low level call to smart-contract was successful, and reverts if the target * was not a contract or bubbling up the revert reason (falling back to {FailedInnerCall}) in case of an * unsuccessful call. */ function verifyCallResultFromTarget( address target, bool success, bytes memory returndata ) internal view returns (bytes memory) { if (!success) { _revert(returndata); } else { // only check if target is a contract if the call was successful and the return data is empty // otherwise we already know that it was a contract if (returndata.length == 0 && target.code.length == 0) { revert AddressEmptyCode(target); } return returndata; } } /** * @dev Tool to verify that a low level call was successful, and reverts if it wasn't, either by bubbling the * revert reason or with a default {FailedInnerCall} error. */ function verifyCallResult(bool success, bytes memory returndata) internal pure returns (bytes memory) { if (!success) { _revert(returndata); } else { return returndata; } } /** * @dev Reverts with returndata if present. Otherwise reverts with {FailedInnerCall}. */ function _revert(bytes memory returndata) private pure { // Look for revert reason and bubble it up if present if (returndata.length > 0) { // The easiest way to bubble the revert reason is using memory via assembly /// @solidity memory-safe-assembly assembly { let returndata_size := mload(returndata) revert(add(32, returndata), returndata_size) } } else { revert FailedInnerCall(); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC20.sol) pragma solidity ^0.8.20; import {IERC20} from "../token/ERC20/IERC20.sol";
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC165.sol) pragma solidity ^0.8.20; import {IERC165} from "../utils/introspection/IERC165.sol";
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v5.0.0) (utils/introspection/IERC165.sol) pragma solidity ^0.8.20; /** * @dev Interface of the ERC-165 standard, as defined in the * https://eips.ethereum.org/EIPS/eip-165[ERC]. * * Implementers can declare support of contract interfaces, which can then be * queried by others ({ERC165Checker}). * * For an implementation, see {ERC165}. */ interface IERC165 { /** * @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[ERC section] * to learn more about how these ids are created. * * This function call must use less than 30 000 gas. */ function supportsInterface(bytes4 interfaceId) external view returns (bool); }
{ "remappings": [ "@lb-protocol/=lib/lb-rewarder/lib/dexv2/", "@moe-core/=lib/lb-rewarder/lib/moe-core/", "@openzeppelin/contracts-upgradeable/=lib/lb-rewarder/lib/openzeppelin-contracts-upgradeable/contracts/", "@openzeppelin/contracts/=lib/lb-rewarder/lib/openzeppelin-contracts/contracts/", "@solmate/=lib/lb-rewarder/lib/moe-core/lib/solmate/", "@tj-dexv2/=lib/lb-rewarder/lib/moe-core/lib/dexv2/", "dexv2/=lib/lb-rewarder/lib/dexv2/", "ds-test/=lib/lb-rewarder/lib/forge-std/lib/ds-test/src/", "erc4626-tests/=lib/lb-rewarder/lib/openzeppelin-contracts-upgradeable/lib/erc4626-tests/", "forge-std/=lib/forge-std/src/", "lb-rewarder/=lib/lb-rewarder/src/", "moe-core/=lib/lb-rewarder/lib/moe-core/", "openzeppelin-contracts-upgradeable/=lib/lb-rewarder/lib/openzeppelin-contracts-upgradeable/", "openzeppelin-contracts/=lib/lb-rewarder/lib/openzeppelin-contracts/", "solmate/=lib/lb-rewarder/lib/moe-core/lib/solmate/src/", "solrary/=lib/solrary/src/" ], "optimizer": { "enabled": true, "runs": 600 }, "metadata": { "useLiteralContent": false, "bytecodeHash": "ipfs", "appendCBOR": true }, "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } }, "evmVersion": "paris", "viaIR": false, "libraries": {} }
Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
[{"inputs":[{"internalType":"address","name":"lbHooksManager","type":"address"},{"internalType":"address","name":"masterChef","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[{"internalType":"address","name":"pair","type":"address"}],"name":"getActiveId","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address[]","name":"pairs","type":"address[]"},{"internalType":"address","name":"user","type":"address"},{"internalType":"uint256[][]","name":"ids","type":"uint256[][]"}],"name":"getBatchHooksData","outputs":[{"components":[{"components":[{"internalType":"address","name":"hooks","type":"address"},{"internalType":"bool","name":"beforeSwap","type":"bool"},{"internalType":"bool","name":"afterSwap","type":"bool"},{"internalType":"bool","name":"beforeFlashLoan","type":"bool"},{"internalType":"bool","name":"afterFlashLoan","type":"bool"},{"internalType":"bool","name":"beforeMint","type":"bool"},{"internalType":"bool","name":"afterMint","type":"bool"},{"internalType":"bool","name":"beforeBurn","type":"bool"},{"internalType":"bool","name":"afterBurn","type":"bool"},{"internalType":"bool","name":"beforeBatchTransferFrom","type":"bool"},{"internalType":"bool","name":"afterBatchTransferFrom","type":"bool"}],"internalType":"struct Hooks.Parameters","name":"hooksParameters","type":"tuple"},{"components":[{"internalType":"enum ILBHooksManager.LBHooksType","name":"hooksType","type":"uint8"},{"components":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct LBHooksLens.Token","name":"rewardToken","type":"tuple"},{"internalType":"uint256","name":"pid","type":"uint256"},{"internalType":"uint256","name":"moePerSecond","type":"uint256"},{"internalType":"uint256","name":"activeId","type":"uint256"},{"internalType":"uint256","name":"rangeStart","type":"uint256"},{"internalType":"uint256","name":"rangeEnd","type":"uint256"},{"internalType":"uint256","name":"pendingRewards","type":"uint256"},{"internalType":"uint256","name":"rewardPerSecond","type":"uint256"},{"internalType":"uint256","name":"lastUpdateTimestamp","type":"uint256"},{"internalType":"uint256","name":"endTimestamp","type":"uint256"},{"internalType":"uint256","name":"remainingRewards","type":"uint256"},{"internalType":"bool","name":"isStarted","type":"bool"},{"internalType":"bool","name":"isEnded","type":"bool"}],"internalType":"struct LBHooksLens.Parameters","name":"parameters","type":"tuple"},{"internalType":"uint256","name":"activeId","type":"uint256"}],"internalType":"struct LBHooksLens.HooksRewarderData[]","name":"rewarderData","type":"tuple[]"},{"components":[{"components":[{"internalType":"address","name":"hooks","type":"address"},{"internalType":"bool","name":"beforeSwap","type":"bool"},{"internalType":"bool","name":"afterSwap","type":"bool"},{"internalType":"bool","name":"beforeFlashLoan","type":"bool"},{"internalType":"bool","name":"afterFlashLoan","type":"bool"},{"internalType":"bool","name":"beforeMint","type":"bool"},{"internalType":"bool","name":"afterMint","type":"bool"},{"internalType":"bool","name":"beforeBurn","type":"bool"},{"internalType":"bool","name":"afterBurn","type":"bool"},{"internalType":"bool","name":"beforeBatchTransferFrom","type":"bool"},{"internalType":"bool","name":"afterBatchTransferFrom","type":"bool"}],"internalType":"struct Hooks.Parameters","name":"hooksParameters","type":"tuple"},{"components":[{"internalType":"enum ILBHooksManager.LBHooksType","name":"hooksType","type":"uint8"},{"components":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct LBHooksLens.Token","name":"rewardToken","type":"tuple"},{"internalType":"uint256","name":"pid","type":"uint256"},{"internalType":"uint256","name":"moePerSecond","type":"uint256"},{"internalType":"uint256","name":"activeId","type":"uint256"},{"internalType":"uint256","name":"rangeStart","type":"uint256"},{"internalType":"uint256","name":"rangeEnd","type":"uint256"},{"internalType":"uint256","name":"pendingRewards","type":"uint256"},{"internalType":"uint256","name":"rewardPerSecond","type":"uint256"},{"internalType":"uint256","name":"lastUpdateTimestamp","type":"uint256"},{"internalType":"uint256","name":"endTimestamp","type":"uint256"},{"internalType":"uint256","name":"remainingRewards","type":"uint256"},{"internalType":"bool","name":"isStarted","type":"bool"},{"internalType":"bool","name":"isEnded","type":"bool"}],"internalType":"struct LBHooksLens.Parameters","name":"parameters","type":"tuple"},{"internalType":"uint256","name":"activeId","type":"uint256"}],"internalType":"struct LBHooksLens.HooksRewarderData[]","name":"extraRewarderData","type":"tuple[]"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"rewarder","type":"address"}],"name":"getExtraHooks","outputs":[{"components":[{"internalType":"address","name":"hooks","type":"address"},{"internalType":"bool","name":"beforeSwap","type":"bool"},{"internalType":"bool","name":"afterSwap","type":"bool"},{"internalType":"bool","name":"beforeFlashLoan","type":"bool"},{"internalType":"bool","name":"afterFlashLoan","type":"bool"},{"internalType":"bool","name":"beforeMint","type":"bool"},{"internalType":"bool","name":"afterMint","type":"bool"},{"internalType":"bool","name":"beforeBurn","type":"bool"},{"internalType":"bool","name":"afterBurn","type":"bool"},{"internalType":"bool","name":"beforeBatchTransferFrom","type":"bool"},{"internalType":"bool","name":"afterBatchTransferFrom","type":"bool"}],"internalType":"struct Hooks.Parameters","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"pair","type":"address"}],"name":"getHooks","outputs":[{"components":[{"internalType":"address","name":"hooks","type":"address"},{"internalType":"bool","name":"beforeSwap","type":"bool"},{"internalType":"bool","name":"afterSwap","type":"bool"},{"internalType":"bool","name":"beforeFlashLoan","type":"bool"},{"internalType":"bool","name":"afterFlashLoan","type":"bool"},{"internalType":"bool","name":"beforeMint","type":"bool"},{"internalType":"bool","name":"afterMint","type":"bool"},{"internalType":"bool","name":"beforeBurn","type":"bool"},{"internalType":"bool","name":"afterBurn","type":"bool"},{"internalType":"bool","name":"beforeBatchTransferFrom","type":"bool"},{"internalType":"bool","name":"afterBatchTransferFrom","type":"bool"}],"internalType":"struct Hooks.Parameters","name":"","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"pair","type":"address"},{"internalType":"address","name":"user","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"getHooksData","outputs":[{"components":[{"components":[{"internalType":"address","name":"hooks","type":"address"},{"internalType":"bool","name":"beforeSwap","type":"bool"},{"internalType":"bool","name":"afterSwap","type":"bool"},{"internalType":"bool","name":"beforeFlashLoan","type":"bool"},{"internalType":"bool","name":"afterFlashLoan","type":"bool"},{"internalType":"bool","name":"beforeMint","type":"bool"},{"internalType":"bool","name":"afterMint","type":"bool"},{"internalType":"bool","name":"beforeBurn","type":"bool"},{"internalType":"bool","name":"afterBurn","type":"bool"},{"internalType":"bool","name":"beforeBatchTransferFrom","type":"bool"},{"internalType":"bool","name":"afterBatchTransferFrom","type":"bool"}],"internalType":"struct Hooks.Parameters","name":"hooksParameters","type":"tuple"},{"components":[{"internalType":"enum ILBHooksManager.LBHooksType","name":"hooksType","type":"uint8"},{"components":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct LBHooksLens.Token","name":"rewardToken","type":"tuple"},{"internalType":"uint256","name":"pid","type":"uint256"},{"internalType":"uint256","name":"moePerSecond","type":"uint256"},{"internalType":"uint256","name":"activeId","type":"uint256"},{"internalType":"uint256","name":"rangeStart","type":"uint256"},{"internalType":"uint256","name":"rangeEnd","type":"uint256"},{"internalType":"uint256","name":"pendingRewards","type":"uint256"},{"internalType":"uint256","name":"rewardPerSecond","type":"uint256"},{"internalType":"uint256","name":"lastUpdateTimestamp","type":"uint256"},{"internalType":"uint256","name":"endTimestamp","type":"uint256"},{"internalType":"uint256","name":"remainingRewards","type":"uint256"},{"internalType":"bool","name":"isStarted","type":"bool"},{"internalType":"bool","name":"isEnded","type":"bool"}],"internalType":"struct LBHooksLens.Parameters","name":"parameters","type":"tuple"},{"internalType":"uint256","name":"activeId","type":"uint256"}],"internalType":"struct LBHooksLens.HooksRewarderData","name":"rewarderData","type":"tuple"},{"components":[{"components":[{"internalType":"address","name":"hooks","type":"address"},{"internalType":"bool","name":"beforeSwap","type":"bool"},{"internalType":"bool","name":"afterSwap","type":"bool"},{"internalType":"bool","name":"beforeFlashLoan","type":"bool"},{"internalType":"bool","name":"afterFlashLoan","type":"bool"},{"internalType":"bool","name":"beforeMint","type":"bool"},{"internalType":"bool","name":"afterMint","type":"bool"},{"internalType":"bool","name":"beforeBurn","type":"bool"},{"internalType":"bool","name":"afterBurn","type":"bool"},{"internalType":"bool","name":"beforeBatchTransferFrom","type":"bool"},{"internalType":"bool","name":"afterBatchTransferFrom","type":"bool"}],"internalType":"struct Hooks.Parameters","name":"hooksParameters","type":"tuple"},{"components":[{"internalType":"enum ILBHooksManager.LBHooksType","name":"hooksType","type":"uint8"},{"components":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct LBHooksLens.Token","name":"rewardToken","type":"tuple"},{"internalType":"uint256","name":"pid","type":"uint256"},{"internalType":"uint256","name":"moePerSecond","type":"uint256"},{"internalType":"uint256","name":"activeId","type":"uint256"},{"internalType":"uint256","name":"rangeStart","type":"uint256"},{"internalType":"uint256","name":"rangeEnd","type":"uint256"},{"internalType":"uint256","name":"pendingRewards","type":"uint256"},{"internalType":"uint256","name":"rewardPerSecond","type":"uint256"},{"internalType":"uint256","name":"lastUpdateTimestamp","type":"uint256"},{"internalType":"uint256","name":"endTimestamp","type":"uint256"},{"internalType":"uint256","name":"remainingRewards","type":"uint256"},{"internalType":"bool","name":"isStarted","type":"bool"},{"internalType":"bool","name":"isEnded","type":"bool"}],"internalType":"struct LBHooksLens.Parameters","name":"parameters","type":"tuple"},{"internalType":"uint256","name":"activeId","type":"uint256"}],"internalType":"struct LBHooksLens.HooksRewarderData","name":"extraRewarderData","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"rewarder","type":"address"}],"name":"getLBHooksType","outputs":[{"internalType":"enum ILBHooksManager.LBHooksType","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"pid","type":"uint256"}],"name":"getMetroPerSecond","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"hooks","type":"address"},{"internalType":"address","name":"user","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"getParametersOf","outputs":[{"components":[{"internalType":"enum ILBHooksManager.LBHooksType","name":"hooksType","type":"uint8"},{"components":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct LBHooksLens.Token","name":"rewardToken","type":"tuple"},{"internalType":"uint256","name":"pid","type":"uint256"},{"internalType":"uint256","name":"moePerSecond","type":"uint256"},{"internalType":"uint256","name":"activeId","type":"uint256"},{"internalType":"uint256","name":"rangeStart","type":"uint256"},{"internalType":"uint256","name":"rangeEnd","type":"uint256"},{"internalType":"uint256","name":"pendingRewards","type":"uint256"},{"internalType":"uint256","name":"rewardPerSecond","type":"uint256"},{"internalType":"uint256","name":"lastUpdateTimestamp","type":"uint256"},{"internalType":"uint256","name":"endTimestamp","type":"uint256"},{"internalType":"uint256","name":"remainingRewards","type":"uint256"},{"internalType":"bool","name":"isStarted","type":"bool"},{"internalType":"bool","name":"isEnded","type":"bool"}],"internalType":"struct LBHooksLens.Parameters","name":"parameters","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"rewarder","type":"address"},{"internalType":"address","name":"account","type":"address"},{"internalType":"uint256[]","name":"ids","type":"uint256[]"}],"name":"getPendingRewards","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"rewarder","type":"address"}],"name":"getPid","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"extraRewarder","type":"address"}],"name":"getRemainingRewards","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"rewarder","type":"address"}],"name":"getRewardToken","outputs":[{"components":[{"internalType":"address","name":"token","type":"address"},{"internalType":"uint256","name":"decimals","type":"uint256"},{"internalType":"string","name":"symbol","type":"string"}],"internalType":"struct LBHooksLens.Token","name":"rewardToken","type":"tuple"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"rewarder","type":"address"}],"name":"getRewardedRange","outputs":[{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"extraRewarder","type":"address"}],"name":"getRewarderParameter","outputs":[{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"}]
Contract Creation Code
60c06040523480156200001157600080fd5b5060405162001cd838038062001cd8833981016040819052620000349162000069565b6001600160a01b039182166080521660a052620000a1565b80516001600160a01b03811681146200006457600080fd5b919050565b600080604083850312156200007d57600080fd5b62000088836200004c565b915062000098602084016200004c565b90509250929050565b60805160a051611c11620000c760003960006104f50152600061058a0152611c116000f3fe608060405234801561001057600080fd5b50600436106100ea5760003560e01c8063483ce3631161008c578063c4aadbc911610066578063c4aadbc91461021c578063dbeb92391461024a578063de03f4081461025d578063fd3e668d1461027057600080fd5b8063483ce363146101bb57806352a2929b146101db57806377078872146101fc57600080fd5b806337209e79116100c857806337209e79146101625780633b6eb94b1461017557806340c2839f1461019557806343b55f35146101a857600080fd5b8063120145fe146100ef5780631a631d111461011957806325248d5e1461013a575b600080fd5b6101026100fd3660046112b9565b610290565b604051610110929190611590565b60405180910390f35b61012c6101273660046115be565b610302565b604051908152602001610110565b61014d6101483660046115be565b6103f0565b60408051928352602083019190915201610110565b61012c6101703660046115db565b6104dc565b6101886101833660046115be565b610568565b60405161011091906115f4565b61012c6101a33660046115be565b6105f7565b61012c6101b63660046115be565b61066a565b6101ce6101c93660046115be565b6106dd565b6040516101109190611602565b6101ee6101e9366004611611565b6109c4565b6040516101109291906116eb565b61020f61020a3660046115be565b610b23565b6040516101109190611710565b61022f61022a3660046115be565b610d61565b60408051938452602084019290925290820152606001610110565b61012c6102583660046112b9565b610e5a565b6101ce61026b3660046115be565b610f54565b61028361027e3660046112b9565b611020565b6040516101109190611723565b610298611139565b6102a0611139565b6102a986610f54565b808352516102b990868686611020565b60208301526102c786610302565b60408301528151516102d8906106dd565b808252516102e890868686611020565b602082015260408083015190820152909590945092505050565b600030330361037857816001600160a01b031663dbe65edc6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610349573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061036d9190611736565b62ffffff1692915050565b604051631a631d1160e01b81526001600160a01b03831660048201523090631a631d11906024015b602060405180830381865afa9250505080156103d9575060408051601f3d908101601f191682019092526103d69181019061175b565b60015b6103e557506000919050565b92915050565b919050565b60008030330361046457826001600160a01b031663fe9ffeb36040518163ffffffff1660e01b81526004016040805180830381865afa158015610437573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061045b9190611774565b91509150915091565b60405163129246af60e11b81526001600160a01b038416600482015230906325248d5e906024016040805180830381865afa9250505080156104c3575060408051601f3d908101601f191682019092526104c091810190611774565b60015b6104d257506000928392509050565b9094909350915050565b604051631430735560e01b8152600481018290526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690631430735590602401602060405180830381865afa158015610544573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906103e5919061175b565b604051633b6eb94b60e01b81526001600160a01b0382811660048301526000917f000000000000000000000000000000000000000000000000000000000000000090911690633b6eb94b90602401602060405180830381865afa1580156105d3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906103e59190611798565b600030330361063e57816001600160a01b031663c946e5dc6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610544573d6000803e3d6000fd5b6040516340c2839f60e01b81526001600160a01b038316600482015230906340c2839f906024016103a0565b60003033036106b157816001600160a01b031663c87729636040518163ffffffff1660e01b8152600401602060405180830381865afa158015610544573d6000803e3d6000fd5b6040516343b55f3560e01b81526001600160a01b038316600482015230906343b55f35906024016103a0565b6040805161016081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e0810182905261010081018290526101208101829052610140810191909152303303610900576000826001600160a01b031663c7d12e886040518163ffffffff1660e01b8152600401602060405180830381865afa15801561077d573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107a1919061175b565b60408051610160810182526001600160a01b0383168152740100000000000000000000000000000000000000008316151560208201527402000000000000000000000000000000000000000083161515918101919091527404000000000000000000000000000000000000000082161515606082015274080000000000000000000000000000000000000000821615156080820152741000000000000000000000000000000000000000008216151560a0820152742000000000000000000000000000000000000000008216151560c0820152744000000000000000000000000000000000000000008216151560e082015274800000000000000000000000000000000000000000821615156101008201527501000000000000000000000000000000000000000000821615156101208201527502000000000000000000000000000000000000000000821615156101408201529091505b9392505050565b60405163483ce36360e01b81526001600160a01b0383166004820152309063483ce363906024015b61016060405180830381865afa925050508015610962575060408051601f3d908101601f1916820190925261095f91810190611814565b60015b6103e55750506040805161016081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e081018290526101008101829052610120810182905261014081019190915290565b6060808567ffffffffffffffff8111156109e0576109e06117b9565b604051908082528060200260200182016040528015610a1957816020015b610a06611139565b8152602001906001900390816109fe5790505b5091508567ffffffffffffffff811115610a3557610a356117b9565b604051908082528060200260200182016040528015610a6e57816020015b610a5b611139565b815260200190600190039081610a535790505b50905060005b86811015610b1857610acb888883818110610a9157610a916118ee565b9050602002016020810190610aa691906115be565b87878785818110610ab957610ab96118ee565b90506020028101906100fd9190611904565b848381518110610add57610add6118ee565b60200260200101848481518110610af657610af66118ee565b6020026020010182905282905250508080610b109061194e565b915050610a74565b509550959350505050565b60408051606080820183526000808352602083015291810191909152303303610ccb576000826001600160a01b03166369940d796040518163ffffffff1660e01b8152600401602060405180830381865afa158015610b86573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610baa9190611975565b6001600160a01b03811680845290915015610c9d57806001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa158015610bfd573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c219190611992565b60ff16826020018181525050806001600160a01b03166395d89b416040518163ffffffff1660e01b8152600401600060405180830381865afa158015610c6b573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610c939190810190611a3d565b6040830152610cc5565b601260208084019190915260408051808201825260018152605360f81b928101929092528301525b50919050565b604051633b83c43960e11b81526001600160a01b03831660048201523090637707887290602401600060405180830381865afa925050508015610d3057506040513d6000823e601f3d908101601f19168201604052610d2d9190810190611a72565b60015b6103e55750506040805160608101825260008082526020808301829052835190810184529081529181019190915290565b60008080303303610dd957836001600160a01b03166339cbec9d6040518163ffffffff1660e01b8152600401606060405180830381865afa158015610daa573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610dce9190611b12565b925092509250610e53565b60405163c4aadbc960e01b81526001600160a01b0385166004820152309063c4aadbc990602401606060405180830381865afa925050508015610e39575060408051601f3d908101601f19168201909252610e3691810190611b12565b60015b610e4b57506000915081905080610e53565b919450925090505b9193909250565b6000303303610edb57604051632b357fb560e11b81526001600160a01b0386169063566aff6a90610e9390879087908790600401611b8b565b602060405180830381865afa158015610eb0573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ed4919061175b565b9050610f4c565b60405163dbeb923960e01b8152309063dbeb923990610f04908890889088908890600401611bae565b602060405180830381865afa925050508015610f3d575060408051601f3d908101601f19168201909252610f3a9181019061175b565b60015b610f4957506000610f4c565b90505b949350505050565b6040805161016081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e0810182905261010081018290526101208101829052610140810191909152303303610ff4576000826001600160a01b031663781a89156040518163ffffffff1660e01b8152600401602060405180830381865afa15801561077d573d6000803e3d6000fd5b604051631bc07e8160e31b81526001600160a01b0383166004820152309063de03f40890602401610928565b6110286111b6565b6001600160a01b03851615610f4c5761104085610568565b81906003811115611053576110536113df565b90816003811115611066576110666113df565b90525061107285610b23565b6020820152611080856103f0565b60c083015260a082015260018151600381111561109f5761109f6113df565b036110c7576110ad8561066a565b604082018190526110bd906104dc565b6060820152611111565b6110d085610d61565b6101408401526101208301526101008201526110eb856105f7565b610160820152610120810151429081101561018083015261014082015111156101a08201525b6001600160a01b03841615610f4c5761112c85858585610e5a565b60e0820152949350505050565b604080516101c081019091526000606082018181526080830182905260a0830182905260c0830182905260e08301829052610100830182905261012083018290526101408301829052610160830182905261018083018290526101a08301919091528152602081016111a96111b6565b8152602001600081525090565b604080516101c0810190915280600081526020016111f7604051806060016040528060006001600160a01b0316815260200160008152602001606081525090565b8152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001600081526020016000151581526020016000151581525090565b6001600160a01b038116811461126a57600080fd5b50565b60008083601f84011261127f57600080fd5b50813567ffffffffffffffff81111561129757600080fd5b6020830191508360208260051b85010111156112b257600080fd5b9250929050565b600080600080606085870312156112cf57600080fd5b84356112da81611255565b935060208501356112ea81611255565b9250604085013567ffffffffffffffff81111561130657600080fd5b6113128782880161126d565b95989497509550505050565b80516001600160a01b03168252602081015161133e602084018215159052565b506040810151611352604084018215159052565b506060810151611366606084018215159052565b50608081015161137a608084018215159052565b5060a081015161138e60a084018215159052565b5060c08101516113a260c084018215159052565b5060e08101516113b660e084018215159052565b506101008181015115159083015261012080820151151590830152610140908101511515910152565b634e487b7160e01b600052602160045260246000fd5b6004811061141357634e487b7160e01b600052602160045260246000fd5b9052565b60005b8381101561143257818101518382015260200161141a565b50506000910152565b6001600160a01b0381511682526020810151602083015260006040820151606060408501528051806060860152611479816080870160208501611417565b601f01601f1916939093016080019392505050565b60006101c061149e8484516113f5565b60208301518160208601526114b58286018261143b565b91505060408301516040850152606083015160608501526080830151608085015260a083015160a085015260c083015160c085015260e083015160e0850152610100808401518186015250610120808401518186015250610140808401518186015250610160808401518186015250610180808401516115388287018215159052565b50506101a09283015115159390920192909252919050565b60006101a061156084845161131e565b6020830151816101608601526115788286018261148e565b91505060408301516101808501528091505092915050565b6040815260006115a36040830185611550565b82810360208401526115b58185611550565b95945050505050565b6000602082840312156115d057600080fd5b81356108f981611255565b6000602082840312156115ed57600080fd5b5035919050565b602081016103e582846113f5565b61016081016103e5828461131e565b60008060008060006060868803121561162957600080fd5b853567ffffffffffffffff8082111561164157600080fd5b61164d89838a0161126d565b90975095506020880135915061166282611255565b9093506040870135908082111561167857600080fd5b506116858882890161126d565b969995985093965092949392505050565b600081518084526020808501808196508360051b8101915082860160005b858110156116de5782840389526116cc848351611550565b988501989350908401906001016116b4565b5091979650505050505050565b6040815260006116fe6040830185611696565b82810360208401526115b58185611696565b6020815260006108f9602083018461143b565b6020815260006108f9602083018461148e565b60006020828403121561174857600080fd5b815162ffffff811681146108f957600080fd5b60006020828403121561176d57600080fd5b5051919050565b6000806040838503121561178757600080fd5b505080516020909101519092909150565b6000602082840312156117aa57600080fd5b8151600481106108f957600080fd5b634e487b7160e01b600052604160045260246000fd5b604051610160810167ffffffffffffffff811182821017156117f3576117f36117b9565b60405290565b80516103eb81611255565b805180151581146103eb57600080fd5b6000610160828403121561182757600080fd5b61182f6117cf565b611838836117f9565b815261184660208401611804565b602082015261185760408401611804565b604082015261186860608401611804565b606082015261187960808401611804565b608082015261188a60a08401611804565b60a082015261189b60c08401611804565b60c08201526118ac60e08401611804565b60e08201526101006118bf818501611804565b908201526101206118d1848201611804565b908201526101406118e3848201611804565b908201529392505050565b634e487b7160e01b600052603260045260246000fd5b6000808335601e1984360301811261191b57600080fd5b83018035915067ffffffffffffffff82111561193657600080fd5b6020019150600581901b36038213156112b257600080fd5b60006001820161196e57634e487b7160e01b600052601160045260246000fd5b5060010190565b60006020828403121561198757600080fd5b81516108f981611255565b6000602082840312156119a457600080fd5b815160ff811681146108f957600080fd5b600082601f8301126119c657600080fd5b815167ffffffffffffffff808211156119e1576119e16117b9565b604051601f8301601f19908116603f01168101908282118183101715611a0957611a096117b9565b81604052838152866020858801011115611a2257600080fd5b611a33846020830160208901611417565b9695505050505050565b600060208284031215611a4f57600080fd5b815167ffffffffffffffff811115611a6657600080fd5b610f4c848285016119b5565b600060208284031215611a8457600080fd5b815167ffffffffffffffff80821115611a9c57600080fd5b9083019060608286031215611ab057600080fd5b604051606081018181108382111715611acb57611acb6117b9565b6040528251611ad981611255565b815260208381015190820152604083015182811115611af757600080fd5b611b03878286016119b5565b60408301525095945050505050565b600080600060608486031215611b2757600080fd5b8351925060208401519150604084015190509250925092565b81835260007f07ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff831115611b7257600080fd5b8260051b80836020870137939093016020019392505050565b6001600160a01b03841681526040602082015260006115b5604083018486611b40565b60006001600160a01b03808716835280861660208401525060606040830152611a33606083018486611b4056fea2646970667358221220507ad8a1c3663692f899b4c3466d117d10e01fb6ac655bb089ac001afb0d66f864736f6c63430008140033000000000000000000000000f6f7ae5d4804b9dbbee41168e26b8d636b8d535a0000000000000000000000001a5ded6adcfc64acede86151b1f142088c6e03da
Deployed Bytecode
0x608060405234801561001057600080fd5b50600436106100ea5760003560e01c8063483ce3631161008c578063c4aadbc911610066578063c4aadbc91461021c578063dbeb92391461024a578063de03f4081461025d578063fd3e668d1461027057600080fd5b8063483ce363146101bb57806352a2929b146101db57806377078872146101fc57600080fd5b806337209e79116100c857806337209e79146101625780633b6eb94b1461017557806340c2839f1461019557806343b55f35146101a857600080fd5b8063120145fe146100ef5780631a631d111461011957806325248d5e1461013a575b600080fd5b6101026100fd3660046112b9565b610290565b604051610110929190611590565b60405180910390f35b61012c6101273660046115be565b610302565b604051908152602001610110565b61014d6101483660046115be565b6103f0565b60408051928352602083019190915201610110565b61012c6101703660046115db565b6104dc565b6101886101833660046115be565b610568565b60405161011091906115f4565b61012c6101a33660046115be565b6105f7565b61012c6101b63660046115be565b61066a565b6101ce6101c93660046115be565b6106dd565b6040516101109190611602565b6101ee6101e9366004611611565b6109c4565b6040516101109291906116eb565b61020f61020a3660046115be565b610b23565b6040516101109190611710565b61022f61022a3660046115be565b610d61565b60408051938452602084019290925290820152606001610110565b61012c6102583660046112b9565b610e5a565b6101ce61026b3660046115be565b610f54565b61028361027e3660046112b9565b611020565b6040516101109190611723565b610298611139565b6102a0611139565b6102a986610f54565b808352516102b990868686611020565b60208301526102c786610302565b60408301528151516102d8906106dd565b808252516102e890868686611020565b602082015260408083015190820152909590945092505050565b600030330361037857816001600160a01b031663dbe65edc6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610349573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061036d9190611736565b62ffffff1692915050565b604051631a631d1160e01b81526001600160a01b03831660048201523090631a631d11906024015b602060405180830381865afa9250505080156103d9575060408051601f3d908101601f191682019092526103d69181019061175b565b60015b6103e557506000919050565b92915050565b919050565b60008030330361046457826001600160a01b031663fe9ffeb36040518163ffffffff1660e01b81526004016040805180830381865afa158015610437573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061045b9190611774565b91509150915091565b60405163129246af60e11b81526001600160a01b038416600482015230906325248d5e906024016040805180830381865afa9250505080156104c3575060408051601f3d908101601f191682019092526104c091810190611774565b60015b6104d257506000928392509050565b9094909350915050565b604051631430735560e01b8152600481018290526000907f0000000000000000000000001a5ded6adcfc64acede86151b1f142088c6e03da6001600160a01b031690631430735590602401602060405180830381865afa158015610544573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906103e5919061175b565b604051633b6eb94b60e01b81526001600160a01b0382811660048301526000917f000000000000000000000000f6f7ae5d4804b9dbbee41168e26b8d636b8d535a90911690633b6eb94b90602401602060405180830381865afa1580156105d3573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906103e59190611798565b600030330361063e57816001600160a01b031663c946e5dc6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610544573d6000803e3d6000fd5b6040516340c2839f60e01b81526001600160a01b038316600482015230906340c2839f906024016103a0565b60003033036106b157816001600160a01b031663c87729636040518163ffffffff1660e01b8152600401602060405180830381865afa158015610544573d6000803e3d6000fd5b6040516343b55f3560e01b81526001600160a01b038316600482015230906343b55f35906024016103a0565b6040805161016081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e0810182905261010081018290526101208101829052610140810191909152303303610900576000826001600160a01b031663c7d12e886040518163ffffffff1660e01b8152600401602060405180830381865afa15801561077d573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107a1919061175b565b60408051610160810182526001600160a01b0383168152740100000000000000000000000000000000000000008316151560208201527402000000000000000000000000000000000000000083161515918101919091527404000000000000000000000000000000000000000082161515606082015274080000000000000000000000000000000000000000821615156080820152741000000000000000000000000000000000000000008216151560a0820152742000000000000000000000000000000000000000008216151560c0820152744000000000000000000000000000000000000000008216151560e082015274800000000000000000000000000000000000000000821615156101008201527501000000000000000000000000000000000000000000821615156101208201527502000000000000000000000000000000000000000000821615156101408201529091505b9392505050565b60405163483ce36360e01b81526001600160a01b0383166004820152309063483ce363906024015b61016060405180830381865afa925050508015610962575060408051601f3d908101601f1916820190925261095f91810190611814565b60015b6103e55750506040805161016081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e081018290526101008101829052610120810182905261014081019190915290565b6060808567ffffffffffffffff8111156109e0576109e06117b9565b604051908082528060200260200182016040528015610a1957816020015b610a06611139565b8152602001906001900390816109fe5790505b5091508567ffffffffffffffff811115610a3557610a356117b9565b604051908082528060200260200182016040528015610a6e57816020015b610a5b611139565b815260200190600190039081610a535790505b50905060005b86811015610b1857610acb888883818110610a9157610a916118ee565b9050602002016020810190610aa691906115be565b87878785818110610ab957610ab96118ee565b90506020028101906100fd9190611904565b848381518110610add57610add6118ee565b60200260200101848481518110610af657610af66118ee565b6020026020010182905282905250508080610b109061194e565b915050610a74565b509550959350505050565b60408051606080820183526000808352602083015291810191909152303303610ccb576000826001600160a01b03166369940d796040518163ffffffff1660e01b8152600401602060405180830381865afa158015610b86573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610baa9190611975565b6001600160a01b03811680845290915015610c9d57806001600160a01b031663313ce5676040518163ffffffff1660e01b8152600401602060405180830381865afa158015610bfd573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610c219190611992565b60ff16826020018181525050806001600160a01b03166395d89b416040518163ffffffff1660e01b8152600401600060405180830381865afa158015610c6b573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610c939190810190611a3d565b6040830152610cc5565b601260208084019190915260408051808201825260018152605360f81b928101929092528301525b50919050565b604051633b83c43960e11b81526001600160a01b03831660048201523090637707887290602401600060405180830381865afa925050508015610d3057506040513d6000823e601f3d908101601f19168201604052610d2d9190810190611a72565b60015b6103e55750506040805160608101825260008082526020808301829052835190810184529081529181019190915290565b60008080303303610dd957836001600160a01b03166339cbec9d6040518163ffffffff1660e01b8152600401606060405180830381865afa158015610daa573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610dce9190611b12565b925092509250610e53565b60405163c4aadbc960e01b81526001600160a01b0385166004820152309063c4aadbc990602401606060405180830381865afa925050508015610e39575060408051601f3d908101601f19168201909252610e3691810190611b12565b60015b610e4b57506000915081905080610e53565b919450925090505b9193909250565b6000303303610edb57604051632b357fb560e11b81526001600160a01b0386169063566aff6a90610e9390879087908790600401611b8b565b602060405180830381865afa158015610eb0573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610ed4919061175b565b9050610f4c565b60405163dbeb923960e01b8152309063dbeb923990610f04908890889088908890600401611bae565b602060405180830381865afa925050508015610f3d575060408051601f3d908101601f19168201909252610f3a9181019061175b565b60015b610f4957506000610f4c565b90505b949350505050565b6040805161016081018252600080825260208201819052918101829052606081018290526080810182905260a0810182905260c0810182905260e0810182905261010081018290526101208101829052610140810191909152303303610ff4576000826001600160a01b031663781a89156040518163ffffffff1660e01b8152600401602060405180830381865afa15801561077d573d6000803e3d6000fd5b604051631bc07e8160e31b81526001600160a01b0383166004820152309063de03f40890602401610928565b6110286111b6565b6001600160a01b03851615610f4c5761104085610568565b81906003811115611053576110536113df565b90816003811115611066576110666113df565b90525061107285610b23565b6020820152611080856103f0565b60c083015260a082015260018151600381111561109f5761109f6113df565b036110c7576110ad8561066a565b604082018190526110bd906104dc565b6060820152611111565b6110d085610d61565b6101408401526101208301526101008201526110eb856105f7565b610160820152610120810151429081101561018083015261014082015111156101a08201525b6001600160a01b03841615610f4c5761112c85858585610e5a565b60e0820152949350505050565b604080516101c081019091526000606082018181526080830182905260a0830182905260c0830182905260e08301829052610100830182905261012083018290526101408301829052610160830182905261018083018290526101a08301919091528152602081016111a96111b6565b8152602001600081525090565b604080516101c0810190915280600081526020016111f7604051806060016040528060006001600160a01b0316815260200160008152602001606081525090565b8152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001600081526020016000815260200160008152602001600081526020016000151581526020016000151581525090565b6001600160a01b038116811461126a57600080fd5b50565b60008083601f84011261127f57600080fd5b50813567ffffffffffffffff81111561129757600080fd5b6020830191508360208260051b85010111156112b257600080fd5b9250929050565b600080600080606085870312156112cf57600080fd5b84356112da81611255565b935060208501356112ea81611255565b9250604085013567ffffffffffffffff81111561130657600080fd5b6113128782880161126d565b95989497509550505050565b80516001600160a01b03168252602081015161133e602084018215159052565b506040810151611352604084018215159052565b506060810151611366606084018215159052565b50608081015161137a608084018215159052565b5060a081015161138e60a084018215159052565b5060c08101516113a260c084018215159052565b5060e08101516113b660e084018215159052565b506101008181015115159083015261012080820151151590830152610140908101511515910152565b634e487b7160e01b600052602160045260246000fd5b6004811061141357634e487b7160e01b600052602160045260246000fd5b9052565b60005b8381101561143257818101518382015260200161141a565b50506000910152565b6001600160a01b0381511682526020810151602083015260006040820151606060408501528051806060860152611479816080870160208501611417565b601f01601f1916939093016080019392505050565b60006101c061149e8484516113f5565b60208301518160208601526114b58286018261143b565b91505060408301516040850152606083015160608501526080830151608085015260a083015160a085015260c083015160c085015260e083015160e0850152610100808401518186015250610120808401518186015250610140808401518186015250610160808401518186015250610180808401516115388287018215159052565b50506101a09283015115159390920192909252919050565b60006101a061156084845161131e565b6020830151816101608601526115788286018261148e565b91505060408301516101808501528091505092915050565b6040815260006115a36040830185611550565b82810360208401526115b58185611550565b95945050505050565b6000602082840312156115d057600080fd5b81356108f981611255565b6000602082840312156115ed57600080fd5b5035919050565b602081016103e582846113f5565b61016081016103e5828461131e565b60008060008060006060868803121561162957600080fd5b853567ffffffffffffffff8082111561164157600080fd5b61164d89838a0161126d565b90975095506020880135915061166282611255565b9093506040870135908082111561167857600080fd5b506116858882890161126d565b969995985093965092949392505050565b600081518084526020808501808196508360051b8101915082860160005b858110156116de5782840389526116cc848351611550565b988501989350908401906001016116b4565b5091979650505050505050565b6040815260006116fe6040830185611696565b82810360208401526115b58185611696565b6020815260006108f9602083018461143b565b6020815260006108f9602083018461148e565b60006020828403121561174857600080fd5b815162ffffff811681146108f957600080fd5b60006020828403121561176d57600080fd5b5051919050565b6000806040838503121561178757600080fd5b505080516020909101519092909150565b6000602082840312156117aa57600080fd5b8151600481106108f957600080fd5b634e487b7160e01b600052604160045260246000fd5b604051610160810167ffffffffffffffff811182821017156117f3576117f36117b9565b60405290565b80516103eb81611255565b805180151581146103eb57600080fd5b6000610160828403121561182757600080fd5b61182f6117cf565b611838836117f9565b815261184660208401611804565b602082015261185760408401611804565b604082015261186860608401611804565b606082015261187960808401611804565b608082015261188a60a08401611804565b60a082015261189b60c08401611804565b60c08201526118ac60e08401611804565b60e08201526101006118bf818501611804565b908201526101206118d1848201611804565b908201526101406118e3848201611804565b908201529392505050565b634e487b7160e01b600052603260045260246000fd5b6000808335601e1984360301811261191b57600080fd5b83018035915067ffffffffffffffff82111561193657600080fd5b6020019150600581901b36038213156112b257600080fd5b60006001820161196e57634e487b7160e01b600052601160045260246000fd5b5060010190565b60006020828403121561198757600080fd5b81516108f981611255565b6000602082840312156119a457600080fd5b815160ff811681146108f957600080fd5b600082601f8301126119c657600080fd5b815167ffffffffffffffff808211156119e1576119e16117b9565b604051601f8301601f19908116603f01168101908282118183101715611a0957611a096117b9565b81604052838152866020858801011115611a2257600080fd5b611a33846020830160208901611417565b9695505050505050565b600060208284031215611a4f57600080fd5b815167ffffffffffffffff811115611a6657600080fd5b610f4c848285016119b5565b600060208284031215611a8457600080fd5b815167ffffffffffffffff80821115611a9c57600080fd5b9083019060608286031215611ab057600080fd5b604051606081018181108382111715611acb57611acb6117b9565b6040528251611ad981611255565b815260208381015190820152604083015182811115611af757600080fd5b611b03878286016119b5565b60408301525095945050505050565b600080600060608486031215611b2757600080fd5b8351925060208401519150604084015190509250925092565b81835260007f07ffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff831115611b7257600080fd5b8260051b80836020870137939093016020019392505050565b6001600160a01b03841681526040602082015260006115b5604083018486611b40565b60006001600160a01b03808716835280861660208401525060606040830152611a33606083018486611b4056fea2646970667358221220507ad8a1c3663692f899b4c3466d117d10e01fb6ac655bb089ac001afb0d66f864736f6c63430008140033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
000000000000000000000000f6f7ae5d4804b9dbbee41168e26b8d636b8d535a0000000000000000000000001a5ded6adcfc64acede86151b1f142088c6e03da
-----Decoded View---------------
Arg [0] : lbHooksManager (address): 0xF6f7Ae5d4804B9DbbeE41168E26B8d636B8D535a
Arg [1] : masterChef (address): 0x1a5Ded6adCfc64aceDE86151B1F142088C6E03da
-----Encoded View---------------
2 Constructor Arguments found :
Arg [0] : 000000000000000000000000f6f7ae5d4804b9dbbee41168e26b8d636b8d535a
Arg [1] : 0000000000000000000000001a5ded6adcfc64acede86151b1f142088c6e03da
Loading...
Loading
Loading...
Loading
Multichain Portfolio | 30 Chains
Chain | Token | Portfolio % | Price | Amount | Value |
---|
A contract address hosts a smart contract, which is a set of code stored on the blockchain that runs when predetermined conditions are met. Learn more about addresses in our Knowledge Base.