Feature Tip: Add private address tag to any address under My Name Tag !
Overview
ETH Balance
0 ETH
Eth Value
$0.00More Info
Private Name Tags
ContractCreator
Sponsored
Latest 1 from a total of 1 transactions
Transaction Hash |
Method
|
Block
|
From
|
To
|
Value | ||||
---|---|---|---|---|---|---|---|---|---|
0x61010060 | 17479005 | 109 days 23 hrs ago | IN | Create: ConvexV1BoosterAdapter | 0 ETH | 0.04587082 |
View more zero value Internal Transactions in Advanced View mode
Advanced mode:
Loading...
Loading
Contract Name:
ConvexV1BoosterAdapter
Compiler Version
v0.8.17+commit.8df45f5f
Optimization Enabled:
Yes with 2000 runs
Other Settings:
default evmVersion
Contract Source Code (Solidity Standard Json-Input format)
// SPDX-License-Identifier: BUSL-1.1 // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2023 pragma solidity ^0.8.17; import {ICreditConfigurator} from "@gearbox-protocol/core-v2/contracts/interfaces/ICreditConfigurator.sol"; import {AbstractAdapter} from "../AbstractAdapter.sol"; import {IAdapter, AdapterType} from "../../interfaces/IAdapter.sol"; import {IBooster} from "../../integrations/convex/IBooster.sol"; import {IBaseRewardPool} from "../../integrations/convex/IBaseRewardPool.sol"; import {IConvexV1BoosterAdapter} from "../../interfaces/convex/IConvexV1BoosterAdapter.sol"; import {IConvexV1BaseRewardPoolAdapter} from "../../interfaces/convex/IConvexV1BaseRewardPoolAdapter.sol"; /// @title Convex V1 Booster adapter interface /// @notice Implements logic allowing CAs to interact with Convex Booster contract ConvexV1BoosterAdapter is AbstractAdapter, IConvexV1BoosterAdapter { AdapterType public constant override _gearboxAdapterType = AdapterType.CONVEX_V1_BOOSTER; uint16 public constant override _gearboxAdapterVersion = 2; /// @inheritdoc IConvexV1BoosterAdapter mapping(uint256 => address) public override pidToPhantomToken; /// @notice Constructor /// @param _creditManager Credit manager address /// @param _booster Booster contract address constructor(address _creditManager, address _booster) AbstractAdapter(_creditManager, _booster) {} /// ------- /// /// DEPOSIT /// /// ------- /// /// @inheritdoc IConvexV1BoosterAdapter function deposit(uint256 _pid, uint256, bool _stake) external override creditFacadeOnly { _deposit(_pid, _stake, msg.data, false); } /// @inheritdoc IConvexV1BoosterAdapter function depositAll(uint256 _pid, bool _stake) external override creditFacadeOnly { _deposit(_pid, _stake, msg.data, true); } /// @dev Internal implementation of `deposit` and `depositAll` /// - Curve LP token is approved before the call /// - Convex LP token (or staked phantom token, if `_stake` is true) is enabled after the call /// - Curve LP token is only disabled when depositing the entire balance function _deposit(uint256 _pid, bool _stake, bytes memory callData, bool disableCurveLP) internal { IBooster.PoolInfo memory pool = IBooster(targetContract).poolInfo(_pid); address tokenIn = pool.lptoken; // F: [ACVX1_B-2, ACVX1_B-3] address tokenOut = _stake ? pidToPhantomToken[_pid] : pool.token; // F: [ACVX1_B-2, ACVX1_B-3] // using `_executeSwap` because tokens are not known in advance and need to check if they are registered _executeSwapSafeApprove(tokenIn, tokenOut, callData, disableCurveLP); } /// -------- /// /// WITHDRAW /// /// -------- /// /// @inheritdoc IConvexV1BoosterAdapter function withdraw(uint256 _pid, uint256) external override creditFacadeOnly { _withdraw(_pid, msg.data, false); } /// @inheritdoc IConvexV1BoosterAdapter function withdrawAll(uint256 _pid) external override creditFacadeOnly { _withdraw(_pid, msg.data, true); } /// @dev Internal implementation of `withdraw` and `withdrawAll` /// - Curve LP token is enabled after the call /// - Convex LP token is only disabled when withdrawing the entire stake function _withdraw(uint256 _pid, bytes memory callData, bool disableConvexLP) internal { IBooster.PoolInfo memory pool = IBooster(targetContract).poolInfo(_pid); address tokenIn = pool.token; // F: [ACVX1_B-4, ACVX1_B-5] address tokenOut = pool.lptoken; // F: [ACVX1_B-4, ACVX1_B-5] // using `_executeSwap` because tokens are not known in advance and need to check if they are registered _executeSwapNoApprove(tokenIn, tokenOut, callData, disableConvexLP); } /// ------ /// /// CONFIG /// /// ------ /// /// @inheritdoc IConvexV1BoosterAdapter function updateStakedPhantomTokensMap() external override configuratorOnly // F: [ACVX1_B-1] { ICreditConfigurator cc = ICreditConfigurator(creditManager.creditConfigurator()); address[] memory allowedContracts = cc.allowedContracts(); uint256 len = allowedContracts.length; for (uint256 i = 0; i < len;) { address allowedContract = allowedContracts[i]; address adapter = creditManager.contractToAdapter(allowedContract); AdapterType aType = IAdapter(adapter)._gearboxAdapterType(); if (aType == AdapterType.CONVEX_V1_BASE_REWARD_POOL) { uint256 pid = IBaseRewardPool(allowedContract).pid(); pidToPhantomToken[pid] = IConvexV1BaseRewardPoolAdapter(adapter).stakedPhantomToken(); } unchecked { ++i; } } } }
// SPDX-License-Identifier: GPL-2.0-or-later // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IACL } from "../interfaces/IACL.sol"; import { IAdapter } from "../interfaces/adapters/IAdapter.sol"; import { IAddressProvider } from "../interfaces/IAddressProvider.sol"; import { ICreditManagerV2 } from "../interfaces/ICreditManagerV2.sol"; import { IPoolService } from "../interfaces/IPoolService.sol"; import { ZeroAddressException } from "../interfaces/IErrors.sol"; /// @title Abstract adapter /// @dev Inheriting adapters MUST use provided internal functions to perform all operations with credit accounts abstract contract AbstractAdapter is IAdapter { /// @notice Credit Manager the adapter is connected to ICreditManagerV2 public immutable override creditManager; /// @notice Address provider IAddressProvider public immutable override addressProvider; /// @notice Address of the contract the adapter is interacting with address public immutable override targetContract; /// @notice ACL contract to check rights IACL public immutable override _acl; /// @notice Constructor /// @param _creditManager Credit Manager to connect this adapter to /// @param _targetContract Address of the contract this adapter should interact with constructor(address _creditManager, address _targetContract) { if (_creditManager == address(0) || _targetContract == address(0)) { revert ZeroAddressException(); // F: [AA-2] } creditManager = ICreditManagerV2(_creditManager); // F: [AA-1] addressProvider = IAddressProvider( IPoolService(creditManager.pool()).addressProvider() ); // F: [AA-1] targetContract = _targetContract; // F: [AA-1] _acl = IACL(addressProvider.getACL()); // F: [AA-1] } /// @notice Reverts if caller of the function is not configurator modifier configuratorOnly() { if (!_acl.isConfigurator(msg.sender)) revert CallerNotConfiguratorException(); // F: [AA-16] _; } /// @notice Reverts if caller of the function is not the Credit Facade /// @dev Adapter functions are only allowed to be called from within the multicall /// Since at this point Credit Account is owned by the Credit Facade, all functions /// of inheriting adapters that perform actions on account MUST have this modifier modifier creditFacadeOnly() { if (msg.sender != _creditFacade()) { revert CreditFacadeOnlyException(); // F: [AA-5] } _; } /// @dev Returns the Credit Facade connected to the Credit Manager function _creditFacade() internal view returns (address) { return creditManager.creditFacade(); // F: [AA-3] } /// @dev Returns the Credit Account currently owned by the Credit Facade /// @dev Inheriting adapters MUST use this function to find the account address function _creditAccount() internal view returns (address) { return creditManager.getCreditAccountOrRevert(_creditFacade()); // F: [AA-4] } /// @dev Returns collateral token mask of given token in the Credit Manager /// @param token Token to get the mask for /// @return tokenMask Collateral token mask /// @dev Reverts if token is not registered as collateral token in the Credit Manager function _getMaskOrRevert(address token) internal view returns (uint256 tokenMask) { tokenMask = creditManager.tokenMasksMap(token); // F: [AA-6] if (tokenMask == 0) { revert TokenNotAllowedException(); // F: [AA-6] } } /// @dev Approves the target contract to spend given token from the Credit Account /// @param token Token to be approved /// @param amount Amount to be approved /// @dev Reverts if token is not registered as collateral token in the Credit Manager function _approveToken(address token, uint256 amount) internal { creditManager.approveCreditAccount( _creditFacade(), targetContract, token, amount ); // F: [AA-7, AA-8] } /// @dev Enables a token in the Credit Account /// @param token Address of the token to enable /// @dev Reverts if token is not registered as collateral token in the Credit Manager function _enableToken(address token) internal { creditManager.checkAndEnableToken(_creditAccount(), token); // F: [AA-7, AA-9] } /// @dev Disables a token in the Credit Account /// @param token Address of the token to disable function _disableToken(address token) internal { creditManager.disableToken(_creditAccount(), token); // F: [AA-7, AA-10] } /// @dev Changes enabled tokens in the Credit Account /// @param tokensToEnable Bitmask of tokens that should be enabled /// @param tokensToDisable Bitmask of tokens that should be disabled /// @dev This function might be useful for adapters that work with limited set of tokens, whose masks can be /// determined in the adapter constructor, thus saving gas by avoiding querying them during execution /// and combining multiple enable/disable operations into a single one function _changeEnabledTokens( uint256 tokensToEnable, uint256 tokensToDisable ) internal { address creditAccount = _creditAccount(); // F: [AA-7] unchecked { uint256 tokensToChange = tokensToEnable ^ tokensToDisable; address token; uint256 mask = 1; while (mask <= tokensToChange) { if (tokensToChange & mask != 0) { (token, ) = creditManager.collateralTokensByMask(mask); if (tokensToEnable & mask != 0) { creditManager.checkAndEnableToken(creditAccount, token); // F: [AA-11] } else { creditManager.disableToken(creditAccount, token); // F: [AA-11] } } if (mask == 1 << 255) break; // F: [AA-11A] mask <<= 1; } } } /// @dev Executes an arbitrary call from the Credit Account to the target contract /// @param callData Data to call the target contract with /// @return result Call output function _execute(bytes memory callData) internal returns (bytes memory result) { return creditManager.executeOrder( _creditFacade(), targetContract, callData ); // F: [AA-7, AA-12] } /// @dev Executes a swap operation on the target contract from the Credit Account /// without explicit approval to spend `tokenIn` /// @param tokenIn The token that the call is expected to spend /// @param tokenOut The token that the call is expected to produce /// @param callData Data to call the target contract with /// @param disableTokenIn Whether the input token should be disabled afterwards /// (for operations that spend the entire balance) /// @return result Call output /// @dev Reverts if tokenIn or tokenOut are not registered as collateral in the Credit Manager function _executeSwapNoApprove( address tokenIn, address tokenOut, bytes memory callData, bool disableTokenIn ) internal returns (bytes memory result) { _getMaskOrRevert(tokenIn); // F: [AA-15] result = _executeSwap(tokenIn, tokenOut, callData, disableTokenIn); // F: [AA-7, AA-13] } /// @dev Executes a swap operation on the target contract from the Credit Account /// with maximal `tokenIn` allowance, and then sets the allowance to 1 /// @param tokenIn The token that the call is expected to spend /// @param tokenOut The token that the call is expected to produce /// @param callData Data to call the target contract with /// @param disableTokenIn Whether the input token should be disabled afterwards /// (for operations that spend the entire balance) /// @return result Call output /// @dev Reverts if tokenIn or tokenOut are not registered as collateral in the Credit Manager function _executeSwapSafeApprove( address tokenIn, address tokenOut, bytes memory callData, bool disableTokenIn ) internal returns (bytes memory result) { _approveToken(tokenIn, type(uint256).max); // F: [AA-14, AA-15] result = _executeSwap(tokenIn, tokenOut, callData, disableTokenIn); // F: [AA-7, AA-14] _approveToken(tokenIn, 1); // F: [AA-14] } /// @dev Implementation of `_executeSwap...` operations /// @dev Kept private as only the internal wrappers are intended to be used /// by inheritors function _executeSwap( address tokenIn, address tokenOut, bytes memory callData, bool disableTokenIn ) private returns (bytes memory result) { result = _execute(callData); // F: [AA-13, AA-14] if (disableTokenIn) { _disableToken(tokenIn); // F: [AA-13, AA-14] } _enableToken(tokenOut); // F: [AA-13, AA-14, AA-15] } }
// SPDX-License-Identifier: BUSL-1.1 // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { Ownable } from "@openzeppelin/contracts/access/Ownable.sol"; /// @title Claimable /// @dev Implements logic for a two-step ownership transfer on top of Ownable contract Claimable is Ownable { /// @dev The new owner that has not claimed ownership yet address public pendingOwner; /// @dev A modifier that restricts the function to the pending owner only modifier onlyPendingOwner() { if (msg.sender != pendingOwner) { revert("Claimable: Sender is not pending owner"); } _; } /// @dev Sets pending owner to the new owner, but does not /// transfer ownership yet /// @param newOwner The address to become the future owner function transferOwnership(address newOwner) public override onlyOwner { require( newOwner != address(0), "Claimable: new owner is the zero address" ); pendingOwner = newOwner; } /// @dev Used by the pending owner to claim ownership after transferOwnership function claimOwnership() external onlyPendingOwner { _transferOwnership(pendingOwner); pendingOwner = address(0); } }
// SPDX-License-Identifier: BUSL-1.1 // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { Pausable } from "@openzeppelin/contracts/security/Pausable.sol"; import { AddressProvider } from "./AddressProvider.sol"; import { IACL } from "../interfaces/IACL.sol"; import { ZeroAddressException, CallerNotConfiguratorException, CallerNotPausableAdminException, CallerNotUnPausableAdminException } from "../interfaces/IErrors.sol"; /// @title ACL Trait /// @notice Utility class for ACL consumers abstract contract ACLTrait is Pausable { // ACL contract to check rights IACL public immutable _acl; /// @dev constructor /// @param addressProvider Address of address repository constructor(address addressProvider) { if (addressProvider == address(0)) revert ZeroAddressException(); // F:[AA-2] _acl = IACL(AddressProvider(addressProvider).getACL()); } /// @dev Reverts if msg.sender is not configurator modifier configuratorOnly() { if (!_acl.isConfigurator(msg.sender)) revert CallerNotConfiguratorException(); _; } ///@dev Pause contract function pause() external { if (!_acl.isPausableAdmin(msg.sender)) revert CallerNotPausableAdminException(); _pause(); } /// @dev Unpause contract function unpause() external { if (!_acl.isUnpausableAdmin(msg.sender)) revert CallerNotUnPausableAdminException(); _unpause(); } }
// SPDX-License-Identifier: BUSL-1.1 // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IAddressProvider } from "../interfaces/IAddressProvider.sol"; import { Claimable } from "./access/Claimable.sol"; import { Errors } from "../libraries/Errors.sol"; // Repositories & services bytes32 constant CONTRACTS_REGISTER = "CONTRACTS_REGISTER"; bytes32 constant ACL = "ACL"; bytes32 constant PRICE_ORACLE = "PRICE_ORACLE"; bytes32 constant ACCOUNT_FACTORY = "ACCOUNT_FACTORY"; bytes32 constant DATA_COMPRESSOR = "DATA_COMPRESSOR"; bytes32 constant TREASURY_CONTRACT = "TREASURY_CONTRACT"; bytes32 constant GEAR_TOKEN = "GEAR_TOKEN"; bytes32 constant WETH_TOKEN = "WETH_TOKEN"; bytes32 constant WETH_GATEWAY = "WETH_GATEWAY"; bytes32 constant LEVERAGED_ACTIONS = "LEVERAGED_ACTIONS"; /// @title AddressRepository /// @notice Stores addresses of deployed contracts contract AddressProvider is Claimable, IAddressProvider { // Mapping from contract keys to respective addresses mapping(bytes32 => address) public addresses; // Contract version uint256 public constant version = 2; constructor() { // @dev Emits first event for contract discovery emit AddressSet("ADDRESS_PROVIDER", address(this)); } /// @return Address of ACL contract function getACL() external view returns (address) { return _getAddress(ACL); // F:[AP-3] } /// @dev Sets address of ACL contract /// @param _address Address of ACL contract function setACL(address _address) external onlyOwner // F:[AP-12] { _setAddress(ACL, _address); // F:[AP-3] } /// @return Address of ContractsRegister function getContractsRegister() external view returns (address) { return _getAddress(CONTRACTS_REGISTER); // F:[AP-4] } /// @dev Sets address of ContractsRegister /// @param _address Address of ContractsRegister function setContractsRegister(address _address) external onlyOwner // F:[AP-12] { _setAddress(CONTRACTS_REGISTER, _address); // F:[AP-4] } /// @return Address of PriceOracle function getPriceOracle() external view override returns (address) { return _getAddress(PRICE_ORACLE); // F:[AP-5] } /// @dev Sets address of PriceOracle /// @param _address Address of PriceOracle function setPriceOracle(address _address) external onlyOwner // F:[AP-12] { _setAddress(PRICE_ORACLE, _address); // F:[AP-5] } /// @return Address of AccountFactory function getAccountFactory() external view returns (address) { return _getAddress(ACCOUNT_FACTORY); // F:[AP-6] } /// @dev Sets address of AccountFactory /// @param _address Address of AccountFactory function setAccountFactory(address _address) external onlyOwner // F:[AP-12] { _setAddress(ACCOUNT_FACTORY, _address); // F:[AP-6] } /// @return Address of DataCompressor function getDataCompressor() external view override returns (address) { return _getAddress(DATA_COMPRESSOR); // F:[AP-7] } /// @dev Sets address of AccountFactory /// @param _address Address of AccountFactory function setDataCompressor(address _address) external onlyOwner // F:[AP-12] { _setAddress(DATA_COMPRESSOR, _address); // F:[AP-7] } /// @return Address of Treasury contract function getTreasuryContract() external view returns (address) { return _getAddress(TREASURY_CONTRACT); // F:[AP-8] } /// @dev Sets address of Treasury Contract /// @param _address Address of Treasury Contract function setTreasuryContract(address _address) external onlyOwner // F:[AP-12] { _setAddress(TREASURY_CONTRACT, _address); // F:[AP-8] } /// @return Address of GEAR token function getGearToken() external view override returns (address) { return _getAddress(GEAR_TOKEN); // F:[AP-9] } /// @dev Sets address of GEAR token /// @param _address Address of GEAR token function setGearToken(address _address) external onlyOwner // F:[AP-12] { _setAddress(GEAR_TOKEN, _address); // F:[AP-9] } /// @return Address of WETH token function getWethToken() external view override returns (address) { return _getAddress(WETH_TOKEN); // F:[AP-10] } /// @dev Sets address of WETH token /// @param _address Address of WETH token function setWethToken(address _address) external onlyOwner // F:[AP-12] { _setAddress(WETH_TOKEN, _address); // F:[AP-10] } /// @return Address of WETH token function getWETHGateway() external view override returns (address) { return _getAddress(WETH_GATEWAY); // F:[AP-11] } /// @dev Sets address of WETH token /// @param _address Address of WETH token function setWETHGateway(address _address) external onlyOwner // F:[AP-12] { _setAddress(WETH_GATEWAY, _address); // F:[AP-11] } /// @return Address of PathFinder function getLeveragedActions() external view returns (address) { return _getAddress(LEVERAGED_ACTIONS); // T:[AP-7] } /// @dev Sets address of PathFinder /// @param _address Address of PathFinder function setLeveragedActions(address _address) external onlyOwner // T:[AP-15] { _setAddress(LEVERAGED_ACTIONS, _address); // T:[AP-7] } /// @return Address of key, reverts if the key doesn't exist function _getAddress(bytes32 key) internal view returns (address) { address result = addresses[key]; require(result != address(0), Errors.AS_ADDRESS_NOT_FOUND); // F:[AP-1] return result; // F:[AP-3, 4, 5, 6, 7, 8, 9, 10, 11] } /// @dev Sets address to map by its key /// @param key Key in string format /// @param value Address function _setAddress(bytes32 key, address value) internal { addresses[key] = value; // F:[AP-3, 4, 5, 6, 7, 8, 9, 10, 11] emit AddressSet(key, value); // F:[AP-2] } }
// SPDX-License-Identifier: BUSL-1.1 // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import { Address } from "@openzeppelin/contracts/utils/Address.sol"; import { EnumerableSet } from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol"; import { ReentrancyGuard } from "@openzeppelin/contracts/security/ReentrancyGuard.sol"; import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol"; // DATA import { MultiCall } from "../libraries/MultiCall.sol"; import { Balance } from "../libraries/Balances.sol"; /// INTERFACES import { ICreditFacade, ICreditFacadeExtended } from "../interfaces/ICreditFacade.sol"; import { ICreditManagerV2, ClosureAction } from "../interfaces/ICreditManagerV2.sol"; import { IPriceOracleV2 } from "../interfaces/IPriceOracle.sol"; import { IDegenNFT } from "../interfaces/IDegenNFT.sol"; import { IWETH } from "../interfaces/external/IWETH.sol"; import { IBlacklistHelper } from "../interfaces/IBlacklistHelper.sol"; import { IPausable } from "../interfaces/IPausable.sol"; // CONSTANTS import { LEVERAGE_DECIMALS } from "../libraries/Constants.sol"; import { PERCENTAGE_FACTOR } from "../libraries/PercentageMath.sol"; // EXCEPTIONS import { ZeroAddressException } from "../interfaces/IErrors.sol"; struct Params { /// @dev Maximal amount of new debt that can be taken per block uint128 maxBorrowedAmountPerBlock; /// @dev True if increasing debt is forbidden bool isIncreaseDebtForbidden; /// @dev Timestamp of the next expiration (for expirable Credit Facades only) uint40 expirationDate; /// @dev Liquidation discount applied to totalValue for emergency liquidator uint16 emergencyLiquidationDiscount; } struct Limits { /// @dev Minimal borrowed amount per credit account uint128 minBorrowedAmount; /// @dev Maximum borrowed amount per credit account uint128 maxBorrowedAmount; } struct CumulativeLossParams { /// @dev Current cumulative loss from all bad debt liquidations uint128 currentCumulativeLoss; /// @dev Max cumulative loss accrued before the system is paused uint128 maxCumulativeLoss; } struct TotalDebt { /// @dev Current total borrowing uint128 currentTotalDebt; /// @dev Total borrowing limit uint128 totalDebtLimit; } /// @title CreditFacade /// @notice User interface for interacting with Credit Manager /// @dev Direct interaction with the Credit Manager is forbidden, but Credit Facade provides all the needed /// account management functions: open / close / liquidate / addCollateral / manageDebt / multicall. /// The latter allows to perform multiple actions within a single transaction, followed by a single /// collateral check in the end. contract CreditFacade is ICreditFacade, ReentrancyGuard { using EnumerableSet for EnumerableSet.AddressSet; using Address for address; using SafeCast for uint256; /// @dev Credit Manager connected to this Credit Facade ICreditManagerV2 public immutable creditManager; /// @dev Whether the whitelisted mode is active bool public immutable whitelisted; /// @dev Whether the Credit Manager's underlying has blacklisting bool public immutable isBlacklistableUnderlying; /// @dev Whether the Credit Facade implements expirable logic bool public immutable expirable; /// @dev Keeps frequently accessed parameters for storage access optimization Params public override params; /// @dev Keeps borrowing limits together for storage access optimization Limits public override limits; /// @dev Keeps parameters that are used to pause the system after too much bad debt over a short period CumulativeLossParams public override lossParams; TotalDebt public override totalDebt; /// @dev Address of the underlying token address public immutable underlying; /// @dev A map that stores whether a user allows a transfer of an account from another user to themselves mapping(address => mapping(address => bool)) public override transfersAllowed; /// @dev Address of WETH address public immutable wethAddress; /// @dev Address of the DegenNFT that gatekeeps account openings in whitelisted mode address public immutable override degenNFT; /// @dev Address of the BlacklistHelper if underlying is blacklistable, otherwise address(0) address public immutable override blacklistHelper; /// @dev Address of the pool connected to the Credit Manager address public immutable pool; /// @dev Stores in a compressed state the last block where borrowing happened and the total amount borrowed in that block uint256 internal totalBorrowedInBlock; /// @dev Contract version uint256 public constant override version = 2_10; /// @dev Restricts actions for users with opened credit accounts only modifier creditConfiguratorOnly() { if (msg.sender != creditManager.creditConfigurator()) revert CreditConfiguratorOnlyException(); _; } /// @dev Initializes creditFacade and connects it with CreditManager /// @param _creditManager address of Credit Manager /// @param _degenNFT address of the DegenNFT or address(0) if whitelisted mode is not used /// @param _blacklistHelper address of the funds recovery contract for blacklistable underlyings. /// Must be address(0) is the underlying is not blacklistable /// @param _expirable Whether the CreditFacade can expire and implements expiration-related logic constructor( address _creditManager, address _degenNFT, address _blacklistHelper, bool _expirable ) { // Additional check that _creditManager is not address(0) if (_creditManager == address(0)) revert ZeroAddressException(); // F:[FA-1] creditManager = ICreditManagerV2(_creditManager); // F:[FA-1A] underlying = ICreditManagerV2(_creditManager).underlying(); // F:[FA-1A] wethAddress = ICreditManagerV2(_creditManager).wethAddress(); // F:[FA-1A] pool = ICreditManagerV2(_creditManager).pool(); degenNFT = _degenNFT; // F:[FA-1A] whitelisted = _degenNFT != address(0); // F:[FA-1A] blacklistHelper = _blacklistHelper; isBlacklistableUnderlying = _blacklistHelper != address(0); if (_blacklistHelper != address(0)) { emit BlacklistHelperSet(_blacklistHelper); } expirable = _expirable; totalDebt.totalDebtLimit = type(uint128).max; } // Notice: ETH interactions // CreditFacade implements a new flow for interacting with WETH compared to V1. // During all actions, any sent ETH value is automatically wrapped into WETH and // sent back to the message sender. This makes the protocol's behavior regarding // ETH more flexible and consistent, since there is no need to pre-wrap WETH before // interacting with the protocol, and no need to compute how much unused ETH has to be sent back. /// @dev Opens credit account, borrows funds from the pool and pulls collateral /// without any additional action. /// - Performs sanity checks to determine whether opening an account is allowed /// - Wraps ETH to WETH and sends it msg. sender is value > 0 /// - Requests CreditManager to open a Credit Account with a specified borrowed amount /// - Transfers collateral in the underlying asset from the user /// - Emits OpenCreditAccount event /// /// More info: https://dev.gearbox.fi/developers/credit/credit_manager#open-credit-account /// /// @param amount The amount of collateral provided by the borrower /// @param onBehalfOf The address to open an account for. Transfers to it have to be allowed if /// msg.sender != obBehalfOf /// @param leverageFactor Percentage of the user's own funds to borrow. 100 is equal to 100% - borrows the same amount /// as the user's own collateral, equivalent to 2x leverage. /// @param referralCode Referral code that is used for potential rewards. 0 if no referral code provided. function openCreditAccount( uint256 amount, address onBehalfOf, uint16 leverageFactor, uint16 referralCode ) external payable override nonReentrant { uint256 borrowedAmount = (amount * leverageFactor) / LEVERAGE_DECIMALS; // F:[FA-5] // Checks whether the new borrowed amount does not violate the block limit _checkAndUpdateBorrowedBlockLimit(borrowedAmount); // F:[FA-11A] // Checks that the borrowed amount is within the borrowing limits _revertIfOutOfBorrowedLimits(borrowedAmount); // F:[FA-11B] // Checks that the msg.sender can open an account for onBehalfOf _revertIfOpenCreditAccountNotAllowed(onBehalfOf); // F:[FA-4A, 4B, 57] // Wraps ETH and sends it back to msg.sender _wrapETH(); // F:[FA-3A] // Checks that the total debt limit is not exceeded and increases total debt _checkAndUpdateTotalDebt(borrowedAmount, true); // F: [FA-11C] // Gets the LT of the underlying (, uint256 ltu) = creditManager.collateralTokens(0); // F:[FA-6] // In order for the account to pass the health check after opening, // the inequality "(amount + borrowedAmount) * LTU > borrowedAmount" must hold // this can be transformed into "amount * LTU > borrowedAmount * (1 - LTU)" if (amount * ltu <= borrowedAmount * (PERCENTAGE_FACTOR - ltu)) revert NotEnoughCollateralException(); // F:[FA-6] // Opens credit accnount and borrows funds from the pool // Returns the new credit account's address address creditAccount = creditManager.openCreditAccount( borrowedAmount, onBehalfOf ); // F:[FA-5] // Emits openCreditAccount event before adding collateral, so that order of events is correct emit OpenCreditAccount( onBehalfOf, creditAccount, borrowedAmount, referralCode ); // F:[FA-5] // Transfers collateral from the user to the new Credit Account addCollateral(onBehalfOf, creditAccount, underlying, amount); // F:[FA-5] } /// @dev Opens a Credit Account and runs a batch of operations in a multicall /// - Opens credit account with the desired borrowed amount /// - Executes all operations in a multicall /// - Checks that the new account has enough collateral /// - Emits OpenCreditAccount event /// /// @param borrowedAmount Debt size /// @param onBehalfOf The address to open an account for. Transfers to it have to be allowed if /// msg.sender != onBehalfOf /// @param calls The array of MultiCall structs encoding the required operations. Generally must have /// at least a call to addCollateral, as otherwise the health check at the end will fail. /// @param referralCode Referral code which is used for potential rewards. 0 if no referral code provided function openCreditAccountMulticall( uint256 borrowedAmount, address onBehalfOf, MultiCall[] calldata calls, uint16 referralCode ) external payable override nonReentrant { // Checks whether the new borrowed amount does not violate the block limit _checkAndUpdateBorrowedBlockLimit(borrowedAmount); // F:[FA-11] // Checks that the msg.sender can open an account for onBehalfOf _revertIfOpenCreditAccountNotAllowed(onBehalfOf); // F:[FA-4A, 4B, 57] // Checks that the borrowed amount is within the borrowing limits _revertIfOutOfBorrowedLimits(borrowedAmount); // F:[FA-11B] // Wraps ETH and sends it back to msg.sender address _wrapETH(); // F:[FA-3B] // Checks that the total debt limit is not exceeded and increases total debt _checkAndUpdateTotalDebt(borrowedAmount, true); // F: [FA-11C] // Requests the Credit Manager to open a Credit Account address creditAccount = creditManager.openCreditAccount( borrowedAmount, onBehalfOf ); // F:[FA-8] // emits a new event emit OpenCreditAccount( onBehalfOf, creditAccount, borrowedAmount, referralCode ); // F:[FA-8] // F:[FA-10]: no free flashloans through opening a Credit Account // and immediately decreasing debt if (calls.length != 0) _multicall(calls, onBehalfOf, creditAccount, false, true); // F:[FA-8] // Checks that the new credit account has enough collateral to cover the debt creditManager.fullCollateralCheck(creditAccount); // F:[FA-8, 9] } /// @dev A version of `closeCreditAccount` with `convertWETH` parameter that is ignored. /// Used for backward compatibility. function closeCreditAccount( address to, uint256 skipTokenMask, bool, MultiCall[] calldata calls ) external payable override nonReentrant { _closeCreditAccount(to, skipTokenMask, calls); } /// @dev Runs a batch of transactions within a multicall and closes the account /// - Wraps ETH to WETH and sends it msg.sender if value > 0 /// - Executes the multicall - the main purpose of a multicall when closing is to convert all assets to underlying /// in order to pay the debt. /// - Closes credit account: /// + Checks the underlying balance: if it is greater than the amount paid to the pool, transfers the underlying /// from the Credit Account and proceeds. If not, tries to transfer the shortfall from msg.sender. /// + Transfers all enabled assets with non-zero balances to the "to" address, unless they are marked /// to be skipped in skipTokenMask /// - Emits a CloseCreditAccount event /// /// @param to Address to send funds to during account closing /// @param skipTokenMask Uint-encoded bit mask where 1's mark tokens that shouldn't be transferred /// @param calls The array of MultiCall structs encoding the operations to execute before closing the account. function closeCreditAccount( address to, uint256 skipTokenMask, MultiCall[] calldata calls ) external payable override nonReentrant { _closeCreditAccount(to, skipTokenMask, calls); } /// @dev IMPLEMENTATION: closeCreditAccount function _closeCreditAccount( address to, uint256 skipTokenMask, MultiCall[] calldata calls ) internal { // Check for existing CA address creditAccount = creditManager.getCreditAccountOrRevert( msg.sender ); // F:[FA-2] // Wraps ETH and sends it back to msg.sender _wrapETH(); // F:[FA-3C] // [FA-13]: Calls to CreditFacade are forbidden during closure if (calls.length != 0) _multicall(calls, msg.sender, creditAccount, true, false); // F:[FA-2, 12, 13] uint256 availableLiquidityBefore = _getAvailableLiquidity(); ( uint256 borrowedAmount, uint256 borrowAmountWithInterest, ) = creditManager.calcCreditAccountAccruedInterest(creditAccount); // Requests the Credit manager to close the Credit Account creditManager.closeCreditAccount( msg.sender, ClosureAction.CLOSE_ACCOUNT, 0, msg.sender, to, skipTokenMask, false ); // F:[FA-2, 12] uint256 availableLiquidityAfter = _getAvailableLiquidity(); if ( availableLiquidityAfter < availableLiquidityBefore + borrowAmountWithInterest ) { revert LiquiditySanityCheckException(); } // Decreases the total debt _checkAndUpdateTotalDebt(borrowedAmount, false); // Emits a CloseCreditAccount event emit CloseCreditAccount(msg.sender, to); // F:[FA-12] } /// @dev Runs a batch of transactions within a multicall and liquidates the account /// - Computes the total value and checks that hf < 1. An account can't be liquidated when hf >= 1. /// Total value has to be computed before the multicall, otherwise the liquidator would be able /// to manipulate it. /// - Wraps ETH to WETH and sends it to msg.sender (liquidator) if value > 0 /// - Executes the multicall - the main purpose of a multicall when liquidating is to convert all assets to underlying /// in order to pay the debt. /// - Liquidate credit account: /// + Computes the amount that needs to be paid to the pool. If totalValue * liquidationDiscount < borrow + interest + fees, /// only totalValue * liquidationDiscount has to be paid. Since liquidationDiscount < 1, the liquidator can take /// totalValue * (1 - liquidationDiscount) as premium. Also computes the remaining funds to be sent to borrower /// as totalValue * liquidationDiscount - amountToPool. /// + If borrower happens to be blacklisted in the underlying asset, sends funds to the blacklist helper /// and marks them as claimable by the borrower. /// + Checks the underlying balance: if it is greater than amountToPool + remainingFunds, transfers the underlying /// from the Credit Account and proceeds. If not, tries to transfer the shortfall from the liquidator. /// + Transfers all enabled assets with non-zero balances to the "to" address, unless they are marked /// to be skipped in skipTokenMask. If the liquidator is confident that all assets were converted /// during the multicall, they can set the mask to uint256.max - 1, to only transfer the underlying /// - Emits LiquidateCreditAccount event /// /// @param to Address to send funds to after liquidation /// @param skipTokenMask Uint-encoded bit mask where 1's mark tokens that shouldn't be transferred /// @param calls The array of MultiCall structs encoding the operations to execute before liquidating the account. function liquidateCreditAccount( address borrower, address to, uint256 skipTokenMask, MultiCall[] calldata calls ) external payable override nonReentrant { _liquidateCreditAccount(borrower, to, skipTokenMask, calls); } /// @dev A version of `liquidateCreditAccount` with `convertWETH` parameter that is ignored. /// Used for backward compatibility. function liquidateCreditAccount( address borrower, address to, uint256 skipTokenMask, bool, MultiCall[] calldata calls ) external payable override nonReentrant { _liquidateCreditAccount(borrower, to, skipTokenMask, calls); } /// @dev IMPLEMENTATION: liquidateCreditAccount function _liquidateCreditAccount( address borrower, address to, uint256 skipTokenMask, MultiCall[] calldata calls ) internal { // Checks that the CA exists to revert early for late liquidations and save gas address creditAccount = creditManager.getCreditAccountOrRevert( borrower ); // F:[FA-2] // Checks that the to address is not zero if (to == address(0)) revert ZeroAddressException(); // F:[FA-16A] // Checks that the account hf < 1 and computes the totalValue // before the multicall (bool isLiquidatable, uint256 totalValue) = _isAccountLiquidatable( creditAccount ); // F:[FA-14] // An account can't be liquidated if hf >= 1 if (!isLiquidatable) revert CantLiquidateWithSuchHealthFactorException(); // F:[FA-14] // Wraps ETH and sends it back to msg.sender _wrapETH(); // F:[FA-3D] // Checks if the liquidation is done while the contract is paused bool emergencyLiquidation = _checkIfEmergencyLiquidator(true); if (calls.length != 0) _multicall(calls, borrower, creditAccount, true, false); // F:[FA-15] if (emergencyLiquidation) { totalValue = (totalValue * params.emergencyLiquidationDiscount) / PERCENTAGE_FACTOR; _checkIfEmergencyLiquidator(false); } uint256 remainingFunds = _closeLiquidatedAccount( totalValue, creditAccount, borrower, to, skipTokenMask, false ); emit LiquidateCreditAccount(borrower, msg.sender, to, remainingFunds); // F:[FA-15] } /// @dev Runs a batch of transactions within a multicall and liquidates the account when /// this Credit Facade is expired /// The general flow of liquidation is nearly the same as normal liquidations, with two main differences: /// - An account can be liquidated on an expired Credit Facade even with hf > 1. However, /// no accounts can be liquidated through this function if the Credit Facade is not expired. /// - Liquidation premiums and fees for liquidating expired accounts are reduced. /// It is still possible to normally liquidate an underwater Credit Account, even when the Credit Facade /// is expired. /// @param to Address to send funds to after liquidation /// @param skipTokenMask Uint-encoded bit mask where 1's mark tokens that shouldn't be transferred /// @param calls The array of MultiCall structs encoding the operations to execute before liquidating the account. /// @notice See more at https://dev.gearbox.fi/docs/documentation/credit/liquidation#liquidating-accounts-by-expiration function liquidateExpiredCreditAccount( address borrower, address to, uint256 skipTokenMask, MultiCall[] calldata calls ) external payable override nonReentrant { _liquidateExpiredCreditAccount(borrower, to, skipTokenMask, calls); } /// @dev A version of `liquidateExpiredCreditAccount` with `convertWETH` parameter that is ignored. /// Used for backward compatibility. function liquidateExpiredCreditAccount( address borrower, address to, uint256 skipTokenMask, bool, MultiCall[] calldata calls ) external payable override nonReentrant { _liquidateExpiredCreditAccount(borrower, to, skipTokenMask, calls); } /// @dev IMPLEMENTATION: liquidateExpiredCreditAccount function _liquidateExpiredCreditAccount( address borrower, address to, uint256 skipTokenMask, MultiCall[] calldata calls ) internal { // Checks that the CA exists to revert early for late liquidations and save gas address creditAccount = creditManager.getCreditAccountOrRevert( borrower ); // Checks that the to address is not zero if (to == address(0)) revert ZeroAddressException(); // Checks that this Credit Facade is expired and reverts if not if (!_isExpired()) { revert CantLiquidateNonExpiredException(); // F: [FA-47,48] } // Calculates the total value of an account (uint256 totalValue, ) = calcTotalValue(creditAccount); // Wraps ETH and sends it back to msg.sender address _wrapETH(); // Checks if the liquidation is done while the contract is paused bool emergencyLiquidation = _checkIfEmergencyLiquidator(true); if (calls.length != 0) _multicall(calls, borrower, creditAccount, true, false); // F:[FA-49] if (emergencyLiquidation) { totalValue = (totalValue * params.emergencyLiquidationDiscount) / PERCENTAGE_FACTOR; _checkIfEmergencyLiquidator(false); } uint256 remainingFunds = _closeLiquidatedAccount( totalValue, creditAccount, borrower, to, skipTokenMask, true ); // Emits event emit LiquidateExpiredCreditAccount( borrower, msg.sender, to, remainingFunds ); // F:[FA-49] } /// @dev Closes a liquidated credit account, possibly expired function _closeLiquidatedAccount( uint256 totalValue, address creditAccount, address borrower, address to, uint256 skipTokenMask, bool expired ) internal returns (uint256 remainingFunds) { uint256 helperBalance = _isBlacklisted(borrower); // If the borrower is blacklisted, transfer the account to a special recovery contract, // so that the attempt to transfer remaining funds to a blacklisted borrower does not // break the liquidation. The borrower can retrieve the funds from the recovery contract afterwards. if (helperBalance > 0) { creditManager.transferAccountOwnership(borrower, blacklistHelper); // F:[FA-56] } uint256 availableLiquidityBefore = _getAvailableLiquidity(); ( uint256 borrowedAmount, uint256 borrowAmountWithInterest, ) = creditManager.calcCreditAccountAccruedInterest(creditAccount); // Liquidates the CA and sends the remaining funds to the borrower or blacklist helper remainingFunds = creditManager.closeCreditAccount( helperBalance > 0 ? blacklistHelper : borrower, expired ? ClosureAction.LIQUIDATE_EXPIRED_ACCOUNT : ClosureAction.LIQUIDATE_ACCOUNT, totalValue, msg.sender, to, skipTokenMask, false ); // F:[FA-15,49] uint256 availableLiquidityAfter = _getAvailableLiquidity(); uint256 loss = availableLiquidityAfter < availableLiquidityBefore + borrowAmountWithInterest ? availableLiquidityBefore + borrowAmountWithInterest - availableLiquidityAfter : 0; if (loss > 0) { params.isIncreaseDebtForbidden = true; // F: [FA-15A] lossParams.currentCumulativeLoss += loss.toUint128(); if ( lossParams.currentCumulativeLoss > lossParams.maxCumulativeLoss ) { _pauseCreditManager(); // F: [FA-15B] } emit IncurLossOnLiquidation(loss); } // Decreases the total debt _checkAndUpdateTotalDebt(borrowedAmount, false); /// Credit Facade increases borrower's claimable balance in BlacklistHelper, so the /// borrower can recover funds to a different address if (helperBalance > 0 && remainingFunds > 1) { _increaseClaimableBalance(borrower, helperBalance); } } /// @dev Checks whether borrower is blacklisted in the underlying token and, if so, /// returns non-zero value equal to blacklist helper's balance of underlying // Zero return value always indicates that borrower is not blacklisted function _isBlacklisted(address borrower) internal view returns (uint256 helperBalance) { if ( isBlacklistableUnderlying && IBlacklistHelper(blacklistHelper).isBlacklisted( underlying, borrower ) // F:[FA-56] ) { // can't realistically overflow unchecked { helperBalance = IERC20(underlying).balanceOf(blacklistHelper) + 1; } } } /// @dev Checks if blacklist helper's balance of underlying increased after liquidation /// and, if so, increases the borrower's claimable balance by the difference /// Not relying on `remainingFunds` to support fee-on-transfer tokens function _increaseClaimableBalance( address borrower, uint256 helperBalanceBefore ) internal { uint256 helperBalance = IERC20(underlying).balanceOf(blacklistHelper); if (helperBalance > helperBalanceBefore) { uint256 amount; unchecked { amount = helperBalance - helperBalanceBefore + 1; } IBlacklistHelper(blacklistHelper).addClaimable( underlying, borrower, amount ); // F:[FA-56] emit UnderlyingSentToBlacklistHelper(borrower, amount); // F:[FA-56] } } /// @dev Increases debt for a Credit Account /// @param borrower Owner of the account /// @param creditAccount CA to increase debt for /// @param amount Amount to borrow function _increaseDebt( address borrower, address creditAccount, uint256 amount ) internal { // It is forbidden to take new debt if increaseDebtForbidden mode is enabled if (params.isIncreaseDebtForbidden) { revert IncreaseDebtForbiddenException(); } // F:[FA-18C] // Checks that the borrowed amount does not violate the per block limit _checkAndUpdateBorrowedBlockLimit(amount); // F:[FA-18A] // Checks that there are no forbidden tokens, as borrowing // is prohibited when forbidden tokens are enabled on the account _checkForbiddenTokens(creditAccount); // Checks that the total debt limit is not exceeded and increases total debt _checkAndUpdateTotalDebt(amount, true); // F: [FA-11C] // Requests the Credit Manager to borrow additional funds from the pool uint256 newBorrowedAmount = creditManager.manageDebt( creditAccount, amount, true ); // F:[FA-17] // Checks that the new total borrowed amount is within bounds _revertIfOutOfBorrowedLimits(newBorrowedAmount); // F:[FA-18B] // Emits event emit IncreaseBorrowedAmount(borrower, amount); // F:[FA-17] } /// @dev Checks that there are no intersections between the user's enabled tokens /// and the set of forbidden tokens /// @notice The main purpose of forbidding tokens is to prevent exposing /// pool funds to dangerous or exploited collateral, without immediately /// liquidating accounts that hold the forbidden token /// There are two ways pool funds can be exposed: /// - The CA owner tries to swap borrowed funds to the forbidden asset: /// this will be blocked by checkAndEnableToken, which is invoked for tokenOut /// after every operation; /// - The CA owner with an already enabled forbidden token transfers it /// to the account - they can't use addCollateral / enableToken due to checkAndEnableToken, /// but can transfer the token directly when it is enabled and it will be counted in the collateral - /// an borrows against it. This check is used to prevent this. /// If the owner has a forbidden token and want to take more debt, they must first /// dispose of the token and disable it. function _checkForbiddenTokens(address creditAccount) internal view { uint256 enabledTokenMask = creditManager.enabledTokensMap( creditAccount ); uint256 forbiddenTokenMask = creditManager.forbiddenTokenMask(); if (enabledTokenMask & forbiddenTokenMask > 0) { revert ActionProhibitedWithForbiddenTokensException(); } } /// @dev Decreases debt for a Credit Account /// @param borrower Owner of the account /// @param creditAccount Account to decrease debt for /// @param amount Amount to repay function _decreaseDebt( address borrower, address creditAccount, uint256 amount ) internal { (uint256 borrowedAmountBefore, , ) = creditManager .calcCreditAccountAccruedInterest(creditAccount); // Requests the creditManager to reduce the borrowed sum by amount uint256 newBorrowedAmount = creditManager.manageDebt( creditAccount, amount, false ); // F:[FA-19] // Checks that the new borrowed amount is within limits _revertIfOutOfBorrowedLimits(newBorrowedAmount); // F:[FA-20] // Decreases total debt // Since part of the amount can be used to repay interest, // we need to compute the difference between the old and new borrowed amount _checkAndUpdateTotalDebt( borrowedAmountBefore - newBorrowedAmount, false ); // Emits an event emit DecreaseBorrowedAmount(borrower, amount); // F:[FA-19] } /// @dev Adds collateral to borrower's credit account /// @param onBehalfOf Address of the borrower whose account is funded /// @param token Address of a collateral token /// @param amount Amount to add function addCollateral( address onBehalfOf, address token, uint256 amount ) external payable override nonReentrant { // Wraps ETH and sends it back to msg.sender _wrapETH(); // F:[FA-3E] // Checks that onBehalfOf has an account address creditAccount = creditManager.getCreditAccountOrRevert( onBehalfOf ); // F:[FA-2] addCollateral(onBehalfOf, creditAccount, token, amount); // Since this action can enable new tokens, Credit Manager // needs to check that the max enabled token limit is not // breached creditManager.checkAndOptimizeEnabledTokens(creditAccount); // F: [FA-21C] } function addCollateral( address onBehalfOf, address creditAccount, address token, uint256 amount ) internal { // Checks that msg.sender can transfer funds to onBehalfOf's account // This is done to prevent malicious actors sending bad collateral // to users // mgs.sender can only add collateral if transfer are approved // from itself to onBehalfOf _revertIfActionOnAccountNotAllowed(onBehalfOf); // F: [FA-21A] // Requests Credit Manager to transfer collateral to the Credit Account creditManager.addCollateral(msg.sender, creditAccount, token, amount); // F:[FA-21] // Emits event emit AddCollateral(onBehalfOf, token, amount); // F:[FA-21] } /// @dev Executes a batch of transactions within a Multicall, to manage an existing account /// - Wraps ETH and sends it back to msg.sender, if value > 0 /// - Executes the Multicall /// - Performs a fullCollateralCheck to verify that hf > 1 after all actions /// @param calls The array of MultiCall structs encoding the operations to execute. function multicall(MultiCall[] calldata calls) external payable override nonReentrant { // Checks that msg.sender has an account address creditAccount = creditManager.getCreditAccountOrRevert( msg.sender ); // Wraps ETH and sends it back to msg.sender _wrapETH(); // F:[FA-3F] if (calls.length != 0) { _multicall(calls, msg.sender, creditAccount, false, false); // Performs a fullCollateralCheck // During a multicall, all intermediary health checks are skipped, // as one fullCollateralCheck at the end is sufficient creditManager.fullCollateralCheck(creditAccount); } } /// @dev IMPLEMENTATION: multicall /// - Transfers ownership from borrower to this contract, as most adapter and Credit Manager functions retrieve /// the Credit Account by msg.sender /// - Executes the provided list of calls: /// + if targetContract == address(this), parses call data in the struct and calls the appropriate function (see _processCreditFacadeMulticall below) /// + if targetContract == adapter, calls the adapter with call data as provided. /// @param borrower Owner of the Credit Account /// @param creditAccount Credit Account address /// @param isClosure Whether the multicall is being invoked during a closure action. Calls to Credit Facade are forbidden inside /// multicalls on closure. /// @param increaseDebtWasCalled True if debt was increased before or during the multicall. Used to prevent free flashloans by /// increasing and decreasing debt within a single multicall. function _multicall( MultiCall[] calldata calls, address borrower, address creditAccount, bool isClosure, bool increaseDebtWasCalled ) internal { // Takes ownership of the Credit Account creditManager.transferAccountOwnership(borrower, address(this)); // F:[FA-26] // Emits event for multicall start - used in analytics to track actions within multicalls emit MultiCallStarted(borrower); // F:[FA-26] // Declares the expectedBalances array, which can later be used for slippage control Balance[] memory expectedBalances; uint256 len = calls.length; // F:[FA-26] for (uint256 i = 0; i < len; ) { MultiCall calldata mcall = calls[i]; // F:[FA-26] // Reverts of calldata has less than 4 bytes if (mcall.callData.length < 4) revert IncorrectCallDataException(); // F:[FA-22] if (mcall.target == address(this)) { // No internal calls on closure except slippage control, to avoid loss manipulation if (isClosure) { bytes4 method = bytes4(mcall.callData); if ( method != ICreditFacadeExtended.revertIfReceivedLessThan.selector ) revert ForbiddenDuringClosureException(); // F:[FA-13] } // // CREDIT FACADE // // increaseDebtWasCalled and expectedBalances are parameters that persist throughout multicall, // therefore they are passed to the internal function processor, which returns updated values ( increaseDebtWasCalled, expectedBalances ) = _processCreditFacadeMulticall( borrower, creditAccount, mcall.callData, increaseDebtWasCalled, expectedBalances ); } else { // // ADAPTERS // // Checks that the target is an allowed adapter and not CreditManager // As CreditFacade has powerful permissions in CreditManagers, // functionCall to it is strictly forbidden, even if // the Configurator adds it as an adapter if ( creditManager.adapterToContract(mcall.target) == address(0) || mcall.target == address(creditManager) ) revert TargetContractNotAllowedException(); // F:[FA-24] // Makes a call mcall.target.functionCall(mcall.callData); // F:[FA-29] } unchecked { ++i; } } // If expectedBalances was set by calling revertIfGetLessThan, // checks that actual token balances are not less than expected balances if (expectedBalances.length != 0) _compareBalances(expectedBalances, creditAccount); // Emits event for multicall end - used in analytics to track actions within multicalls emit MultiCallFinished(); // F:[FA-27,27,29] // Returns ownership back to the borrower creditManager.transferAccountOwnership(address(this), borrower); // F:[FA-27,27,29] } /// @dev Internal function for processing calls to Credit Facade within the multicall /// @param borrower Original owner of the Credit Account /// @param creditAccount Credit Account address /// @param callData Call data of the currently processed call /// @param increaseDebtWasCalledBefore Whether debt was increased before entering the function /// @param expectedBalances Array of expected balances before entering the function function _processCreditFacadeMulticall( address borrower, address creditAccount, bytes calldata callData, bool increaseDebtWasCalledBefore, Balance[] memory expectedBalancesBefore ) internal returns (bool increaseDebtWasCalled, Balance[] memory expectedBalances) { increaseDebtWasCalled = increaseDebtWasCalledBefore; expectedBalances = expectedBalancesBefore; bytes4 method = bytes4(callData); // // REVERT_IF_GET_LESS_THAN // // This is an extension function that instructs CreditFacade to check token balances at the end // Used to control slippage after the entire sequence of operations, since tracking slippage // On each operation is not ideal if (method == ICreditFacadeExtended.revertIfReceivedLessThan.selector) { // Method can only be called once since the provided Balance array // contains deltas that are added to the current balances // Calling this function again could potentially override old values // and cause confusion, especially if called later in the MultiCall if (expectedBalances.length != 0) revert ExpectedBalancesAlreadySetException(); // F:[FA-45A] // Retrieves the balance list from calldata expectedBalances = abi.decode(callData[4:], (Balance[])); // F:[FA-45] // Sets expected balances to currentBalance + delta expectedBalances = _storeBalances(expectedBalances, creditAccount); // F:[FA-45] } // // ADD COLLATERAL // else if (method == ICreditFacade.addCollateral.selector) { // Parses parameters from calldata (address onBehalfOf, address token, uint256 amount) = abi.decode( callData[4:], (address, address, uint256) ); // F:[FA-26, 27] // In case onBehalfOf isn't the owner of the currently processed account, // retrieves onBehalfOf's account addCollateral( onBehalfOf, onBehalfOf == borrower ? creditAccount : creditManager.getCreditAccountOrRevert(onBehalfOf), token, amount ); // F:[FA-26, 27] } // // INCREASE DEBT // else if (method == ICreditFacadeExtended.increaseDebt.selector) { // Sets increaseDebtWasCalled to prevent debt reductions afterwards, // as that could be used to get free flash loans increaseDebtWasCalled = true; // F:[FA-28] // Parses parameters from calldata uint256 amount = abi.decode(callData[4:], (uint256)); // F:[FA-26] _increaseDebt(borrower, creditAccount, amount); // F:[FA-26] } // // DECREASE DEBT // else if (method == ICreditFacadeExtended.decreaseDebt.selector) { // it's forbidden to call decreaseDebt after increaseDebt, in the same multicall if (increaseDebtWasCalled) revert IncreaseAndDecreaseForbiddenInOneCallException(); // F:[FA-28] // Parses parameters from calldata uint256 amount = abi.decode(callData[4:], (uint256)); // F:[FA-27] _decreaseDebt(borrower, creditAccount, amount); // F:[FA-27] } // // ENABLE TOKEN // else if (method == ICreditFacadeExtended.enableToken.selector) { // Parses token address token = abi.decode(callData[4:], (address)); // F: [FA-53] // Executes enableToken for creditAccount _enableToken(borrower, creditAccount, token); // F: [FA-53] } // // DISABLE TOKEN // // This is an extenstion method used to disable tokens on a Credit Account // Can be used to remove troublesome tokens (e.g., forbidden tokens) from an account else if (method == ICreditFacadeExtended.disableToken.selector) { // Parses token address token = abi.decode(callData[4:], (address)); // F: [FA-54] // Executes disableToken for creditAccount _disableToken(borrower, creditAccount, token); // F: [FA-54] } else { // Reverts if the passed selector is unrecognized revert UnknownMethodException(); // F:[FA-23] } } /// @dev Adds expected deltas to current balances on a Credit account and returns the result /// @param expected Expected changes to existing balances /// @param creditAccount Credit Account to compute balances for function _storeBalances(Balance[] memory expected, address creditAccount) internal view returns (Balance[] memory) { uint256 len = expected.length; // F:[FA-45] for (uint256 i = 0; i < len; ) { expected[i].balance += IERC20(expected[i].token).balanceOf( creditAccount ); // F:[FA-45] unchecked { ++i; } } return expected; // F:[FA-45] } /// @dev Compares current balances to previously saved expected balances. /// Reverts if at least one balance is lower than expected /// @param expected Expected balances after all operations /// @param creditAccount Credit Account to check function _compareBalances(Balance[] memory expected, address creditAccount) internal view { uint256 len = expected.length; // F:[FA-45] for (uint256 i = 0; i < len; ) { if ( IERC20(expected[i].token).balanceOf(creditAccount) < expected[i].balance ) revert BalanceLessThanMinimumDesiredException(expected[i].token); // F:[FA-45] unchecked { ++i; } } } /// @dev Transfers credit account to another user /// By default, this action is forbidden, and the user has to approve transfers from sender to itself /// by calling approveAccountTransfer. /// This is done to prevent malicious actors from transferring compromised accounts to other users. /// @param to Address to transfer the account to function transferAccountOwnership(address to) external override nonReentrant { // In whitelisted mode only select addresses can have Credit Accounts // So this action is prohibited if (whitelisted) revert NotAllowedInWhitelistedMode(); // F:[FA-32] address creditAccount = creditManager.getCreditAccountOrRevert( msg.sender ); // F:[FA-2] // Checks that transfer is allowed if (!transfersAllowed[msg.sender][to]) revert AccountTransferNotAllowedException(); // F:[FA-33] /// Checks that the account hf > 1, as it is forbidden to transfer /// accounts that are liquidatable (bool isLiquidatable, ) = _isAccountLiquidatable(creditAccount); // F:[FA-34] if (isLiquidatable) revert CantTransferLiquidatableAccountException(); // F:[FA-34] // Requests the Credit Manager to transfer the account creditManager.transferAccountOwnership(msg.sender, to); // F:[FA-35] // Emits event emit TransferAccount(msg.sender, to); // F:[FA-35] } /// @dev Verifies that the msg.sender can open an account for onBehalfOf /// - For expirable Credit Facade, expiration date must not be reached /// - For whitelisted mode, msg.sender must open the account for themselves /// and have at least one DegenNFT to burn /// - Otherwise, checks that account transfers from msg.sender to onBehalfOf /// are approved /// @param onBehalfOf Account which would own credit account function _revertIfOpenCreditAccountNotAllowed(address onBehalfOf) internal { // Opening new Credit Accounts is prohibited in increaseDebtForbidden mode if (params.isIncreaseDebtForbidden) revert IncreaseDebtForbiddenException(); // F:[FA-7] // Checks that this CreditFacade is not expired if (_isExpired()) { revert OpenAccountNotAllowedAfterExpirationException(); // F: [FA-46] } // Checks that the borrower is not blacklisted, if the underlying is blacklistable if (_isBlacklisted(onBehalfOf) != 0) { revert NotAllowedForBlacklistedAddressException(); // F:[FA-57] } // F:[FA-5] covers case when degenNFT == address(0) if (degenNFT != address(0)) { // F:[FA-4B] // In whitelisted mode, users can only open an account by burning a DegenNFT // And opening an account for another address is forbidden if (whitelisted && msg.sender != onBehalfOf) revert NotAllowedInWhitelistedMode(); // F:[FA-4B] IDegenNFT(degenNFT).burn(onBehalfOf, 1); // F:[FA-4B] } _revertIfActionOnAccountNotAllowed(onBehalfOf); } /// @dev Checks if the message sender is allowed to do an action on a CA /// @param onBehalfOf The account which owns the target CA function _revertIfActionOnAccountNotAllowed(address onBehalfOf) internal view { // msg.sender must either be the account owner themselves, // or be approved for transfers if ( msg.sender != onBehalfOf && !transfersAllowed[msg.sender][onBehalfOf] ) revert AccountTransferNotAllowedException(); // F:[FA-04C] } /// @dev Checks that the per-block borrow limit was not violated and updates the /// amount borrowed in current block function _checkAndUpdateBorrowedBlockLimit(uint256 amount) internal { // Skipped in whitelisted mode, since there is a strict limit on the number // of credit accounts that can be opened, which implies a limit on borrowing if (!whitelisted) { uint256 _limitPerBlock = params.maxBorrowedAmountPerBlock; // F:[FA-18] // If the limit is unit128.max, the check is disabled // F:[FA-36] test case when _limitPerBlock == type(uint128).max if (_limitPerBlock != type(uint128).max) { ( uint64 lastBlock, uint128 lastLimit ) = getTotalBorrowedInBlock(); // F:[FA-18, 37] uint256 newLimit = (lastBlock == block.number) ? amount + lastLimit // F:[FA-37] : amount; // F:[FA-18, 37] if (newLimit > _limitPerBlock) revert BorrowedBlockLimitException(); // F:[FA-18] _updateTotalBorrowedInBlock(newLimit.toUint128()); // F:[FA-37] } } } /// @dev Checks that the borrowed principal is within borrowing limits /// @param borrowedAmount The current principal of a Credit Account function _revertIfOutOfBorrowedLimits(uint256 borrowedAmount) internal view { // Checks that amount is in limits if ( borrowedAmount < uint256(limits.minBorrowedAmount) || borrowedAmount > uint256(limits.maxBorrowedAmount) ) revert BorrowAmountOutOfLimitsException(); // F: } function _checkIfEmergencyLiquidator(bool state) internal returns (bool) { return creditManager.checkEmergencyPausable(msg.sender, state); } /// @dev Updates total debt and checks that it does not exceed the limit function _checkAndUpdateTotalDebt(uint256 delta, bool isIncrease) internal { if (delta > 0) { TotalDebt memory td = totalDebt; if (isIncrease) { td.currentTotalDebt += delta.toUint128(); if (td.currentTotalDebt > td.totalDebtLimit) { revert BorrowAmountOutOfLimitsException(); } } else { td.currentTotalDebt -= delta.toUint128(); } totalDebt = td; } } /// @dev Returns the last block where debt was taken, /// and the total amount borrowed in that block function getTotalBorrowedInBlock() public view returns (uint64 blockLastUpdate, uint128 borrowedInBlock) { blockLastUpdate = uint64(totalBorrowedInBlock >> 128); // F:[FA-37] borrowedInBlock = uint128(totalBorrowedInBlock & type(uint128).max); // F:[FA-37] } /// @dev Saves the total amount borrowed in the current block for future checks /// @param borrowedInBlock Updated total borrowed amount function _updateTotalBorrowedInBlock(uint128 borrowedInBlock) internal { totalBorrowedInBlock = uint256(block.number << 128) | borrowedInBlock; // F:[FA-37] } /// @dev Approves account transfer from another user to msg.sender /// @param from Address for which account transfers are allowed/forbidden /// @param state True is transfer is allowed, false if forbidden function approveAccountTransfer(address from, bool state) external override nonReentrant { transfersAllowed[from][msg.sender] = state; // F:[FA-38] // Emits event emit TransferAccountAllowed(from, msg.sender, state); // F:[FA-38] } /// @dev Enables token in enabledTokenMask for a Credit Account /// @param creditAccount Account for which the token is enabled /// @param token Collateral token to enabled function _enableToken( address borrower, address creditAccount, address token ) internal { // Will revert if the token is not known or forbidden, // If the token is disabled, adds the respective bit to the mask, otherwise does nothing creditManager.checkAndEnableToken(creditAccount, token); // F:[FA-39] // Emits event emit TokenEnabled(borrower, token); } /// @dev Disable a token for a Credit Account /// @param borrower Owner of the account /// @param token Token to disable function _disableToken( address borrower, address creditAccount, address token ) internal { // If the token is enabled, removes a respective bit from the mask, // otherwise does nothing if (creditManager.disableToken(creditAccount, token)) { // Emits event emit TokenDisabled(borrower, token); } // F: [FA-54] } /// @dev Pauses the Credit Manager function _pauseCreditManager() internal { IPausable(address(creditManager)).pause(); } // // GETTERS // /// @dev Returns true if token is a collateral token and is not forbidden, /// otherwise returns false /// @param token Token to check function isTokenAllowed(address token) public view override returns (bool allowed) { uint256 tokenMask = creditManager.tokenMasksMap(token); // F:[FA-40] allowed = (tokenMask != 0) && (creditManager.forbiddenTokenMask() & tokenMask == 0); // F:[FA-40] } /// @dev Calculates total value for provided Credit Account in underlying /// More: https://dev.gearbox.fi/developers/credit/economy#totalUSD-value /// /// @param creditAccount Credit Account address /// @return total Total value in underlying /// @return twv Total weighted (discounted by liquidation thresholds) value in underlying function calcTotalValue(address creditAccount) public view override returns (uint256 total, uint256 twv) { IPriceOracleV2 priceOracle = IPriceOracleV2( creditManager.priceOracle() ); // F:[FA-41] (uint256 totalUSD, uint256 twvUSD) = _calcTotalValueUSD( priceOracle, creditAccount ); total = priceOracle.convertFromUSD(totalUSD, underlying); // F:[FA-41] twv = priceOracle.convertFromUSD(twvUSD, underlying) / PERCENTAGE_FACTOR; // F:[FA-41] } /// @dev Calculates total value for provided Credit Account in USD /// @param priceOracle Oracle used to convert assets to USD /// @param creditAccount Address of the Credit Account /// @return totalUSD Total value of the account in USD /// @return twvUSD Total weighted (discounted by liquidation thresholds) value in USD function _calcTotalValueUSD( IPriceOracleV2 priceOracle, address creditAccount ) internal view returns (uint256 totalUSD, uint256 twvUSD) { uint256 tokenMask = 1; uint256 enabledTokensMask = creditManager.enabledTokensMap( creditAccount ); // F:[FA-41] while (tokenMask <= enabledTokensMask) { if (enabledTokensMask & tokenMask != 0) { (address token, uint16 liquidationThreshold) = creditManager .collateralTokensByMask(tokenMask); uint256 balance = IERC20(token).balanceOf(creditAccount); // F:[FA-41] if (balance > 1) { uint256 value = priceOracle.convertToUSD(balance, token); // F:[FA-41] unchecked { totalUSD += value; // F:[FA-41] } twvUSD += value * liquidationThreshold; // F:[FA-41] } } // T:[FA-41] tokenMask = tokenMask << 1; // F:[FA-41] } } /** * @dev Calculates health factor for the credit account * * sum(asset[i] * liquidation threshold[i]) * Hf = -------------------------------------------- * borrowed amount + interest accrued + fees * * * More info: https://dev.gearbox.fi/developers/credit/economy#health-factor * * @param creditAccount Credit account address * @return hf = Health factor in bp (see PERCENTAGE FACTOR in PercentageMath.sol) */ function calcCreditAccountHealthFactor(address creditAccount) public view override returns (uint256 hf) { (, uint256 twv) = calcTotalValue(creditAccount); // F:[FA-42] (, , uint256 borrowAmountWithInterestAndFees) = creditManager .calcCreditAccountAccruedInterest(creditAccount); // F:[FA-42] hf = (twv * PERCENTAGE_FACTOR) / borrowAmountWithInterestAndFees; // F:[FA-42] } /// @dev Returns true if the borrower has an open Credit Account /// @param borrower Borrower address function hasOpenedCreditAccount(address borrower) public view override returns (bool) { return creditManager.creditAccounts(borrower) != address(0); // F:[FA-43] } /// @dev Wraps ETH into WETH and sends it back to msg.sender function _wrapETH() internal { if (msg.value > 0) { IWETH(wethAddress).deposit{ value: msg.value }(); // F:[FA-3] IWETH(wethAddress).transfer(msg.sender, msg.value); // F:[FA-3] } } /// @dev Checks if account is liquidatable (i.e., hf < 1) /// @param creditAccount Address of credit account to check /// @return isLiquidatable True if account can be liquidated /// @return totalValue Total value of the Credit Account in underlying function _isAccountLiquidatable(address creditAccount) internal view returns (bool isLiquidatable, uint256 totalValue) { IPriceOracleV2 priceOracle = IPriceOracleV2( creditManager.priceOracle() ); // F:[FA-14] (uint256 totalUSD, uint256 twvUSD) = _calcTotalValueUSD( priceOracle, creditAccount ); // Computes total value in underlying totalValue = priceOracle.convertFromUSD(totalUSD, underlying); // F:[FA-14] (, , uint256 borrowAmountWithInterestAndFees) = creditManager .calcCreditAccountAccruedInterest(creditAccount); // F:[FA-14] // borrowAmountPlusInterestRateUSD x 10000 to be compared with USD values multiplied by LTs uint256 borrowAmountPlusInterestRateUSD = priceOracle.convertToUSD( borrowAmountWithInterestAndFees, underlying ) * PERCENTAGE_FACTOR; // Checks that current Hf < 1 isLiquidatable = twvUSD < borrowAmountPlusInterestRateUSD; } /// @dev Returns whether the Credit Facade is expired function _isExpired() internal view returns (bool isExpired) { isExpired = (expirable) && (block.timestamp >= params.expirationDate); // F: [FA-46,47,48] } /// @dev Returns the current available liquidity of the pool function _getAvailableLiquidity() internal view returns (uint256) { return IERC20(underlying).balanceOf(pool); } // // CONFIGURATION // /// @dev Sets the increaseDebtForbidden mode /// @notice increaseDebtForbidden can be used to secure pool funds /// without pausing the entire system. E.g., if a bug is reported /// that can potentially lead to loss of funds, but there is no /// immediate threat, new borrowing can be stopped, while other /// functionality (trading, closing/liquidating accounts) is retained function setIncreaseDebtForbidden(bool _mode) external creditConfiguratorOnly // F:[FA-44] { params.isIncreaseDebtForbidden = _mode; } /// @dev Sets borrowing limit per single block /// @notice Borrowing limit per block in conjunction with /// the monitoring system serves to minimize loss from hacks /// While an attacker would be able to steal, in worst case, /// up to (limitPerBlock * n blocks) of funds, the monitoring /// system would pause the contracts after detecting suspicious /// activity function setLimitPerBlock(uint128 newLimit) external creditConfiguratorOnly // F:[FA-44] { params.maxBorrowedAmountPerBlock = newLimit; } /// @dev Sets the total debt limit and the current total debt value (used for Credit Facade migration) function setTotalDebtParams(uint128 newCurrentTotalDebt, uint128 newLimit) external creditConfiguratorOnly { totalDebt.currentTotalDebt = newCurrentTotalDebt; totalDebt.totalDebtLimit = newLimit; } /// @dev Sets Credit Facade expiration date /// @notice See more at https://dev.gearbox.fi/docs/documentation/credit/liquidation#liquidating-accounts-by-expiration function setExpirationDate(uint40 newExpirationDate) external creditConfiguratorOnly { if (!expirable) { revert NotAllowedWhenNotExpirableException(); } params.expirationDate = newExpirationDate; } /// @dev Sets borrowing limits per single Credit Account /// @param _minBorrowedAmount The minimal borrowed amount per Credit Account. Minimal amount can be relevant /// for liquidations, since very small amounts will make liquidations unprofitable for liquidators /// @param _maxBorrowedAmount The maximal borrowed amount per Credit Account. Used to limit exposure per a single /// credit account - especially relevant in whitelisted mode. function setCreditAccountLimits( uint128 _minBorrowedAmount, uint128 _maxBorrowedAmount ) external creditConfiguratorOnly { limits.minBorrowedAmount = _minBorrowedAmount; // F: limits.maxBorrowedAmount = _maxBorrowedAmount; // F: } /// @dev Sets the max cumulative loss that can be accrued before pausing the Credit Manager function setMaxCumulativeLoss(uint128 _maxCumulativeLoss) external creditConfiguratorOnly { lossParams.maxCumulativeLoss = _maxCumulativeLoss; } /// @dev Resets the current cumulative loss value function resetCumulativeLoss() external creditConfiguratorOnly { lossParams.currentCumulativeLoss = 0; } /// @dev Sets the new emergency liquidation discount value function setEmergencyLiquidationDiscount(uint16 newDiscount) external creditConfiguratorOnly { params.emergencyLiquidationDiscount = newDiscount; } }
// SPDX-License-Identifier: BUSL-1.1 // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; // LIBRARIES import { Address } from "@openzeppelin/contracts/utils/Address.sol"; import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol"; import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol"; import { ACLTrait } from "../core/ACLTrait.sol"; // INTERFACES import { IAccountFactory } from "../interfaces/IAccountFactory.sol"; import { ICreditAccount } from "../interfaces/ICreditAccount.sol"; import { IPoolService } from "../interfaces/IPoolService.sol"; import { IWETHGateway } from "../interfaces/IWETHGateway.sol"; import { ICreditManagerV2, ClosureAction } from "../interfaces/ICreditManagerV2.sol"; import { IAddressProvider } from "../interfaces/IAddressProvider.sol"; import { IPriceOracleV2 } from "../interfaces/IPriceOracle.sol"; // CONSTANTS import { RAY } from "../libraries/Constants.sol"; import { PERCENTAGE_FACTOR } from "../libraries/PercentageMath.sol"; import { DEFAULT_FEE_INTEREST, DEFAULT_FEE_LIQUIDATION, DEFAULT_LIQUIDATION_PREMIUM, LEVERAGE_DECIMALS, ALLOWANCE_THRESHOLD, UNIVERSAL_CONTRACT } from "../libraries/Constants.sol"; uint256 constant ADDR_BIT_SIZE = 160; uint256 constant INDEX_PRECISION = 10**9; struct Slot1 { /// @dev Interest fee charged by the protocol: fee = interest accrued * feeInterest uint16 feeInterest; /// @dev Liquidation fee charged by the protocol: fee = totalValue * feeLiquidation uint16 feeLiquidation; /// @dev Multiplier used to compute the total value of funds during liquidation. /// At liquidation, the borrower's funds are discounted, and the pool is paid out of discounted value /// The liquidator takes the difference between the discounted and actual values as premium. uint16 liquidationDiscount; /// @dev Liquidation fee charged by the protocol during liquidation by expiry. Typically lower than feeLiquidation. uint16 feeLiquidationExpired; /// @dev Multiplier used to compute the total value of funds during liquidation by expiry. Typically higher than /// liquidationDiscount (meaning lower premium). uint16 liquidationDiscountExpired; /// @dev Price oracle used to evaluate assets on Credit Accounts. IPriceOracleV2 priceOracle; /// @dev Liquidation threshold for the underlying token. uint16 ltUnderlying; } /// @title Credit Manager /// @notice Encapsulates the business logic for managing Credit Accounts /// /// More info: https://dev.gearbox.fi/developers/credit/credit_manager contract CreditManager is ICreditManagerV2, ACLTrait { using SafeERC20 for IERC20; using Address for address payable; using SafeCast for uint256; /// @dev used to protect against reentrancy. Bool is gas-optimal, /// since there are other non-zero values packed into the same slot bool private entered; bool public emergencyLiquidation; /// @dev The maximal number of enabled tokens on a single Credit Account uint8 public override maxAllowedEnabledTokenLength = 12; /// @dev Address of the connected Credit Facade address public override creditFacade; /// @dev Stores fees & parameters commonly used together for gas savings Slot1 internal slot1; /// @dev A map from borrower addresses to Credit Account addresses mapping(address => address) public override creditAccounts; /// @dev Factory contract for Credit Accounts IAccountFactory public immutable _accountFactory; /// @dev Address of the underlying asset address public immutable override underlying; /// @dev Address of the connected pool /// @notice [DEPRECATED]: use pool() instead. address public immutable override poolService; /// @dev Address of the connected pool address public immutable override pool; /// @dev Address of WETH address public immutable override wethAddress; /// @dev Address of WETH Gateway address public immutable wethGateway; /// @dev Address of the connected Credit Configurator address public creditConfigurator; /// @dev Map of token's bit mask to its address and LT compressed into a single uint256 /// @notice Use collateralTokens(uint256 i) to get uncompressed values. mapping(uint256 => uint256) internal collateralTokensCompressed; /// @dev Total number of known collateral tokens. uint256 public collateralTokensCount; /// @dev Internal map of token addresses to their indidivual masks. /// @notice A mask is a uint256 that has only 1 non-zero bit in the position correspondingto /// the token's index (i.e., tokenMask = 2 ** index) /// Masks are used to efficiently check set inclusion, since it only involves /// a single AND and comparison to zero mapping(address => uint256) internal tokenMasksMapInternal; /// @dev Bit mask encoding a set of forbidden tokens uint256 public override forbiddenTokenMask; /// @dev Maps Credit Accounts to bit masks encoding their enabled token sets /// Only enabled tokens are counted as collateral for the Credit Account /// @notice An enabled token mask encodes an enabled token by setting /// the bit at the position equal to token's index to 1 mapping(address => uint256) public override enabledTokensMap; /// @dev Maps Credit Accounts to their current cumulative drops in value during fast checks /// See more details in fastCollateralCheck() mapping(address => uint256) public cumulativeDropAtFastCheckRAY; /// @dev Maps allowed adapters to their respective target contracts. mapping(address => address) public override adapterToContract; /// @dev Maps 3rd party contracts to their respective adapters mapping(address => address) public override contractToAdapter; /// @dev Maps addresses to their status as emergency liquidator. /// @notice Emergency liquidators are trusted addresses /// that are able to liquidate positions while the contracts are paused, /// e.g. when there is a risk of bad debt while an exploit is being patched. /// In the interest of fairness, emergency liquidators do not receive a premium /// And are compensated by the Gearbox DAO separately. mapping(address => bool) public override canLiquidateWhilePaused; /// @dev Stores address of the Universal adapter /// @notice See more at https://dev.gearbox.fi/docs/documentation/integrations/universal address public universalAdapter; /// @dev contract version uint256 public constant override version = 2_10; // // MODIFIERS // /// @dev Protects against reentrancy. /// @notice Custom ReentrancyGuard implementation is used to optimize storage reads. modifier nonReentrant() { if (entered) { revert ReentrancyLockException(); } entered = true; _; entered = false; } /// @dev Restricts calls to Credit Facade or allowed adapters modifier adaptersOrCreditFacadeOnly() { if ( adapterToContract[msg.sender] == address(0) && msg.sender != creditFacade ) revert AdaptersOrCreditFacadeOnlyException(); // _; } /// @dev Restricts calls to Credit Facade only modifier creditFacadeOnly() { if (msg.sender != creditFacade) revert CreditFacadeOnlyException(); _; } /// @dev Restricts calls to Credit Configurator only modifier creditConfiguratorOnly() { if (msg.sender != creditConfigurator) revert CreditConfiguratorOnlyException(); _; } modifier whenNotPausedOrEmergency() { require(!paused() || emergencyLiquidation, "Pausable: paused"); _; } /// @dev Constructor /// @param _pool Address of the pool to borrow funds from constructor(address _pool) ACLTrait(address(IPoolService(_pool).addressProvider())) { IAddressProvider addressProvider = IPoolService(_pool) .addressProvider(); pool = _pool; // F:[CM-1] poolService = _pool; // F:[CM-1] address _underlying = IPoolService(pool).underlyingToken(); // F:[CM-1] underlying = _underlying; // F:[CM-1] // The underlying is the first token added as collateral _addToken(_underlying); // F:[CM-1] wethAddress = addressProvider.getWethToken(); // F:[CM-1] wethGateway = addressProvider.getWETHGateway(); // F:[CM-1] // Price oracle is stored in Slot1, as it is accessed frequently with fees slot1.priceOracle = IPriceOracleV2(addressProvider.getPriceOracle()); // F:[CM-1] _accountFactory = IAccountFactory(addressProvider.getAccountFactory()); // F:[CM-1] creditConfigurator = msg.sender; // F:[CM-1] } // // CREDIT ACCOUNT MANAGEMENT // /// @dev Opens credit account and borrows funds from the pool. /// - Takes Credit Account from the factory; /// - Requests the pool to lend underlying to the Credit Account /// /// @param borrowedAmount Amount to be borrowed by the Credit Account /// @param onBehalfOf The owner of the newly opened Credit Account function openCreditAccount(uint256 borrowedAmount, address onBehalfOf) external override whenNotPaused // F:[CM-5] nonReentrant creditFacadeOnly // F:[CM-2] returns (address) { // Takes a Credit Account from the factory and sets initial parameters // The Credit Account will be connected to this Credit Manager until closing address creditAccount = _accountFactory.takeCreditAccount( borrowedAmount, IPoolService(pool).calcLinearCumulative_RAY() ); // F:[CM-8] // Requests the pool to transfer tokens the Credit Account IPoolService(pool).lendCreditAccount(borrowedAmount, creditAccount); // F:[CM-8] // Checks that the onBehalfOf does not already have an account, and records it as owner _safeCreditAccountSet(onBehalfOf, creditAccount); // F:[CM-7] // Initializes the enabled token mask for Credit Account to 1 (only the underlying is enabled) enabledTokensMap[creditAccount] = 1; // F:[CM-8] // Returns the address of the opened Credit Account return creditAccount; // F:[CM-8] } /// @dev Closes a Credit Account - covers both normal closure and liquidation /// - Checks whether the contract is paused, and, if so, if the payer is an emergency liquidator. /// Only emergency liquidators are able to liquidate account while the CM is paused. /// Emergency liquidations do not pay a liquidator premium or liquidation fees. /// - Calculates payments to various recipients on closure: /// + Computes amountToPool, which is the amount to be sent back to the pool. /// This includes the principal, interest and fees, but can't be more than /// total position value /// + Computes remainingFunds during liquidations - these are leftover funds /// after paying the pool and the liquidator, and are sent to the borrower /// + Computes protocol profit, which includes interest and liquidation fees /// + Computes loss if the totalValue is less than borrow amount + interest /// - Checks the underlying token balance: /// + if it is larger than amountToPool, then the pool is paid fully from funds on the Credit Account /// + else tries to transfer the shortfall from the payer - either the borrower during closure, or liquidator during liquidation /// - Send assets to the "to" address, as long as they are not included into skipTokenMask /// - If convertWETH is true, the function converts WETH into ETH before sending /// - Returns the Credit Account back to factory /// /// @param borrower Borrower address /// @param closureActionType Whether the account is closed, liquidated or liquidated due to expiry /// @param totalValue Portfolio value for liqution, 0 for ordinary closure /// @param payer Address which would be charged if credit account has not enough funds to cover amountToPool /// @param to Address to which the leftover funds will be sent /// @param skipTokenMask Tokenmask contains 1 for tokens which needed to be skipped for sending /// @param convertWETH If true converts WETH to ETH function closeCreditAccount( address borrower, ClosureAction closureActionType, uint256 totalValue, address payer, address to, uint256 skipTokenMask, bool convertWETH ) external override nonReentrant creditFacadeOnly // F:[CM-2] returns (uint256 remainingFunds) { // If the contract is paused and the payer is the emergency liquidator, // changes closure action to LIQUIDATE_PAUSED, so that the premium is nullified // If the payer is not an emergency liquidator, reverts if (paused()) { if ( canLiquidateWhilePaused[payer] && (closureActionType == ClosureAction.LIQUIDATE_ACCOUNT || closureActionType == ClosureAction.LIQUIDATE_EXPIRED_ACCOUNT) ) { closureActionType = ClosureAction.LIQUIDATE_PAUSED; // F: [CM-12, 13] } else revert("Pausable: paused"); // F:[CM-5] } // Checks that the Credit Account exists for the borrower address creditAccount = getCreditAccountOrRevert(borrower); // F:[CM-6, 9, 10] // Sets borrower's Credit Account to zero address in the map // This needs to be done before other actions, to prevent inconsistent state // in the middle of closing transaction - e.g., _transferAssetsTo can be used to report a lower // value of a CA to third parties before the end of the function execution, since it // gives up control flow when some assets are already removed from the account delete creditAccounts[borrower]; // F:[CM-9] // Makes all computations needed to close credit account uint256 amountToPool; uint256 borrowedAmount; { uint256 profit; uint256 loss; uint256 borrowedAmountWithInterest; ( borrowedAmount, borrowedAmountWithInterest, ) = calcCreditAccountAccruedInterest(creditAccount); // F: (amountToPool, remainingFunds, profit, loss) = calcClosePayments( totalValue, closureActionType, borrowedAmount, borrowedAmountWithInterest ); // F:[CM-10,11,12] uint256 underlyingBalance = IERC20(underlying).balanceOf( creditAccount ); // If there is an underlying surplus, transfers it to the "to" address if (underlyingBalance > amountToPool + remainingFunds + 1) { unchecked { _safeTokenTransfer( creditAccount, underlying, to, underlyingBalance - amountToPool - remainingFunds - 1, convertWETH ); // F:[CM-10,12,16] } // If there is an underlying shortfall, attempts to transfer it from the payer } else { unchecked { IERC20(underlying).safeTransferFrom( payer, creditAccount, amountToPool + remainingFunds - underlyingBalance + 1 ); // F:[CM-11,13] } } // Transfers the due funds to the pool _safeTokenTransfer( creditAccount, underlying, pool, amountToPool, false ); // F:[CM-10,11,12,13] // Signals to the pool that debt has been repaid. The pool relies // on the Credit Manager to repay the debt correctly, and does not // check internally whether the underlying was actually transferred IPoolService(pool).repayCreditAccount(borrowedAmount, profit, loss); // F:[CM-10,11,12,13] } // transfer remaining funds to the borrower [liquidations only] if (remainingFunds > 1) { _safeTokenTransfer( creditAccount, underlying, borrower, remainingFunds, false ); // F:[CM-13,18] } // Tokens in skipTokenMask are disabled before transferring all assets uint256 enabledTokensMask = enabledTokensMap[creditAccount] & ~skipTokenMask; // F:[CM-14] _transferAssetsTo(creditAccount, to, convertWETH, enabledTokensMask); // F:[CM-14,17,19] // Returns Credit Account to the factory _accountFactory.returnCreditAccount(creditAccount); // F:[CM-9] } /// @dev Manages debt size for borrower: /// /// - Increase debt: /// + Increases debt by transferring funds from the pool to the credit account /// + Updates the cumulative index to keep interest the same. Since interest /// is always computed dynamically as borrowedAmount * (cumulativeIndexNew / cumulativeIndexOpen - 1), /// cumulativeIndexOpen needs to be updated, as the borrow amount has changed /// /// - Decrease debt: /// + Repays debt partially + all interest and fees accrued thus far /// + Updates cunulativeIndex to cumulativeIndex now /// /// @param creditAccount Address of the Credit Account to change debt for /// @param amount Amount to increase / decrease the principal by /// @param increase True to increase principal, false to decrease /// @return newBorrowedAmount The new debt principal function manageDebt( address creditAccount, uint256 amount, bool increase ) external whenNotPaused // F:[CM-5] nonReentrant creditFacadeOnly // F:[CM-2] returns (uint256 newBorrowedAmount) { ( uint256 borrowedAmount, uint256 cumulativeIndexAtOpen_RAY, uint256 cumulativeIndexNow_RAY ) = _getCreditAccountParameters(creditAccount); uint256 newCumulativeIndex; if (increase) { newBorrowedAmount = borrowedAmount + amount; // Computes the new cumulative index to keep the interest // unchanged with different principal newCumulativeIndex = _calcNewCumulativeIndex( borrowedAmount, amount, cumulativeIndexNow_RAY, cumulativeIndexAtOpen_RAY, true ); // Requests the pool to lend additional funds to the Credit Account IPoolService(pool).lendCreditAccount(amount, creditAccount); // F:[CM-20] } else { // Computes the interest accrued thus far uint256 interestAccrued = (borrowedAmount * cumulativeIndexNow_RAY) / cumulativeIndexAtOpen_RAY - borrowedAmount; // F:[CM-21] // Computes profit, taken as a percentage of the interest rate uint256 profit = (interestAccrued * slot1.feeInterest) / PERCENTAGE_FACTOR; // F:[CM-21] if (amount >= interestAccrued + profit) { // If the amount covers all of the interest and fees, they are // paid first, and the remainder is used to pay the principal newBorrowedAmount = borrowedAmount + interestAccrued + profit - amount; // Pays the amount back to the pool ICreditAccount(creditAccount).safeTransfer( underlying, pool, amount ); // F:[CM-21] // Signals the pool that the debt was partially repaid IPoolService(pool).repayCreditAccount( amount - interestAccrued - profit, profit, 0 ); // F:[CM-21] // Since interest is fully repaid, the Credit Account's cumulativeIndexAtOpen // is set to the current cumulative index - which means interest starts accruing // on the new principal from zero newCumulativeIndex = IPoolService(pool) .calcLinearCumulative_RAY(); // F:[CM-21] } else { // If the amount is not enough to cover interest and fees, // it is split between the two pro-rata. Since the fee is the percentage // of interest, this ensures that the new fee is consistent with the // new pending interest uint256 amountToInterest = (amount * PERCENTAGE_FACTOR) / (PERCENTAGE_FACTOR + slot1.feeInterest); uint256 amountToFees = amount - amountToInterest; // Since interest and fees are paid out first, the principal // remains unchanged newBorrowedAmount = borrowedAmount; // Pays the amount back to the pool ICreditAccount(creditAccount).safeTransfer( underlying, pool, amount ); // F:[CM-21] // Signals the pool that the debt was partially repaid IPoolService(pool).repayCreditAccount(0, amountToFees, 0); // F:[CM-21] // Since the interest was only repaid partially, we need to recompute the // cumulativeIndexAtOpen, so that "borrowAmount * (indexNow / indexAtOpenNew - 1)" // is equal to interestAccrued - amountToInterest newCumulativeIndex = _calcNewCumulativeIndex( borrowedAmount, amountToInterest, cumulativeIndexNow_RAY, cumulativeIndexAtOpen_RAY, false ); } } // // Sets new parameters on the Credit Account ICreditAccount(creditAccount).updateParameters( newBorrowedAmount, newCumulativeIndex ); // F:[CM-20. 21] } /// @dev Calculates the new cumulative index when debt is updated /// @param borrowedAmount Current debt principal /// @param delta Absolute value of total debt amount change /// @param cumulativeIndexNow Current cumulative index of the pool /// @param cumulativeIndexOpen Last updated cumulative index recorded for the corresponding debt position /// @param isIncrease Whether the debt is increased or decreased /// @notice Handles two potential cases: /// * Debt principal is increased by delta - in this case, the principal is changed /// but the interest / fees have to stay the same /// * Interest is decreased by delta - in this case, the principal stays the same, /// but the interest changes. The delta is assumed to have fee repayment excluded. /// The debt decrease case where delta > interest + fees is trivial and should be handled outside /// this function. function _calcNewCumulativeIndex( uint256 borrowedAmount, uint256 delta, uint256 cumulativeIndexNow, uint256 cumulativeIndexOpen, bool isIncrease ) internal pure returns (uint256 newCumulativeIndex) { if (isIncrease) { // In case of debt increase, the principal increases by exactly delta, but interest has to be kept unchanged // newCumulativeIndex is proven to be the solution to // borrowedAmount * (cumulativeIndexNow / cumulativeIndexOpen - 1) == // == (borrowedAmount + delta) * (cumulativeIndexNow / newCumulativeIndex - 1) uint256 newBorrowedAmount = borrowedAmount + delta; newCumulativeIndex = ((cumulativeIndexNow * newBorrowedAmount * INDEX_PRECISION) / ((INDEX_PRECISION * cumulativeIndexNow * borrowedAmount) / cumulativeIndexOpen + INDEX_PRECISION * delta)); } else { // In case of debt decrease, the principal is the same, but the interest is reduced exactly by delta // newCumulativeIndex is proven to be the solution to // borrowedAmount * (cumulativeIndexNow / cumulativeIndexOpen - 1) - delta == // == borrowedAmount * (cumulativeIndexNow / newCumulativeIndex - 1) newCumulativeIndex = (INDEX_PRECISION * cumulativeIndexNow * cumulativeIndexOpen) / (INDEX_PRECISION * cumulativeIndexNow - (INDEX_PRECISION * delta * cumulativeIndexOpen) / borrowedAmount); } } /// @dev Adds collateral to borrower's credit account /// @param payer Address of the account which will be charged to provide additional collateral /// @param creditAccount Address of the Credit Account /// @param token Collateral token to add /// @param amount Amount to add function addCollateral( address payer, address creditAccount, address token, uint256 amount ) external whenNotPaused // F:[CM-5] nonReentrant creditFacadeOnly // F:[CM-2] { // Checks that the token is not forbidden // And enables it so that it is counted in collateral _checkAndEnableToken(creditAccount, token); // F:[CM-22] IERC20(token).safeTransferFrom(payer, creditAccount, amount); // F:[CM-22] } /// @dev Transfers Credit Account ownership to another address /// @param from Address of previous owner /// @param to Address of new owner function transferAccountOwnership(address from, address to) external override whenNotPausedOrEmergency // F:[CM-5] nonReentrant creditFacadeOnly // F:[CM-2] { address creditAccount = getCreditAccountOrRevert(from); // F:[CM-6] delete creditAccounts[from]; // F:[CM-24] _safeCreditAccountSet(to, creditAccount); // F:[CM-23, 24] } /// @dev Requests the Credit Account to approve a collateral token to another contract. /// @param borrower Borrower's address /// @param targetContract Spender to change allowance for /// @param token Collateral token to approve /// @param amount New allowance amount function approveCreditAccount( address borrower, address targetContract, address token, uint256 amount ) external override whenNotPausedOrEmergency // F:[CM-5] nonReentrant { // This function can only be called by connected adapters (must be a correct adapter/contract pair), // Credit Facade or Universal Adapter if ( (adapterToContract[msg.sender] != targetContract && msg.sender != creditFacade && msg.sender != universalAdapter) || targetContract == address(0) ) { revert AdaptersOrCreditFacadeOnlyException(); // F:[CM-3,25] } // Checks that the token is a collateral token // Forbidden tokens can be approved, since users need that to // sell them off if (tokenMasksMap(token) == 0) revert TokenNotAllowedException(); // F: address creditAccount = getCreditAccountOrRevert(borrower); // F:[CM-6] // Attempts to set allowance directly to the required amount // If unsuccessful, assumes that the token requires setting allowance to zero first if (!_approve(token, targetContract, creditAccount, amount, false)) { _approve(token, targetContract, creditAccount, 0, true); // F: _approve(token, targetContract, creditAccount, amount, true); } } /// @dev Internal function used to approve token from a Credit Account /// Uses Credit Account's execute to properly handle both ERC20-compliant and /// non-compliant (no returned value from "approve") tokens function _approve( address token, address targetContract, address creditAccount, uint256 amount, bool revertIfFailed ) internal returns (bool) { // Makes a low-level call to approve from the Credit Account // and parses the value. If nothing or true was returned, // assumes that the call succeeded try ICreditAccount(creditAccount).execute( token, abi.encodeWithSelector( IERC20.approve.selector, targetContract, amount ) ) returns (bytes memory result) { if (result.length == 0 || abi.decode(result, (bool)) == true) return true; } catch {} // On the first try, failure is allowed to handle tokens // that prohibit changing allowance from non-zero value; // After that, failure results in a revert if (revertIfFailed) revert AllowanceFailedException(); return false; } /// @dev Requests a Credit Account to make a low-level call with provided data /// This is the intended pathway for state-changing interactions with 3rd-party protocols /// @param borrower Borrower's address /// @param targetContract Contract to be called /// @param data Data to pass with the call function executeOrder( address borrower, address targetContract, bytes memory data ) external override whenNotPausedOrEmergency // F:[CM-5] nonReentrant returns (bytes memory) { // Checks that msg.sender is the adapter associated with the passed // target contract. The exception is the Universal Adapter, which // can potentially call any target. if ( adapterToContract[msg.sender] != targetContract || targetContract == address(0) ) { if (msg.sender != universalAdapter) revert TargetContractNotAllowedException(); // F:[CM-28] } address creditAccount = getCreditAccountOrRevert(borrower); // F:[CM-6] // Emits an event emit ExecuteOrder(borrower, targetContract); // F:[CM-29] // Returned data is provided as-is to the caller; // It is expected that is is parsed and returned as a correct type // by the adapter itself. return ICreditAccount(creditAccount).execute(targetContract, data); // F:[CM-29] } // // COLLATERAL VALIDITY AND ACCOUNT HEALTH CHECKS // /// @dev Enables a token on a Credit Account, including it /// into account health and total value calculations /// @param creditAccount Address of a Credit Account to enable the token for /// @param token Address of the token to be enabled function checkAndEnableToken(address creditAccount, address token) external override whenNotPausedOrEmergency adaptersOrCreditFacadeOnly // F:[CM-3] nonReentrant { _checkAndEnableToken(creditAccount, token); // F:[CM-30] } /// @dev IMPLEMENTATION: checkAndEnableToken /// @param creditAccount Address of a Credit Account to enable the token for /// @param token Address of the token to be enabled function _checkAndEnableToken(address creditAccount, address token) internal { uint256 tokenMask = tokenMasksMap(token); // F:[CM-30,31] // Checks that the token is valid collateral recognized by the system // and that it is not forbidden if (tokenMask == 0 || forbiddenTokenMask & tokenMask != 0) revert TokenNotAllowedException(); // F:[CM-30] // Performs an inclusion check using token masks, // to avoid accidentally disabling the token if (enabledTokensMap[creditAccount] & tokenMask == 0) enabledTokensMap[creditAccount] |= tokenMask; // F:[CM-31] } /// @dev Optimized health check for individual swap-like operations. /// @notice Fast health check assumes that only two tokens (input and output) /// participate in the operation and computes a % change in weighted value between /// inbound and outbound collateral. The cumulative negative change across several /// swaps in sequence cannot be larger than feeLiquidation (a fee that the /// protocol is ready to waive if needed). Since this records a % change /// between just two tokens, the corresponding % change in TWV will always be smaller, /// which makes this check safe. /// More details at https://dev.gearbox.fi/docs/documentation/risk/fast-collateral-check#fast-check-protection /// @param creditAccount Address of the Credit Account /// @param tokenIn Address of the token spent by the swap /// @param tokenOut Address of the token received from the swap /// @param balanceInBefore Balance of tokenIn before the operation /// @param balanceOutBefore Balance of tokenOut before the operation function fastCollateralCheck( address creditAccount, address tokenIn, address tokenOut, uint256 balanceInBefore, uint256 balanceOutBefore ) external override adaptersOrCreditFacadeOnly // F:[CM-3] nonReentrant { // Checks that inbound collateral is known and not forbidden // Enables it if disabled, to include it into TWV _checkAndEnableToken(creditAccount, tokenOut); // [CM-32] uint256 balanceInAfter = IERC20(tokenIn).balanceOf(creditAccount); // F: [CM-34] uint256 balanceOutAfter = IERC20(tokenOut).balanceOf(creditAccount); // F: [CM-34] (uint256 amountInCollateral, uint256 amountOutCollateral) = slot1 .priceOracle .fastCheck( balanceInBefore - balanceInAfter, tokenIn, balanceOutAfter - balanceOutBefore, tokenOut ); // F:[CM-34] // Disables tokenIn if the entire balance was spent by the operation if (balanceInAfter <= 1) _disableToken(creditAccount, tokenIn); // F:[CM-33] // Collateral values must be compared weighted by respective LTs, // as otherwise a high-LT (e.g., underlying) token can be swapped // to an equivalent amount of a low-LT asset. Without weighting, this would // pass the check (since inbound and outbound values are equal), // while the health factor of the account would be reduced severely. amountOutCollateral *= liquidationThresholds(tokenOut); // F:[CM-34] amountInCollateral *= liquidationThresholds(tokenIn); // F:[CM-34] // If the value of inbound collateral is larger than inbound collateral // a health check does not need to be performed; // However, the number of enabled tokens needs to be checked against the limit, // as a new collateral token was potentially enabled if (amountOutCollateral >= amountInCollateral) { _checkAndOptimizeEnabledTokens(creditAccount); // F:[CM-35] return; // F:[CM-34] } // The new cumulative drop in value is computed in RAY format, for precision uint256 cumulativeDropRAY = RAY - ((amountOutCollateral * RAY) / amountInCollateral) + cumulativeDropAtFastCheckRAY[creditAccount]; // F:[CM-36] // If then new cumulative drop is less than feeLiquidation, the check is successful, // otherwise, a full collateral check is required if ( cumulativeDropRAY <= (slot1.feeLiquidation * RAY) / PERCENTAGE_FACTOR ) { cumulativeDropAtFastCheckRAY[creditAccount] = cumulativeDropRAY; // F:[CM-36] _checkAndOptimizeEnabledTokens(creditAccount); // F:[CM-37] return; } // If a fast collateral check didn't pass, a full check is performed and // the cumulative drop is reset back to 0 (1 for gas-efficiency). _fullCollateralCheck(creditAccount); // F:[CM-34,36] cumulativeDropAtFastCheckRAY[creditAccount] = 1; // F:[CM-36] } /// @dev Performs a full health check on an account, summing up /// value of all enabled collateral tokens /// @param creditAccount Address of the Credit Account to check function fullCollateralCheck(address creditAccount) external override adaptersOrCreditFacadeOnly // F:[CM-3] nonReentrant { _fullCollateralCheck(creditAccount); } /// @dev IMPLEMENTATION: fullCollateralCheck /// @param creditAccount Address of the Credit Account to check function _fullCollateralCheck(address creditAccount) internal { IPriceOracleV2 _priceOracle = slot1.priceOracle; uint256 enabledTokenMask = enabledTokensMap[creditAccount]; uint256 borrowAmountPlusInterestRateUSD; uint256 len; unchecked { // The total weighted value of a Credit Account has to be compared // with the entire debt sum, including interest and fees ( , , uint256 borrowedAmountWithInterestAndFees ) = calcCreditAccountAccruedInterest(creditAccount); borrowAmountPlusInterestRateUSD = _priceOracle.convertToUSD( borrowedAmountWithInterestAndFees * PERCENTAGE_FACTOR, underlying ); len = _getMaxIndex(enabledTokenMask) + 1; } uint256 tokenMask; uint256 twvUSD; bool atLeastOneTokenWasDisabled; for (uint256 i; i < len; ) { // The order of evaluation is adjusted to optimize for // farming, as it is the largest expected use case // Since farming positions are at the end of the collateral token list // the loop moves through token masks in descending order (except underlying, which is // checked first) unchecked { tokenMask = i == 0 ? 1 : 1 << (len - i); } // CASE enabledTokenMask & tokenMask == 0 F:[CM-38] if (enabledTokenMask & tokenMask != 0) { ( address token, uint16 liquidationThreshold ) = collateralTokensByMask(tokenMask); uint256 balance = IERC20(token).balanceOf(creditAccount); // Collateral calculations are only done if there is a non-zero balance if (balance > 1) { twvUSD += _priceOracle.convertToUSD(balance, token) * liquidationThreshold; // Full collateral check evaluates a Credit Account's health factor lazily; // Once the TWV computed thus far exceeds the debt, the check is considered // successful, and the function returns without evaluating any further collateral if (twvUSD >= borrowAmountPlusInterestRateUSD) { // Since a full collateral check is usually called after an operation or MultiCall // involving many tokens, potentially many new tokens can be enabled. As such, // the function needs to check whether the enabled token limit is violated, // and disable any unused tokens, if so. Note that the number of enabled tokens // is calculated from the updated enabledTokenMask, so some of the unused tokens may have already // been disabled uint256 totalTokensEnabled = _calcEnabledTokens( enabledTokenMask ); if (totalTokensEnabled > maxAllowedEnabledTokenLength) { unchecked { _optimizeEnabledTokens( creditAccount, enabledTokenMask, totalTokensEnabled, // At this stage in the function, at least underlying // must have been processed, so it can be skipped 1, // Since the function disables all unused tokens it finds // and iterates in descending order, // _optimizeEnabledTokens only needs to check up to len - i len - i ); // F:[CM-41] where i=0 } } else { // Saves enabledTokensMask if at least one token was disabled if (atLeastOneTokenWasDisabled) { enabledTokensMap[ creditAccount ] = enabledTokenMask; // F:[CM-39] } } return; // F:[CM-40] } // Zero-balance tokens are disabled; this is done by flipping the // bit in enabledTokenMask, which is then written into storage at the // very end, to avoid redundant storage writes } else { enabledTokenMask ^= tokenMask; // F:[CM-39] atLeastOneTokenWasDisabled = true; // F:[CM-39] } } unchecked { ++i; } } revert NotEnoughCollateralException(); } /// @dev Checks that the number of enabled tokens on a Credit Account /// does not violate the maximal enabled token limit and tries /// to disable unused tokens if it does /// @param creditAccount Account to check enabled tokens for function checkAndOptimizeEnabledTokens(address creditAccount) external override adaptersOrCreditFacadeOnly // F: [CM-2] { _checkAndOptimizeEnabledTokens(creditAccount); } /// @dev IMPLEMENTATION: checkAndOptimizeEnabledTokens function _checkAndOptimizeEnabledTokens(address creditAccount) internal { uint256 enabledTokenMask = enabledTokensMap[creditAccount]; uint256 totalTokensEnabled = _calcEnabledTokens(enabledTokenMask); if (totalTokensEnabled > maxAllowedEnabledTokenLength) { uint256 maxIndex = _getMaxIndex(enabledTokenMask) + 1; _optimizeEnabledTokens( creditAccount, enabledTokenMask, totalTokensEnabled, 0, maxIndex ); } } /// @dev Calculates the number of enabled tokens, based on the /// provided token mask /// @param enabledTokenMask Bit mask encoding a set of enabled tokens function _calcEnabledTokens(uint256 enabledTokenMask) internal pure returns (uint256 totalTokensEnabled) { // Bit mask is a number encoding enabled tokens as 1's; // Therefore, to count the number of enabled tokens, we simply // need to keep shifting the mask by one bit and checking if the rightmost bit is 1, // until the whole mask is 0; // Since bit shifting is overflow-safe and the loop has at most 256 steps, // the whole function can be marked as unsafe to optimize gas unchecked { while (enabledTokenMask > 0) { totalTokensEnabled += enabledTokenMask & 1; enabledTokenMask = enabledTokenMask >> 1; } } } /// @dev Searches for tokens with zero balance among enabled tokens /// on a Credit Account and disables them, until the total number /// of enabled tokens is at maxAllowedEnabledTokenLength /// @param creditAccount The Credit Account to optimize /// @param enabledTokenMask Mask encoding the set of currentl enabled tokens /// @param totalTokensEnabled The current number of enabled tokens /// @param minIndex Inclusive lower bound of search range /// @param maxIndex Non-inclusive upper bound of search range function _optimizeEnabledTokens( address creditAccount, uint256 enabledTokenMask, uint256 totalTokensEnabled, uint256 minIndex, uint256 maxIndex ) internal { // The whole block can be marked unchecked, since: // - maxIndex < 256 at all times (i.e., tokenMask < 2 ** 256); // - totalTokensEnabled does not go lower than maxAllowedEnabledTokenLength // (the function returns at that point) unchecked { for (uint256 i = minIndex; i < maxIndex; ) { uint256 tokenMask = 1 << i; if (enabledTokenMask & tokenMask != 0) { (address token, ) = collateralTokensByMask(tokenMask); uint256 balance = IERC20(token).balanceOf(creditAccount); if (balance <= 1) { enabledTokenMask ^= tokenMask; --totalTokensEnabled; if ( totalTokensEnabled <= maxAllowedEnabledTokenLength ) { enabledTokensMap[creditAccount] = enabledTokenMask; return; } } } ++i; } } revert TooManyEnabledTokensException(); } /// @dev Disables a token on a credit account /// @notice Usually called by adapters to disable spent tokens during a multicall, /// but can also be called separately from the Credit Facade to remove /// unwanted tokens function disableToken(address creditAccount, address token) external override whenNotPausedOrEmergency // F:[CM-5] adaptersOrCreditFacadeOnly // F:[CM-3] nonReentrant returns (bool) { return _disableToken(creditAccount, token); } /// @dev IMPLEMENTATION: disableToken function _disableToken(address creditAccount, address token) internal returns (bool wasChanged) { // The enabled token mask encodes all enabled tokens as 1, // therefore the corresponding bit is set to 0 to disable it uint256 tokenMask = tokenMasksMap(token); if (enabledTokensMap[creditAccount] & tokenMask != 0) { enabledTokensMap[creditAccount] &= ~tokenMask; // F:[CM-46] wasChanged = true; } } /// @dev Checks if the contract is paused; if true, checks that the caller is emergency liquidator /// and temporarily enables a special emergencyLiquidator mode to allow liquidation. /// @notice Some whenNotPausedOrEmergency functions in CreditManager need to be executable to perform /// multicalls during liquidations. emergencyLiquidation mode is enabled temporarily /// (for the span of a single multicall) to override /// the paused state and allow a special privileged role to liquidate unhealthy positions, if the /// contracts are paused due to an emergency. /// @notice To save gas, emergency liquidation setting is skipped when the CM is not paused. /// /// /// @param caller Address of CreditFacade caller /// @param state True to enable and false to disable emergencyLiqudation mde /// @return True if contract paused otherwise false. If the contract is not paused, there is no need /// to call this function to disable the emergencyLiquidation mode. function checkEmergencyPausable(address caller, bool state) external creditFacadeOnly // F:[CM-2] returns (bool) { bool pausable = paused(); // F: [CM-67] if (pausable && canLiquidateWhilePaused[caller]) { emergencyLiquidation = state; // F: [CM-67] } return pausable; // F: [CM-67] } // // INTERNAL HELPERS // /// @dev Transfers all enabled assets from a Credit Account to the "to" address /// @param creditAccount Credit Account to transfer assets from /// @param to Recipient address /// @param convertWETH Whether WETH must be converted to ETH before sending /// @param enabledTokensMask A bit mask encoding enabled tokens. All of the tokens included /// in the mask will be transferred. If any tokens need to be skipped, they must be /// excluded from the mask beforehand. function _transferAssetsTo( address creditAccount, address to, bool convertWETH, uint256 enabledTokensMask ) internal { // Since underlying should have been transferred to "to" before this function is called // (if there is a surplus), its tokenMask of 1 is skipped uint256 tokenMask = 2; // Since enabledTokensMask encodes all enabled tokens as 1, // tokenMask > enabledTokensMask is equivalent to the last 1 bit being passed // The loop can be ended at this point while (tokenMask <= enabledTokensMask) { // enabledTokensMask & tokenMask == tokenMask when the token is enabled, // and 0 otherwise if (enabledTokensMask & tokenMask != 0) { (address token, ) = collateralTokensByMask(tokenMask); // F:[CM-44] uint256 amount = IERC20(token).balanceOf(creditAccount); // F:[CM-44] if (amount > 1) { // 1 is subtracted from amount to leave a non-zero value // in the balance mapping, optimizing future writes // Since the amount is checked to be more than 1, // the block can be marked as unchecked // F:[CM-44] unchecked { _safeTokenTransfer( creditAccount, token, to, amount - 1, convertWETH ); // F:[CM-44] } } } // The loop iterates by moving 1 bit to the left, // which corresponds to moving on to the next token tokenMask = tokenMask << 1; // F:[CM-44] } } /// @dev Requests the Credit Account to transfer a token to another address /// Able to unwrap WETH before sending, if requested /// @param creditAccount Address of the sender Credit Account /// @param token Address of the token /// @param to Recipient address /// @param amount Amount to transfer function _safeTokenTransfer( address creditAccount, address token, address to, uint256 amount, bool convertToETH ) internal { if (convertToETH && token == wethAddress) { ICreditAccount(creditAccount).safeTransfer( token, wethGateway, amount ); // F:[CM-45] IWETHGateway(wethGateway).unwrapWETH(to, amount); // F:[CM-45] } else { ICreditAccount(creditAccount).safeTransfer(token, to, amount); // F:[CM-45] } } /// @dev Sets the Credit Account owner while checking that they do not /// have an account already /// @param borrower The new owner of the Credit Account /// @param creditAccount The Credit Account address function _safeCreditAccountSet(address borrower, address creditAccount) internal { if (borrower == address(0) || creditAccounts[borrower] != address(0)) revert ZeroAddressOrUserAlreadyHasAccountException(); // F:[CM-7] creditAccounts[borrower] = creditAccount; // F:[CM-7] } // // GETTERS // /// @dev Computes amounts that must be sent to various addresses before closing an account /// @param totalValue Credit Accounts total value in underlying /// @param closureActionType Type of account closure /// * CLOSE_ACCOUNT: The account is healthy and is closed normally /// * LIQUIDATE_ACCOUNT: The account is unhealthy and is being liquidated to avoid bad debt /// * LIQUIDATE_EXPIRED_ACCOUNT: The account has expired and is being liquidated (lowered liquidation premium) /// * LIQUIDATE_PAUSED: The account is liquidated while the system is paused due to emergency (no liquidation premium) /// @param borrowedAmount Credit Account's debt principal /// @param borrowedAmountWithInterest Credit Account's debt principal + interest /// @return amountToPool Amount of underlying to be sent to the pool /// @return remainingFunds Amount of underlying to be sent to the borrower (only applicable to liquidations) /// @return profit Protocol's profit from fees (if any) /// @return loss Protocol's loss from bad debt (if any) function calcClosePayments( uint256 totalValue, ClosureAction closureActionType, uint256 borrowedAmount, uint256 borrowedAmountWithInterest ) public view override returns ( uint256 amountToPool, uint256 remainingFunds, uint256 profit, uint256 loss ) { // The amount to be paid to pool is computed with fees included // The pool will compute the amount of Diesel tokens to treasury // based on profit amountToPool = borrowedAmountWithInterest + ((borrowedAmountWithInterest - borrowedAmount) * slot1.feeInterest) / PERCENTAGE_FACTOR; // F:[CM-43] if ( closureActionType == ClosureAction.LIQUIDATE_ACCOUNT || closureActionType == ClosureAction.LIQUIDATE_EXPIRED_ACCOUNT || closureActionType == ClosureAction.LIQUIDATE_PAUSED ) { // LIQUIDATION CASE uint256 totalFunds; // During liquidation, totalValue of the account is discounted // by (1 - liquidationPremium). This means that totalValue * liquidationPremium // is removed from all calculations and can be claimed by the liquidator at the end of transaction // The liquidation premium depends on liquidation type: // * For normal unhealthy account liquidations, usual premium applies // * For expiry liquidations, the premium is typically reduced, // since the account does not risk bad debt, so the liquidation // is not as urgent // * For emergency (paused) liquidations, there is not premium. // This is done in order to preserve fairness, as emergency liquidator // is a priviledged role. Any compensation to the emergency liquidator must // be coordinated with the DAO out of band. if (closureActionType == ClosureAction.LIQUIDATE_ACCOUNT) { // UNHEALTHY ACCOUNT CASE totalFunds = (totalValue * slot1.liquidationDiscount) / PERCENTAGE_FACTOR; // F:[CM-43] amountToPool += (totalValue * slot1.feeLiquidation) / PERCENTAGE_FACTOR; // F:[CM-43] } else if ( closureActionType == ClosureAction.LIQUIDATE_EXPIRED_ACCOUNT ) { // EXPIRED ACCOUNT CASE totalFunds = (totalValue * slot1.liquidationDiscountExpired) / PERCENTAGE_FACTOR; // F:[CM-43] amountToPool += (totalValue * slot1.feeLiquidationExpired) / PERCENTAGE_FACTOR; // F:[CM-43] } else { // PAUSED CASE totalFunds = totalValue; // F: [CM-43] amountToPool += (totalValue * slot1.feeLiquidation) / PERCENTAGE_FACTOR; // F:[CM-43] } // If there are any funds left after all respective payments (this // includes the liquidation premium, since totalFunds is already // discounted from totalValue), they are recorded to remainingFunds // and will later be sent to the borrower. // If totalFunds is not sufficient to cover the entire payment to pool, // the Credit Manager will repay what it can. When totalFunds >= debt + interest, // this simply means that part of protocol fees will be waived (profit is reduced). Otherwise, // there is bad debt (loss > 0). // Since values are compared to each other before subtracting, // this can be marked as unchecked to optimize gas unchecked { if (totalFunds > amountToPool) { remainingFunds = totalFunds - amountToPool - 1; // F:[CM-43] } else { amountToPool = totalFunds; // F:[CM-43] } if (totalFunds >= borrowedAmountWithInterest) { profit = amountToPool - borrowedAmountWithInterest; // F:[CM-43] } else { loss = borrowedAmountWithInterest - amountToPool; // F:[CM-43] } } } else { // CLOSURE CASE // During closure, it is assumed that the user has enough to cover // the principal + interest + fees. closeCreditAccount, thus, will // attempt to charge them the entire amount. // Since in this case amountToPool + borrowedAmountWithInterest + fee, // this block can be marked as unchecked unchecked { profit = amountToPool - borrowedAmountWithInterest; // F:[CM-43] } } } /// @dev Returns the collateral token at requested index and its liquidation threshold /// @param id The index of token to return function collateralTokens(uint256 id) public view returns (address token, uint16 liquidationThreshold) { // Collateral tokens are stored under their masks rather than // indicies, so this is simply a convenience function that wraps // the getter by mask return collateralTokensByMask(1 << id); } /// @dev Returns the collateral token with requested mask and its liquidationThreshold /// @param tokenMask Token mask corresponding to the token function collateralTokensByMask(uint256 tokenMask) public view override returns (address token, uint16 liquidationThreshold) { // The underlying is a special case and its mask is always 1 if (tokenMask == 1) { token = underlying; // F:[CM-47] liquidationThreshold = slot1.ltUnderlying; } else { // The address and LT of a collateral token are compressed into a single uint256 // The first 160 bits of the number is the address, and any bits after that are interpreted as LT uint256 collateralTokenCompressed = collateralTokensCompressed[ tokenMask ]; // F:[CM-47] // Unsafe downcasting is justified, since the right 160 bits of collateralTokenCompressed // always stores the uint160 encoded address and the extra bits need to be cut token = address(uint160(collateralTokenCompressed)); // F:[CM-47] liquidationThreshold = (collateralTokenCompressed >> ADDR_BIT_SIZE) .toUint16(); // F:[CM-47] } } /// @dev Returns the address of a borrower's Credit Account, or reverts if there is none. /// @param borrower Borrower's address function getCreditAccountOrRevert(address borrower) public view override returns (address result) { result = creditAccounts[borrower]; // F:[CM-48] if (result == address(0)) revert HasNoOpenedAccountException(); // F:[CM-48] } /// @dev Calculates the debt accrued by a Credit Account /// @param creditAccount Address of the Credit Account /// @return borrowedAmount The debt principal /// @return borrowedAmountWithInterest The debt principal + accrued interest /// @return borrowedAmountWithInterestAndFees The debt principal + accrued interest and protocol fees function calcCreditAccountAccruedInterest(address creditAccount) public view override returns ( uint256 borrowedAmount, uint256 borrowedAmountWithInterest, uint256 borrowedAmountWithInterestAndFees ) { uint256 cumulativeIndexAtOpen_RAY; uint256 cumulativeIndexNow_RAY; ( borrowedAmount, cumulativeIndexAtOpen_RAY, cumulativeIndexNow_RAY ) = _getCreditAccountParameters(creditAccount); // F:[CM-49] // Interest is never stored and is always computed dynamically // as the difference between the current cumulative index of the pool // and the cumulative index recorded in the Credit Account borrowedAmountWithInterest = (borrowedAmount * cumulativeIndexNow_RAY) / cumulativeIndexAtOpen_RAY; // F:[CM-49] // Fees are computed as a percentage of interest borrowedAmountWithInterestAndFees = borrowedAmountWithInterest + ((borrowedAmountWithInterest - borrowedAmount) * slot1.feeInterest) / PERCENTAGE_FACTOR; // F: [CM-49] } /// @dev Returns the parameters of the Credit Account required to calculate debt /// @param creditAccount Address of the Credit Account /// @return borrowedAmount Debt principal amount /// @return cumulativeIndexAtOpen_RAY The cumulative index value used to calculate /// interest in conjunction with current pool index. Not necessarily the index /// value at the time of account opening, since it can be updated by manageDebt. /// @return cumulativeIndexNow_RAY Current cumulative index of the pool function _getCreditAccountParameters(address creditAccount) internal view returns ( uint256 borrowedAmount, uint256 cumulativeIndexAtOpen_RAY, uint256 cumulativeIndexNow_RAY ) { borrowedAmount = ICreditAccount(creditAccount).borrowedAmount(); // F:[CM-49,50] cumulativeIndexAtOpen_RAY = ICreditAccount(creditAccount) .cumulativeIndexAtOpen(); // F:[CM-49,50] cumulativeIndexNow_RAY = IPoolService(pool).calcLinearCumulative_RAY(); // F:[CM-49,50] } /// @dev Returns the liquidation threshold for the provided token /// @param token Token to retrieve the LT for function liquidationThresholds(address token) public view override returns (uint16 lt) { // Underlying is a special case and its LT is stored separately if (token == underlying) return slot1.ltUnderlying; // F:[CM-47] uint256 tokenMask = tokenMasksMap(token); if (tokenMask == 0) revert TokenNotAllowedException(); (, lt) = collateralTokensByMask(tokenMask); // F:[CM-47] } /// @dev Returns the mask for the provided token /// @param token Token to returns the mask for function tokenMasksMap(address token) public view override returns (uint256 mask) { mask = (token == underlying) ? 1 : tokenMasksMapInternal[token]; } /// @dev Returns the largest token index out of enabled tokens, based on a mask /// @param mask Bit mask encoding enabled tokens /// @return index Largest index out of the set of enabled tokens function _getMaxIndex(uint256 mask) internal pure returns (uint256 index) { if (mask == 1) return 0; // Performs a binary search within the range of all token indices // If right-shifting a mask by n turns it into 1, then n is the largest index uint256 high = 256; uint256 low = 1; while (true) { index = (high + low) >> 1; uint256 testMask = 1 << index; if (testMask & mask != 0 && (mask >> index == 1)) break; if (testMask >= mask) { high = index; } else { low = index; } } } /// @dev Returns the fee parameters of the Credit Manager /// @return feeInterest Percentage of interest taken by the protocol as profit /// @return feeLiquidation Percentage of account value taken by the protocol as profit /// during unhealthy account liquidations /// @return liquidationDiscount Multiplier that reduces the effective totalValue during unhealthy account liquidations, /// allowing the liquidator to take the unaccounted for remainder as premium. Equal to (1 - liquidationPremium) /// @return feeLiquidationExpired Percentage of account value taken by the protocol as profit /// during expired account liquidations /// @return liquidationDiscountExpired Multiplier that reduces the effective totalValue during expired account liquidations, /// allowing the liquidator to take the unaccounted for remainder as premium. Equal to (1 - liquidationPremiumExpired) function fees() external view override returns ( uint16 feeInterest, uint16 feeLiquidation, uint16 liquidationDiscount, uint16 feeLiquidationExpired, uint16 liquidationDiscountExpired ) { feeInterest = slot1.feeInterest; // F:[CM-51] feeLiquidation = slot1.feeLiquidation; // F:[CM-51] liquidationDiscount = slot1.liquidationDiscount; // F:[CM-51] feeLiquidationExpired = slot1.feeLiquidationExpired; // F:[CM-51] liquidationDiscountExpired = slot1.liquidationDiscountExpired; // F:[CM-51] } /// @dev Returns the price oracle used to evaluate collateral tokens function priceOracle() external view override returns (IPriceOracleV2) { return slot1.priceOracle; } // // CONFIGURATION // // The following function change vital Credit Manager parameters // and can only be called by the Credit Configurator // /// @dev Adds a token to the list of collateral tokens /// @param token Address of the token to add function addToken(address token) external creditConfiguratorOnly // F:[CM-4] { _addToken(token); // F:[CM-52] } /// @dev IMPLEMENTATION: addToken /// @param token Address of the token to add function _addToken(address token) internal { // Checks that the token is not already known (has an associated token mask) if (tokenMasksMapInternal[token] > 0) revert TokenAlreadyAddedException(); // F:[CM-52] // Checks that there aren't too many tokens // Since token masks are 256 bit numbers with each bit corresponding to 1 token, // only at most 256 are supported if (collateralTokensCount >= 256) revert TooManyTokensException(); // F:[CM-52] // The tokenMask of a token is a bit mask with 1 at position corresponding to its index // (i.e. 2 ** index or 1 << index) uint256 tokenMask = 1 << collateralTokensCount; tokenMasksMapInternal[token] = tokenMask; // F:[CM-53] collateralTokensCompressed[tokenMask] = uint256(uint160(token)); // F:[CM-47] collateralTokensCount++; // F:[CM-47] } /// @dev Sets fees and premiums /// @param _feeInterest Percentage of interest taken by the protocol as profit /// @param _feeLiquidation Percentage of account value taken by the protocol as profit /// during unhealthy account liquidations /// @param _liquidationDiscount Multiplier that reduces the effective totalValue during unhealthy account liquidations, /// allowing the liquidator to take the unaccounted for remainder as premium. Equal to (1 - liquidationPremium) /// @param _feeLiquidationExpired Percentage of account value taken by the protocol as profit /// during expired account liquidations /// @param _liquidationDiscountExpired Multiplier that reduces the effective totalValue during expired account liquidations, /// allowing the liquidator to take the unaccounted for remainder as premium. Equal to (1 - liquidationPremiumExpired) function setParams( uint16 _feeInterest, uint16 _feeLiquidation, uint16 _liquidationDiscount, uint16 _feeLiquidationExpired, uint16 _liquidationDiscountExpired ) external creditConfiguratorOnly // F:[CM-4] { slot1.feeInterest = _feeInterest; // F:[CM-51] slot1.feeLiquidation = _feeLiquidation; // F:[CM-51] slot1.liquidationDiscount = _liquidationDiscount; // F:[CM-51] slot1.feeLiquidationExpired = _feeLiquidationExpired; // F:[CM-51] slot1.liquidationDiscountExpired = _liquidationDiscountExpired; // F:[CM-51] } // // CONFIGURATION // /// @dev Sets the liquidation threshold for a collateral token /// @notice Liquidation thresholds are weights used to compute /// TWV with. They denote the risk of the token, with /// more volatile and unpredictable tokens having lower LTs. /// @param token The collateral token to set the LT for /// @param liquidationThreshold The new LT function setLiquidationThreshold(address token, uint16 liquidationThreshold) external creditConfiguratorOnly // F:[CM-4] { // Underlying is a special case and its LT is stored in Slot1, // to be accessed frequently if (token == underlying) { // F:[CM-47] slot1.ltUnderlying = liquidationThreshold; // F:[CM-47] } else { uint256 tokenMask = tokenMasksMap(token); // F:[CM-47, 54] if (tokenMask == 0) revert TokenNotAllowedException(); // Token address and liquidation threshold are encoded into a single uint256 collateralTokensCompressed[tokenMask] = (collateralTokensCompressed[tokenMask] & type(uint160).max) | (uint256(liquidationThreshold) << 160); // F:[CM-47] } } /// @dev Sets the forbidden token mask /// @param _forbidMask The new bit mask encoding the tokens that are forbidden /// @notice Forbidden tokens are counted as collateral during health checks, however, they cannot be enabled /// or received as a result of adapter operation anymore. This means that a token can never be /// acquired through adapter operations after being forbidden. Accounts that have enabled forbidden tokens /// also can't borrow any additional funds until they disable those tokens. function setForbidMask(uint256 _forbidMask) external creditConfiguratorOnly // F:[CM-4] { forbiddenTokenMask = _forbidMask; // F:[CM-55] } /// @dev Sets the maximal number of enabled tokens on a single Credit Account. /// @param newMaxEnabledTokens The new enabled token limit. function setMaxEnabledTokens(uint8 newMaxEnabledTokens) external creditConfiguratorOnly // F: [CM-4] { maxAllowedEnabledTokenLength = newMaxEnabledTokens; // F: [CC-37] } /// @dev Sets the link between an adapter and its corresponding targetContract /// @param adapter Address of the adapter to be used to access the target contract /// @param targetContract A 3rd-party contract for which the adapter is set /// @notice The function can be called with (adapter, address(0)) and (address(0), targetContract) /// to disallow a particular target or adapter, since this would set values in respective /// mappings to address(0). function changeContractAllowance(address adapter, address targetContract) external creditConfiguratorOnly { if (adapter != address(0)) { adapterToContract[adapter] = targetContract; // F:[CM-56] } if (targetContract != address(0)) { contractToAdapter[targetContract] = adapter; // F:[CM-56] } // The universal adapter can potentially target multiple contracts, // so it is set using a special vanity address if (targetContract == UNIVERSAL_CONTRACT) { universalAdapter = adapter; // F:[CM-56] } } /// @dev Sets the Credit Facade /// @param _creditFacade Address of the new Credit Facade function upgradeCreditFacade(address _creditFacade) external creditConfiguratorOnly // F:[CM-4] { creditFacade = _creditFacade; } /// @dev Sets the Price Oracle /// @param _priceOracle Address of the new Price Oracle function upgradePriceOracle(address _priceOracle) external creditConfiguratorOnly // F:[CM-4] { slot1.priceOracle = IPriceOracleV2(_priceOracle); } /// @dev Adds an address to the list of emergency liquidators /// @param liquidator Address to add to the list function addEmergencyLiquidator(address liquidator) external creditConfiguratorOnly // F:[CM-4] { canLiquidateWhilePaused[liquidator] = true; } /// @dev Removes an address from the list of emergency liquidators /// @param liquidator Address to remove from the list function removeEmergencyLiquidator(address liquidator) external creditConfiguratorOnly // F: [CM-4] { canLiquidateWhilePaused[liquidator] = false; } /// @dev Sets a new Credit Configurator /// @param _creditConfigurator Address of the new Credit Configurator function setConfigurator(address _creditConfigurator) external creditConfiguratorOnly // F:[CM-4] { creditConfigurator = _creditConfigurator; // F:[CM-58] emit NewConfigurator(_creditConfigurator); // F:[CM-58] } }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IACL } from "../IACL.sol"; import { IAddressProvider } from "../IAddressProvider.sol"; import { ICreditManagerV2 } from "../ICreditManagerV2.sol"; // NOTE: new values must always be added at the end of the enum enum AdapterType { ABSTRACT, UNISWAP_V2_ROUTER, UNISWAP_V3_ROUTER, CURVE_V1_EXCHANGE_ONLY, YEARN_V2, CURVE_V1_2ASSETS, CURVE_V1_3ASSETS, CURVE_V1_4ASSETS, CURVE_V1_STECRV_POOL, CURVE_V1_WRAPPER, CONVEX_V1_BASE_REWARD_POOL, CONVEX_V1_BOOSTER, CONVEX_V1_CLAIM_ZAP, LIDO_V1, UNIVERSAL, LIDO_WSTETH_V1, BALANCER_VAULT, AAVE_V2_LENDING_POOL, AAVE_V2_WRAPPED_ATOKEN, COMPOUND_V2_CERC20, COMPOUND_V2_CETHER } interface IAdapterExceptions { /// @notice Thrown when adapter tries to use a token that's not a collateral token of the connected Credit Manager error TokenNotAllowedException(); /// @notice Thrown when caller of a `creditFacadeOnly` function is not the Credit Facade error CreditFacadeOnlyException(); /// @notice Thrown when caller of a `configuratorOnly` function is not configurator error CallerNotConfiguratorException(); } interface IAdapter is IAdapterExceptions { /// @notice Credit Manager the adapter is connected to function creditManager() external view returns (ICreditManagerV2); /// @notice Address of the contract the adapter is interacting with function targetContract() external view returns (address); /// @notice Address provider function addressProvider() external view returns (IAddressProvider); /// @notice ACL contract to check rights function _acl() external view returns (IACL); /// @notice Adapter type function _gearboxAdapterType() external pure returns (AdapterType); /// @notice Adapter version function _gearboxAdapterVersion() external pure returns (uint16); }
// SPDX-License-Identifier: MIT pragma solidity >=0.7.4; interface IWETH { /// @dev Deposits native ETH into the contract and mints WETH function deposit() external payable; /// @dev Transfers WETH to another account function transfer(address to, uint256 value) external returns (bool); /// @dev Burns WETH from msg.sender and send back native ETH function withdraw(uint256) external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IVersion } from "./IVersion.sol"; interface IAccountFactoryEvents { /// @dev Emits when the account mining contract is changed /// @notice Not applicable to factories deployed after V2 event AccountMinerChanged(address indexed miner); /// @dev Emits when a new Credit Account is created event NewCreditAccount(address indexed account); /// @dev Emits when a Credit Manager takes an account from the factory event InitializeCreditAccount( address indexed account, address indexed creditManager ); /// @dev Emits when a Credit Manager returns an account to the factory event ReturnCreditAccount(address indexed account); /// @dev Emits when a Credit Account is taking out of the factory forever /// by root event TakeForever(address indexed creditAccount, address indexed to); } interface IAccountFactoryGetters { /// @dev Gets the next available credit account after the passed one, or address(0) if the passed account is the tail /// @param creditAccount Credit Account previous to the one to retrieve function getNext(address creditAccount) external view returns (address); /// @dev Head of CA linked list function head() external view returns (address); /// @dev Tail of CA linked list function tail() external view returns (address); /// @dev Returns the number of unused credit accounts in stock function countCreditAccountsInStock() external view returns (uint256); /// @dev Returns the credit account address under the passed id /// @param id The index of the requested CA function creditAccounts(uint256 id) external view returns (address); /// @dev Returns the number of deployed credit accounts function countCreditAccounts() external view returns (uint256); } interface IAccountFactory is IAccountFactoryGetters, IAccountFactoryEvents, IVersion { /// @dev Provides a new credit account to a Credit Manager function takeCreditAccount( uint256 _borrowedAmount, uint256 _cumulativeIndexAtOpen ) external returns (address); /// @dev Retrieves the Credit Account from the Credit Manager and adds it to the stock /// @param usedAccount Address of returned credit account function returnCreditAccount(address usedAccount) external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IVersion } from "./IVersion.sol"; interface IACLExceptions { /// @dev Thrown when attempting to delete an address from a set that is not a pausable admin error AddressNotPausableAdminException(address addr); /// @dev Thrown when attempting to delete an address from a set that is not a unpausable admin error AddressNotUnpausableAdminException(address addr); } interface IACLEvents { /// @dev Emits when a new admin is added that can pause contracts event PausableAdminAdded(address indexed newAdmin); /// @dev Emits when a Pausable admin is removed event PausableAdminRemoved(address indexed admin); /// @dev Emits when a new admin is added that can unpause contracts event UnpausableAdminAdded(address indexed newAdmin); /// @dev Emits when an Unpausable admin is removed event UnpausableAdminRemoved(address indexed admin); } /// @title ACL interface interface IACL is IACLEvents, IACLExceptions, IVersion { /// @dev Returns true if the address is a pausable admin and false if not /// @param addr Address to check function isPausableAdmin(address addr) external view returns (bool); /// @dev Returns true if the address is unpausable admin and false if not /// @param addr Address to check function isUnpausableAdmin(address addr) external view returns (bool); /// @dev Returns true if an address has configurator rights /// @param account Address to check function isConfigurator(address account) external view returns (bool); /// @dev Returns address of configurator function owner() external view returns (address); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IVersion } from "./IVersion.sol"; interface IAddressProviderEvents { /// @dev Emits when an address is set for a contract role event AddressSet(bytes32 indexed service, address indexed newAddress); } /// @title Optimised for front-end Address Provider interface interface IAddressProvider is IAddressProviderEvents, IVersion { /// @return Address of ACL contract function getACL() external view returns (address); /// @return Address of ContractsRegister function getContractsRegister() external view returns (address); /// @return Address of AccountFactory function getAccountFactory() external view returns (address); /// @return Address of DataCompressor function getDataCompressor() external view returns (address); /// @return Address of GEAR token function getGearToken() external view returns (address); /// @return Address of WETH token function getWethToken() external view returns (address); /// @return Address of WETH Gateway function getWETHGateway() external view returns (address); /// @return Address of PriceOracle function getPriceOracle() external view returns (address); /// @return Address of DAO Treasury Multisig function getTreasuryContract() external view returns (address); /// @return Address of PathFinder function getLeveragedActions() external view returns (address); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IVersion } from "./IVersion.sol"; interface IBlacklistHelperEvents { /// @dev Emitted when a borrower's claimable balance is increased event ClaimableAdded( address indexed underlying, address indexed holder, uint256 amount ); /// @dev Emitted when a borrower claims their tokens event Claimed( address indexed underlying, address indexed holder, address to, uint256 amount ); /// @dev Emitted when a Credit Facade is added to BlacklistHelper event CreditFacadeAdded(address indexed creditFacade); /// @dev Emitted when a Credit Facade is removed from BlacklistHelper event CreditFacadeRemoved(address indexed creditFacade); } interface IBlacklistHelperExceptions { /// @dev Thrown when an access-restricted function is called by non-CreditFacade error CreditFacadeOnlyException(); /// @dev Thrown when attempting to add a Credit Facade that has non-blacklistable underlying error CreditFacadeNonBlacklistable(); /// @dev Thrown when attempting to claim funds without having anything claimable error NothingToClaimException(); } interface IBlacklistHelper is IBlacklistHelperEvents, IBlacklistHelperExceptions, IVersion { /// @dev Returns whether the account is blacklisted for a particular underlying /// @param underlying Underlying token to check /// @param account Account to check function isBlacklisted(address underlying, address account) external view returns (bool); /// @dev Transfers the sender's claimable balance of underlying to the specified address /// @param underlying Underlying to transfer /// @param to Recipient address function claim(address underlying, address to) external; /// @dev Increases the underlying balance available to claim by the account /// @param underlying Underlying to increase claimable for /// @param holder Account to increase claimable for /// @param amount Amount to increase claimable claimable for function addClaimable( address underlying, address holder, uint256 amount ) external; /// @dev Returns the amount claimable by an account /// @param underlying Underlying to get the amount for /// @param holder Acccount to get the amount for function claimable(address underlying, address holder) external view returns (uint256); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IVersion } from "./IVersion.sol"; /// @title Credit Account /// @notice Implements generic credit account logic: /// - Holds collateral assets /// - Stores general parameters: borrowed amount, cumulative index at open and block when it was initialized /// - Transfers assets /// - Executes financial orders by calling connected protocols on its behalf /// /// More: https://dev.gearbox.fi/developers/credit/credit_account interface ICrediAccountExceptions { /// @dev throws if the caller is not the connected Credit Manager error CallerNotCreditManagerException(); /// @dev throws if the caller is not the factory error CallerNotFactoryException(); } interface ICreditAccount is ICrediAccountExceptions, IVersion { /// @dev Called on new Credit Account creation. /// @notice Initialize is used instead of constructor, since the contract is cloned. function initialize() external; /// @dev Connects this credit account to a Credit Manager. Restricted to the account factory (owner) only. /// @param _creditManager Credit manager address /// @param _borrowedAmount The amount borrowed at Credit Account opening /// @param _cumulativeIndexAtOpen The interest index at Credit Account opening function connectTo( address _creditManager, uint256 _borrowedAmount, uint256 _cumulativeIndexAtOpen ) external; /// @dev Updates borrowed amount and cumulative index. Restricted to the currently connected Credit Manager. /// @param _borrowedAmount The amount currently lent to the Credit Account /// @param _cumulativeIndexAtOpen New cumulative index to calculate interest from function updateParameters( uint256 _borrowedAmount, uint256 _cumulativeIndexAtOpen ) external; /// @dev Removes allowance for a token to a 3rd-party contract. Restricted to factory only. /// @param token ERC20 token to remove allowance for. /// @param targetContract Target contract to revoke allowance to. function cancelAllowance(address token, address targetContract) external; /// @dev Transfers tokens from the credit account to a provided address. Restricted to the current Credit Manager only. /// @param token Token to be transferred from the Credit Account. /// @param to Address of the recipient. /// @param amount Amount to be transferred. function safeTransfer( address token, address to, uint256 amount ) external; /// @dev Returns the principal amount borrowed from the pool function borrowedAmount() external view returns (uint256); /// @dev Returns the cumulative interest index since the last Credit Account's debt update function cumulativeIndexAtOpen() external view returns (uint256); /// @dev Returns the block at which the contract was last taken from the factory function since() external view returns (uint256); /// @dev Returns the address of the currently connected Credit Manager function creditManager() external view returns (address); /// @dev Address of the Credit Account factory function factory() external view returns (address); /// @dev Executes a call to a 3rd party contract with provided data. Restricted to the current Credit Manager only. /// @param destination Contract address to be called. /// @param data Data to call the contract with. function execute(address destination, bytes memory data) external returns (bytes memory); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IAddressProvider } from "./IAddressProvider.sol"; import { CreditManager } from "../credit/CreditManager.sol"; import { CreditFacade } from "../credit/CreditFacade.sol"; import { IVersion } from "./IVersion.sol"; /// @dev A struct containing parameters for a recognized collateral token in the system struct CollateralToken { /// @dev Address of the collateral token address token; /// @dev Address of the liquidation threshold uint16 liquidationThreshold; } /// @dev A struct representing the initial Credit Manager configuration parameters struct CreditManagerOpts { /// @dev The minimal debt principal amount uint128 minBorrowedAmount; /// @dev The maximal debt principal amount uint128 maxBorrowedAmount; /// @dev The initial list of collateral tokens to allow CollateralToken[] collateralTokens; /// @dev Address of DegenNFT, address(0) if whitelisted mode is not used address degenNFT; /// @dev Address of BlacklistHelper, address(0) if the underlying is not blacklistable address blacklistHelper; /// @dev Whether the Credit Manager is connected to an expirable pool (and the CreditFacade is expirable) bool expirable; } interface ICreditConfiguratorEvents { /// @dev Emits when a collateral token's liquidation threshold is changed event TokenLiquidationThresholdUpdated( address indexed token, uint16 liquidityThreshold ); /// @dev Emits when a new or a previously forbidden token is allowed event TokenAllowed(address indexed token); /// @dev Emits when a collateral token is forbidden event TokenForbidden(address indexed token); /// @dev Emits when a contract <> adapter pair is linked for a Credit Manager event ContractAllowed(address indexed protocol, address indexed adapter); /// @dev Emits when a 3rd-party contract is forbidden event ContractForbidden(address indexed protocol); /// @dev Emits when a particular adapter for a target contract is forbidden event AdapterForbidden(address indexed adapter); /// @dev Emits when debt principal limits are changed event LimitsUpdated(uint256 minBorrowedAmount, uint256 maxBorrowedAmount); /// @dev Emits when Credit Manager's fee parameters are updated event FeesUpdated( uint16 feeInterest, uint16 feeLiquidation, uint16 liquidationPremium, uint16 feeLiquidationExpired, uint16 liquidationPremiumExpired ); /// @dev Emits when a new Price Oracle is connected to the Credit Manager event PriceOracleUpgraded(address indexed newPriceOracle); /// @dev Emits when a new Credit Facade is connected to the Credit Manager event CreditFacadeUpgraded(address indexed newCreditFacade); /// @dev Emits when a new Credit Configurator is connected to the Credit Manager event CreditConfiguratorUpgraded(address indexed newCreditConfigurator); /// @dev Emits when the status of the debt increase restriction is changed event IncreaseDebtForbiddenModeChanged(bool); /// @dev Emits when the borrowing limit per block is changed event LimitPerBlockUpdated(uint128); /// @dev Emits when an address is added to the upgradeable contract list event AddedToUpgradeable(address); /// @dev Emits when an address is removed from the upgradeable contract list event RemovedFromUpgradeable(address); /// @dev Emits when the expiration date is updated in an expirable Credit Facade event ExpirationDateUpdated(uint40); /// @dev Emits when the enabled token limit is updated event MaxEnabledTokensUpdated(uint8); /// @dev Emits when an address is added to the list of emergency liquidators event EmergencyLiquidatorAdded(address); /// @dev Emits when an address is removed from the list of emergency liquidators event EmergencyLiquidatorRemoved(address); /// @dev Emits when new max cumulative loss is set event NewMaxCumulativeLoss(uint128); /// @dev Emits when the current cumulative loss in Credit Facade is reset event CumulativeLossReset(); /// @dev Emits when the emergency liquidation premium is set event NewEmergencyLiquidationDiscount(uint16); /// @dev Emits when a new total debt limit is set event NewTotalDebtLimit(uint128); } /// @dev CreditConfigurator Exceptions interface ICreditConfiguratorExceptions { /// @dev Thrown if the underlying's LT is set directly /// @notice Underlying LT is derived from fee parameters and is set automatically /// on updating fees error SetLTForUnderlyingException(); /// @dev Thrown if the newly set LT if zero or greater than the underlying's LT error IncorrectLiquidationThresholdException(); /// @dev Thrown if feeInterest or (liquidationPremium + feeLiquidation) is out of [0%..100%] range (encoded as [0..10000]) error IncorrectFeesException(); /// @dev Thrown if borrowing limits are incorrect: minLimit > maxLimit or maxLimit > blockLimit error IncorrectLimitsException(); /// @dev Thrown if the new expiration date is less than the current expiration date or block.timestamp error IncorrectExpirationDateException(); /// @dev Thrown if address of CreditManager or CreditFacade are being set as a target for an adapter error CreditManagerOrFacadeUsedAsTargetContractsException(); /// @dev Thrown if an adapter that is already linked to a contract is being connected to another error AdapterUsedTwiceException(); /// @dev Thrown if a contract (adapter or Credit Facade) set in a Credit Configurator returns a wrong Credit Manager /// or retrieving the Credit Manager from it fails error IncompatibleContractException(); /// @dev Thrown if attempting to forbid an adapter that is not allowed for the Credit Manager error ContractIsNotAnAllowedAdapterException(); } interface ICreditConfigurator is ICreditConfiguratorEvents, ICreditConfiguratorExceptions, IVersion { // // STATE-CHANGING FUNCTIONS // /// @dev Adds token to the list of allowed collateral tokens, and sets the LT /// @param token Address of token to be added /// @param liquidationThreshold Liquidation threshold for account health calculations function addCollateralToken(address token, uint16 liquidationThreshold) external; /// @dev Sets a liquidation threshold for any token except the underlying /// @param token Token address /// @param liquidationThreshold in PERCENTAGE_FORMAT (100% = 10000) function setLiquidationThreshold(address token, uint16 liquidationThreshold) external; /// @dev Allow a known collateral token if it was forbidden before. /// @param token Address of collateral token function allowToken(address token) external; /// @dev Forbids a collateral token. /// Forbidden tokens are counted as collateral during health checks, however, they cannot be enabled /// or received as a result of adapter operation anymore. This means that a token can never be /// acquired through adapter operations after being forbidden. /// @param token Address of collateral token to forbid function forbidToken(address token) external; /// @dev Adds pair [contract <-> adapter] to the list of allowed contracts /// or updates adapter address if a contract already has a connected adapter /// @param targetContract Address of allowed contract /// @param adapter Adapter address function allowContract(address targetContract, address adapter) external; /// @dev Forbids contract as a target for calls from Credit Accounts /// @param targetContract Address of a contract to be forbidden function forbidContract(address targetContract) external; /// @dev Forbids adapter (and only the adapter - the target contract is not affected) /// @param adapter Address of adapter to disable /// @notice Used to clean up orphaned adapters function forbidAdapter(address adapter) external; /// @dev Sets borrowed amount limits in Credit Facade /// @param _minBorrowedAmount Minimum borrowed amount /// @param _maxBorrowedAmount Maximum borrowed amount function setLimits(uint128 _minBorrowedAmount, uint128 _maxBorrowedAmount) external; /// @dev Sets fees for creditManager /// @param _feeInterest Percent which protocol charges additionally for interest rate /// @param _feeLiquidation The fee that is paid to the pool from liquidation /// @param _liquidationPremium Discount for totalValue which is given to liquidator /// @param _feeLiquidationExpired The fee that is paid to the pool from liquidation when liquidating an expired account /// @param _liquidationPremiumExpired Discount for totalValue which is given to liquidator when liquidating an expired account function setFees( uint16 _feeInterest, uint16 _feeLiquidation, uint16 _liquidationPremium, uint16 _feeLiquidationExpired, uint16 _liquidationPremiumExpired ) external; /// @dev Upgrades the price oracle in the Credit Manager, taking the address /// from the address provider function upgradePriceOracle() external; /// @dev Upgrades the Credit Facade corresponding to the Credit Manager /// @param _creditFacade address of the new CreditFacade /// @param migrateParams Whether the previous CreditFacade's parameter need to be copied function upgradeCreditFacade(address _creditFacade, bool migrateParams) external; /// @dev Upgrades the Credit Configurator for a connected Credit Manager /// @param _creditConfigurator New Credit Configurator's address function upgradeCreditConfigurator(address _creditConfigurator) external; /// @dev Enables or disables borrowing /// In Credit Facade (and, consequently, the Credit Manager) /// @param _mode Prohibits borrowing if true, and allows borrowing otherwise function setIncreaseDebtForbidden(bool _mode) external; /// @dev Sets the maximal borrowed amount per block /// @param newLimit The new max borrowed amount per block function setLimitPerBlock(uint128 newLimit) external; /// @dev Sets expiration date in a CreditFacade connected /// To a CreditManager with an expirable pool /// @param newExpirationDate The timestamp of the next expiration function setExpirationDate(uint40 newExpirationDate) external; /// @dev Sets the maximal amount of enabled tokens per Credit Account /// @param maxEnabledTokens The new maximal number of enabled tokens /// @notice A large number of enabled collateral tokens on a Credit Account /// can make liquidations and health checks prohibitively expensive in terms of gas, /// hence the number is limited function setMaxEnabledTokens(uint8 maxEnabledTokens) external; /// @dev Adds an address to the list of emergency liquidators /// @param liquidator The address to add to the list /// @notice Emergency liquidators are trusted addresses /// that are able to liquidate positions while the contracts are paused, /// e.g. when there is a risk of bad debt while an exploit is being patched. /// In the interest of fairness, emergency liquidators do not receive a premium /// And are compensated by the Gearbox DAO separately. function addEmergencyLiquidator(address liquidator) external; /// @dev Removex an address frp, the list of emergency liquidators /// @param liquidator The address to remove from the list function removeEmergencyLiquidator(address liquidator) external; // // GETTERS // /// @dev Address provider (needed for upgrading the Price Oracle) function addressProvider() external view returns (IAddressProvider); /// @dev Returns the Credit Facade currently connected to the Credit Manager function creditFacade() external view returns (CreditFacade); /// @dev Address of the Credit Manager function creditManager() external view returns (CreditManager); /// @dev Address of the Credit Manager's underlying asset function underlying() external view returns (address); /// @dev Returns all allowed contracts function allowedContracts() external view returns (address[] memory); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { Balance } from "../libraries/Balances.sol"; import { MultiCall } from "../libraries/MultiCall.sol"; import { ICreditManagerV2, ICreditManagerV2Exceptions } from "./ICreditManagerV2.sol"; import { IVersion } from "./IVersion.sol"; interface ICreditFacadeExtended { /// @dev Stores expected balances (computed as current balance + passed delta) /// and compare with actual balances at the end of a multicall, reverts /// if at least one is less than expected /// @param expected Array of expected balance changes /// @notice This is an extenstion function that does not exist in the Credit Facade /// itself and can only be used within a multicall function revertIfReceivedLessThan(Balance[] memory expected) external; /// @dev Enables token in enabledTokenMask for the Credit Account of msg.sender /// @param token Address of token to enable function enableToken(address token) external; /// @dev Disables a token on the caller's Credit Account /// @param token Token to disable /// @notice This is an extenstion function that does not exist in the Credit Facade /// itself and can only be used within a multicall function disableToken(address token) external; /// @dev Adds collateral to borrower's credit account /// @param onBehalfOf Address of the borrower whose account is funded /// @param token Address of a collateral token /// @param amount Amount to add function addCollateral( address onBehalfOf, address token, uint256 amount ) external payable; /// @dev Increases debt for msg.sender's Credit Account /// - Borrows the requested amount from the pool /// - Updates the CA's borrowAmount / cumulativeIndexOpen /// to correctly compute interest going forward /// - Performs a full collateral check /// /// @param amount Amount to borrow function increaseDebt(uint256 amount) external; /// @dev Decrease debt /// - Decreases the debt by paying the requested amount + accrued interest + fees back to the pool /// - It's also include to this payment interest accrued at the moment and fees /// - Updates cunulativeIndex to cumulativeIndex now /// /// @param amount Amount to increase borrowed amount function decreaseDebt(uint256 amount) external; } interface ICreditFacadeEvents { /// @dev Emits when Blacklist Helper is set for the Credit Facade upon creation event BlacklistHelperSet(address indexed blacklistHelper); /// @dev Emits when a new Credit Account is opened through the /// Credit Facade event OpenCreditAccount( address indexed onBehalfOf, address indexed creditAccount, uint256 borrowAmount, uint16 referralCode ); /// @dev Emits when the account owner closes their CA normally event CloseCreditAccount(address indexed borrower, address indexed to); /// @dev Emits when a Credit Account is liquidated due to low health factor event LiquidateCreditAccount( address indexed borrower, address indexed liquidator, address indexed to, uint256 remainingFunds ); /// @dev Emits when a Credit Account is liquidated due to expiry event LiquidateExpiredCreditAccount( address indexed borrower, address indexed liquidator, address indexed to, uint256 remainingFunds ); /// @dev Emits when remaining funds in underlying currency are sent to /// the blacklist helper upon blacklisted borrower liquidation event UnderlyingSentToBlacklistHelper( address indexed borrower, uint256 amount ); /// @dev Emits when the account owner increases CA's debt event IncreaseBorrowedAmount(address indexed borrower, uint256 amount); /// @dev Emits when the account owner reduces CA's debt event DecreaseBorrowedAmount(address indexed borrower, uint256 amount); /// @dev Emits when the account owner add new collateral to a CA event AddCollateral( address indexed onBehalfOf, address indexed token, uint256 value ); /// @dev Emits when a multicall is started event MultiCallStarted(address indexed borrower); /// @dev Emits when a multicall is finished event MultiCallFinished(); /// @dev Emits when Credit Account ownership is transferred event TransferAccount(address indexed oldOwner, address indexed newOwner); /// @dev Emits when the user changes approval for account transfers to itself from another address event TransferAccountAllowed( address indexed from, address indexed to, bool state ); /// @dev Emits when the account owner enables a token on their CA event TokenEnabled(address indexed borrower, address indexed token); /// @dev Emits when the account owner disables a token on their CA event TokenDisabled(address indexed borrower, address indexed token); /// @dev Emits when pool incurs loss on account liquidation and facade forbids borrowing event IncurLossOnLiquidation(uint256 loss); } interface ICreditFacadeExceptions is ICreditManagerV2Exceptions { /// @dev Thrown if the CreditFacade is not expirable, and an aciton is attempted that /// requires expirability error NotAllowedWhenNotExpirableException(); /// @dev Thrown if whitelisted mode is enabled, and an action is attempted that is /// not allowed in whitelisted mode error NotAllowedInWhitelistedMode(); /// @dev Thrown if a user attempts to transfer a CA to an address that didn't allow it error AccountTransferNotAllowedException(); /// @dev Thrown if a liquidator tries to liquidate an account with a health factor above 1 error CantLiquidateWithSuchHealthFactorException(); /// @dev Thrown if a liquidator tries to liquidate an account by expiry while a Credit Facade is not expired error CantLiquidateNonExpiredException(); /// @dev Thrown if call data passed to a multicall is too short error IncorrectCallDataException(); /// @dev Thrown inside account closure multicall if the borrower attempts an action that is forbidden on closing /// an account error ForbiddenDuringClosureException(); /// @dev Thrown if debt increase and decrease are subsequently attempted in one multicall error IncreaseAndDecreaseForbiddenInOneCallException(); /// @dev Thrown if a selector that doesn't match any allowed function is passed to the Credit Facade /// during a multicall error UnknownMethodException(); /// @dev Thrown if a user tries to open an account or increase debt with increaseDebtForbidden mode on error IncreaseDebtForbiddenException(); /// @dev Thrown if the account owner tries to transfer an unhealthy account error CantTransferLiquidatableAccountException(); /// @dev Thrown if too much new debt was taken within a single block error BorrowedBlockLimitException(); /// @dev Thrown if the new debt principal for a CA falls outside of borrowing limits error BorrowAmountOutOfLimitsException(); /// @dev Thrown if one of the balances on a Credit Account is less than expected /// at the end of a multicall, if revertIfReceivedLessThan was called error BalanceLessThanMinimumDesiredException(address); /// @dev Thrown if a user attempts to open an account on a Credit Facade that has expired error OpenAccountNotAllowedAfterExpirationException(); /// @dev Thrown if expected balances are attempted to be set through revertIfReceivedLessThan twice error ExpectedBalancesAlreadySetException(); /// @dev Thrown if a Credit Account has enabled forbidden tokens and the owner attempts to perform an action /// that is not allowed with any forbidden tokens enabled error ActionProhibitedWithForbiddenTokensException(); /// @dev Thrown when attempting to perform an action on behalf of a borrower /// that is blacklisted in the underlying token error NotAllowedForBlacklistedAddressException(); /// @dev Thrown when the pool receives less funds than borrowAmountWithInterest on account closure error LiquiditySanityCheckException(); } interface ICreditFacade is ICreditFacadeEvents, ICreditFacadeExceptions, IVersion { // // CREDIT ACCOUNT MANAGEMENT // /// @dev Opens credit account, borrows funds from the pool and pulls collateral /// without any additional action. /// @param amount The amount of collateral provided by the borrower /// @param onBehalfOf The address to open an account for. Transfers to it have to be allowed if /// msg.sender != obBehalfOf /// @param leverageFactor Percentage of the user's own funds to borrow. 100 is equal to 100% - borrows the same amount /// as the user's own collateral, equivalent to 2x leverage. /// @param referralCode Referral code that is used for potential rewards. 0 if no referral code provided. function openCreditAccount( uint256 amount, address onBehalfOf, uint16 leverageFactor, uint16 referralCode ) external payable; /// @dev Opens a Credit Account and runs a batch of operations in a multicall /// @param borrowedAmount Debt size /// @param onBehalfOf The address to open an account for. Transfers to it have to be allowed if /// msg.sender != obBehalfOf /// @param calls The array of MultiCall structs encoding the required operations. Generally must have /// at least a call to addCollateral, as otherwise the health check at the end will fail. /// @param referralCode Referral code which is used for potential rewards. 0 if no referral code provided function openCreditAccountMulticall( uint256 borrowedAmount, address onBehalfOf, MultiCall[] calldata calls, uint16 referralCode ) external payable; /// @dev Runs a batch of transactions within a multicall and closes the account /// - Wraps ETH to WETH and sends it msg.sender if value > 0 /// - Executes the multicall - the main purpose of a multicall when closing is to convert all assets to underlying /// in order to pay the debt. /// - Closes credit account: /// + Checks the underlying balance: if it is greater than the amount paid to the pool, transfers the underlying /// from the Credit Account and proceeds. If not, tries to transfer the shortfall from msg.sender. /// + Transfers all enabled assets with non-zero balances to the "to" address, unless they are marked /// to be skipped in skipTokenMask /// - Emits a CloseCreditAccount event /// /// @param to Address to send funds to during account closing /// @param skipTokenMask Uint-encoded bit mask where 1's mark tokens that shouldn't be transferred /// @param calls The array of MultiCall structs encoding the operations to execute before closing the account. function closeCreditAccount( address to, uint256 skipTokenMask, MultiCall[] calldata calls ) external payable; /// @dev A version of `closeCreditAccount` with `convertWETH` parameter that is ignored. /// Used for backward compatibility. function closeCreditAccount( address to, uint256 skipTokenMask, bool convertWETH, MultiCall[] calldata calls ) external payable; /// @dev Runs a batch of transactions within a multicall and liquidates the account /// - Computes the total value and checks that hf < 1. An account can't be liquidated when hf >= 1. /// Total value has to be computed before the multicall, otherwise the liquidator would be able /// to manipulate it. /// - Wraps ETH to WETH and sends it to msg.sender (liquidator) if value > 0 /// - Executes the multicall - the main purpose of a multicall when liquidating is to convert all assets to underlying /// in order to pay the debt. /// - Liquidate credit account: /// + Computes the amount that needs to be paid to the pool. If totalValue * liquidationDiscount < borrow + interest + fees, /// only totalValue * liquidationDiscount has to be paid. Since liquidationDiscount < 1, the liquidator can take /// totalValue * (1 - liquidationDiscount) as premium. Also computes the remaining funds to be sent to borrower /// as totalValue * liquidationDiscount - amountToPool. /// + Checks the underlying balance: if it is greater than amountToPool + remainingFunds, transfers the underlying /// from the Credit Account and proceeds. If not, tries to transfer the shortfall from the liquidator. /// + Transfers all enabled assets with non-zero balances to the "to" address, unless they are marked /// to be skipped in skipTokenMask. If the liquidator is confident that all assets were converted /// during the multicall, they can set the mask to uint256.max - 1, to only transfer the underlying /// - Emits LiquidateCreditAccount event /// /// @param to Address to send funds to after liquidation /// @param skipTokenMask Uint-encoded bit mask where 1's mark tokens that shouldn't be transferred /// @param calls The array of MultiCall structs encoding the operations to execute before liquidating the account. function liquidateCreditAccount( address borrower, address to, uint256 skipTokenMask, MultiCall[] calldata calls ) external payable; /// @dev A version of `liquidateCreditAccount` with `convertWETH` parameter that is ignored. /// Used for backward compatibility. function liquidateCreditAccount( address borrower, address to, uint256 skipTokenMask, bool convertWETH, MultiCall[] calldata calls ) external payable; /// @dev Runs a batch of transactions within a multicall and liquidates the account when /// this Credit Facade is expired /// The general flow of liquidation is nearly the same as normal liquidations, with two main differences: /// - An account can be liquidated on an expired Credit Facade even with hf > 1. However, /// no accounts can be liquidated through this function if the Credit Facade is not expired. /// - Liquidation premiums and fees for liquidating expired accounts are reduced. /// It is still possible to normally liquidate an underwater Credit Account, even when the Credit Facade /// is expired. /// @param to Address to send funds to after liquidation /// @param skipTokenMask Uint-encoded bit mask where 1's mark tokens that shouldn't be transferred /// @param calls The array of MultiCall structs encoding the operations to execute before liquidating the account. /// @notice See more at https://dev.gearbox.fi/docs/documentation/credit/liquidation#liquidating-accounts-by-expiration function liquidateExpiredCreditAccount( address borrower, address to, uint256 skipTokenMask, MultiCall[] calldata calls ) external payable; /// @dev A version of `liquidateExpiredCreditAccount` with `convertWETH` parameter that is ignored. /// Used for backward compatibility. function liquidateExpiredCreditAccount( address borrower, address to, uint256 skipTokenMask, bool convertWETH, MultiCall[] calldata calls ) external payable; /// @dev Adds collateral to borrower's credit account /// @param onBehalfOf Address of the borrower whose account is funded /// @param token Address of a collateral token /// @param amount Amount to add function addCollateral( address onBehalfOf, address token, uint256 amount ) external payable; /// @dev Executes a batch of transactions within a Multicall, to manage an existing account /// - Wraps ETH and sends it back to msg.sender, if value > 0 /// - Executes the Multicall /// - Performs a fullCollateralCheck to verify that hf > 1 after all actions /// @param calls The array of MultiCall structs encoding the operations to execute. function multicall(MultiCall[] calldata calls) external payable; /// @dev Returns true if the borrower has an open Credit Account /// @param borrower Borrower address function hasOpenedCreditAccount(address borrower) external view returns (bool); /// @dev Approves account transfer from another user to msg.sender /// @param from Address for which account transfers are allowed/forbidden /// @param state True is transfer is allowed, false if forbidden function approveAccountTransfer(address from, bool state) external; /// @dev Transfers credit account to another user /// By default, this action is forbidden, and the user has to approve transfers from sender to itself /// by calling approveAccountTransfer. /// This is done to prevent malicious actors from transferring compromised accounts to other users. /// @param to Address to transfer the account to function transferAccountOwnership(address to) external; // // GETTERS // /// @dev Calculates total value for provided Credit Account in underlying /// /// @param creditAccount Credit Account address /// @return total Total value in underlying /// @return twv Total weighted (discounted by liquidation thresholds) value in underlying function calcTotalValue(address creditAccount) external view returns (uint256 total, uint256 twv); /** * @dev Calculates health factor for the credit account * * sum(asset[i] * liquidation threshold[i]) * Hf = -------------------------------------------- * borrowed amount + interest accrued + fees * * * More info: https://dev.gearbox.fi/developers/credit/economy#health-factor * * @param creditAccount Credit account address * @return hf = Health factor in bp (see PERCENTAGE FACTOR in PercentageMath.sol) */ function calcCreditAccountHealthFactor(address creditAccount) external view returns (uint256 hf); /// @dev Returns true if token is a collateral token and is not forbidden, /// otherwise returns false /// @param token Token to check function isTokenAllowed(address token) external view returns (bool); /// @dev Returns the CreditManager connected to this Credit Facade function creditManager() external view returns (ICreditManagerV2); /// @dev Returns true if 'from' is allowed to transfer Credit Accounts to 'to' /// @param from Sender address to check allowance for /// @param to Receiver address to check allowance for function transfersAllowed(address from, address to) external view returns (bool); /// @return maxBorrowedAmountPerBlock Maximal amount of new debt that can be taken per block /// @return isIncreaseDebtForbidden True if increasing debt is forbidden /// @return expirationDate Timestamp of the next expiration (for expirable Credit Facades only) /// @return emergencyLiquidationDiscount Premium for liquidations when the system is paused function params() external view returns ( uint128 maxBorrowedAmountPerBlock, bool isIncreaseDebtForbidden, uint40 expirationDate, uint16 emergencyLiquidationDiscount ); /// @return minBorrowedAmount Minimal borrowed amount per credit account /// @return maxBorrowedAmount Maximal borrowed amount per credit account function limits() external view returns (uint128 minBorrowedAmount, uint128 maxBorrowedAmount); function lossParams() external view returns (uint128 currentCumulativeLoss, uint128 maxCumulativeLoss); function totalDebt() external view returns (uint128 currentTotalDebt, uint128 totalDebtLimit); /// @dev Address of the DegenNFT that gatekeeps account openings in whitelisted mode function degenNFT() external view returns (address); /// @dev Address of the underlying asset function underlying() external view returns (address); /// @dev Address of the blacklist helper or address(0), if underlying is not blacklistable function blacklistHelper() external view returns (address); /// @dev Whether the underlying of connected Credit Manager is blacklistable function isBlacklistableUnderlying() external view returns (bool); } interface ICreditFacadeV2 { /// @return maxBorrowedAmountPerBlock Maximal amount of new debt that can be taken per block /// @return isIncreaseDebtForbidden True if increasing debt is forbidden /// @return expirationDate Timestamp of the next expiration (for expirable Credit Facades only) function params() external view returns ( uint128 maxBorrowedAmountPerBlock, bool isIncreaseDebtForbidden, uint40 expirationDate ); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IPriceOracleV2 } from "./IPriceOracle.sol"; import { IVersion } from "./IVersion.sol"; enum ClosureAction { CLOSE_ACCOUNT, LIQUIDATE_ACCOUNT, LIQUIDATE_EXPIRED_ACCOUNT, LIQUIDATE_PAUSED } interface ICreditManagerV2Events { /// @dev Emits when a call to an external contract is made through the Credit Manager event ExecuteOrder(address indexed borrower, address indexed target); /// @dev Emits when a configurator is upgraded event NewConfigurator(address indexed newConfigurator); } interface ICreditManagerV2Exceptions { /// @dev Thrown if an access-restricted function is called by an address that is not /// the connected Credit Facade, or an allowed adapter error AdaptersOrCreditFacadeOnlyException(); /// @dev Thrown if an access-restricted function is called by an address that is not /// the connected Credit Facade error CreditFacadeOnlyException(); /// @dev Thrown if an access-restricted function is called by an address that is not /// the connected Credit Configurator error CreditConfiguratorOnlyException(); /// @dev Thrown on attempting to open a Credit Account for or transfer a Credit Account /// to the zero address or an address that already owns a Credit Account error ZeroAddressOrUserAlreadyHasAccountException(); /// @dev Thrown on attempting to execute an order to an address that is not an allowed /// target contract error TargetContractNotAllowedException(); /// @dev Thrown on failing a full collateral check after an operation error NotEnoughCollateralException(); /// @dev Thrown on attempting to receive a token that is not a collateral token /// or was forbidden error TokenNotAllowedException(); /// @dev Thrown if an attempt to approve a collateral token to a target contract failed error AllowanceFailedException(); /// @dev Thrown on attempting to perform an action for an address that owns no Credit Account error HasNoOpenedAccountException(); /// @dev Thrown on attempting to add a token that is already in a collateral list error TokenAlreadyAddedException(); /// @dev Thrown on configurator attempting to add more than 256 collateral tokens error TooManyTokensException(); /// @dev Thrown if more than the maximal number of tokens were enabled on a Credit Account, /// and there are not enough unused token to disable error TooManyEnabledTokensException(); /// @dev Thrown when a reentrancy into the contract is attempted error ReentrancyLockException(); } /// @notice All Credit Manager functions are access-restricted and can only be called /// by the Credit Facade or allowed adapters. Users are not allowed to /// interact with the Credit Manager directly interface ICreditManagerV2 is ICreditManagerV2Events, ICreditManagerV2Exceptions, IVersion { // // CREDIT ACCOUNT MANAGEMENT // /// @dev Opens credit account and borrows funds from the pool. /// - Takes Credit Account from the factory; /// - Requests the pool to lend underlying to the Credit Account /// /// @param borrowedAmount Amount to be borrowed by the Credit Account /// @param onBehalfOf The owner of the newly opened Credit Account function openCreditAccount(uint256 borrowedAmount, address onBehalfOf) external returns (address); /// @dev Closes a Credit Account - covers both normal closure and liquidation /// - Checks whether the contract is paused, and, if so, if the payer is an emergency liquidator. /// Only emergency liquidators are able to liquidate account while the CM is paused. /// Emergency liquidations do not pay a liquidator premium or liquidation fees. /// - Calculates payments to various recipients on closure: /// + Computes amountToPool, which is the amount to be sent back to the pool. /// This includes the principal, interest and fees, but can't be more than /// total position value /// + Computes remainingFunds during liquidations - these are leftover funds /// after paying the pool and the liquidator, and are sent to the borrower /// + Computes protocol profit, which includes interest and liquidation fees /// + Computes loss if the totalValue is less than borrow amount + interest /// - Checks the underlying token balance: /// + if it is larger than amountToPool, then the pool is paid fully from funds on the Credit Account /// + else tries to transfer the shortfall from the payer - either the borrower during closure, or liquidator during liquidation /// - Send assets to the "to" address, as long as they are not included into skipTokenMask /// - If convertWETH is true, the function converts WETH into ETH before sending /// - Returns the Credit Account back to factory /// /// @param borrower Borrower address /// @param closureActionType Whether the account is closed, liquidated or liquidated due to expiry /// @param totalValue Portfolio value for liqution, 0 for ordinary closure /// @param payer Address which would be charged if credit account has not enough funds to cover amountToPool /// @param to Address to which the leftover funds will be sent /// @param skipTokenMask Tokenmask contains 1 for tokens which needed to be skipped for sending /// @param convertWETH If true converts WETH to ETH function closeCreditAccount( address borrower, ClosureAction closureActionType, uint256 totalValue, address payer, address to, uint256 skipTokenMask, bool convertWETH ) external returns (uint256 remainingFunds); /// @dev Manages debt size for borrower: /// /// - Increase debt: /// + Increases debt by transferring funds from the pool to the credit account /// + Updates the cumulative index to keep interest the same. Since interest /// is always computed dynamically as borrowedAmount * (cumulativeIndexNew / cumulativeIndexOpen - 1), /// cumulativeIndexOpen needs to be updated, as the borrow amount has changed /// /// - Decrease debt: /// + Repays debt partially + all interest and fees accrued thus far /// + Updates cunulativeIndex to cumulativeIndex now /// /// @param creditAccount Address of the Credit Account to change debt for /// @param amount Amount to increase / decrease the principal by /// @param increase True to increase principal, false to decrease /// @return newBorrowedAmount The new debt principal function manageDebt( address creditAccount, uint256 amount, bool increase ) external returns (uint256 newBorrowedAmount); /// @dev Adds collateral to borrower's credit account /// @param payer Address of the account which will be charged to provide additional collateral /// @param creditAccount Address of the Credit Account /// @param token Collateral token to add /// @param amount Amount to add function addCollateral( address payer, address creditAccount, address token, uint256 amount ) external; /// @dev Transfers Credit Account ownership to another address /// @param from Address of previous owner /// @param to Address of new owner function transferAccountOwnership(address from, address to) external; /// @dev Requests the Credit Account to approve a collateral token to another contract. /// @param borrower Borrower's address /// @param targetContract Spender to change allowance for /// @param token Collateral token to approve /// @param amount New allowance amount function approveCreditAccount( address borrower, address targetContract, address token, uint256 amount ) external; /// @dev Requests a Credit Account to make a low-level call with provided data /// This is the intended pathway for state-changing interactions with 3rd-party protocols /// @param borrower Borrower's address /// @param targetContract Contract to be called /// @param data Data to pass with the call function executeOrder( address borrower, address targetContract, bytes memory data ) external returns (bytes memory); // // COLLATERAL VALIDITY AND ACCOUNT HEALTH CHECKS // /// @dev Enables a token on a Credit Account, including it /// into account health and total value calculations /// @param creditAccount Address of a Credit Account to enable the token for /// @param token Address of the token to be enabled function checkAndEnableToken(address creditAccount, address token) external; /// @dev Optimized health check for individual swap-like operations. /// @notice Fast health check assumes that only two tokens (input and output) /// participate in the operation and computes a % change in weighted value between /// inbound and outbound collateral. The cumulative negative change across several /// swaps in sequence cannot be larger than feeLiquidation (a fee that the /// protocol is ready to waive if needed). Since this records a % change /// between just two tokens, the corresponding % change in TWV will always be smaller, /// which makes this check safe. /// More details at https://dev.gearbox.fi/docs/documentation/risk/fast-collateral-check#fast-check-protection /// @param creditAccount Address of the Credit Account /// @param tokenIn Address of the token spent by the swap /// @param tokenOut Address of the token received from the swap /// @param balanceInBefore Balance of tokenIn before the operation /// @param balanceOutBefore Balance of tokenOut before the operation function fastCollateralCheck( address creditAccount, address tokenIn, address tokenOut, uint256 balanceInBefore, uint256 balanceOutBefore ) external; /// @dev Performs a full health check on an account, summing up /// value of all enabled collateral tokens /// @param creditAccount Address of the Credit Account to check function fullCollateralCheck(address creditAccount) external; /// @dev Checks that the number of enabled tokens on a Credit Account /// does not violate the maximal enabled token limit and tries /// to disable unused tokens if it does /// @param creditAccount Account to check enabled tokens for function checkAndOptimizeEnabledTokens(address creditAccount) external; /// @dev Disables a token on a credit account /// @notice Usually called by adapters to disable spent tokens during a multicall, /// but can also be called separately from the Credit Facade to remove /// unwanted tokens /// @return True if token mask was change otherwise False function disableToken(address creditAccount, address token) external returns (bool); // // GETTERS // /// @dev Returns the address of a borrower's Credit Account, or reverts if there is none. /// @param borrower Borrower's address function getCreditAccountOrRevert(address borrower) external view returns (address); /// @dev Computes amounts that must be sent to various addresses before closing an account /// @param totalValue Credit Accounts total value in underlying /// @param closureActionType Type of account closure /// * CLOSE_ACCOUNT: The account is healthy and is closed normally /// * LIQUIDATE_ACCOUNT: The account is unhealthy and is being liquidated to avoid bad debt /// * LIQUIDATE_EXPIRED_ACCOUNT: The account has expired and is being liquidated (lowered liquidation premium) /// * LIQUIDATE_PAUSED: The account is liquidated while the system is paused due to emergency (no liquidation premium) /// @param borrowedAmount Credit Account's debt principal /// @param borrowedAmountWithInterest Credit Account's debt principal + interest /// @return amountToPool Amount of underlying to be sent to the pool /// @return remainingFunds Amount of underlying to be sent to the borrower (only applicable to liquidations) /// @return profit Protocol's profit from fees (if any) /// @return loss Protocol's loss from bad debt (if any) function calcClosePayments( uint256 totalValue, ClosureAction closureActionType, uint256 borrowedAmount, uint256 borrowedAmountWithInterest ) external view returns ( uint256 amountToPool, uint256 remainingFunds, uint256 profit, uint256 loss ); /// @dev Calculates the debt accrued by a Credit Account /// @param creditAccount Address of the Credit Account /// @return borrowedAmount The debt principal /// @return borrowedAmountWithInterest The debt principal + accrued interest /// @return borrowedAmountWithInterestAndFees The debt principal + accrued interest and protocol fees function calcCreditAccountAccruedInterest(address creditAccount) external view returns ( uint256 borrowedAmount, uint256 borrowedAmountWithInterest, uint256 borrowedAmountWithInterestAndFees ); /// @dev Maps Credit Accounts to bit masks encoding their enabled token sets /// Only enabled tokens are counted as collateral for the Credit Account /// @notice An enabled token mask encodes an enabled token by setting /// the bit at the position equal to token's index to 1 function enabledTokensMap(address creditAccount) external view returns (uint256); /// @dev Maps the Credit Account to its current percentage drop across all swaps since /// the last full check, in RAY format function cumulativeDropAtFastCheckRAY(address creditAccount) external view returns (uint256); /// @dev Returns the collateral token at requested index and its liquidation threshold /// @param id The index of token to return function collateralTokens(uint256 id) external view returns (address token, uint16 liquidationThreshold); /// @dev Returns the collateral token with requested mask and its liquidationThreshold /// @param tokenMask Token mask corresponding to the token function collateralTokensByMask(uint256 tokenMask) external view returns (address token, uint16 liquidationThreshold); /// @dev Total number of known collateral tokens. function collateralTokensCount() external view returns (uint256); /// @dev Returns the mask for the provided token /// @param token Token to returns the mask for function tokenMasksMap(address token) external view returns (uint256); /// @dev Bit mask encoding a set of forbidden tokens function forbiddenTokenMask() external view returns (uint256); /// @dev Maps allowed adapters to their respective target contracts. function adapterToContract(address adapter) external view returns (address); /// @dev Maps 3rd party contracts to their respective adapters function contractToAdapter(address targetContract) external view returns (address); /// @dev Address of the underlying asset function underlying() external view returns (address); /// @dev Address of the connected pool function pool() external view returns (address); /// @dev Address of the connected pool /// @notice [DEPRECATED]: use pool() instead. function poolService() external view returns (address); /// @dev A map from borrower addresses to Credit Account addresses function creditAccounts(address borrower) external view returns (address); /// @dev Address of the connected Credit Configurator function creditConfigurator() external view returns (address); /// @dev Address of WETH function wethAddress() external view returns (address); /// @dev Returns the liquidation threshold for the provided token /// @param token Token to retrieve the LT for function liquidationThresholds(address token) external view returns (uint16); /// @dev The maximal number of enabled tokens on a single Credit Account function maxAllowedEnabledTokenLength() external view returns (uint8); /// @dev Maps addresses to their status as emergency liquidator. /// @notice Emergency liquidators are trusted addresses /// that are able to liquidate positions while the contracts are paused, /// e.g. when there is a risk of bad debt while an exploit is being patched. /// In the interest of fairness, emergency liquidators do not receive a premium /// And are compensated by the Gearbox DAO separately. function canLiquidateWhilePaused(address) external view returns (bool); /// @dev Returns the fee parameters of the Credit Manager /// @return feeInterest Percentage of interest taken by the protocol as profit /// @return feeLiquidation Percentage of account value taken by the protocol as profit /// during unhealthy account liquidations /// @return liquidationDiscount Multiplier that reduces the effective totalValue during unhealthy account liquidations, /// allowing the liquidator to take the unaccounted for remainder as premium. Equal to (1 - liquidationPremium) /// @return feeLiquidationExpired Percentage of account value taken by the protocol as profit /// during expired account liquidations /// @return liquidationDiscountExpired Multiplier that reduces the effective totalValue during expired account liquidations, /// allowing the liquidator to take the unaccounted for remainder as premium. Equal to (1 - liquidationPremiumExpired) function fees() external view returns ( uint16 feeInterest, uint16 feeLiquidation, uint16 liquidationDiscount, uint16 feeLiquidationExpired, uint16 liquidationDiscountExpired ); /// @dev Address of the connected Credit Facade function creditFacade() external view returns (address); /// @dev Address of the connected Price Oracle function priceOracle() external view returns (IPriceOracleV2); /// @dev Address of the universal adapter function universalAdapter() external view returns (address); /// @dev Contract's version function version() external view returns (uint256); /// @dev Paused() state function checkEmergencyPausable(address caller, bool state) external returns (bool); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IVersion } from "./IVersion.sol"; import { IERC721Metadata } from "@openzeppelin/contracts/token/ERC721/extensions/IERC721Metadata.sol"; interface IDegenNFTExceptions { /// @dev Thrown if an access-restricted function was called by non-CreditFacade error CreditFacadeOrConfiguratorOnlyException(); /// @dev Thrown if an access-restricted function was called by non-minter error MinterOnlyException(); /// @dev Thrown if trying to add a burner address that is not a correct Credit Facade error InvalidCreditFacadeException(); /// @dev Thrown if the account's balance is not sufficient for an action (usually a burn) error InsufficientBalanceException(); } interface IDegenNFTEvents { /// @dev Minted when new minter set event NewMinterSet(address indexed); /// @dev Minted each time when new credit facade added event NewCreditFacadeAdded(address indexed); /// @dev Minted each time when new credit facade added event NewCreditFacadeRemoved(address indexed); } interface IDegenNFT is IDegenNFTExceptions, IDegenNFTEvents, IVersion, IERC721Metadata { /// @dev address of the current minter function minter() external view returns (address); /// @dev Stores the total number of tokens on holder accounts function totalSupply() external view returns (uint256); /// @dev Stores the base URI for NFT metadata function baseURI() external view returns (string memory); /// @dev Mints a specified amount of tokens to the address /// @param to Address the tokens are minted to /// @param amount The number of tokens to mint function mint(address to, uint256 amount) external; /// @dev Burns a number of tokens from a specified address /// @param from The address a token will be burnt from /// @param amount The number of tokens to burn function burn(address from, uint256 amount) external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; /// @dev Common contract exceptions /// @dev Thrown on attempting to set an important address to zero address error ZeroAddressException(); /// @dev Thrown on attempting to call a non-implemented function error NotImplementedException(); /// @dev Thrown on attempting to set an EOA as an important contract in the system error AddressIsNotContractException(address); /// @dev Thrown on attempting to use a non-ERC20 contract or an EOA as a token error IncorrectTokenContractException(); /// @dev Thrown on attempting to set a token price feed to an address that is not a /// correct price feed error IncorrectPriceFeedException(); /// @dev Thrown on attempting to call an access restricted function as a non-Configurator error CallerNotConfiguratorException(); /// @dev Thrown on attempting to call an access restricted function as a non-Configurator error CallerNotControllerException(); /// @dev Thrown on attempting to pause a contract as a non-Pausable admin error CallerNotPausableAdminException(); /// @dev Thrown on attempting to pause a contract as a non-Unpausable admin error CallerNotUnPausableAdminException();
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; interface IPausable { function pause() external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import "../core/AddressProvider.sol"; import { IVersion } from "./IVersion.sol"; interface IPoolServiceEvents { /// @dev Emits on new liquidity being added to the pool event AddLiquidity( address indexed sender, address indexed onBehalfOf, uint256 amount, uint256 referralCode ); /// @dev Emits on liquidity being removed to the pool event RemoveLiquidity( address indexed sender, address indexed to, uint256 amount ); /// @dev Emits on a Credit Manager borrowing funds for a Credit Account event Borrow( address indexed creditManager, address indexed creditAccount, uint256 amount ); /// @dev Emits on repayment of a Credit Account's debt event Repay( address indexed creditManager, uint256 borrowedAmount, uint256 profit, uint256 loss ); /// @dev Emits on updating the interest rate model event NewInterestRateModel(address indexed newInterestRateModel); /// @dev Emits on connecting a new Credit Manager event NewCreditManagerConnected(address indexed creditManager); /// @dev Emits when a Credit Manager is forbidden to borrow event BorrowForbidden(address indexed creditManager); /// @dev Emitted when loss is incurred that can't be covered by treasury funds event UncoveredLoss(address indexed creditManager, uint256 loss); /// @dev Emits when the liquidity limit is changed event NewExpectedLiquidityLimit(uint256 newLimit); /// @dev Emits when the withdrawal fee is changed event NewWithdrawFee(uint256 fee); } /// @title Pool Service Interface /// @notice Implements business logic: /// - Adding/removing pool liquidity /// - Managing diesel tokens & diesel rates /// - Taking/repaying Credit Manager debt /// More: https://dev.gearbox.fi/developers/pool/abstractpoolservice interface IPoolService is IPoolServiceEvents, IVersion { // // LIQUIDITY MANAGEMENT // /** * @dev Adds liquidity to pool * - transfers the underlying to the pool * - mints Diesel (LP) tokens to onBehalfOf * @param amount Amount of tokens to be deposited * @param onBehalfOf The address that will receive the dToken * @param referralCode Code used to register the integrator originating the operation, for potential rewards. * 0 if the action is executed directly by the user, without a facilitator. */ function addLiquidity( uint256 amount, address onBehalfOf, uint256 referralCode ) external; /** * @dev Removes liquidity from pool * - burns LP's Diesel (LP) tokens * - returns the equivalent amount of underlying to 'to' * @param amount Amount of Diesel tokens to burn * @param to Address to transfer the underlying to */ function removeLiquidity(uint256 amount, address to) external returns (uint256); /** * @dev Lends pool funds to a Credit Account * @param borrowedAmount Credit Account's debt principal * @param creditAccount Credit Account's address */ function lendCreditAccount(uint256 borrowedAmount, address creditAccount) external; /** * @dev Repays the Credit Account's debt * @param borrowedAmount Amount of principal ro repay * @param profit The treasury profit from repayment * @param loss Amount of underlying that the CA wan't able to repay * @notice Assumes that the underlying (including principal + interest + fees) * was already transferred */ function repayCreditAccount( uint256 borrowedAmount, uint256 profit, uint256 loss ) external; // // GETTERS // /** * @dev Returns the total amount of liquidity in the pool, including borrowed and available funds */ function expectedLiquidity() external view returns (uint256); /** * @dev Returns the limit on total liquidity */ function expectedLiquidityLimit() external view returns (uint256); /** * @dev Returns the available liquidity, which is expectedLiquidity - totalBorrowed */ function availableLiquidity() external view returns (uint256); /** * @dev Calculates the current interest index, RAY format */ function calcLinearCumulative_RAY() external view returns (uint256); /** * @dev Calculates the current borrow rate, RAY format */ function borrowAPY_RAY() external view returns (uint256); /** * @dev Returns the total borrowed amount (includes principal only) */ function totalBorrowed() external view returns (uint256); /** * ç **/ function getDieselRate_RAY() external view returns (uint256); /** * @dev Returns the address of the underlying */ function underlyingToken() external view returns (address); /** * @dev Returns the address of the diesel token */ function dieselToken() external view returns (address); /** * @dev Returns the address of a Credit Manager by its id */ function creditManagers(uint256 id) external view returns (address); /** * @dev Returns the number of known Credit Managers */ function creditManagersCount() external view returns (uint256); /** * @dev Maps Credit Manager addresses to their status as a borrower. * Returns false if borrowing is not allowed. */ function creditManagersCanBorrow(address id) external view returns (bool); /// @dev Converts a quantity of the underlying to Diesel tokens function toDiesel(uint256 amount) external view returns (uint256); /// @dev Converts a quantity of Diesel tokens to the underlying function fromDiesel(uint256 amount) external view returns (uint256); /// @dev Returns the withdrawal fee function withdrawFee() external view returns (uint256); /// @dev Returns the timestamp of the pool's last update function _timestampLU() external view returns (uint256); /// @dev Returns the interest index at the last pool update function _cumulativeIndex_RAY() external view returns (uint256); /// @dev Returns the address provider function addressProvider() external view returns (AddressProvider); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; import { IVersion } from "./IVersion.sol"; interface IPriceOracleV2Events { /// @dev Emits when a new price feed is added event NewPriceFeed(address indexed token, address indexed priceFeed); } interface IPriceOracleV2Exceptions { /// @dev Thrown if a price feed returns 0 error ZeroPriceException(); /// @dev Thrown if the last recorded result was not updated in the last round error ChainPriceStaleException(); /// @dev Thrown on attempting to get a result for a token that does not have a price feed error PriceOracleNotExistsException(); } /// @title Price oracle interface interface IPriceOracleV2 is IPriceOracleV2Events, IPriceOracleV2Exceptions, IVersion { /// @dev Converts a quantity of an asset to USD (decimals = 8). /// @param amount Amount to convert /// @param token Address of the token to be converted function convertToUSD(uint256 amount, address token) external view returns (uint256); /// @dev Converts a quantity of USD (decimals = 8) to an equivalent amount of an asset /// @param amount Amount to convert /// @param token Address of the token converted to function convertFromUSD(uint256 amount, address token) external view returns (uint256); /// @dev Converts one asset into another /// /// @param amount Amount to convert /// @param tokenFrom Address of the token to convert from /// @param tokenTo Address of the token to convert to function convert( uint256 amount, address tokenFrom, address tokenTo ) external view returns (uint256); /// @dev Returns collateral values for two tokens, required for a fast check /// @param amountFrom Amount of the outbound token /// @param tokenFrom Address of the outbound token /// @param amountTo Amount of the inbound token /// @param tokenTo Address of the inbound token /// @return collateralFrom Value of the outbound token amount in USD /// @return collateralTo Value of the inbound token amount in USD function fastCheck( uint256 amountFrom, address tokenFrom, uint256 amountTo, address tokenTo ) external view returns (uint256 collateralFrom, uint256 collateralTo); /// @dev Returns token's price in USD (8 decimals) /// @param token The token to compute the price for function getPrice(address token) external view returns (uint256); /// @dev Returns the price feed address for the passed token /// @param token Token to get the price feed for function priceFeeds(address token) external view returns (address priceFeed); /// @dev Returns the price feed for the passed token, /// with additional parameters /// @param token Token to get the price feed for function priceFeedsWithFlags(address token) external view returns ( address priceFeed, bool skipCheck, uint256 decimals ); } interface IPriceOracleV2Ext is IPriceOracleV2 { /// @dev Sets a price feed if it doesn't exist, or updates an existing one /// @param token Address of the token to set the price feed for /// @param priceFeed Address of a USD price feed adhering to Chainlink's interface function addPriceFeed(address token, address priceFeed) external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; /// @title IVersion /// @dev Declares a version function which returns the contract's version interface IVersion { /// @dev Returns contract version function version() external view returns (uint256); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; interface IWETHGateway { /// @dev Converts ETH to WETH and add liqudity to the pool /// @param pool Address of PoolService contract to add liquidity to. This pool must have WETH as an underlying. /// @param onBehalfOf The address that will receive the diesel token. /// @param referralCode Code used to log the transaction facilitator, for potential rewards. 0 if non-applicable. function addLiquidityETH( address pool, address onBehalfOf, uint16 referralCode ) external payable; /// @dev Removes liquidity from the pool and converts WETH to ETH /// - burns lp's diesel (LP) tokens /// - unwraps WETH to ETH and sends to the LP /// @param pool Address of PoolService contract to withdraw liquidity from. This pool must have WETH as an underlying. /// @param amount Amount of Diesel tokens to send. /// @param to Address to transfer ETH to. function removeLiquidityETH( address pool, uint256 amount, address payable to ) external; /// @dev Converts WETH to ETH, and sends to the passed address /// @param to Address to send ETH to /// @param amount Amount of WETH to unwrap function unwrapWETH(address to, uint256 amount) external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; struct Balance { address token; uint256 balance; } library BalanceOps { error UnknownToken(address); function copyBalance(Balance memory b) internal pure returns (Balance memory) { return Balance({ token: b.token, balance: b.balance }); } function addBalance( Balance[] memory b, address token, uint256 amount ) internal pure { b[getIndex(b, token)].balance += amount; } function subBalance( Balance[] memory b, address token, uint256 amount ) internal pure { b[getIndex(b, token)].balance -= amount; } function getBalance(Balance[] memory b, address token) internal pure returns (uint256 amount) { return b[getIndex(b, token)].balance; } function setBalance( Balance[] memory b, address token, uint256 amount ) internal pure { b[getIndex(b, token)].balance = amount; } function getIndex(Balance[] memory b, address token) internal pure returns (uint256 index) { for (uint256 i; i < b.length; ) { if (b[i].token == token) { return i; } unchecked { ++i; } } revert UnknownToken(token); } function copy(Balance[] memory b, uint256 len) internal pure returns (Balance[] memory res) { res = new Balance[](len); for (uint256 i; i < len; ) { res[i] = copyBalance(b[i]); unchecked { ++i; } } } function clone(Balance[] memory b) internal pure returns (Balance[] memory) { return copy(b, b.length); } function getModifiedAfterSwap( Balance[] memory b, address tokenFrom, uint256 amountFrom, address tokenTo, uint256 amountTo ) internal pure returns (Balance[] memory res) { res = copy(b, b.length); setBalance(res, tokenFrom, getBalance(b, tokenFrom) - amountFrom); setBalance(res, tokenTo, getBalance(b, tokenTo) + amountTo); } }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; // Denominations uint256 constant WAD = 1e18; uint256 constant RAY = 1e27; // 25% of type(uint256).max uint256 constant ALLOWANCE_THRESHOLD = type(uint96).max >> 3; // FEE = 50% uint16 constant DEFAULT_FEE_INTEREST = 50_00; // 50% // LIQUIDATION_FEE 1.5% uint16 constant DEFAULT_FEE_LIQUIDATION = 1_50; // 1.5% // LIQUIDATION PREMIUM 4% uint16 constant DEFAULT_LIQUIDATION_PREMIUM = 4_00; // 4% // LIQUIDATION_FEE_EXPIRED 2% uint16 constant DEFAULT_FEE_LIQUIDATION_EXPIRED = 1_00; // 2% // LIQUIDATION PREMIUM EXPIRED 2% uint16 constant DEFAULT_LIQUIDATION_PREMIUM_EXPIRED = 2_00; // 2% // DEFAULT PROPORTION OF MAX BORROWED PER BLOCK TO MAX BORROWED PER ACCOUNT uint16 constant DEFAULT_LIMIT_PER_BLOCK_MULTIPLIER = 2; // Seconds in a year uint256 constant SECONDS_PER_YEAR = 365 days; uint256 constant SECONDS_PER_ONE_AND_HALF_YEAR = (SECONDS_PER_YEAR * 3) / 2; // OPERATIONS // Leverage decimals - 100 is equal to 2x leverage (100% * collateral amount + 100% * borrowed amount) uint8 constant LEVERAGE_DECIMALS = 100; // Maximum withdraw fee for pool in PERCENTAGE_FACTOR format uint8 constant MAX_WITHDRAW_FEE = 100; uint256 constant EXACT_INPUT = 1; uint256 constant EXACT_OUTPUT = 2; address constant UNIVERSAL_CONTRACT = 0xCcCCccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC;
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2022 pragma solidity ^0.8.10; /// @title Errors library library Errors { // // COMMON // string public constant ZERO_ADDRESS_IS_NOT_ALLOWED = "Z0"; string public constant NOT_IMPLEMENTED = "NI"; string public constant INCORRECT_PATH_LENGTH = "PL"; string public constant INCORRECT_ARRAY_LENGTH = "CR"; string public constant REGISTERED_CREDIT_ACCOUNT_MANAGERS_ONLY = "CP"; string public constant REGISTERED_POOLS_ONLY = "RP"; string public constant INCORRECT_PARAMETER = "IP"; // // MATH // string public constant MATH_MULTIPLICATION_OVERFLOW = "M1"; string public constant MATH_ADDITION_OVERFLOW = "M2"; string public constant MATH_DIVISION_BY_ZERO = "M3"; // // POOL // string public constant POOL_CONNECTED_CREDIT_MANAGERS_ONLY = "PS0"; string public constant POOL_INCOMPATIBLE_CREDIT_ACCOUNT_MANAGER = "PS1"; string public constant POOL_MORE_THAN_EXPECTED_LIQUIDITY_LIMIT = "PS2"; string public constant POOL_INCORRECT_WITHDRAW_FEE = "PS3"; string public constant POOL_CANT_ADD_CREDIT_MANAGER_TWICE = "PS4"; // // ACCOUNT FACTORY // string public constant AF_CANT_CLOSE_CREDIT_ACCOUNT_IN_THE_SAME_BLOCK = "AF1"; string public constant AF_MINING_IS_FINISHED = "AF2"; string public constant AF_CREDIT_ACCOUNT_NOT_IN_STOCK = "AF3"; string public constant AF_EXTERNAL_ACCOUNTS_ARE_FORBIDDEN = "AF4"; // // ADDRESS PROVIDER // string public constant AS_ADDRESS_NOT_FOUND = "AP1"; // // CONTRACTS REGISTER // string public constant CR_POOL_ALREADY_ADDED = "CR1"; string public constant CR_CREDIT_MANAGER_ALREADY_ADDED = "CR2"; // // CREDIT ACCOUNT // string public constant CA_CONNECTED_CREDIT_MANAGER_ONLY = "CA1"; string public constant CA_FACTORY_ONLY = "CA2"; // // ACL // string public constant ACL_CALLER_NOT_PAUSABLE_ADMIN = "ACL1"; string public constant ACL_CALLER_NOT_CONFIGURATOR = "ACL2"; // // WETH GATEWAY // string public constant WG_DESTINATION_IS_NOT_WETH_COMPATIBLE = "WG1"; string public constant WG_RECEIVE_IS_NOT_ALLOWED = "WG2"; string public constant WG_NOT_ENOUGH_FUNDS = "WG3"; // // TOKEN DISTRIBUTOR // string public constant TD_WALLET_IS_ALREADY_CONNECTED_TO_VC = "TD1"; string public constant TD_INCORRECT_WEIGHTS = "TD2"; string public constant TD_NON_ZERO_BALANCE_AFTER_DISTRIBUTION = "TD3"; string public constant TD_CONTRIBUTOR_IS_NOT_REGISTERED = "TD4"; }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; struct MultiCall { address target; bytes callData; } library MultiCallOps { function copyMulticall(MultiCall memory call) internal pure returns (MultiCall memory) { return MultiCall({ target: call.target, callData: call.callData }); } function trim(MultiCall[] memory calls) internal pure returns (MultiCall[] memory trimmed) { uint256 len = calls.length; if (len == 0) return calls; uint256 foundLen; while (calls[foundLen].target != address(0)) { unchecked { ++foundLen; if (foundLen == len) return calls; } } if (foundLen > 0) return copy(calls, foundLen); } function copy(MultiCall[] memory calls, uint256 len) internal pure returns (MultiCall[] memory res) { res = new MultiCall[](len); for (uint256 i; i < len; ) { res[i] = copyMulticall(calls[i]); unchecked { ++i; } } } function clone(MultiCall[] memory calls) internal pure returns (MultiCall[] memory res) { return copy(calls, calls.length); } function append(MultiCall[] memory calls, MultiCall memory newCall) internal pure returns (MultiCall[] memory res) { uint256 len = calls.length; res = new MultiCall[](len + 1); for (uint256 i; i < len; ) { res[i] = copyMulticall(calls[i]); unchecked { ++i; } } res[len] = copyMulticall(newCall); } function prepend(MultiCall[] memory calls, MultiCall memory newCall) internal pure returns (MultiCall[] memory res) { uint256 len = calls.length; res = new MultiCall[](len + 1); res[0] = copyMulticall(newCall); for (uint256 i = 1; i < len + 1; ) { res[i] = copyMulticall(calls[i]); unchecked { ++i; } } } function concat(MultiCall[] memory calls1, MultiCall[] memory calls2) internal pure returns (MultiCall[] memory res) { uint256 len1 = calls1.length; uint256 lenTotal = len1 + calls2.length; if (lenTotal == calls1.length) return clone(calls1); if (lenTotal == calls2.length) return clone(calls2); res = new MultiCall[](lenTotal); for (uint256 i; i < lenTotal; ) { res[i] = (i < len1) ? copyMulticall(calls1[i]) : copyMulticall(calls2[i - len1]); unchecked { ++i; } } } }
// SPDX-License-Identifier: agpl-3.0 pragma solidity ^0.8.10; import { Errors } from "./Errors.sol"; uint16 constant PERCENTAGE_FACTOR = 1e4; //percentage plus two decimals uint256 constant HALF_PERCENT = PERCENTAGE_FACTOR / 2; /** * @title PercentageMath library * @author Aave * @notice Provides functions to perform percentage calculations * @dev Percentages are defined by default with 2 decimals of precision (100.00). The precision is indicated by PERCENTAGE_FACTOR * @dev Operations are rounded half up **/ library PercentageMath { /** * @dev Executes a percentage multiplication * @param value The value of which the percentage needs to be calculated * @param percentage The percentage of the value to be calculated * @return The percentage of value **/ function percentMul(uint256 value, uint256 percentage) internal pure returns (uint256) { if (value == 0 || percentage == 0) { return 0; // T:[PM-1] } // require( // value <= (type(uint256).max - HALF_PERCENT) / percentage, // Errors.MATH_MULTIPLICATION_OVERFLOW // ); // T:[PM-1] return (value * percentage + HALF_PERCENT) / PERCENTAGE_FACTOR; // T:[PM-1] } /** * @dev Executes a percentage division * @param value The value of which the percentage needs to be calculated * @param percentage The percentage of the value to be calculated * @return The value divided the percentage **/ function percentDiv(uint256 value, uint256 percentage) internal pure returns (uint256) { require(percentage != 0, Errors.MATH_DIVISION_BY_ZERO); // T:[PM-2] uint256 halfPercentage = percentage / 2; // T:[PM-2] // require( // value <= (type(uint256).max - halfPercentage) / PERCENTAGE_FACTOR, // Errors.MATH_MULTIPLICATION_OVERFLOW // ); // T:[PM-2] return (value * PERCENTAGE_FACTOR + halfPercentage) / percentage; } }
// SPDX-License-Identifier: GPL-2.0-or-later // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2023 pragma solidity ^0.8.17; import {AbstractAdapter} from "@gearbox-protocol/core-v2/contracts/adapters/AbstractAdapter.sol";
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol"; interface IBaseRewardPool { // // STATE CHANGING FUNCTIONS // function stake(uint256 _amount) external returns (bool); function stakeAll() external returns (bool); function stakeFor(address _for, uint256 _amount) external returns (bool); function withdraw(uint256 amount, bool claim) external returns (bool); function withdrawAll(bool claim) external; function withdrawAndUnwrap(uint256 amount, bool claim) external returns (bool); function withdrawAllAndUnwrap(bool claim) external; function getReward(address _account, bool _claimExtras) external returns (bool); function getReward() external returns (bool); function donate(uint256 _amount) external returns (bool); // // GETTERS // function earned(address account) external view returns (uint256); function totalSupply() external view returns (uint256); function balanceOf(address account) external view returns (uint256); function extraRewardsLength() external view returns (uint256); function lastTimeRewardApplicable() external view returns (uint256); function rewardPerToken() external view returns (uint256); function rewardToken() external view returns (IERC20); function stakingToken() external view returns (IERC20); function duration() external view returns (uint256); function operator() external view returns (address); function rewardManager() external view returns (address); function pid() external view returns (uint256); function periodFinish() external view returns (uint256); function rewardRate() external view returns (uint256); function lastUpdateTime() external view returns (uint256); function rewardPerTokenStored() external view returns (uint256); function queuedRewards() external view returns (uint256); function currentRewards() external view returns (uint256); function historicalRewards() external view returns (uint256); function newRewardRatio() external view returns (uint256); function userRewardPerTokenPaid(address account) external view returns (uint256); function rewards(address account) external view returns (uint256); function extraRewards(uint256 i) external view returns (address); }
// SPDX-License-Identifier: MIT pragma solidity ^0.8.10; interface IBooster { struct PoolInfo { address lptoken; address token; address gauge; address crvRewards; address stash; bool shutdown; } function deposit(uint256 _pid, uint256 _amount, bool _stake) external returns (bool); function depositAll(uint256 _pid, bool _stake) external returns (bool); function withdraw(uint256 _pid, uint256 _amount) external returns (bool); function withdrawAll(uint256 _pid) external returns (bool); // function earmarkRewards(uint256 _pid) external returns (bool); // function earmarkFees() external returns (bool); // // GETTERS // function poolInfo(uint256 i) external view returns (PoolInfo memory); function poolLength() external view returns (uint256); function staker() external view returns (address); function minter() external view returns (address); function crv() external view returns (address); function registry() external view returns (address); function stakerRewards() external view returns (address); function lockRewards() external view returns (address); function lockFees() external view returns (address); }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2023 pragma solidity ^0.8.17; import {IAdapter} from "../IAdapter.sol"; /// @title Convex V1 BaseRewardPool adapter interface /// @notice Implements logic for interacting with Convex reward pool interface IConvexV1BaseRewardPoolAdapter is IAdapter { /// @notice Address of a Curve LP token deposited into the Convex pool function curveLPtoken() external view returns (address); /// @notice Address of a Convex LP token staked in the reward pool function stakingToken() external view returns (address); /// @notice Address of a phantom token representing account's stake in the reward pool function stakedPhantomToken() external view returns (address); /// @notice Collateral token mask of a Curve LP token in the credit manager function curveLPTokenMask() external view returns (uint256); /// @notice Collateral token mask of a Convex LP token in the credit manager function stakingTokenMask() external view returns (uint256); /// @notice Collateral token mask of a reward pool stake token function stakedTokenMask() external view returns (uint256); /// @notice Bitmask of all reward tokens of the pool (CRV, CVX, extra reward tokens, if any) in the credit manager function rewardTokensMask() external view returns (uint256); /// @notice Stakes Convex LP token in the reward pool /// @dev `amount` parameter is ignored since calldata is passed directly to the target contract function stake(uint256) external; /// @notice Stakes the entire balance of Convex LP token in the reward pool, disables LP token function stakeAll() external; /// @notice Claims rewards on the current position, enables reward tokens function getReward() external; /// @notice Withdraws Convex LP token from the reward pool /// @param claim Whether to claim staking rewards /// @dev `amount` parameter is ignored since calldata is passed directly to the target contract function withdraw(uint256, bool claim) external; /// @notice Withdraws the entire balance of Convex LP token from the reward pool, disables staked token /// @param claim Whether to claim staking rewards function withdrawAll(bool claim) external; /// @notice Withdraws Convex LP token from the reward pool and unwraps it into Curve LP token /// @param claim Whether to claim staking rewards /// @dev `amount` parameter is ignored since calldata is passed directly to the target contract function withdrawAndUnwrap(uint256, bool claim) external; /// @notice Withdraws the entire balance of Convex LP token from the reward pool and unwraps it into Curve LP token, /// disables staked token /// @param claim Whether to claim staking rewards function withdrawAllAndUnwrap(bool claim) external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2023 pragma solidity ^0.8.17; import {IAdapter} from "../IAdapter.sol"; /// @title Convex V1 Booster adapter interface /// @notice Implements logic allowing CAs to interact with Convex Booster interface IConvexV1BoosterAdapter is IAdapter { /// @notice Maps pool ID to phantom token representing staked position function pidToPhantomToken(uint256) external view returns (address); /// @notice Deposits Curve LP tokens into Booster /// @param _pid ID of the pool to deposit to /// @param _stake Whether to stake Convex LP tokens in the rewards pool /// @dev `_amount` parameter is ignored since calldata is passed directly to the target contract function deposit(uint256 _pid, uint256, bool _stake) external; /// @notice Deposits the entire balance of Curve LP tokens into Booster, disables Curve LP token /// @param _pid ID of the pool to deposit to /// @param _stake Whether to stake Convex LP tokens in the rewards pool function depositAll(uint256 _pid, bool _stake) external; /// @notice Withdraws Curve LP tokens from Booster /// @param _pid ID of the pool to withdraw from /// @dev `_amount` parameter is ignored since calldata is passed directly to the target contract function withdraw(uint256 _pid, uint256) external; /// @notice Withdraws all Curve LP tokens from Booster, disables Convex LP token /// @param _pid ID of the pool to withdraw from /// @dev `_amount` parameter is ignored since calldata is passed directly to the target contract function withdrawAll(uint256 _pid) external; /// @notice Updates the mapping of pool IDs to phantom staked token addresses function updateStakedPhantomTokensMap() external; }
// SPDX-License-Identifier: MIT // Gearbox Protocol. Generalized leverage for DeFi protocols // (c) Gearbox Holdings, 2023 pragma solidity ^0.8.17; import {IAdapter, AdapterType} from "@gearbox-protocol/core-v2/contracts/interfaces/adapters/IAdapter.sol";
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (access/Ownable.sol) pragma solidity ^0.8.0; import "../utils/Context.sol"; /** * @dev Contract module which provides a basic access control mechanism, where * there is an account (an owner) that can be granted exclusive access to * specific functions. * * By default, the owner account will be the one that deploys the contract. This * can later be changed with {transferOwnership}. * * This module is used through inheritance. It will make available the modifier * `onlyOwner`, which can be applied to your functions to restrict their use to * the owner. */ abstract contract Ownable is Context { address private _owner; event OwnershipTransferred(address indexed previousOwner, address indexed newOwner); /** * @dev Initializes the contract setting the deployer as the initial owner. */ constructor() { _transferOwnership(_msgSender()); } /** * @dev Throws if called by any account other than the owner. */ modifier onlyOwner() { _checkOwner(); _; } /** * @dev Returns the address of the current owner. */ function owner() public view virtual returns (address) { return _owner; } /** * @dev Throws if the sender is not the owner. */ function _checkOwner() internal view virtual { require(owner() == _msgSender(), "Ownable: caller is not the owner"); } /** * @dev Leaves the contract without owner. It will not be possible to call * `onlyOwner` functions anymore. Can only be called by the current owner. * * NOTE: Renouncing ownership will leave the contract without an owner, * thereby removing any functionality that is only available to the owner. */ 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 { require(newOwner != address(0), "Ownable: new owner is the zero address"); _transferOwnership(newOwner); } /** * @dev Transfers ownership of the contract to a new account (`newOwner`). * Internal function without access restriction. */ function _transferOwnership(address newOwner) internal virtual { address oldOwner = _owner; _owner = newOwner; emit OwnershipTransferred(oldOwner, newOwner); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.7.0) (security/Pausable.sol) pragma solidity ^0.8.0; import "../utils/Context.sol"; /** * @dev Contract module which allows children to implement an emergency stop * mechanism that can be triggered by an authorized account. * * This module is used through inheritance. It will make available the * modifiers `whenNotPaused` and `whenPaused`, which can be applied to * the functions of your contract. Note that they will not be pausable by * simply including this module, only once the modifiers are put in place. */ abstract contract Pausable is Context { /** * @dev Emitted when the pause is triggered by `account`. */ event Paused(address account); /** * @dev Emitted when the pause is lifted by `account`. */ event Unpaused(address account); bool private _paused; /** * @dev Initializes the contract in unpaused state. */ constructor() { _paused = false; } /** * @dev Modifier to make a function callable only when the contract is not paused. * * Requirements: * * - The contract must not be paused. */ modifier whenNotPaused() { _requireNotPaused(); _; } /** * @dev Modifier to make a function callable only when the contract is paused. * * Requirements: * * - The contract must be paused. */ modifier whenPaused() { _requirePaused(); _; } /** * @dev Returns true if the contract is paused, and false otherwise. */ function paused() public view virtual returns (bool) { return _paused; } /** * @dev Throws if the contract is paused. */ function _requireNotPaused() internal view virtual { require(!paused(), "Pausable: paused"); } /** * @dev Throws if the contract is not paused. */ function _requirePaused() internal view virtual { require(paused(), "Pausable: not paused"); } /** * @dev Triggers stopped state. * * Requirements: * * - The contract must not be paused. */ function _pause() internal virtual whenNotPaused { _paused = true; emit Paused(_msgSender()); } /** * @dev Returns to normal state. * * Requirements: * * - The contract must be paused. */ function _unpause() internal virtual whenPaused { _paused = false; emit Unpaused(_msgSender()); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.0) (security/ReentrancyGuard.sol) pragma solidity ^0.8.0; /** * @dev Contract module that helps prevent reentrant calls to a function. * * Inheriting from `ReentrancyGuard` will make the {nonReentrant} modifier * available, which can be applied to functions to make sure there are no nested * (reentrant) calls to them. * * Note that because there is a single `nonReentrant` guard, functions marked as * `nonReentrant` may not call one another. This can be worked around by making * those functions `private`, and then adding `external` `nonReentrant` entry * points to them. * * TIP: If you would like to learn more about reentrancy and alternative ways * to protect against it, check out our blog post * https://blog.openzeppelin.com/reentrancy-after-istanbul/[Reentrancy After Istanbul]. */ abstract contract ReentrancyGuard { // Booleans are more expensive than uint256 or any type that takes up a full // word because each write operation emits an extra SLOAD to first read the // slot's contents, replace the bits taken up by the boolean, and then write // back. This is the compiler's defense against contract upgrades and // pointer aliasing, and it cannot be disabled. // The values being non-zero value makes deployment a bit more expensive, // but in exchange the refund on every call to nonReentrant will be lower in // amount. Since refunds are capped to a percentage of the total // transaction's gas, it is best to keep them low in cases like this one, to // increase the likelihood of the full refund coming into effect. uint256 private constant _NOT_ENTERED = 1; uint256 private constant _ENTERED = 2; uint256 private _status; constructor() { _status = _NOT_ENTERED; } /** * @dev Prevents a contract from calling itself, directly or indirectly. * Calling a `nonReentrant` function from another `nonReentrant` * function is not supported. It is possible to prevent this from happening * by making the `nonReentrant` function external, and making it call a * `private` function that does the actual work. */ modifier nonReentrant() { _nonReentrantBefore(); _; _nonReentrantAfter(); } function _nonReentrantBefore() private { // On the first call to nonReentrant, _status will be _NOT_ENTERED require(_status != _ENTERED, "ReentrancyGuard: reentrant call"); // Any calls to nonReentrant after this point will fail _status = _ENTERED; } function _nonReentrantAfter() private { // By storing the original value once again, a refund is triggered (see // https://eips.ethereum.org/EIPS/eip-2200) _status = _NOT_ENTERED; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC20/extensions/draft-IERC20Permit.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 Permit extension allowing approvals to be made via signatures, as defined in * https://eips.ethereum.org/EIPS/eip-2612[EIP-2612]. * * Adds the {permit} method, which can be used to change an account's ERC20 allowance (see {IERC20-allowance}) by * presenting a message signed by the account. By not relying on {IERC20-approve}, the token holder account doesn't * need to send a transaction, and thus is not required to hold Ether at all. */ interface IERC20Permit { /** * @dev Sets `value` as the allowance of `spender` over ``owner``'s tokens, * given ``owner``'s signed approval. * * IMPORTANT: The same issues {IERC20-approve} has related to transaction * ordering also apply here. * * Emits an {Approval} event. * * Requirements: * * - `spender` cannot be the zero address. * - `deadline` must be a timestamp in the future. * - `v`, `r` and `s` must be a valid `secp256k1` signature from `owner` * over the EIP712-formatted function arguments. * - the signature must use ``owner``'s current nonce (see {nonces}). * * For more information on the signature format, see the * https://eips.ethereum.org/EIPS/eip-2612#specification[relevant EIP * section]. */ function permit( address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) external; /** * @dev Returns the current nonce for `owner`. This value must be * included whenever a signature is generated for {permit}. * * Every successful call to {permit} increases ``owner``'s nonce by one. This * prevents a signature from being used multiple times. */ function nonces(address owner) external view returns (uint256); /** * @dev Returns the domain separator used in the encoding of the signature for {permit}, as defined by {EIP712}. */ // solhint-disable-next-line func-name-mixedcase function DOMAIN_SEPARATOR() external view returns (bytes32); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.6.0) (token/ERC20/IERC20.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC20 standard as defined in the EIP. */ 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 amount of tokens in existence. */ function totalSupply() external view returns (uint256); /** * @dev Returns the amount of tokens owned by `account`. */ function balanceOf(address account) external view returns (uint256); /** * @dev Moves `amount` tokens from the caller's account to `to`. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transfer(address to, uint256 amount) 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 `amount` as the allowance of `spender` over the caller's tokens. * * Returns a boolean value indicating whether the operation succeeded. * * IMPORTANT: Beware that changing an allowance with this method brings the risk * that someone may use both the old and the new allowance by unfortunate * transaction ordering. One possible solution to mitigate this race * condition is to first reduce the spender's allowance to 0 and set the * desired value afterwards: * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729 * * Emits an {Approval} event. */ function approve(address spender, uint256 amount) external returns (bool); /** * @dev Moves `amount` tokens from `from` to `to` using the * allowance mechanism. `amount` is then deducted from the caller's * allowance. * * Returns a boolean value indicating whether the operation succeeded. * * Emits a {Transfer} event. */ function transferFrom( address from, address to, uint256 amount ) external returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.0) (token/ERC20/utils/SafeERC20.sol) pragma solidity ^0.8.0; import "../IERC20.sol"; import "../extensions/draft-IERC20Permit.sol"; import "../../../utils/Address.sol"; /** * @title SafeERC20 * @dev Wrappers around ERC20 operations that throw on failure (when the token * contract returns false). Tokens that return no value (and instead revert or * throw on failure) are also supported, non-reverting calls are assumed to be * successful. * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract, * which allows you to call the safe operations as `token.safeTransfer(...)`, etc. */ library SafeERC20 { using Address for address; function safeTransfer( IERC20 token, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value)); } function safeTransferFrom( IERC20 token, address from, address to, uint256 value ) internal { _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value)); } /** * @dev Deprecated. This function has issues similar to the ones found in * {IERC20-approve}, and its usage is discouraged. * * Whenever possible, use {safeIncreaseAllowance} and * {safeDecreaseAllowance} instead. */ function safeApprove( IERC20 token, address spender, uint256 value ) internal { // safeApprove should only be called when setting an initial allowance, // or when resetting it to zero. To increase and decrease it, use // 'safeIncreaseAllowance' and 'safeDecreaseAllowance' require( (value == 0) || (token.allowance(address(this), spender) == 0), "SafeERC20: approve from non-zero to non-zero allowance" ); _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value)); } function safeIncreaseAllowance( IERC20 token, address spender, uint256 value ) internal { uint256 newAllowance = token.allowance(address(this), spender) + value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } function safeDecreaseAllowance( IERC20 token, address spender, uint256 value ) internal { unchecked { uint256 oldAllowance = token.allowance(address(this), spender); require(oldAllowance >= value, "SafeERC20: decreased allowance below zero"); uint256 newAllowance = oldAllowance - value; _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance)); } } function safePermit( IERC20Permit token, address owner, address spender, uint256 value, uint256 deadline, uint8 v, bytes32 r, bytes32 s ) internal { uint256 nonceBefore = token.nonces(owner); token.permit(owner, spender, value, deadline, v, r, s); uint256 nonceAfter = token.nonces(owner); require(nonceAfter == nonceBefore + 1, "SafeERC20: permit did not succeed"); } /** * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement * on the return value: the return value is optional (but if data is returned, it must not be false). * @param token The token targeted by the call. * @param data The call data (encoded using abi.encode or one of its variants). */ function _callOptionalReturn(IERC20 token, 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, "SafeERC20: low-level call failed"); if (returndata.length > 0) { // Return data is optional require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed"); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (token/ERC721/extensions/IERC721Metadata.sol) pragma solidity ^0.8.0; import "../IERC721.sol"; /** * @title ERC-721 Non-Fungible Token Standard, optional metadata extension * @dev See https://eips.ethereum.org/EIPS/eip-721 */ interface IERC721Metadata is IERC721 { /** * @dev Returns the token collection name. */ function name() external view returns (string memory); /** * @dev Returns the token collection symbol. */ function symbol() external view returns (string memory); /** * @dev Returns the Uniform Resource Identifier (URI) for `tokenId` token. */ function tokenURI(uint256 tokenId) external view returns (string memory); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.0) (token/ERC721/IERC721.sol) pragma solidity ^0.8.0; import "../../utils/introspection/IERC165.sol"; /** * @dev Required interface of an ERC721 compliant contract. */ interface IERC721 is IERC165 { /** * @dev Emitted when `tokenId` token is transferred from `from` to `to`. */ event Transfer(address indexed from, address indexed to, uint256 indexed tokenId); /** * @dev Emitted when `owner` enables `approved` to manage the `tokenId` token. */ event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId); /** * @dev Emitted when `owner` enables or disables (`approved`) `operator` to manage all of its assets. */ event ApprovalForAll(address indexed owner, address indexed operator, bool approved); /** * @dev Returns the number of tokens in ``owner``'s account. */ function balanceOf(address owner) external view returns (uint256 balance); /** * @dev Returns the owner of the `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function ownerOf(uint256 tokenId) external view returns (address owner); /** * @dev Safely transfers `tokenId` token from `from` to `to`. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function safeTransferFrom( address from, address to, uint256 tokenId, bytes calldata data ) external; /** * @dev Safely transfers `tokenId` token from `from` to `to`, checking first that contract recipients * are aware of the ERC721 protocol to prevent tokens from being forever locked. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must exist and be owned by `from`. * - If the caller is not `from`, it must have been allowed to move this token by either {approve} or {setApprovalForAll}. * - If `to` refers to a smart contract, it must implement {IERC721Receiver-onERC721Received}, which is called upon a safe transfer. * * Emits a {Transfer} event. */ function safeTransferFrom( address from, address to, uint256 tokenId ) external; /** * @dev Transfers `tokenId` token from `from` to `to`. * * WARNING: Note that the caller is responsible to confirm that the recipient is capable of receiving ERC721 * or else they may be permanently lost. Usage of {safeTransferFrom} prevents loss, though the caller must * understand this adds an external call which potentially creates a reentrancy vulnerability. * * Requirements: * * - `from` cannot be the zero address. * - `to` cannot be the zero address. * - `tokenId` token must be owned by `from`. * - If the caller is not `from`, it must be approved to move this token by either {approve} or {setApprovalForAll}. * * Emits a {Transfer} event. */ function transferFrom( address from, address to, uint256 tokenId ) external; /** * @dev Gives permission to `to` to transfer `tokenId` token to another account. * The approval is cleared when the token is transferred. * * Only a single account can be approved at a time, so approving the zero address clears previous approvals. * * Requirements: * * - The caller must own the token or be an approved operator. * - `tokenId` must exist. * * Emits an {Approval} event. */ function approve(address to, uint256 tokenId) external; /** * @dev Approve or remove `operator` as an operator for the caller. * Operators can call {transferFrom} or {safeTransferFrom} for any token owned by the caller. * * Requirements: * * - The `operator` cannot be the caller. * * Emits an {ApprovalForAll} event. */ function setApprovalForAll(address operator, bool _approved) external; /** * @dev Returns the account approved for `tokenId` token. * * Requirements: * * - `tokenId` must exist. */ function getApproved(uint256 tokenId) external view returns (address operator); /** * @dev Returns if the `operator` is allowed to manage all of the assets of `owner`. * * See {setApprovalForAll} */ function isApprovedForAll(address owner, address operator) external view returns (bool); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.0) (utils/Address.sol) pragma solidity ^0.8.1; /** * @dev Collection of functions related to the address type */ library Address { /** * @dev Returns true if `account` is a contract. * * [IMPORTANT] * ==== * It is unsafe to assume that an address for which this function returns * false is an externally-owned account (EOA) and not a contract. * * Among others, `isContract` will return false for the following * types of addresses: * * - an externally-owned account * - a contract in construction * - an address where a contract will be created * - an address where a contract lived, but was destroyed * ==== * * [IMPORTANT] * ==== * You shouldn't rely on `isContract` to protect against flash loan attacks! * * Preventing calls from contracts is highly discouraged. It breaks composability, breaks support for smart wallets * like Gnosis Safe, and does not provide security since it can be circumvented by calling from a contract * constructor. * ==== */ function isContract(address account) internal view returns (bool) { // This method relies on extcodesize/address.code.length, which returns 0 // for contracts in construction, since the code is only stored at the end // of the constructor execution. return account.code.length > 0; } /** * @dev Replacement for Solidity's `transfer`: sends `amount` wei to * `recipient`, forwarding all available gas and reverting on errors. * * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost * of certain opcodes, possibly making contracts go over the 2300 gas limit * imposed by `transfer`, making them unable to receive funds via * `transfer`. {sendValue} removes this limitation. * * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more]. * * IMPORTANT: because control is transferred to `recipient`, care must be * taken to not create reentrancy vulnerabilities. Consider using * {ReentrancyGuard} or the * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern]. */ function sendValue(address payable recipient, uint256 amount) internal { require(address(this).balance >= amount, "Address: insufficient balance"); (bool success, ) = recipient.call{value: amount}(""); require(success, "Address: unable to send value, recipient may have reverted"); } /** * @dev Performs a Solidity function call using a low level `call`. A * plain `call` is an unsafe replacement for a function call: use this * function instead. * * If `target` reverts with a revert reason, it is bubbled up by this * function (like regular Solidity function calls). * * Returns the raw returned data. To convert to the expected return value, * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`]. * * Requirements: * * - `target` must be a contract. * - calling `target` with `data` must not revert. * * _Available since v3.1._ */ function functionCall(address target, bytes memory data) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, "Address: low-level call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with * `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { return functionCallWithValue(target, data, 0, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but also transferring `value` wei to `target`. * * Requirements: * * - the calling contract must have an ETH balance of at least `value`. * - the called Solidity function must be `payable`. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value ) internal returns (bytes memory) { return functionCallWithValue(target, data, value, "Address: low-level call with value failed"); } /** * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but * with `errorMessage` as a fallback revert reason when `target` reverts. * * _Available since v3.1._ */ function functionCallWithValue( address target, bytes memory data, uint256 value, string memory errorMessage ) internal returns (bytes memory) { require(address(this).balance >= value, "Address: insufficient balance for call"); (bool success, bytes memory returndata) = target.call{value: value}(data); return verifyCallResultFromTarget(target, success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) { return functionStaticCall(target, data, "Address: low-level static call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a static call. * * _Available since v3.3._ */ function functionStaticCall( address target, bytes memory data, string memory errorMessage ) internal view returns (bytes memory) { (bool success, bytes memory returndata) = target.staticcall(data); return verifyCallResultFromTarget(target, success, returndata, errorMessage); } /** * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) { return functionDelegateCall(target, data, "Address: low-level delegate call failed"); } /** * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`], * but performing a delegate call. * * _Available since v3.4._ */ function functionDelegateCall( address target, bytes memory data, string memory errorMessage ) internal returns (bytes memory) { (bool success, bytes memory returndata) = target.delegatecall(data); return verifyCallResultFromTarget(target, success, returndata, errorMessage); } /** * @dev Tool to verify that a low level call to smart-contract was successful, and revert (either by bubbling * the revert reason or using the provided one) in case of unsuccessful call or if target was not a contract. * * _Available since v4.8._ */ function verifyCallResultFromTarget( address target, bool success, bytes memory returndata, string memory errorMessage ) internal view returns (bytes memory) { if (success) { if (returndata.length == 0) { // only check isContract if the call was successful and the return data is empty // otherwise we already know that it was a contract require(isContract(target), "Address: call to non-contract"); } return returndata; } else { _revert(returndata, errorMessage); } } /** * @dev Tool to verify that a low level call was successful, and revert if it wasn't, either by bubbling the * revert reason or using the provided one. * * _Available since v4.3._ */ function verifyCallResult( bool success, bytes memory returndata, string memory errorMessage ) internal pure returns (bytes memory) { if (success) { return returndata; } else { _revert(returndata, errorMessage); } } function _revert(bytes memory returndata, string memory errorMessage) 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(errorMessage); } } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/Context.sol) pragma solidity ^0.8.0; /** * @dev Provides information about the current execution context, including the * sender of the transaction and its data. While these are generally available * via msg.sender and msg.data, they should not be accessed in such a direct * manner, since when dealing with meta-transactions the account sending and * paying for execution may not be the actual sender (as far as an application * is concerned). * * This contract is only required for intermediate, library-like contracts. */ abstract contract Context { function _msgSender() internal view virtual returns (address) { return msg.sender; } function _msgData() internal view virtual returns (bytes calldata) { return msg.data; } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts v4.4.1 (utils/introspection/IERC165.sol) pragma solidity ^0.8.0; /** * @dev Interface of the ERC165 standard, as defined in the * https://eips.ethereum.org/EIPS/eip-165[EIP]. * * Implementers can declare support of contract interfaces, which can then be * queried by others ({ERC165Checker}). * * For an implementation, see {ERC165}. */ 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[EIP 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); }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.0) (utils/math/SafeCast.sol) // This file was procedurally generated from scripts/generate/templates/SafeCast.js. pragma solidity ^0.8.0; /** * @dev Wrappers over Solidity's uintXX/intXX casting operators with added overflow * checks. * * Downcasting from uint256/int256 in Solidity does not revert on overflow. This can * easily result in undesired exploitation or bugs, since developers usually * assume that overflows raise errors. `SafeCast` restores this intuition by * reverting the transaction when such an operation overflows. * * Using this library instead of the unchecked operations eliminates an entire * class of bugs, so it's recommended to use it always. * * Can be combined with {SafeMath} and {SignedSafeMath} to extend it to smaller types, by performing * all math on `uint256` and `int256` and then downcasting. */ library SafeCast { /** * @dev Returns the downcasted uint248 from uint256, reverting on * overflow (when the input is greater than largest uint248). * * Counterpart to Solidity's `uint248` operator. * * Requirements: * * - input must fit into 248 bits * * _Available since v4.7._ */ function toUint248(uint256 value) internal pure returns (uint248) { require(value <= type(uint248).max, "SafeCast: value doesn't fit in 248 bits"); return uint248(value); } /** * @dev Returns the downcasted uint240 from uint256, reverting on * overflow (when the input is greater than largest uint240). * * Counterpart to Solidity's `uint240` operator. * * Requirements: * * - input must fit into 240 bits * * _Available since v4.7._ */ function toUint240(uint256 value) internal pure returns (uint240) { require(value <= type(uint240).max, "SafeCast: value doesn't fit in 240 bits"); return uint240(value); } /** * @dev Returns the downcasted uint232 from uint256, reverting on * overflow (when the input is greater than largest uint232). * * Counterpart to Solidity's `uint232` operator. * * Requirements: * * - input must fit into 232 bits * * _Available since v4.7._ */ function toUint232(uint256 value) internal pure returns (uint232) { require(value <= type(uint232).max, "SafeCast: value doesn't fit in 232 bits"); return uint232(value); } /** * @dev Returns the downcasted uint224 from uint256, reverting on * overflow (when the input is greater than largest uint224). * * Counterpart to Solidity's `uint224` operator. * * Requirements: * * - input must fit into 224 bits * * _Available since v4.2._ */ function toUint224(uint256 value) internal pure returns (uint224) { require(value <= type(uint224).max, "SafeCast: value doesn't fit in 224 bits"); return uint224(value); } /** * @dev Returns the downcasted uint216 from uint256, reverting on * overflow (when the input is greater than largest uint216). * * Counterpart to Solidity's `uint216` operator. * * Requirements: * * - input must fit into 216 bits * * _Available since v4.7._ */ function toUint216(uint256 value) internal pure returns (uint216) { require(value <= type(uint216).max, "SafeCast: value doesn't fit in 216 bits"); return uint216(value); } /** * @dev Returns the downcasted uint208 from uint256, reverting on * overflow (when the input is greater than largest uint208). * * Counterpart to Solidity's `uint208` operator. * * Requirements: * * - input must fit into 208 bits * * _Available since v4.7._ */ function toUint208(uint256 value) internal pure returns (uint208) { require(value <= type(uint208).max, "SafeCast: value doesn't fit in 208 bits"); return uint208(value); } /** * @dev Returns the downcasted uint200 from uint256, reverting on * overflow (when the input is greater than largest uint200). * * Counterpart to Solidity's `uint200` operator. * * Requirements: * * - input must fit into 200 bits * * _Available since v4.7._ */ function toUint200(uint256 value) internal pure returns (uint200) { require(value <= type(uint200).max, "SafeCast: value doesn't fit in 200 bits"); return uint200(value); } /** * @dev Returns the downcasted uint192 from uint256, reverting on * overflow (when the input is greater than largest uint192). * * Counterpart to Solidity's `uint192` operator. * * Requirements: * * - input must fit into 192 bits * * _Available since v4.7._ */ function toUint192(uint256 value) internal pure returns (uint192) { require(value <= type(uint192).max, "SafeCast: value doesn't fit in 192 bits"); return uint192(value); } /** * @dev Returns the downcasted uint184 from uint256, reverting on * overflow (when the input is greater than largest uint184). * * Counterpart to Solidity's `uint184` operator. * * Requirements: * * - input must fit into 184 bits * * _Available since v4.7._ */ function toUint184(uint256 value) internal pure returns (uint184) { require(value <= type(uint184).max, "SafeCast: value doesn't fit in 184 bits"); return uint184(value); } /** * @dev Returns the downcasted uint176 from uint256, reverting on * overflow (when the input is greater than largest uint176). * * Counterpart to Solidity's `uint176` operator. * * Requirements: * * - input must fit into 176 bits * * _Available since v4.7._ */ function toUint176(uint256 value) internal pure returns (uint176) { require(value <= type(uint176).max, "SafeCast: value doesn't fit in 176 bits"); return uint176(value); } /** * @dev Returns the downcasted uint168 from uint256, reverting on * overflow (when the input is greater than largest uint168). * * Counterpart to Solidity's `uint168` operator. * * Requirements: * * - input must fit into 168 bits * * _Available since v4.7._ */ function toUint168(uint256 value) internal pure returns (uint168) { require(value <= type(uint168).max, "SafeCast: value doesn't fit in 168 bits"); return uint168(value); } /** * @dev Returns the downcasted uint160 from uint256, reverting on * overflow (when the input is greater than largest uint160). * * Counterpart to Solidity's `uint160` operator. * * Requirements: * * - input must fit into 160 bits * * _Available since v4.7._ */ function toUint160(uint256 value) internal pure returns (uint160) { require(value <= type(uint160).max, "SafeCast: value doesn't fit in 160 bits"); return uint160(value); } /** * @dev Returns the downcasted uint152 from uint256, reverting on * overflow (when the input is greater than largest uint152). * * Counterpart to Solidity's `uint152` operator. * * Requirements: * * - input must fit into 152 bits * * _Available since v4.7._ */ function toUint152(uint256 value) internal pure returns (uint152) { require(value <= type(uint152).max, "SafeCast: value doesn't fit in 152 bits"); return uint152(value); } /** * @dev Returns the downcasted uint144 from uint256, reverting on * overflow (when the input is greater than largest uint144). * * Counterpart to Solidity's `uint144` operator. * * Requirements: * * - input must fit into 144 bits * * _Available since v4.7._ */ function toUint144(uint256 value) internal pure returns (uint144) { require(value <= type(uint144).max, "SafeCast: value doesn't fit in 144 bits"); return uint144(value); } /** * @dev Returns the downcasted uint136 from uint256, reverting on * overflow (when the input is greater than largest uint136). * * Counterpart to Solidity's `uint136` operator. * * Requirements: * * - input must fit into 136 bits * * _Available since v4.7._ */ function toUint136(uint256 value) internal pure returns (uint136) { require(value <= type(uint136).max, "SafeCast: value doesn't fit in 136 bits"); return uint136(value); } /** * @dev Returns the downcasted uint128 from uint256, reverting on * overflow (when the input is greater than largest uint128). * * Counterpart to Solidity's `uint128` operator. * * Requirements: * * - input must fit into 128 bits * * _Available since v2.5._ */ function toUint128(uint256 value) internal pure returns (uint128) { require(value <= type(uint128).max, "SafeCast: value doesn't fit in 128 bits"); return uint128(value); } /** * @dev Returns the downcasted uint120 from uint256, reverting on * overflow (when the input is greater than largest uint120). * * Counterpart to Solidity's `uint120` operator. * * Requirements: * * - input must fit into 120 bits * * _Available since v4.7._ */ function toUint120(uint256 value) internal pure returns (uint120) { require(value <= type(uint120).max, "SafeCast: value doesn't fit in 120 bits"); return uint120(value); } /** * @dev Returns the downcasted uint112 from uint256, reverting on * overflow (when the input is greater than largest uint112). * * Counterpart to Solidity's `uint112` operator. * * Requirements: * * - input must fit into 112 bits * * _Available since v4.7._ */ function toUint112(uint256 value) internal pure returns (uint112) { require(value <= type(uint112).max, "SafeCast: value doesn't fit in 112 bits"); return uint112(value); } /** * @dev Returns the downcasted uint104 from uint256, reverting on * overflow (when the input is greater than largest uint104). * * Counterpart to Solidity's `uint104` operator. * * Requirements: * * - input must fit into 104 bits * * _Available since v4.7._ */ function toUint104(uint256 value) internal pure returns (uint104) { require(value <= type(uint104).max, "SafeCast: value doesn't fit in 104 bits"); return uint104(value); } /** * @dev Returns the downcasted uint96 from uint256, reverting on * overflow (when the input is greater than largest uint96). * * Counterpart to Solidity's `uint96` operator. * * Requirements: * * - input must fit into 96 bits * * _Available since v4.2._ */ function toUint96(uint256 value) internal pure returns (uint96) { require(value <= type(uint96).max, "SafeCast: value doesn't fit in 96 bits"); return uint96(value); } /** * @dev Returns the downcasted uint88 from uint256, reverting on * overflow (when the input is greater than largest uint88). * * Counterpart to Solidity's `uint88` operator. * * Requirements: * * - input must fit into 88 bits * * _Available since v4.7._ */ function toUint88(uint256 value) internal pure returns (uint88) { require(value <= type(uint88).max, "SafeCast: value doesn't fit in 88 bits"); return uint88(value); } /** * @dev Returns the downcasted uint80 from uint256, reverting on * overflow (when the input is greater than largest uint80). * * Counterpart to Solidity's `uint80` operator. * * Requirements: * * - input must fit into 80 bits * * _Available since v4.7._ */ function toUint80(uint256 value) internal pure returns (uint80) { require(value <= type(uint80).max, "SafeCast: value doesn't fit in 80 bits"); return uint80(value); } /** * @dev Returns the downcasted uint72 from uint256, reverting on * overflow (when the input is greater than largest uint72). * * Counterpart to Solidity's `uint72` operator. * * Requirements: * * - input must fit into 72 bits * * _Available since v4.7._ */ function toUint72(uint256 value) internal pure returns (uint72) { require(value <= type(uint72).max, "SafeCast: value doesn't fit in 72 bits"); return uint72(value); } /** * @dev Returns the downcasted uint64 from uint256, reverting on * overflow (when the input is greater than largest uint64). * * Counterpart to Solidity's `uint64` operator. * * Requirements: * * - input must fit into 64 bits * * _Available since v2.5._ */ function toUint64(uint256 value) internal pure returns (uint64) { require(value <= type(uint64).max, "SafeCast: value doesn't fit in 64 bits"); return uint64(value); } /** * @dev Returns the downcasted uint56 from uint256, reverting on * overflow (when the input is greater than largest uint56). * * Counterpart to Solidity's `uint56` operator. * * Requirements: * * - input must fit into 56 bits * * _Available since v4.7._ */ function toUint56(uint256 value) internal pure returns (uint56) { require(value <= type(uint56).max, "SafeCast: value doesn't fit in 56 bits"); return uint56(value); } /** * @dev Returns the downcasted uint48 from uint256, reverting on * overflow (when the input is greater than largest uint48). * * Counterpart to Solidity's `uint48` operator. * * Requirements: * * - input must fit into 48 bits * * _Available since v4.7._ */ function toUint48(uint256 value) internal pure returns (uint48) { require(value <= type(uint48).max, "SafeCast: value doesn't fit in 48 bits"); return uint48(value); } /** * @dev Returns the downcasted uint40 from uint256, reverting on * overflow (when the input is greater than largest uint40). * * Counterpart to Solidity's `uint40` operator. * * Requirements: * * - input must fit into 40 bits * * _Available since v4.7._ */ function toUint40(uint256 value) internal pure returns (uint40) { require(value <= type(uint40).max, "SafeCast: value doesn't fit in 40 bits"); return uint40(value); } /** * @dev Returns the downcasted uint32 from uint256, reverting on * overflow (when the input is greater than largest uint32). * * Counterpart to Solidity's `uint32` operator. * * Requirements: * * - input must fit into 32 bits * * _Available since v2.5._ */ function toUint32(uint256 value) internal pure returns (uint32) { require(value <= type(uint32).max, "SafeCast: value doesn't fit in 32 bits"); return uint32(value); } /** * @dev Returns the downcasted uint24 from uint256, reverting on * overflow (when the input is greater than largest uint24). * * Counterpart to Solidity's `uint24` operator. * * Requirements: * * - input must fit into 24 bits * * _Available since v4.7._ */ function toUint24(uint256 value) internal pure returns (uint24) { require(value <= type(uint24).max, "SafeCast: value doesn't fit in 24 bits"); return uint24(value); } /** * @dev Returns the downcasted uint16 from uint256, reverting on * overflow (when the input is greater than largest uint16). * * Counterpart to Solidity's `uint16` operator. * * Requirements: * * - input must fit into 16 bits * * _Available since v2.5._ */ function toUint16(uint256 value) internal pure returns (uint16) { require(value <= type(uint16).max, "SafeCast: value doesn't fit in 16 bits"); return uint16(value); } /** * @dev Returns the downcasted uint8 from uint256, reverting on * overflow (when the input is greater than largest uint8). * * Counterpart to Solidity's `uint8` operator. * * Requirements: * * - input must fit into 8 bits * * _Available since v2.5._ */ function toUint8(uint256 value) internal pure returns (uint8) { require(value <= type(uint8).max, "SafeCast: value doesn't fit in 8 bits"); return uint8(value); } /** * @dev Converts a signed int256 into an unsigned uint256. * * Requirements: * * - input must be greater than or equal to 0. * * _Available since v3.0._ */ function toUint256(int256 value) internal pure returns (uint256) { require(value >= 0, "SafeCast: value must be positive"); return uint256(value); } /** * @dev Returns the downcasted int248 from int256, reverting on * overflow (when the input is less than smallest int248 or * greater than largest int248). * * Counterpart to Solidity's `int248` operator. * * Requirements: * * - input must fit into 248 bits * * _Available since v4.7._ */ function toInt248(int256 value) internal pure returns (int248 downcasted) { downcasted = int248(value); require(downcasted == value, "SafeCast: value doesn't fit in 248 bits"); } /** * @dev Returns the downcasted int240 from int256, reverting on * overflow (when the input is less than smallest int240 or * greater than largest int240). * * Counterpart to Solidity's `int240` operator. * * Requirements: * * - input must fit into 240 bits * * _Available since v4.7._ */ function toInt240(int256 value) internal pure returns (int240 downcasted) { downcasted = int240(value); require(downcasted == value, "SafeCast: value doesn't fit in 240 bits"); } /** * @dev Returns the downcasted int232 from int256, reverting on * overflow (when the input is less than smallest int232 or * greater than largest int232). * * Counterpart to Solidity's `int232` operator. * * Requirements: * * - input must fit into 232 bits * * _Available since v4.7._ */ function toInt232(int256 value) internal pure returns (int232 downcasted) { downcasted = int232(value); require(downcasted == value, "SafeCast: value doesn't fit in 232 bits"); } /** * @dev Returns the downcasted int224 from int256, reverting on * overflow (when the input is less than smallest int224 or * greater than largest int224). * * Counterpart to Solidity's `int224` operator. * * Requirements: * * - input must fit into 224 bits * * _Available since v4.7._ */ function toInt224(int256 value) internal pure returns (int224 downcasted) { downcasted = int224(value); require(downcasted == value, "SafeCast: value doesn't fit in 224 bits"); } /** * @dev Returns the downcasted int216 from int256, reverting on * overflow (when the input is less than smallest int216 or * greater than largest int216). * * Counterpart to Solidity's `int216` operator. * * Requirements: * * - input must fit into 216 bits * * _Available since v4.7._ */ function toInt216(int256 value) internal pure returns (int216 downcasted) { downcasted = int216(value); require(downcasted == value, "SafeCast: value doesn't fit in 216 bits"); } /** * @dev Returns the downcasted int208 from int256, reverting on * overflow (when the input is less than smallest int208 or * greater than largest int208). * * Counterpart to Solidity's `int208` operator. * * Requirements: * * - input must fit into 208 bits * * _Available since v4.7._ */ function toInt208(int256 value) internal pure returns (int208 downcasted) { downcasted = int208(value); require(downcasted == value, "SafeCast: value doesn't fit in 208 bits"); } /** * @dev Returns the downcasted int200 from int256, reverting on * overflow (when the input is less than smallest int200 or * greater than largest int200). * * Counterpart to Solidity's `int200` operator. * * Requirements: * * - input must fit into 200 bits * * _Available since v4.7._ */ function toInt200(int256 value) internal pure returns (int200 downcasted) { downcasted = int200(value); require(downcasted == value, "SafeCast: value doesn't fit in 200 bits"); } /** * @dev Returns the downcasted int192 from int256, reverting on * overflow (when the input is less than smallest int192 or * greater than largest int192). * * Counterpart to Solidity's `int192` operator. * * Requirements: * * - input must fit into 192 bits * * _Available since v4.7._ */ function toInt192(int256 value) internal pure returns (int192 downcasted) { downcasted = int192(value); require(downcasted == value, "SafeCast: value doesn't fit in 192 bits"); } /** * @dev Returns the downcasted int184 from int256, reverting on * overflow (when the input is less than smallest int184 or * greater than largest int184). * * Counterpart to Solidity's `int184` operator. * * Requirements: * * - input must fit into 184 bits * * _Available since v4.7._ */ function toInt184(int256 value) internal pure returns (int184 downcasted) { downcasted = int184(value); require(downcasted == value, "SafeCast: value doesn't fit in 184 bits"); } /** * @dev Returns the downcasted int176 from int256, reverting on * overflow (when the input is less than smallest int176 or * greater than largest int176). * * Counterpart to Solidity's `int176` operator. * * Requirements: * * - input must fit into 176 bits * * _Available since v4.7._ */ function toInt176(int256 value) internal pure returns (int176 downcasted) { downcasted = int176(value); require(downcasted == value, "SafeCast: value doesn't fit in 176 bits"); } /** * @dev Returns the downcasted int168 from int256, reverting on * overflow (when the input is less than smallest int168 or * greater than largest int168). * * Counterpart to Solidity's `int168` operator. * * Requirements: * * - input must fit into 168 bits * * _Available since v4.7._ */ function toInt168(int256 value) internal pure returns (int168 downcasted) { downcasted = int168(value); require(downcasted == value, "SafeCast: value doesn't fit in 168 bits"); } /** * @dev Returns the downcasted int160 from int256, reverting on * overflow (when the input is less than smallest int160 or * greater than largest int160). * * Counterpart to Solidity's `int160` operator. * * Requirements: * * - input must fit into 160 bits * * _Available since v4.7._ */ function toInt160(int256 value) internal pure returns (int160 downcasted) { downcasted = int160(value); require(downcasted == value, "SafeCast: value doesn't fit in 160 bits"); } /** * @dev Returns the downcasted int152 from int256, reverting on * overflow (when the input is less than smallest int152 or * greater than largest int152). * * Counterpart to Solidity's `int152` operator. * * Requirements: * * - input must fit into 152 bits * * _Available since v4.7._ */ function toInt152(int256 value) internal pure returns (int152 downcasted) { downcasted = int152(value); require(downcasted == value, "SafeCast: value doesn't fit in 152 bits"); } /** * @dev Returns the downcasted int144 from int256, reverting on * overflow (when the input is less than smallest int144 or * greater than largest int144). * * Counterpart to Solidity's `int144` operator. * * Requirements: * * - input must fit into 144 bits * * _Available since v4.7._ */ function toInt144(int256 value) internal pure returns (int144 downcasted) { downcasted = int144(value); require(downcasted == value, "SafeCast: value doesn't fit in 144 bits"); } /** * @dev Returns the downcasted int136 from int256, reverting on * overflow (when the input is less than smallest int136 or * greater than largest int136). * * Counterpart to Solidity's `int136` operator. * * Requirements: * * - input must fit into 136 bits * * _Available since v4.7._ */ function toInt136(int256 value) internal pure returns (int136 downcasted) { downcasted = int136(value); require(downcasted == value, "SafeCast: value doesn't fit in 136 bits"); } /** * @dev Returns the downcasted int128 from int256, reverting on * overflow (when the input is less than smallest int128 or * greater than largest int128). * * Counterpart to Solidity's `int128` operator. * * Requirements: * * - input must fit into 128 bits * * _Available since v3.1._ */ function toInt128(int256 value) internal pure returns (int128 downcasted) { downcasted = int128(value); require(downcasted == value, "SafeCast: value doesn't fit in 128 bits"); } /** * @dev Returns the downcasted int120 from int256, reverting on * overflow (when the input is less than smallest int120 or * greater than largest int120). * * Counterpart to Solidity's `int120` operator. * * Requirements: * * - input must fit into 120 bits * * _Available since v4.7._ */ function toInt120(int256 value) internal pure returns (int120 downcasted) { downcasted = int120(value); require(downcasted == value, "SafeCast: value doesn't fit in 120 bits"); } /** * @dev Returns the downcasted int112 from int256, reverting on * overflow (when the input is less than smallest int112 or * greater than largest int112). * * Counterpart to Solidity's `int112` operator. * * Requirements: * * - input must fit into 112 bits * * _Available since v4.7._ */ function toInt112(int256 value) internal pure returns (int112 downcasted) { downcasted = int112(value); require(downcasted == value, "SafeCast: value doesn't fit in 112 bits"); } /** * @dev Returns the downcasted int104 from int256, reverting on * overflow (when the input is less than smallest int104 or * greater than largest int104). * * Counterpart to Solidity's `int104` operator. * * Requirements: * * - input must fit into 104 bits * * _Available since v4.7._ */ function toInt104(int256 value) internal pure returns (int104 downcasted) { downcasted = int104(value); require(downcasted == value, "SafeCast: value doesn't fit in 104 bits"); } /** * @dev Returns the downcasted int96 from int256, reverting on * overflow (when the input is less than smallest int96 or * greater than largest int96). * * Counterpart to Solidity's `int96` operator. * * Requirements: * * - input must fit into 96 bits * * _Available since v4.7._ */ function toInt96(int256 value) internal pure returns (int96 downcasted) { downcasted = int96(value); require(downcasted == value, "SafeCast: value doesn't fit in 96 bits"); } /** * @dev Returns the downcasted int88 from int256, reverting on * overflow (when the input is less than smallest int88 or * greater than largest int88). * * Counterpart to Solidity's `int88` operator. * * Requirements: * * - input must fit into 88 bits * * _Available since v4.7._ */ function toInt88(int256 value) internal pure returns (int88 downcasted) { downcasted = int88(value); require(downcasted == value, "SafeCast: value doesn't fit in 88 bits"); } /** * @dev Returns the downcasted int80 from int256, reverting on * overflow (when the input is less than smallest int80 or * greater than largest int80). * * Counterpart to Solidity's `int80` operator. * * Requirements: * * - input must fit into 80 bits * * _Available since v4.7._ */ function toInt80(int256 value) internal pure returns (int80 downcasted) { downcasted = int80(value); require(downcasted == value, "SafeCast: value doesn't fit in 80 bits"); } /** * @dev Returns the downcasted int72 from int256, reverting on * overflow (when the input is less than smallest int72 or * greater than largest int72). * * Counterpart to Solidity's `int72` operator. * * Requirements: * * - input must fit into 72 bits * * _Available since v4.7._ */ function toInt72(int256 value) internal pure returns (int72 downcasted) { downcasted = int72(value); require(downcasted == value, "SafeCast: value doesn't fit in 72 bits"); } /** * @dev Returns the downcasted int64 from int256, reverting on * overflow (when the input is less than smallest int64 or * greater than largest int64). * * Counterpart to Solidity's `int64` operator. * * Requirements: * * - input must fit into 64 bits * * _Available since v3.1._ */ function toInt64(int256 value) internal pure returns (int64 downcasted) { downcasted = int64(value); require(downcasted == value, "SafeCast: value doesn't fit in 64 bits"); } /** * @dev Returns the downcasted int56 from int256, reverting on * overflow (when the input is less than smallest int56 or * greater than largest int56). * * Counterpart to Solidity's `int56` operator. * * Requirements: * * - input must fit into 56 bits * * _Available since v4.7._ */ function toInt56(int256 value) internal pure returns (int56 downcasted) { downcasted = int56(value); require(downcasted == value, "SafeCast: value doesn't fit in 56 bits"); } /** * @dev Returns the downcasted int48 from int256, reverting on * overflow (when the input is less than smallest int48 or * greater than largest int48). * * Counterpart to Solidity's `int48` operator. * * Requirements: * * - input must fit into 48 bits * * _Available since v4.7._ */ function toInt48(int256 value) internal pure returns (int48 downcasted) { downcasted = int48(value); require(downcasted == value, "SafeCast: value doesn't fit in 48 bits"); } /** * @dev Returns the downcasted int40 from int256, reverting on * overflow (when the input is less than smallest int40 or * greater than largest int40). * * Counterpart to Solidity's `int40` operator. * * Requirements: * * - input must fit into 40 bits * * _Available since v4.7._ */ function toInt40(int256 value) internal pure returns (int40 downcasted) { downcasted = int40(value); require(downcasted == value, "SafeCast: value doesn't fit in 40 bits"); } /** * @dev Returns the downcasted int32 from int256, reverting on * overflow (when the input is less than smallest int32 or * greater than largest int32). * * Counterpart to Solidity's `int32` operator. * * Requirements: * * - input must fit into 32 bits * * _Available since v3.1._ */ function toInt32(int256 value) internal pure returns (int32 downcasted) { downcasted = int32(value); require(downcasted == value, "SafeCast: value doesn't fit in 32 bits"); } /** * @dev Returns the downcasted int24 from int256, reverting on * overflow (when the input is less than smallest int24 or * greater than largest int24). * * Counterpart to Solidity's `int24` operator. * * Requirements: * * - input must fit into 24 bits * * _Available since v4.7._ */ function toInt24(int256 value) internal pure returns (int24 downcasted) { downcasted = int24(value); require(downcasted == value, "SafeCast: value doesn't fit in 24 bits"); } /** * @dev Returns the downcasted int16 from int256, reverting on * overflow (when the input is less than smallest int16 or * greater than largest int16). * * Counterpart to Solidity's `int16` operator. * * Requirements: * * - input must fit into 16 bits * * _Available since v3.1._ */ function toInt16(int256 value) internal pure returns (int16 downcasted) { downcasted = int16(value); require(downcasted == value, "SafeCast: value doesn't fit in 16 bits"); } /** * @dev Returns the downcasted int8 from int256, reverting on * overflow (when the input is less than smallest int8 or * greater than largest int8). * * Counterpart to Solidity's `int8` operator. * * Requirements: * * - input must fit into 8 bits * * _Available since v3.1._ */ function toInt8(int256 value) internal pure returns (int8 downcasted) { downcasted = int8(value); require(downcasted == value, "SafeCast: value doesn't fit in 8 bits"); } /** * @dev Converts an unsigned uint256 into a signed int256. * * Requirements: * * - input must be less than or equal to maxInt256. * * _Available since v3.0._ */ function toInt256(uint256 value) internal pure returns (int256) { // Note: Unsafe cast below is okay because `type(int256).max` is guaranteed to be positive require(value <= uint256(type(int256).max), "SafeCast: value doesn't fit in an int256"); return int256(value); } }
// SPDX-License-Identifier: MIT // OpenZeppelin Contracts (last updated v4.8.0) (utils/structs/EnumerableSet.sol) // This file was procedurally generated from scripts/generate/templates/EnumerableSet.js. pragma solidity ^0.8.0; /** * @dev Library for managing * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive * types. * * Sets have the following properties: * * - Elements are added, removed, and checked for existence in constant time * (O(1)). * - Elements are enumerated in O(n). No guarantees are made on the ordering. * * ``` * contract Example { * // Add the library methods * using EnumerableSet for EnumerableSet.AddressSet; * * // Declare a set state variable * EnumerableSet.AddressSet private mySet; * } * ``` * * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`) * and `uint256` (`UintSet`) are supported. * * [WARNING] * ==== * Trying to delete such a structure from storage will likely result in data corruption, rendering the structure * unusable. * See https://github.com/ethereum/solidity/pull/11843[ethereum/solidity#11843] for more info. * * In order to clean an EnumerableSet, you can either remove all elements one by one or create a fresh instance using an * array of EnumerableSet. * ==== */ library EnumerableSet { // To implement this library for multiple types with as little code // repetition as possible, we write it in terms of a generic Set type with // bytes32 values. // The Set implementation uses private functions, and user-facing // implementations (such as AddressSet) are just wrappers around the // underlying Set. // This means that we can only create new EnumerableSets for types that fit // in bytes32. struct Set { // Storage of set values bytes32[] _values; // Position of the value in the `values` array, plus 1 because index 0 // means a value is not in the set. mapping(bytes32 => uint256) _indexes; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function _add(Set storage set, bytes32 value) private returns (bool) { if (!_contains(set, value)) { set._values.push(value); // The value is stored at length-1, but we add 1 to all indexes // and use 0 as a sentinel value set._indexes[value] = set._values.length; return true; } else { return false; } } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function _remove(Set storage set, bytes32 value) private returns (bool) { // We read and store the value's index to prevent multiple reads from the same storage slot uint256 valueIndex = set._indexes[value]; if (valueIndex != 0) { // Equivalent to contains(set, value) // To delete an element from the _values array in O(1), we swap the element to delete with the last one in // the array, and then remove the last element (sometimes called as 'swap and pop'). // This modifies the order of the array, as noted in {at}. uint256 toDeleteIndex = valueIndex - 1; uint256 lastIndex = set._values.length - 1; if (lastIndex != toDeleteIndex) { bytes32 lastValue = set._values[lastIndex]; // Move the last value to the index where the value to delete is set._values[toDeleteIndex] = lastValue; // Update the index for the moved value set._indexes[lastValue] = valueIndex; // Replace lastValue's index to valueIndex } // Delete the slot where the moved value was stored set._values.pop(); // Delete the index for the deleted slot delete set._indexes[value]; return true; } else { return false; } } /** * @dev Returns true if the value is in the set. O(1). */ function _contains(Set storage set, bytes32 value) private view returns (bool) { return set._indexes[value] != 0; } /** * @dev Returns the number of values on the set. O(1). */ function _length(Set storage set) private view returns (uint256) { return set._values.length; } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function _at(Set storage set, uint256 index) private view returns (bytes32) { return set._values[index]; } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function _values(Set storage set) private view returns (bytes32[] memory) { return set._values; } // Bytes32Set struct Bytes32Set { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(Bytes32Set storage set, bytes32 value) internal returns (bool) { return _add(set._inner, value); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) { return _remove(set._inner, value); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) { return _contains(set._inner, value); } /** * @dev Returns the number of values in the set. O(1). */ function length(Bytes32Set storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) { return _at(set._inner, index); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(Bytes32Set storage set) internal view returns (bytes32[] memory) { bytes32[] memory store = _values(set._inner); bytes32[] memory result; /// @solidity memory-safe-assembly assembly { result := store } return result; } // AddressSet struct AddressSet { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(AddressSet storage set, address value) internal returns (bool) { return _add(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(AddressSet storage set, address value) internal returns (bool) { return _remove(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(AddressSet storage set, address value) internal view returns (bool) { return _contains(set._inner, bytes32(uint256(uint160(value)))); } /** * @dev Returns the number of values in the set. O(1). */ function length(AddressSet storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(AddressSet storage set, uint256 index) internal view returns (address) { return address(uint160(uint256(_at(set._inner, index)))); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(AddressSet storage set) internal view returns (address[] memory) { bytes32[] memory store = _values(set._inner); address[] memory result; /// @solidity memory-safe-assembly assembly { result := store } return result; } // UintSet struct UintSet { Set _inner; } /** * @dev Add a value to a set. O(1). * * Returns true if the value was added to the set, that is if it was not * already present. */ function add(UintSet storage set, uint256 value) internal returns (bool) { return _add(set._inner, bytes32(value)); } /** * @dev Removes a value from a set. O(1). * * Returns true if the value was removed from the set, that is if it was * present. */ function remove(UintSet storage set, uint256 value) internal returns (bool) { return _remove(set._inner, bytes32(value)); } /** * @dev Returns true if the value is in the set. O(1). */ function contains(UintSet storage set, uint256 value) internal view returns (bool) { return _contains(set._inner, bytes32(value)); } /** * @dev Returns the number of values in the set. O(1). */ function length(UintSet storage set) internal view returns (uint256) { return _length(set._inner); } /** * @dev Returns the value stored at position `index` in the set. O(1). * * Note that there are no guarantees on the ordering of values inside the * array, and it may change when more values are added or removed. * * Requirements: * * - `index` must be strictly less than {length}. */ function at(UintSet storage set, uint256 index) internal view returns (uint256) { return uint256(_at(set._inner, index)); } /** * @dev Return the entire set in an array * * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that * this function has an unbounded cost, and using it as part of a state-changing function may render the function * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block. */ function values(UintSet storage set) internal view returns (uint256[] memory) { bytes32[] memory store = _values(set._inner); uint256[] memory result; /// @solidity memory-safe-assembly assembly { result := store } return result; } }
{ "optimizer": { "enabled": true, "runs": 2000 }, "outputSelection": { "*": { "*": [ "evm.bytecode", "evm.deployedBytecode", "devdoc", "userdoc", "metadata", "abi" ] } }, "libraries": {} }
Contract Security Audit
- No Contract Security Audit Submitted- Submit Audit Here
[{"inputs":[{"internalType":"address","name":"_creditManager","type":"address"},{"internalType":"address","name":"_booster","type":"address"}],"stateMutability":"nonpayable","type":"constructor"},{"inputs":[],"name":"CallerNotConfiguratorException","type":"error"},{"inputs":[],"name":"CreditFacadeOnlyException","type":"error"},{"inputs":[],"name":"TokenNotAllowedException","type":"error"},{"inputs":[],"name":"ZeroAddressException","type":"error"},{"inputs":[],"name":"_acl","outputs":[{"internalType":"contract IACL","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"_gearboxAdapterType","outputs":[{"internalType":"enum AdapterType","name":"","type":"uint8"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"_gearboxAdapterVersion","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"addressProvider","outputs":[{"internalType":"contract IAddressProvider","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"creditManager","outputs":[{"internalType":"contract ICreditManagerV2","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_pid","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"},{"internalType":"bool","name":"_stake","type":"bool"}],"name":"deposit","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_pid","type":"uint256"},{"internalType":"bool","name":"_stake","type":"bool"}],"name":"depositAll","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"pidToPhantomToken","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"targetContract","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"updateStakedPhantomTokensMap","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_pid","type":"uint256"},{"internalType":"uint256","name":"","type":"uint256"}],"name":"withdraw","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_pid","type":"uint256"}],"name":"withdrawAll","outputs":[],"stateMutability":"nonpayable","type":"function"}]
Contract Creation Code
6101006040523480156200001257600080fd5b506040516200173e3803806200173e8339810160408190526200003591620001f1565b81816001600160a01b03821615806200005557506001600160a01b038116155b156200007457604051635919af9760e11b815260040160405180910390fd5b6001600160a01b0382166080819052604080516316f0115b60e01b815290516316f0115b916004808201926020929091908290030181865afa158015620000bf573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620000e5919062000230565b6001600160a01b0316632954018c6040518163ffffffff1660e01b8152600401602060405180830381865afa15801562000123573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019062000149919062000230565b6001600160a01b0390811660a081905290821660c05260408051630873769560e01b815290516308737695916004808201926020929091908290030181865afa1580156200019b573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190620001c1919062000230565b6001600160a01b031660e052506200025792505050565b6001600160a01b0381168114620001ee57600080fd5b50565b600080604083850312156200020557600080fd5b82516200021281620001d8565b60208401519092506200022581620001d8565b809150509250929050565b6000602082840312156200024357600080fd5b81516200025081620001d8565b9392505050565b60805160a05160c05160e05161144b620002f3600039600081816101bc015261046b0152600081816101e30152818161093701528181610a2301528181610b990152610d500152600061012401526000818161020a015281816105180152818161066f0152818161088001528181610b2601528181610c6701528181610d1901528181610ddd01528181610e9e0152610f53015261144b6000f3fe608060405234801561001057600080fd5b50600436106100d45760003560e01c8063958e2d3111610081578063bd90df701161005b578063bd90df70146101de578063c12c21c014610205578063ce30bbdb1461022c57600080fd5b8063958e2d311461019c5780639b51ecd3146101af578063a50cf2c8146101b757600080fd5b8063441a3e70116100b2578063441a3e701461015b57806360759fce1461016e57806378aa73a41461018157600080fd5b8063251d48c0146100d95780632954018c1461011f57806343a0d06614610146575b600080fd5b6101026100e7366004610fe4565b6000602081905290815260409020546001600160a01b031681565b6040516001600160a01b0390911681526020015b60405180910390f35b6101027f000000000000000000000000000000000000000000000000000000000000000081565b61015961015436600461100b565b610241565b005b610159610169366004611044565b6102c1565b61015961017c366004611066565b61033f565b610189600281565b60405161ffff9091168152602001610116565b6101596101aa366004610fe4565b6103bd565b61015961043d565b6101027f000000000000000000000000000000000000000000000000000000000000000081565b6101027f000000000000000000000000000000000000000000000000000000000000000081565b6101027f000000000000000000000000000000000000000000000000000000000000000081565b610234600b81565b60405161011691906110ac565b61024961087c565b6001600160a01b0316336001600160a01b03161461027a57604051636c01359160e11b815260040160405180910390fd5b6102bc83826000368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201829052509250610905915050565b505050565b6102c961087c565b6001600160a01b0316336001600160a01b0316146102fa57604051636c01359160e11b815260040160405180910390fd5b61033b826000368080601f016020809104026020016040519081016040528093929190818152602001838380828437600092018290525092506109f1915050565b5050565b61034761087c565b6001600160a01b0316336001600160a01b03161461037857604051636c01359160e11b815260040160405180910390fd5b61033b82826000368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525060019250610905915050565b6103c561087c565b6001600160a01b0316336001600160a01b0316146103f657604051636c01359160e11b815260040160405180910390fd5b61043a816000368080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250600192506109f1915050565b50565b6040517f5f259aba0000000000000000000000000000000000000000000000000000000081523360048201527f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690635f259aba90602401602060405180830381865afa1580156104ba573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906104de91906110d4565b610514576040517f61081c1500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663f9aa028a6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610574573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610598919061110f565b90506000816001600160a01b031663373c8f626040518163ffffffff1660e01b8152600401600060405180830381865afa1580156105da573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526106029190810190611171565b805190915060005b818110156108765760008382815181106106265761062661121e565b60209081029190910101516040517ffdd576450000000000000000000000000000000000000000000000000000000081526001600160a01b0380831660048301529192506000917f0000000000000000000000000000000000000000000000000000000000000000169063fdd5764590602401602060405180830381865afa1580156106b6573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106da919061110f565b90506000816001600160a01b031663ce30bbdb6040518163ffffffff1660e01b8152600401602060405180830381865afa15801561071c573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107409190611234565b9050600a81601481111561075657610756611096565b03610868576000836001600160a01b031663f10684546040518163ffffffff1660e01b8152600401602060405180830381865afa15801561079b573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107bf9190611255565b9050826001600160a01b03166320b2c1516040518163ffffffff1660e01b8152600401602060405180830381865afa1580156107ff573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610823919061110f565b60009182526020829052604090912080547fffffffffffffffffffffffff0000000000000000000000000000000000000000166001600160a01b039092169190911790555b83600101935050505061060a565b50505050565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316632f7a18816040518163ffffffff1660e01b8152600401602060405180830381865afa1580156108dc573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610900919061110f565b905090565b6040517f1526fe27000000000000000000000000000000000000000000000000000000008152600481018590526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690631526fe279060240160c060405180830381865afa158015610986573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109aa919061126e565b80519091506000856109c05782602001516109d9565b6000878152602081905260409020546001600160a01b03165b90506109e782828787610ab6565b5050505050505050565b6040517f1526fe27000000000000000000000000000000000000000000000000000000008152600481018490526000907f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031690631526fe279060240160c060405180830381865afa158015610a72573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610a96919061126e565b6020810151815191925090610aad82828787610b03565b50505050505050565b6060610ae2857fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff610b24565b610aee85858585610c07565b9050610afb856001610b24565b949350505050565b6060610b0e85610c2c565b50610b1b85858585610c07565b95945050505050565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166346fb371d610b5b61087c565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b0391821660048201527f000000000000000000000000000000000000000000000000000000000000000082166024820152908516604482015260648101849052608401600060405180830381600087803b158015610beb57600080fd5b505af1158015610bff573d6000803e3d6000fd5b505050505050565b6060610c1283610d15565b90508115610c2357610c2385610ddb565b610afb84610e9c565b6040517ff67c5bd00000000000000000000000000000000000000000000000000000000081526001600160a01b0382811660048301526000917f00000000000000000000000000000000000000000000000000000000000000009091169063f67c5bd090602401602060405180830381865afa158015610cb0573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610cd49190611255565b905080600003610d10576040517f700ca0af00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b919050565b60607f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316636ce4074a610d4e61087c565b7f0000000000000000000000000000000000000000000000000000000000000000856040518463ffffffff1660e01b8152600401610d8e93929190611333565b6000604051808303816000875af1158015610dad573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610dd59190810190611381565b92915050565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b0316630d8f9cee610e12610f4f565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b03918216600482015290841660248201526044016020604051808303816000875af1158015610e78573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061033b91906110d4565b7f00000000000000000000000000000000000000000000000000000000000000006001600160a01b03166351e3f160610ed3610f4f565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b0391821660048201529084166024820152604401600060405180830381600087803b158015610f3457600080fd5b505af1158015610f48573d6000803e3d6000fd5b5050505050565b60007f00000000000000000000000000000000000000000000000000000000000000006001600160a01b031663e958b704610f8861087c565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b039091166004820152602401602060405180830381865afa1580156108dc573d6000803e3d6000fd5b600060208284031215610ff657600080fd5b5035919050565b801515811461043a57600080fd5b60008060006060848603121561102057600080fd5b8335925060208401359150604084013561103981610ffd565b809150509250925092565b6000806040838503121561105757600080fd5b50508035926020909101359150565b6000806040838503121561107957600080fd5b82359150602083013561108b81610ffd565b809150509250929050565b634e487b7160e01b600052602160045260246000fd5b60208101601583106110ce57634e487b7160e01b600052602160045260246000fd5b91905290565b6000602082840312156110e657600080fd5b81516110f181610ffd565b9392505050565b80516001600160a01b0381168114610d1057600080fd5b60006020828403121561112157600080fd5b6110f1826110f8565b634e487b7160e01b600052604160045260246000fd5b604051601f8201601f1916810167ffffffffffffffff811182821017156111695761116961112a565b604052919050565b6000602080838503121561118457600080fd5b825167ffffffffffffffff8082111561119c57600080fd5b818501915085601f8301126111b057600080fd5b8151818111156111c2576111c261112a565b8060051b91506111d3848301611140565b81815291830184019184810190888411156111ed57600080fd5b938501935b8385101561121257611203856110f8565b825293850193908501906111f2565b98975050505050505050565b634e487b7160e01b600052603260045260246000fd5b60006020828403121561124657600080fd5b8151601581106110f157600080fd5b60006020828403121561126757600080fd5b5051919050565b600060c0828403121561128057600080fd5b60405160c0810181811067ffffffffffffffff821117156112a3576112a361112a565b6040526112af836110f8565b81526112bd602084016110f8565b60208201526112ce604084016110f8565b60408201526112df606084016110f8565b60608201526112f0608084016110f8565b608082015260a083015161130381610ffd565b60a08201529392505050565b60005b8381101561132a578181015183820152602001611312565b50506000910152565b60006001600160a01b03808616835280851660208401525060606040830152825180606084015261136b81608085016020870161130f565b601f01601f191691909101608001949350505050565b60006020828403121561139357600080fd5b815167ffffffffffffffff808211156113ab57600080fd5b818401915084601f8301126113bf57600080fd5b8151818111156113d1576113d161112a565b6113e46020601f19601f84011601611140565b91508082528560208285010111156113fb57600080fd5b61140c81602084016020860161130f565b5094935050505056fea2646970667358221220dcd5fd9d768dd1b0784c6903b21389f172816fafb5c7507ed1925b14ca160d0564736f6c63430008110033000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f7000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae31
Deployed Bytecode
0x608060405234801561001057600080fd5b50600436106100d45760003560e01c8063958e2d3111610081578063bd90df701161005b578063bd90df70146101de578063c12c21c014610205578063ce30bbdb1461022c57600080fd5b8063958e2d311461019c5780639b51ecd3146101af578063a50cf2c8146101b757600080fd5b8063441a3e70116100b2578063441a3e701461015b57806360759fce1461016e57806378aa73a41461018157600080fd5b8063251d48c0146100d95780632954018c1461011f57806343a0d06614610146575b600080fd5b6101026100e7366004610fe4565b6000602081905290815260409020546001600160a01b031681565b6040516001600160a01b0390911681526020015b60405180910390f35b6101027f000000000000000000000000cf64698aff7e5f27a11dff868af228653ba53be081565b61015961015436600461100b565b610241565b005b610159610169366004611044565b6102c1565b61015961017c366004611066565b61033f565b610189600281565b60405161ffff9091168152602001610116565b6101596101aa366004610fe4565b6103bd565b61015961043d565b6101027f000000000000000000000000523da3a8961e4dd4f6206dbf7e6c749f51796bb381565b6101027f000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae3181565b6101027f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f781565b610234600b81565b60405161011691906110ac565b61024961087c565b6001600160a01b0316336001600160a01b03161461027a57604051636c01359160e11b815260040160405180910390fd5b6102bc83826000368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201829052509250610905915050565b505050565b6102c961087c565b6001600160a01b0316336001600160a01b0316146102fa57604051636c01359160e11b815260040160405180910390fd5b61033b826000368080601f016020809104026020016040519081016040528093929190818152602001838380828437600092018290525092506109f1915050565b5050565b61034761087c565b6001600160a01b0316336001600160a01b03161461037857604051636c01359160e11b815260040160405180910390fd5b61033b82826000368080601f01602080910402602001604051908101604052809392919081815260200183838082843760009201919091525060019250610905915050565b6103c561087c565b6001600160a01b0316336001600160a01b0316146103f657604051636c01359160e11b815260040160405180910390fd5b61043a816000368080601f016020809104026020016040519081016040528093929190818152602001838380828437600092019190915250600192506109f1915050565b50565b6040517f5f259aba0000000000000000000000000000000000000000000000000000000081523360048201527f000000000000000000000000523da3a8961e4dd4f6206dbf7e6c749f51796bb36001600160a01b031690635f259aba90602401602060405180830381865afa1580156104ba573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906104de91906110d4565b610514576040517f61081c1500000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b60007f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f76001600160a01b031663f9aa028a6040518163ffffffff1660e01b8152600401602060405180830381865afa158015610574573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610598919061110f565b90506000816001600160a01b031663373c8f626040518163ffffffff1660e01b8152600401600060405180830381865afa1580156105da573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f191682016040526106029190810190611171565b805190915060005b818110156108765760008382815181106106265761062661121e565b60209081029190910101516040517ffdd576450000000000000000000000000000000000000000000000000000000081526001600160a01b0380831660048301529192506000917f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f7169063fdd5764590602401602060405180830381865afa1580156106b6573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906106da919061110f565b90506000816001600160a01b031663ce30bbdb6040518163ffffffff1660e01b8152600401602060405180830381865afa15801561071c573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107409190611234565b9050600a81601481111561075657610756611096565b03610868576000836001600160a01b031663f10684546040518163ffffffff1660e01b8152600401602060405180830381865afa15801561079b573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906107bf9190611255565b9050826001600160a01b03166320b2c1516040518163ffffffff1660e01b8152600401602060405180830381865afa1580156107ff573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610823919061110f565b60009182526020829052604090912080547fffffffffffffffffffffffff0000000000000000000000000000000000000000166001600160a01b039092169190911790555b83600101935050505061060a565b50505050565b60007f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f76001600160a01b0316632f7a18816040518163ffffffff1660e01b8152600401602060405180830381865afa1580156108dc573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610900919061110f565b905090565b6040517f1526fe27000000000000000000000000000000000000000000000000000000008152600481018590526000907f000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae316001600160a01b031690631526fe279060240160c060405180830381865afa158015610986573d6000803e3d6000fd5b505050506040513d601f19601f820116820180604052508101906109aa919061126e565b80519091506000856109c05782602001516109d9565b6000878152602081905260409020546001600160a01b03165b90506109e782828787610ab6565b5050505050505050565b6040517f1526fe27000000000000000000000000000000000000000000000000000000008152600481018490526000907f000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae316001600160a01b031690631526fe279060240160c060405180830381865afa158015610a72573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610a96919061126e565b6020810151815191925090610aad82828787610b03565b50505050505050565b6060610ae2857fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff610b24565b610aee85858585610c07565b9050610afb856001610b24565b949350505050565b6060610b0e85610c2c565b50610b1b85858585610c07565b95945050505050565b7f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f76001600160a01b03166346fb371d610b5b61087c565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b0391821660048201527f000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae3182166024820152908516604482015260648101849052608401600060405180830381600087803b158015610beb57600080fd5b505af1158015610bff573d6000803e3d6000fd5b505050505050565b6060610c1283610d15565b90508115610c2357610c2385610ddb565b610afb84610e9c565b6040517ff67c5bd00000000000000000000000000000000000000000000000000000000081526001600160a01b0382811660048301526000917f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f79091169063f67c5bd090602401602060405180830381865afa158015610cb0573d6000803e3d6000fd5b505050506040513d601f19601f82011682018060405250810190610cd49190611255565b905080600003610d10576040517f700ca0af00000000000000000000000000000000000000000000000000000000815260040160405180910390fd5b919050565b60607f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f76001600160a01b0316636ce4074a610d4e61087c565b7f000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae31856040518463ffffffff1660e01b8152600401610d8e93929190611333565b6000604051808303816000875af1158015610dad573d6000803e3d6000fd5b505050506040513d6000823e601f3d908101601f19168201604052610dd59190810190611381565b92915050565b7f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f76001600160a01b0316630d8f9cee610e12610f4f565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b03918216600482015290841660248201526044016020604051808303816000875af1158015610e78573d6000803e3d6000fd5b505050506040513d601f19601f8201168201806040525081019061033b91906110d4565b7f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f76001600160a01b03166351e3f160610ed3610f4f565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b0391821660048201529084166024820152604401600060405180830381600087803b158015610f3457600080fd5b505af1158015610f48573d6000803e3d6000fd5b5050505050565b60007f000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f76001600160a01b031663e958b704610f8861087c565b6040517fffffffff0000000000000000000000000000000000000000000000000000000060e084901b1681526001600160a01b039091166004820152602401602060405180830381865afa1580156108dc573d6000803e3d6000fd5b600060208284031215610ff657600080fd5b5035919050565b801515811461043a57600080fd5b60008060006060848603121561102057600080fd5b8335925060208401359150604084013561103981610ffd565b809150509250925092565b6000806040838503121561105757600080fd5b50508035926020909101359150565b6000806040838503121561107957600080fd5b82359150602083013561108b81610ffd565b809150509250929050565b634e487b7160e01b600052602160045260246000fd5b60208101601583106110ce57634e487b7160e01b600052602160045260246000fd5b91905290565b6000602082840312156110e657600080fd5b81516110f181610ffd565b9392505050565b80516001600160a01b0381168114610d1057600080fd5b60006020828403121561112157600080fd5b6110f1826110f8565b634e487b7160e01b600052604160045260246000fd5b604051601f8201601f1916810167ffffffffffffffff811182821017156111695761116961112a565b604052919050565b6000602080838503121561118457600080fd5b825167ffffffffffffffff8082111561119c57600080fd5b818501915085601f8301126111b057600080fd5b8151818111156111c2576111c261112a565b8060051b91506111d3848301611140565b81815291830184019184810190888411156111ed57600080fd5b938501935b8385101561121257611203856110f8565b825293850193908501906111f2565b98975050505050505050565b634e487b7160e01b600052603260045260246000fd5b60006020828403121561124657600080fd5b8151601581106110f157600080fd5b60006020828403121561126757600080fd5b5051919050565b600060c0828403121561128057600080fd5b60405160c0810181811067ffffffffffffffff821117156112a3576112a361112a565b6040526112af836110f8565b81526112bd602084016110f8565b60208201526112ce604084016110f8565b60408201526112df606084016110f8565b60608201526112f0608084016110f8565b608082015260a083015161130381610ffd565b60a08201529392505050565b60005b8381101561132a578181015183820152602001611312565b50506000910152565b60006001600160a01b03808616835280851660208401525060606040830152825180606084015261136b81608085016020870161130f565b601f01601f191691909101608001949350505050565b60006020828403121561139357600080fd5b815167ffffffffffffffff808211156113ab57600080fd5b818401915084601f8301126113bf57600080fd5b8151818111156113d1576113d161112a565b6113e46020601f19601f84011601611140565b91508082528560208285010111156113fb57600080fd5b61140c81602084016020860161130f565b5094935050505056fea2646970667358221220dcd5fd9d768dd1b0784c6903b21389f172816fafb5c7507ed1925b14ca160d0564736f6c63430008110033
Constructor Arguments (ABI-Encoded and is the last bytes of the Contract Creation Code above)
000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f7000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae31
-----Decoded View---------------
Arg [0] : _creditManager (address): 0x672461Bfc20DD783444a830Ad4c38b345aB6E2f7
Arg [1] : _booster (address): 0xF403C135812408BFbE8713b5A23a04b3D48AAE31
-----Encoded View---------------
2 Constructor Arguments found :
Arg [0] : 000000000000000000000000672461bfc20dd783444a830ad4c38b345ab6e2f7
Arg [1] : 000000000000000000000000f403c135812408bfbe8713b5a23a04b3d48aae31
Loading...
Loading
Loading...
Loading
Make sure to use the "Vote Down" button for any spammy posts, and the "Vote Up" for interesting conversations.
[ Download: CSV Export ]
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.