// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
import "../utils/EnumerableSet.sol";
import "../utils/Address.sol";
import "../utils/Context.sol";
/**
* @dev Contract module that allows children to implement role-based access
* control mechanisms.
*
* Roles are referred to by their `bytes32` identifier. These should be exposed
* in the external API and be unique. The best way to achieve this is by
* using `public constant` hash digests:
*
* ```
* bytes32 public constant MY_ROLE = keccak256("MY_ROLE");
* ```
*
* Roles can be used to represent a set of permissions. To restrict access to a
* function call, use {hasRole}:
*
* ```
* function foo() public {
* require(hasRole(MY_ROLE, msg.sender));
* ...
* }
* ```
*
* Roles can be granted and revoked dynamically via the {grantRole} and
* {revokeRole} functions. Each role has an associated admin role, and only
* accounts that have a role's admin role can call {grantRole} and {revokeRole}.
*
* By default, the admin role for all roles is `DEFAULT_ADMIN_ROLE`, which means
* that only accounts with this role will be able to grant or revoke other
* roles. More complex role relationships can be created by using
* {_setRoleAdmin}.
*
* WARNING: The `DEFAULT_ADMIN_ROLE` is also its own admin: it has permission to
* grant and revoke this role. Extra precautions should be taken to secure
* accounts that have been granted it.
*/
abstract contract AccessControl is Context {
using EnumerableSet for EnumerableSet.AddressSet;
using Address for address;
struct RoleData {
EnumerableSet.AddressSet members;
bytes32 adminRole;
}
mapping (bytes32 => RoleData) private _roles;
bytes32 public constant DEFAULT_ADMIN_ROLE = 0x00;
/**
* @dev Emitted when `newAdminRole` is set as ``role``'s admin role, replacing `previousAdminRole`
*
* `DEFAULT_ADMIN_ROLE` is the starting admin for all roles, despite
* {RoleAdminChanged} not being emitted signaling this.
*
* _Available since v3.1._
*/
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole);
/**
* @dev Emitted when `account` is granted `role`.
*
* `sender` is the account that originated the contract call, an admin role
* bearer except when using {_setupRole}.
*/
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Emitted when `account` is revoked `role`.
*
* `sender` is the account that originated the contract call:
* - if using `revokeRole`, it is the admin role bearer
* - if using `renounceRole`, it is the role bearer (i.e. `account`)
*/
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender);
/**
* @dev Returns `true` if `account` has been granted `role`.
*/
function hasRole(bytes32 role, address account) public view returns (bool) {
return _roles[role].members.contains(account);
}
/**
* @dev Returns the number of accounts that have `role`. Can be used
* together with {getRoleMember} to enumerate all bearers of a role.
*/
function getRoleMemberCount(bytes32 role) public view returns (uint256) {
return _roles[role].members.length();
}
/**
* @dev Returns one of the accounts that have `role`. `index` must be a
* value between 0 and {getRoleMemberCount}, non-inclusive.
*
* Role bearers are not sorted in any particular way, and their ordering may
* change at any point.
*
* WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure
* you perform all queries on the same block. See the following
* https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post]
* for more information.
*/
function getRoleMember(bytes32 role, uint256 index) public view returns (address) {
return _roles[role].members.at(index);
}
/**
* @dev Returns the admin role that controls `role`. See {grantRole} and
* {revokeRole}.
*
* To change a role's admin, use {_setRoleAdmin}.
*/
function getRoleAdmin(bytes32 role) public view returns (bytes32) {
return _roles[role].adminRole;
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function grantRole(bytes32 role, address account) public virtual {
require(hasRole(_roles[role].adminRole, _msgSender()), "AccessControl: sender must be an admin to grant");
_grantRole(role, account);
}
/**
* @dev Revokes `role` from `account`.
*
* If `account` had been granted `role`, emits a {RoleRevoked} event.
*
* Requirements:
*
* - the caller must have ``role``'s admin role.
*/
function revokeRole(bytes32 role, address account) public virtual {
require(hasRole(_roles[role].adminRole, _msgSender()), "AccessControl: sender must be an admin to revoke");
_revokeRole(role, account);
}
/**
* @dev Revokes `role` from the calling account.
*
* Roles are often managed via {grantRole} and {revokeRole}: this function's
* purpose is to provide a mechanism for accounts to lose their privileges
* if they are compromised (such as when a trusted device is misplaced).
*
* If the calling account had been granted `role`, emits a {RoleRevoked}
* event.
*
* Requirements:
*
* - the caller must be `account`.
*/
function renounceRole(bytes32 role, address account) public virtual {
require(account == _msgSender(), "AccessControl: can only renounce roles for self");
_revokeRole(role, account);
}
/**
* @dev Grants `role` to `account`.
*
* If `account` had not been already granted `role`, emits a {RoleGranted}
* event. Note that unlike {grantRole}, this function doesn't perform any
* checks on the calling account.
*
* [WARNING]
* ====
* This function should only be called from the constructor when setting
* up the initial roles for the system.
*
* Using this function in any other way is effectively circumventing the admin
* system imposed by {AccessControl}.
* ====
*/
function _setupRole(bytes32 role, address account) internal virtual {
_grantRole(role, account);
}
/**
* @dev Sets `adminRole` as ``role``'s admin role.
*
* Emits a {RoleAdminChanged} event.
*/
function _setRoleAdmin(bytes32 role, bytes32 adminRole) internal virtual {
emit RoleAdminChanged(role, _roles[role].adminRole, adminRole);
_roles[role].adminRole = adminRole;
}
function _grantRole(bytes32 role, address account) private {
if (_roles[role].members.add(account)) {
emit RoleGranted(role, account, _msgSender());
}
}
function _revokeRole(bytes32 role, address account) private {
if (_roles[role].members.remove(account)) {
emit RoleRevoked(role, account, _msgSender());
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
/**
* @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
* ====
*/
function isContract(address account) internal view returns (bool) {
// This method relies on extcodesize, which returns 0 for contracts in
// construction, since the code is only stored at the end of the
// constructor execution.
uint256 size;
// solhint-disable-next-line no-inline-assembly
assembly { size := extcodesize(account) }
return size > 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");
// solhint-disable-next-line avoid-low-level-calls, avoid-call-value
(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 functionCall(target, data, "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");
require(isContract(target), "Address: call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.call{ value: value }(data);
return _verifyCallResult(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) {
require(isContract(target), "Address: static call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.staticcall(data);
return _verifyCallResult(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) {
require(isContract(target), "Address: delegate call to non-contract");
// solhint-disable-next-line avoid-low-level-calls
(bool success, bytes memory returndata) = target.delegatecall(data);
return _verifyCallResult(success, returndata, errorMessage);
}
function _verifyCallResult(bool success, bytes memory returndata, string memory errorMessage) private pure returns(bytes memory) {
if (success) {
return returndata;
} else {
// 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
// solhint-disable-next-line no-inline-assembly
assembly {
let returndata_size := mload(returndata)
revert(add(32, returndata), returndata_size)
}
} else {
revert(errorMessage);
}
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
interface AggregatorInterface {
function latestAnswer()
external
view
returns (
int256
);
function latestTimestamp()
external
view
returns (
uint256
);
function latestRound()
external
view
returns (
uint256
);
function getAnswer(
uint256 roundId
)
external
view
returns (
int256
);
function getTimestamp(
uint256 roundId
)
external
view
returns (
uint256
);
event AnswerUpdated(
int256 indexed current,
uint256 indexed roundId,
uint256 updatedAt
);
event NewRound(
uint256 indexed roundId,
address indexed startedBy,
uint256 startedAt
);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
import "./AggregatorInterface.sol";
import "./AggregatorV3Interface.sol";
interface AggregatorV2V3Interface is AggregatorInterface, AggregatorV3Interface
{
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
interface AggregatorV3Interface {
function decimals()
external
view
returns (
uint8
);
function description()
external
view
returns (
string memory
);
function version()
external
view
returns (
uint256
);
// getRoundData and latestRoundData should both raise "No data present"
// if they do not have data to report, instead of returning unset values
// which could be misinterpreted as actual reported values.
function getRoundData(
uint80 _roundId
)
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
function latestRoundData()
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
}
//SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
/*
Copyright 2018 Set Labs Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import "@openzeppelin/contracts/math/SafeMath.sol";
library CommonMath {
using SafeMath for uint256;
/**
* Calculates and returns the maximum value for a uint256
*
* @return The maximum value for uint256
*/
function maxUInt256() internal pure returns (uint256) {
return 2**256 - 1;
}
/**
* @dev Performs the power on a specified value, reverts on overflow.
*/
function safePower(uint256 a, uint256 pow) internal pure returns (uint256) {
require(a > 0);
uint256 result = 1;
for (uint256 i = 0; i < pow; i++) {
uint256 previousResult = result;
// Using safemath multiplication prevents overflows
result = previousResult.mul(a);
}
return result;
}
/**
* Checks for rounding errors and returns value of potential partial amounts of a principal
*
* @param _principal Number fractional amount is derived from
* @param _numerator Numerator of fraction
* @param _denominator Denominator of fraction
* @return uint256 Fractional amount of principal calculated
*/
function getPartialAmount(
uint256 _principal,
uint256 _numerator,
uint256 _denominator
) internal pure returns (uint256) {
// Get remainder of partial amount (if 0 not a partial amount)
uint256 remainder = mulmod(_principal, _numerator, _denominator);
// Return if not a partial amount
if (remainder == 0) {
return _principal.mul(_numerator).div(_denominator);
}
// Calculate error percentage
uint256 errPercentageTimes1000000 = remainder.mul(1000000).div(
_numerator.mul(_principal)
);
// Require error percentage is less than 0.1%.
require(
errPercentageTimes1000000 < 1000,
"CommonMath.getPartialAmount: Rounding error exceeds bounds"
);
return _principal.mul(_numerator).div(_denominator);
}
}
// SPDX-License-Identifier: MIT
pragma solidity >=0.6.0 <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 GSN 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 payable) {
return msg.sender;
}
function _msgData() internal view virtual returns (bytes memory) {
this; // silence state mutability warning without generating bytecode - see https://github.com/ethereum/solidity/issues/2691
return msg.data;
}
}
// SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
pragma abicoder v2;
// contracts
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Factory.sol";
import "./base/UniswapV3TwapLiquidityManager.sol";
// libraries
import "../libraries/LiquidityHelper.sol";
contract DefiEdgeTwapStrategy is UniswapV3TwapLiquidityManager {
using SafeMath for uint256;
// events
event Mint(address indexed user, uint256 share, uint256 amount0, uint256 amount1);
event Burn(address indexed user, uint256 share, uint256 amount0, uint256 amount1);
event Hold();
event Rebalance(NewTick[] ticks);
event PartialRebalance(PartialTick[] ticks);
struct PartialTick {
uint256 index;
bool burn;
uint256 amount0;
uint256 amount1;
}
struct NewTick {
int24 tickLower;
int24 tickUpper;
uint256 amount0;
uint256 amount1;
}
/**
* @param _factory Address of the strategy factory
* @param _pool Address of the pool
* @param _chainlinkRegistry Chainlink registry address
* @param _manager Address of the manager
* @param _useTwap is twap will be used to fetch usd price or chainlink will be used
* @param _ticks Array of the ticks
*/
constructor(
ITwapStrategyFactory _factory,
IUniswapV3Pool _pool,
FeedRegistryInterface _chainlinkRegistry,
ITwapStrategyManager _manager,
bool[2] memory _useTwap,
Tick[] memory _ticks
) {
require(!isInvalidTicks(_ticks), "IT");
// checks for valid ticks length
require(_ticks.length <= MAX_TICK_LENGTH, "ITL");
manager = _manager;
factory = _factory;
chainlinkRegistry = _chainlinkRegistry;
pool = _pool;
token0 = IERC20(pool.token0());
token1 = IERC20(pool.token1());
useTwap = _useTwap;
// useTwap = _useTwapForToken0 ? [true, false] : [false, true];
for (uint256 i = 0; i < _ticks.length; i++) {
ticks.push(Tick(_ticks[i].tickLower, _ticks[i].tickUpper));
}
}
/**
* @notice Adds liquidity to the primary range
* @param _amount0 Amount of token0
* @param _amount1 Amount of token1
* @param _amount0Min Minimum amount of token0 to be minted
* @param _amount1Min Minimum amount of token1 to be minted
* @param _minShare Minimum amount of shares to be received to the user
*/
function mint(
uint256 _amount0,
uint256 _amount1,
uint256 _amount0Min,
uint256 _amount1Min,
uint256 _minShare
)
external
onlyValidStrategy
nonReentrant
returns (
uint256 amount0,
uint256 amount1,
uint256 share
)
{
require(manager.isUserWhiteListed(msg.sender), "UA");
// get total amounts with fees
(uint256 totalAmount0, uint256 totalAmount1, , ) = this.getAUMWithFees(true);
// calculate optimal token0 & token1 amount for mint
(_amount0, _amount1) = TwapShareHelper.getOptimalAmounts(_amount0, _amount1, _amount0Min, _amount1Min, totalAmount0, totalAmount1);
amount0 = _amount0;
amount1 = _amount1;
if (amount0 > 0) {
TransferHelper.safeTransferFrom(address(token0), msg.sender, address(this), amount0);
}
if (amount1 > 0) {
TransferHelper.safeTransferFrom(address(token1), msg.sender, address(this), amount1);
}
// issue share based on the liquidity added
share = issueShare(amount0, amount1, totalAmount0, totalAmount1, msg.sender);
// prevent front running of strategy fee
require(share >= _minShare, "SC");
// price slippage check
require(amount0 >= _amount0Min && amount1 >= _amount1Min, "S");
uint256 _shareLimit = manager.limit();
// share limit
if (_shareLimit != 0) {
require(totalSupply() <= _shareLimit, "L");
}
reserve0 = reserve0.add(amount0);
reserve1 = reserve1.add(amount1);
emit Mint(msg.sender, share, amount0, amount1);
}
/**
* @notice Burn liquidity and transfer tokens back to the user
* @param _shares Shares to be burned
* @param _amount0Min Mimimum amount of token0 to be received
* @param _amount1Min Minimum amount of token1 to be received
*/
function burn(
uint256 _shares,
uint256 _amount0Min,
uint256 _amount1Min
) external nonReentrant returns (uint256 collect0, uint256 collect1) {
// check if the user has sufficient shares
require(balanceOf(msg.sender) >= _shares && _shares != 0, "INS");
uint256 amount0;
uint256 amount1;
uint256 totalFee0;
uint256 totalFee1;
// burn liquidity based on shares from existing ticks
for (uint256 i = 0; i < ticks.length; i++) {
Tick storage tick = ticks[i];
uint256 fee0;
uint256 fee1;
// burn liquidity and collect fees
(amount0, amount1, fee0, fee1) = burnLiquidity(tick.tickLower, tick.tickUpper, _shares, 0);
totalFee0 = totalFee0.add(fee0);
totalFee1 = totalFee1.add(fee1);
// add to total amounts
collect0 = collect0.add(amount0);
collect1 = collect1.add(amount1);
}
if (totalFee0 > 0 || totalFee1 > 0) {
_transferPerformanceFees(totalFee0, totalFee1);
}
// transfer performance fees
// give from unused amounts
uint256 total0 = reserve0;
uint256 total1 = reserve1;
uint256 _totalSupply = totalSupply();
if (total0 > collect0) {
collect0 = collect0.add(FullMath.mulDiv(total0 - collect0, _shares, _totalSupply));
}
if (total1 > collect1) {
collect1 = collect1.add(FullMath.mulDiv(total1 - collect1, _shares, _totalSupply));
}
// check slippage
require(_amount0Min <= collect0 && _amount1Min <= collect1, "S");
// burn shares
_burn(msg.sender, _shares);
// transfer tokens
if (collect0 > 0) {
TransferHelper.safeTransfer(address(token0), msg.sender, collect0);
}
if (collect1 > 0) {
TransferHelper.safeTransfer(address(token1), msg.sender, collect1);
}
reserve0 = reserve0.sub(collect0);
reserve1 = reserve1.sub(collect1);
emit Burn(msg.sender, _shares, collect0, collect1);
}
/**
* @notice Rebalances the strategy
* @param _zeroToOne swap direction - true if swapping token0 to token1 else false
* @param _amountIn amount of token to swap
* @param _isOneInchSwap true if swap is happening from one inch
* @param _swapData Swap data to perform exchange from 1inch
* @param _existingTicks Array of existing ticks to rebalance
* @param _newTicks New ticks in case there are any
* @param _burnAll When burning into new ticks, should we burn all liquidity?
*/
function rebalance(
bool _zeroToOne,
uint256 _amountIn,
bool _isOneInchSwap,
bytes calldata _swapData,
PartialTick[] calldata _existingTicks,
NewTick[] calldata _newTicks,
bool _burnAll
) external onlyOperator onlyValidStrategy nonReentrant {
uint256 totalFee0;
uint256 totalFee1;
if (_burnAll) {
require(_existingTicks.length == 0, "IA");
onHold = true;
(totalFee0, totalFee1) = burnAllLiquidity();
if (totalFee0 > 0 || totalFee1 > 0) {
_transferPerformanceFees(totalFee0, totalFee1);
}
delete ticks;
emit Hold();
}
//swap from 1inch if needed
if (_swapData.length > 0) {
_swap(_zeroToOne, _amountIn, _isOneInchSwap, _swapData);
}
// redeploy the partial ticks
if (_existingTicks.length > 0) {
for (uint256 i = 0; i < _existingTicks.length; i++) {
// require existing ticks to be in decreasing order
if (i > 0) require(_existingTicks[i - 1].index > _existingTicks[i].index, "IO"); // invalid order
Tick memory _tick = ticks[_existingTicks[i].index];
if (_existingTicks[i].burn) {
// burn liquidity from range
(, , uint256 fee0, uint256 fee1) = _burnLiquiditySingle(_existingTicks[i].index);
totalFee0 = totalFee0.add(fee0);
totalFee1 = totalFee1.add(fee1);
}
if (_existingTicks[i].amount0 > 0 || _existingTicks[i].amount1 > 0) {
// mint liquidity
mintLiquidity(_tick.tickLower, _tick.tickUpper, _existingTicks[i].amount0, _existingTicks[i].amount1, address(this));
} else if (_existingTicks[i].burn) {
// shift the index element at last of array
ticks[_existingTicks[i].index] = ticks[ticks.length - 1];
// remove last element
ticks.pop();
}
}
if (totalFee0 > 0 || totalFee1 > 0) {
_transferPerformanceFees(totalFee0, totalFee1);
}
emit PartialRebalance(_existingTicks);
}
// deploy liquidity into new ticks
if (_newTicks.length > 0) {
redeploy(_newTicks);
emit Rebalance(_newTicks);
}
require(!isInvalidTicks(ticks), "IT");
// checks for valid ticks length
require(ticks.length <= MAX_TICK_LENGTH + 10, "ITL");
}
/**
* @notice Redeploys between ticks
* @param _ticks Array of the ticks with amounts
*/
function redeploy(NewTick[] memory _ticks) internal {
// set hold false
onHold = false;
// redeploy the liquidity
for (uint256 i = 0; i < _ticks.length; i++) {
NewTick memory tick = _ticks[i];
// mint liquidity
mintLiquidity(tick.tickLower, tick.tickUpper, tick.amount0, tick.amount1, address(this));
// push to ticks array
ticks.push(Tick(tick.tickLower, tick.tickUpper));
}
}
/**
* @notice Withdraws funds from the contract in case of emergency
* @dev only governance can withdraw the funds, it can be frozen from the factory permenently
* @param _token Token to transfer
* @param _to Where to transfer the token
* @param _amount Amount to be withdrawn
* @param _newTicks Ticks data to burn liquidity from
*/
function emergencyWithdraw(
address _token,
address _to,
uint256 _amount,
NewTick[] calldata _newTicks
) external {
require(onlyGovernance() && !factory.freezeEmergency());
if (_newTicks.length > 0) {
for (uint256 tickIndex = 0; tickIndex < _newTicks.length; tickIndex++) {
NewTick memory tick = _newTicks[tickIndex];
(uint128 currentLiquidity, , , , ) = pool.positions(PositionKey.compute(address(this), tick.tickLower, tick.tickUpper));
pool.burn(tick.tickLower, tick.tickUpper, currentLiquidity);
pool.collect(address(this), tick.tickLower, tick.tickUpper, type(uint128).max, type(uint128).max);
}
}
if (_amount > 0) {
TransferHelper.safeTransfer(_token, _to, _amount);
}
reserve0 = token0.balanceOf(address(this));
reserve1 = token1.balanceOf(address(this));
}
/**
* @notice Withdraws airdropped tokens
* @dev only governance can withdraw the funds
* @param _token Token to transfer
* @param _to Where to transfer the token
*/
function airdropWithdraw(address _token, address _to) external {
require(onlyGovernance());
require(_token != address(token0) && _token != address(token1), "IT");
uint256 _amount = IERC20(_token).balanceOf(address(this));
if (_amount > 0) {
TransferHelper.safeTransfer(_token, _to, _amount);
}
}
}
// SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
pragma abicoder v2;
import "./DefiEdgeTwapStrategy.sol";
import "./base/TwapStrategyManager.sol";
import "@openzeppelin/contracts/math/SafeMath.sol";
import "./interfaces/IDefiEdgeTwapStrategyDeployer.sol";
import "./interfaces/ITwapStrategyBase.sol";
contract DefiEdgeTwapStrategyFactory is ITwapStrategyFactory {
using SafeMath for uint256;
mapping(uint256 => address) public override strategyByIndex; // map strategies by index
mapping(address => bool) public override isValidStrategy; // make strategy valid when deployed
mapping(address => address) public override strategyByManager; // strategy manager contracts linked with strategies
mapping(address => mapping(address => uint256)) internal _heartBeat; // map heartBeat for base and quote token
mapping(address => uint256) public override twapPricePeriod;
uint256 public override defaultTwapPricePeriod = 600;
// total number of strategies
uint256 public override totalIndex;
uint256 public override maximumManagerPerformanceFeeRate = 20e6; // default 20% - 1e8 means 100%
uint256 public constant MAX_PROTOCOL_PERFORMANCE_FEES_RATE = 100e6; // maximum 100%
// uint256 public override protocolPerformanceFeeRate; // 1e8 means 100%
uint256 public override defaultProtocolPerformanceFeeRate;
mapping(address => uint256) public override protocolPerformanceFeeRateByPool; // 1e8 means 100%
mapping(address => uint256) public override protocolPerformanceFeeRateByStrategy; // 1e8 means 100%
uint256 public override protocolFeeRate; // 1e8 means 100%
uint256 public override defaultAllowedSlippage;
uint256 public override defaultAllowedSwapDeviation;
mapping(address => uint256) internal _allowedSlippageByPool; // allowed slippage on the swap
mapping(address => uint256) internal _allowedSwapDeviationByPool; // allowed swap deviation between slippage and per swap
uint256 public constant MAX_DECIMAL = 18; // pool token decimal should be less then 18
// governance address
address public override governance;
// pending governance
address public override pendingGovernance;
// protocol fee
address public override feeTo; // receive protocol fees here
uint256 public override strategyCreationFee; // fee for strategy creation in native blockchain token
IDefiEdgeTwapStrategyDeployer public override deployerProxy;
IUniswapV3Factory public override uniswapV3Factory; // Uniswap V3 pool factory
FeedRegistryInterface public override chainlinkRegistry; // Chainlink registry
// IOneInchRouter public override oneInchRouter;
address public override swapProxy;
// mapping of blacklisted strategies
mapping(address => bool) public override denied;
// when true emergency functions will be frozen forever
bool public override freezeEmergency;
// Modifiers
modifier onlyGovernance() {
require(msg.sender == governance, "NO");
_;
}
constructor(
address _governance,
IDefiEdgeTwapStrategyDeployer _deployerProxy,
FeedRegistryInterface _chainlinkRegistry,
IUniswapV3Factory _uniswapV3factory,
uint256 _allowedSlippage,
uint256 _allowedDeviation
) {
governance = _governance;
deployerProxy = _deployerProxy;
uniswapV3Factory = _uniswapV3factory;
chainlinkRegistry = _chainlinkRegistry;
defaultAllowedSlippage = _allowedSlippage;
defaultAllowedSwapDeviation = _allowedDeviation;
}
/**
* @inheritdoc ITwapStrategyFactory
*/
function createStrategy(CreateStrategyParams calldata params) external payable override {
require(msg.value == strategyCreationFee, "INSUFFICIENT_FEES");
IUniswapV3Pool pool = IUniswapV3Pool(params.pool);
require(IERC20Minimal(pool.token0()).decimals() <= MAX_DECIMAL && IERC20Minimal(pool.token1()).decimals() <= MAX_DECIMAL, "ID");
address poolAddress = uniswapV3Factory.getPool(pool.token0(), pool.token1(), pool.fee());
require(poolAddress != address(0) && poolAddress == address(pool), "IP");
address manager = address(
new TwapStrategyManager(
ITwapStrategyFactory(address(this)),
params.operator,
params.feeTo,
params.managementFeeRate,
params.performanceFeeRate,
params.limit
)
);
address strategy = deployerProxy.createStrategy(
ITwapStrategyFactory(address(this)),
params.pool,
chainlinkRegistry,
ITwapStrategyManager(manager),
params.useTwap,
params.ticks
);
strategyByManager[manager] = strategy;
totalIndex = totalIndex.add(1);
strategyByIndex[totalIndex] = strategy;
isValidStrategy[strategy] = true;
emit NewStrategy(strategy, msg.sender);
}
/**
* @notice Changes default TWAP period
* @param _pool Address of the pool
* @param _twapPricePeriod Timespan in seconds
*/
function changeDefaultTwapPeriod(address _pool, uint256 _twapPricePeriod) external onlyGovernance {
twapPricePeriod[_pool] = _twapPricePeriod;
emit TwapPricePeriodChanged(_pool, _twapPricePeriod);
}
/**
* @notice Changes allowed slippage for specific pool
* @param _pool Address of the pool
* @param _allowedSlippage New allowed slippage specific to the pool
*/
function changeAllowedSlippage(address _pool, uint256 _allowedSlippage) external override onlyGovernance {
_allowedSlippageByPool[_pool] = _allowedSlippage;
emit ChangeAllowedSlippage(_pool, _allowedSlippage);
}
/**
* @notice Change allowed swap deviation
* @param _pool Address of the new pool
* @param _allowedSwapDeviation New allowed swap deviation value
*/
function changeAllowedSwapDeviation(address _pool, uint256 _allowedSwapDeviation) external override onlyGovernance {
_allowedSwapDeviationByPool[_pool] = _allowedSwapDeviation;
emit ChangeAllowedSwapDeviation(_pool, _allowedSwapDeviation);
}
/**
* @notice Current allowed slippage if the slippage for specific pool is not defined it'll return default allowed slippage
* @param _pool Address of the pool
* @return Current allowed slippage
*/
function allowedSlippage(address _pool) public view override returns (uint256) {
if (_allowedSlippageByPool[_pool] > 0) {
return _allowedSlippageByPool[_pool];
} else {
return defaultAllowedSlippage;
}
}
/**
* @notice Current allowed swap deviation by pool, if by pool is not defiened it'll return the default vallue
* @param _pool Address of the pool
* @return Current allowed swap deviation
*/
function allowedSwapDeviation(address _pool) public view override returns (uint256) {
if (_allowedSwapDeviationByPool[_pool] > 0) {
return _allowedSwapDeviationByPool[_pool];
} else {
return defaultAllowedSwapDeviation;
}
}
/**
* @notice Changes default values for the slippage and deviation
* @param _allowedSlippage New default allowed slippage
* @param _allowedSwapDeviation New default allowed deviation for the swap.
*/
function changeDefaultValues(uint256 _allowedSlippage, uint256 _allowedSwapDeviation) external override onlyGovernance {
if (_allowedSlippage > 0) {
defaultAllowedSlippage = _allowedSlippage;
emit ChangeAllowedSlippage(address(0), defaultAllowedSlippage);
}
if (_allowedSwapDeviation > 0) {
defaultAllowedSwapDeviation = _allowedSwapDeviation;
emit ChangeAllowedSwapDeviation(address(0), defaultAllowedSwapDeviation);
}
}
/**
* @notice Changes protocol fees
* @param _fee New fee in 1e8 format
*/
function changeProtocolFeeRate(uint256 _fee) external onlyGovernance {
require(_fee <= 1e7, "IA"); // should be less than 10%
protocolFeeRate = _fee;
emit ChangeProtocolFee(protocolFeeRate);
}
/**
* @notice Changes maximum cap for manager performance fees
* @param _fee New fee in 1e8 format
*/
function changeMaxManagerPerformanceFeeRate(uint256 _fee) external onlyGovernance {
require(_fee <= 1e8, "IA"); // should be less than 100%
maximumManagerPerformanceFeeRate = _fee;
emit ChangeDefaultMaxManagerPerformanceFee(_fee);
}
/**
* @notice Changes protocol performance fees by per pool, per strategy or setup default performance fee
* @param pool Address of the pool
* @param strategy Address of the strategy
* @param _feeRate New fee in 1e8 format
*/
function changeProtocolPerformanceFeeRate(address pool, address strategy, uint256 _feeRate) external onlyGovernance {
require(_feeRate <= MAX_PROTOCOL_PERFORMANCE_FEES_RATE, "IA"); // should be less than 100%
if (pool != address(0)) {
protocolPerformanceFeeRateByPool[pool] = _feeRate;
emit ChangeProtocolPerformanceFee(pool, _feeRate);
}
if (strategy != address(0)) {
protocolPerformanceFeeRateByStrategy[strategy] = _feeRate;
emit ChangeProtocolPerformanceFee(strategy, _feeRate);
}
if (pool == address(0) && strategy == address(0)) {
defaultProtocolPerformanceFeeRate = _feeRate;
emit ChangeProtocolPerformanceFee(address(0), _feeRate);
}
}
/**
* @notice Get protocol performance fees by per pool, per strategy
* @param pool Address of the pool
* @param strategy Address of the strategy
* @return _feeRate New fee in 1e8 format
*/
function getProtocolPerformanceFeeRate(address pool, address strategy) external view override returns(uint256 _feeRate) {
uint256 _protocolPerformanceFeeRateByStrategy = protocolPerformanceFeeRateByStrategy[strategy];
uint256 _protocolPerformanceFeeRateByPool = protocolPerformanceFeeRateByPool[pool];
if (_protocolPerformanceFeeRateByStrategy > 0) {
_feeRate = _protocolPerformanceFeeRateByStrategy;
} else if (_protocolPerformanceFeeRateByPool > 0) {
_feeRate = _protocolPerformanceFeeRateByPool;
} else {
_feeRate = defaultProtocolPerformanceFeeRate;
}
}
/**
* @notice Change feeTo address
* @param _feeTo New fee to address
*/
function changeFeeTo(address _feeTo) external onlyGovernance {
feeTo = _feeTo;
}
/**
* @notice Change the governance address
* @param _governance Address of the new governance
*/
function changeGovernance(address _governance) external onlyGovernance {
pendingGovernance = _governance;
}
/**
* @notice Change the operator
*/
function acceptGovernance() external {
require(msg.sender == pendingGovernance);
governance = pendingGovernance;
}
/**
* @notice Adds strategy to Denylist, rebalance and add liquidity will be stopped
* @param _strategy Address of the strategy
*/
function deny(address _strategy, bool _status) external onlyGovernance {
denied[_strategy] = _status;
emit StrategyStatusChanged(_status);
}
/**
* @notice Changes strategy creation fees
* @param _fee New fee in 1e18 format
*/
function changeFeeForStrategyCreation(uint256 _fee) external onlyGovernance {
strategyCreationFee = _fee;
emit ChangeStrategyCreationFee(strategyCreationFee);
}
/**
* @notice Governance claims fees received from strategy creation
*/
function claimFees(address _to) external onlyGovernance {
uint256 balance = address(this).balance;
if (balance > 0) {
payable(_to).transfer(balance);
emit ClaimFees(_to, balance);
}
}
/**
* @notice Update heartBeat for specific feeds
* @param _base base token address
* @param _quote quote token address
* @param _period heartbeat in seconds
*/
function setMinHeartbeat(
address _base,
address _quote,
uint256 _period
) external onlyGovernance {
_heartBeat[_base][_quote] = _period;
_heartBeat[_quote][_base] = _period;
}
/**
* @notice Fetch heartBeat for specific feeds, if hearbeat is 0 then it will return 3600 seconds by default
* @param _base base token address
* @param _quote quote token address
*/
function getHeartBeat(address _base, address _quote) external view override returns (uint256) {
if (_heartBeat[_base][_quote] == 0) {
return 3600;
} else {
return _heartBeat[_base][_quote];
}
}
/**
* @notice Change ALO swap proxy
* @param _swapProxy swap proxy contract address
*/
function changeSwapProxy(address _swapProxy) external onlyGovernance {
swapProxy = _swapProxy;
emit ChangeSwapProxy(_swapProxy);
}
/**
* @notice Freeze emergency function, can be done only once
*/
function freezeEmergencyFunctions() external override onlyGovernance {
freezeEmergency = true;
emit EmergencyFrozen();
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
library Denominations {
address public constant ETH = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;
address public constant BTC = 0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB;
// Fiat currencies follow https://en.wikipedia.org/wiki/ISO_4217
address public constant USD = address(840);
address public constant GBP = address(826);
address public constant EUR = address(978);
address public constant JPY = address(392);
address public constant KRW = address(410);
address public constant CNY = address(156);
address public constant AUD = address(36);
address public constant CAD = address(124);
address public constant CHF = address(756);
address public constant ARS = address(32);
address public constant PHP = address(608);
address public constant NZD = address(554);
address public constant SGD = address(702);
address public constant NGN = address(566);
address public constant ZAR = address(710);
address public constant RUB = address(643);
address public constant INR = address(356);
address public constant BRL = address(986);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.6;
import "@openzeppelin/contracts/utils/Context.sol";
import "@openzeppelin/contracts/math/SafeMath.sol";
import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
/**
* @dev Implementation of the {IERC20} interface.
*
* This implementation is agnostic to the way tokens are created. This means
* that a supply mechanism has to be added in a derived contract using {_mint}.
* For a generic mechanism see {ERC20PresetMinterPauser}.
*
* TIP: For a detailed writeup see our guide
* https://forum.zeppelin.solutions/t/how-to-implement-erc20-supply-mechanisms/226[How
* to implement supply mechanisms].
*
* We have followed general OpenZeppelin guidelines: functions revert instead
* of returning `false` on failure. This behavior is nonetheless conventional
* and does not conflict with the expectations of ERC20 applications.
*
* Additionally, an {Approval} event is emitted on calls to {transferFrom}.
* This allows applications to reconstruct the allowance for all accounts just
* by listening to said events. Other implementations of the EIP may not emit
* these events, as it isn't required by the specification.
*
* Finally, the non-standard {decreaseAllowance} and {increaseAllowance}
* functions have been added to mitigate the well-known issues around setting
* allowances. See {IERC20-approve}.
*/
abstract contract ERC20 is Context, IERC20 {
using SafeMath for uint256;
mapping(address => uint256) private _balances;
mapping(address => mapping(address => uint256)) public override allowance; // map approval of from to to address
uint256 internal _totalSupply;
bytes32 public constant name = "DefiEdge Share";
bytes32 public constant symbol = "DEShare";
uint8 public constant decimals = 18;
/**
* @dev See {IERC20-balanceOf}.
*/
function balanceOf(address account)
public
view
virtual
override
returns (uint256)
{
return _balances[account];
}
/**
* @dev See {IERC20-transfer}.
*
* Requirements:
*
* - `recipient` cannot be the zero address.
* - the caller must have a balance of at least `amount`.
*/
function transfer(address recipient, uint256 amount)
public
virtual
override
returns (bool)
{
_transfer(_msgSender(), recipient, amount);
return true;
}
/**
* @dev See {IERC20-approve}.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function approve(address spender, uint256 amount)
public
virtual
override
returns (bool)
{
_approve(_msgSender(), spender, amount);
return true;
}
/**
* @dev See {IERC20-transferFrom}.
*
* Emits an {Approval} event indicating the updated allowance. This is not
* required by the EIP. See the note at the beginning of {ERC20}.
*
* Requirements:
*
* - `sender` and `recipient` cannot be the zero address.
* - `sender` must have a balance of at least `amount`.
* - the caller must have allowance for ``sender``'s tokens of at least
* `amount`.
*/
function transferFrom(
address sender,
address recipient,
uint256 amount
) public virtual override returns (bool) {
_transfer(sender, recipient, amount);
_approve(
sender,
_msgSender(),
allowance[sender][_msgSender()].sub(amount, "a")
);
return true;
}
/**
* @dev Atomically increases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
*/
function increaseAllowance(address spender, uint256 addedValue)
public
virtual
returns (bool)
{
_approve(
_msgSender(),
spender,
allowance[_msgSender()][spender].add(addedValue)
);
return true;
}
/**
* @dev Atomically decreases the allowance granted to `spender` by the caller.
*
* This is an alternative to {approve} that can be used as a mitigation for
* problems described in {IERC20-approve}.
*
* Emits an {Approval} event indicating the updated allowance.
*
* Requirements:
*
* - `spender` cannot be the zero address.
* - `spender` must have allowance for the caller of at least
* `subtractedValue`.
*/
function decreaseAllowance(address spender, uint256 subtractedValue)
public
virtual
returns (bool)
{
_approve(
_msgSender(),
spender,
allowance[_msgSender()][spender].sub(subtractedValue, "a")
);
return true;
}
/**
* @dev Moves tokens `amount` from `sender` to `recipient`.
*
* This is internal function is equivalent to {transfer}, and can be used to
* e.g. implement automatic token fees, slashing mechanisms, etc.
*
* Emits a {Transfer} event.
*
* Requirements:
*
* - `sender` cannot be the zero address.
* - `recipient` cannot be the zero address.
* - `sender` must have a balance of at least `amount`.
*/
function _transfer(
address sender,
address recipient,
uint256 amount
) internal virtual {
_beforeTokenTransfer(sender, recipient, amount);
_balances[sender] = _balances[sender].sub(
amount,
"ERC20: transfer amount exceeds balance"
);
_balances[recipient] = _balances[recipient].add(amount);
emit Transfer(sender, recipient, amount);
}
/** @dev Creates `amount` tokens and assigns them to `account`, increasing
* the total supply.
*
* Emits a {Transfer} event with `from` set to the zero address.
*
* Requirements:
*
* - `to` cannot be the zero address.
*/
function _mint(address account, uint256 amount) internal virtual {
_beforeTokenTransfer(address(0), account, amount);
_totalSupply = _totalSupply.add(amount);
_balances[account] = _balances[account].add(amount);
emit Transfer(address(0), account, amount);
}
/**
* @dev Destroys `amount` tokens from `account`, reducing the
* total supply.
*
* Emits a {Transfer} event with `to` set to the zero address.
*
* Requirements:
*
* - `account` cannot be the zero address.
* - `account` must have at least `amount` tokens.
*/
function _burn(address account, uint256 amount) internal virtual {
_beforeTokenTransfer(account, address(0), amount);
_balances[account] = _balances[account].sub(amount, "b");
_totalSupply = _totalSupply.sub(amount);
emit Transfer(account, address(0), amount);
}
/**
* @dev Sets `amount` as the allowance of `spender` over the `owner` s tokens.
*
* This internal function is equivalent to `approve`, and can be used to
* e.g. set automatic allowances for certain subsystems, etc.
*
* Emits an {Approval} event.
*
* Requirements:
*
* - `owner` cannot be the zero address.
* - `spender` cannot be the zero address.
*/
function _approve(
address owner,
address spender,
uint256 amount
) internal virtual {
allowance[owner][spender] = amount;
emit Approval(owner, spender, amount);
}
/**
* @dev Hook that is called before any transfer of tokens. This includes
* minting and burning.
*
* Calling conditions:
*
* - when `from` and `to` are both non-zero, `amount` of ``from``'s tokens
* will be to transferred to `to`.
* - when `from` is zero, `amount` tokens will be minted for `to`.
* - when `to` is zero, `amount` of ``from``'s tokens will be burned.
* - `from` and `to` are never both zero.
*
* To learn more about hooks, head to xref:ROOT:extending-contracts.adoc#using-hooks[Using Hooks].
*/
function _beforeTokenTransfer(
address from,
address to,
uint256 amount
) internal virtual {}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.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.
*/
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;
// When the value to delete is the last one, the swap operation is unnecessary. However, since this occurs
// so rarely, we still do the swap anyway to avoid the gas cost of adding an 'if' statement.
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] = toDeleteIndex + 1; // All indexes are 1-based
// 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) {
require(set._values.length > index, "EnumerableSet: index out of bounds");
return set._values[index];
}
// 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);
}
// 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))));
}
// 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 on 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));
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
pragma abicoder v2;
import "./AggregatorV2V3Interface.sol";
interface FeedRegistryInterface {
struct Phase {
uint16 phaseId;
uint80 startingAggregatorRoundId;
uint80 endingAggregatorRoundId;
}
event FeedProposed(
address indexed asset,
address indexed denomination,
address indexed proposedAggregator,
address currentAggregator,
address sender
);
event FeedConfirmed(
address indexed asset,
address indexed denomination,
address indexed latestAggregator,
address previousAggregator,
uint16 nextPhaseId,
address sender
);
// V3 AggregatorV3Interface
function decimals(
address base,
address quote
)
external
view
returns (
uint8
);
function description(
address base,
address quote
)
external
view
returns (
string memory
);
function version(
address base,
address quote
)
external
view
returns (
uint256
);
function latestRoundData(
address base,
address quote
)
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
function getRoundData(
address base,
address quote,
uint80 _roundId
)
external
view
returns (
uint80 roundId,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
// V2 AggregatorInterface
function latestAnswer(
address base,
address quote
)
external
view
returns (
int256 answer
);
function latestTimestamp(
address base,
address quote
)
external
view
returns (
uint256 timestamp
);
function latestRound(
address base,
address quote
)
external
view
returns (
uint256 roundId
);
function getAnswer(
address base,
address quote,
uint256 roundId
)
external
view
returns (
int256 answer
);
function getTimestamp(
address base,
address quote,
uint256 roundId
)
external
view
returns (
uint256 timestamp
);
// Registry getters
function getFeed(
address base,
address quote
)
external
view
returns (
AggregatorV2V3Interface aggregator
);
function getPhaseFeed(
address base,
address quote,
uint16 phaseId
)
external
view
returns (
AggregatorV2V3Interface aggregator
);
function isFeedEnabled(
address aggregator
)
external
view
returns (
bool
);
function getPhase(
address base,
address quote,
uint16 phaseId
)
external
view
returns (
Phase memory phase
);
// Round helpers
function getRoundFeed(
address base,
address quote,
uint80 roundId
)
external
view
returns (
AggregatorV2V3Interface aggregator
);
function getPhaseRange(
address base,
address quote,
uint16 phaseId
)
external
view
returns (
uint80 startingRoundId,
uint80 endingRoundId
);
function getPreviousRoundId(
address base,
address quote,
uint80 roundId
) external
view
returns (
uint80 previousRoundId
);
function getNextRoundId(
address base,
address quote,
uint80 roundId
) external
view
returns (
uint80 nextRoundId
);
// Feed management
function proposeFeed(
address base,
address quote,
address aggregator
) external;
function confirmFeed(
address base,
address quote,
address aggregator
) external;
// Proposed aggregator
function getProposedFeed(
address base,
address quote
)
external
view
returns (
AggregatorV2V3Interface proposedAggregator
);
function proposedGetRoundData(
address base,
address quote,
uint80 roundId
)
external
view
returns (
uint80 id,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
function proposedLatestRoundData(
address base,
address quote
)
external
view
returns (
uint80 id,
int256 answer,
uint256 startedAt,
uint256 updatedAt,
uint80 answeredInRound
);
// Phases
function getCurrentPhaseId(
address base,
address quote
)
external
view
returns (
uint16 currentPhaseId
);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.4.0;
/// @title FixedPoint96
/// @notice A library for handling binary fixed point numbers, see https://en.wikipedia.org/wiki/Q_(number_format)
/// @dev Used in SqrtPriceMath.sol
library FixedPoint96 {
uint8 internal constant RESOLUTION = 96;
uint256 internal constant Q96 = 0x1000000000000000000000000;
}
// SPDX-License-Identifier: MIT
pragma solidity >=0.4.0;
/// @title Contains 512-bit math functions
/// @notice Facilitates multiplication and division that can have overflow of an intermediate value without any loss of precision
/// @dev Handles "phantom overflow" i.e., allows multiplication and division where an intermediate value overflows 256 bits
library FullMath {
/// @notice Calculates floor(a×b÷denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
/// @param a The multiplicand
/// @param b The multiplier
/// @param denominator The divisor
/// @return result The 256-bit result
/// @dev Credit to Remco Bloemen under MIT license https://xn--2-umb.com/21/muldiv
function mulDiv(
uint256 a,
uint256 b,
uint256 denominator
) internal pure returns (uint256 result) {
// 512-bit multiply [prod1 prod0] = a * b
// Compute the product mod 2**256 and mod 2**256 - 1
// then use the Chinese Remainder Theorem to reconstruct
// the 512 bit result. The result is stored in two 256
// variables such that product = prod1 * 2**256 + prod0
uint256 prod0; // Least significant 256 bits of the product
uint256 prod1; // Most significant 256 bits of the product
assembly {
let mm := mulmod(a, b, not(0))
prod0 := mul(a, b)
prod1 := sub(sub(mm, prod0), lt(mm, prod0))
}
// Handle non-overflow cases, 256 by 256 division
if (prod1 == 0) {
require(denominator > 0);
assembly {
result := div(prod0, denominator)
}
return result;
}
// Make sure the result is less than 2**256.
// Also prevents denominator == 0
require(denominator > prod1);
///////////////////////////////////////////////
// 512 by 256 division.
///////////////////////////////////////////////
// Make division exact by subtracting the remainder from [prod1 prod0]
// Compute remainder using mulmod
uint256 remainder;
assembly {
remainder := mulmod(a, b, denominator)
}
// Subtract 256 bit number from 512 bit number
assembly {
prod1 := sub(prod1, gt(remainder, prod0))
prod0 := sub(prod0, remainder)
}
// Factor powers of two out of denominator
// Compute largest power of two divisor of denominator.
// Always >= 1.
uint256 twos = -denominator & denominator;
// Divide denominator by power of two
assembly {
denominator := div(denominator, twos)
}
// Divide [prod1 prod0] by the factors of two
assembly {
prod0 := div(prod0, twos)
}
// Shift in bits from prod1 into prod0. For this we need
// to flip `twos` such that it is 2**256 / twos.
// If twos is zero, then it becomes one
assembly {
twos := add(div(sub(0, twos), twos), 1)
}
prod0 |= prod1 * twos;
// Invert denominator mod 2**256
// Now that denominator is an odd number, it has an inverse
// modulo 2**256 such that denominator * inv = 1 mod 2**256.
// Compute the inverse by starting with a seed that is correct
// correct for four bits. That is, denominator * inv = 1 mod 2**4
uint256 inv = (3 * denominator) ^ 2;
// Now use Newton-Raphson iteration to improve the precision.
// Thanks to Hensel's lifting lemma, this also works in modular
// arithmetic, doubling the correct bits in each step.
inv *= 2 - denominator * inv; // inverse mod 2**8
inv *= 2 - denominator * inv; // inverse mod 2**16
inv *= 2 - denominator * inv; // inverse mod 2**32
inv *= 2 - denominator * inv; // inverse mod 2**64
inv *= 2 - denominator * inv; // inverse mod 2**128
inv *= 2 - denominator * inv; // inverse mod 2**256
// Because the division is now exact we can divide by multiplying
// with the modular inverse of denominator. This will give us the
// correct result modulo 2**256. Since the precoditions guarantee
// that the outcome is less than 2**256, this is the final result.
// We don't need to compute the high bits of the result and prod1
// is no longer required.
result = prod0 * inv;
return result;
}
/// @notice Calculates ceil(a×b÷denominator) with full precision. Throws if result overflows a uint256 or denominator == 0
/// @param a The multiplicand
/// @param b The multiplier
/// @param denominator The divisor
/// @return result The 256-bit result
function mulDivRoundingUp(
uint256 a,
uint256 b,
uint256 denominator
) internal pure returns (uint256 result) {
result = mulDiv(a, b, denominator);
if (mulmod(a, b, denominator) > 0) {
require(result < type(uint256).max);
result++;
}
}
}
// SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
pragma abicoder v2;
import "./ITwapStrategyFactory.sol";
import "./ITwapStrategyManager.sol";
import "./ITwapStrategyBase.sol";
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import "@chainlink/contracts/src/v0.7/interfaces/FeedRegistryInterface.sol";
interface IDefiEdgeTwapStrategyDeployer {
function createStrategy(
ITwapStrategyFactory _factory,
IUniswapV3Pool _pool,
FeedRegistryInterface _chainlinkRegistry,
ITwapStrategyManager _manager,
bool[2] memory _useTwap,
ITwapStrategyBase.Tick[] memory _ticks
) external returns (address);
event StrategyDeployed(address strategy);
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
/**
* @dev Interface of the ERC20 standard as defined in the EIP.
*/
interface IERC20 {
/**
* @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 `recipient`.
*
* Returns a boolean value indicating whether the operation succeeded.
*
* Emits a {Transfer} event.
*/
function transfer(address recipient, 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 `sender` to `recipient` 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 sender, address recipient, uint256 amount) external returns (bool);
/**
* @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);
}
pragma solidity ^0.7.6;
interface IERC20Minimal {
function decimals() external view returns (uint8);
}
//SPDX-License-Identifier: Unlicense
pragma solidity ^0.7.6;
interface ISwapProxy {
function aggregatorSwap(bytes calldata swapData) external;
function isAllowedOneInchCaller(address) external view returns (bool);
}
//SPDX-License-Identifier: Unlicense
pragma solidity ^0.7.6;
pragma abicoder v2;
import "./ITwapStrategyFactory.sol";
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import "./ITwapStrategyManager.sol";
interface ITwapStrategyBase {
struct Tick {
int24 tickLower;
int24 tickUpper;
}
event ClaimFee(uint256 managerFee, uint256 protocolFee);
function onHold() external view returns (bool);
function accManagementFeeShares() external view returns (uint256);
function factory() external view returns (ITwapStrategyFactory);
function pool() external view returns (IUniswapV3Pool);
function manager() external view returns (ITwapStrategyManager);
function useTwap(uint256 index) external view returns (bool);
function claimFee() external;
}
//SPDX-License-Identifier: Unlicense
pragma solidity ^0.7.6;
pragma abicoder v2;
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Factory.sol";
import "@chainlink/contracts/src/v0.7/interfaces/FeedRegistryInterface.sol";
import "./ITwapStrategyBase.sol";
import "./IDefiEdgeTwapStrategyDeployer.sol";
interface ITwapStrategyFactory {
struct CreateStrategyParams {
address operator;
address feeTo;
uint256 managementFeeRate;
uint256 performanceFeeRate;
uint256 limit;
IUniswapV3Pool pool;
bool[2] useTwap;
ITwapStrategyBase.Tick[] ticks;
}
function totalIndex() external view returns (uint256);
function strategyCreationFee() external view returns (uint256); // fee for strategy creation in native token
function defaultAllowedSlippage() external view returns (uint256); // 1e18 means 100%
function defaultAllowedSwapDeviation() external view returns (uint256); // 1e18 means 100%
function allowedSlippage(address _pool) external view returns (uint256); // 1e18 means 100%
function allowedSwapDeviation(address _pool) external view returns (uint256); // 1e18 means 100%
function defaultTwapPricePeriod() external view returns (uint256);
function twapPricePeriod(address) external view returns (uint256); //in seconds
function isValidStrategy(address) external view returns (bool);
function strategyByIndex(uint256) external view returns (address);
function strategyByManager(address) external view returns (address);
function feeTo() external view returns (address);
function denied(address) external view returns (bool);
function maximumManagerPerformanceFeeRate() external view returns (uint256); // 1e8 means 100%
function protocolFeeRate() external view returns (uint256); // 1e8 means 100%
function protocolPerformanceFeeRateByPool(address) external view returns (uint256); // 1e8 means 100%
function protocolPerformanceFeeRateByStrategy(address) external view returns (uint256); // 1e8 means 100%
function defaultProtocolPerformanceFeeRate() external view returns (uint256); // 1e8 means 100%
function getProtocolPerformanceFeeRate(address pool, address strategy) external view returns(uint256 _feeRate); // 1e8 means 100%
function governance() external view returns (address);
function pendingGovernance() external view returns (address);
function deployerProxy() external view returns (IDefiEdgeTwapStrategyDeployer);
function uniswapV3Factory() external view returns (IUniswapV3Factory);
function chainlinkRegistry() external view returns (FeedRegistryInterface);
function swapProxy() external view returns (address);
function freezeEmergency() external view returns (bool);
function getHeartBeat(address _base, address _quote) external view returns (uint256);
function createStrategy(CreateStrategyParams calldata params) external payable;
function freezeEmergencyFunctions() external;
function changeAllowedSlippage(address, uint256) external;
function changeAllowedSwapDeviation(address, uint256) external;
function changeDefaultValues(uint256, uint256) external;
event NewStrategy(address indexed strategy, address indexed creater);
event ChangeProtocolFee(uint256 fee);
event ChangeDefaultMaxManagerPerformanceFee(uint256 _feeRate);
event ChangeProtocolPerformanceFee(address strategyOrPool, uint256 _feeRate);
event StrategyStatusChanged(bool status);
event ChangeStrategyCreationFee(uint256 amount);
event ClaimFees(address to, uint256 amount);
event TwapPricePeriodChanged(address pool, uint256 period);
event ChangeAllowedSlippage(address pool, uint256 value);
event ChangeAllowedSwapDeviation(address pool, uint256 value);
event EmergencyFrozen();
event ChangeSwapProxy(address newSwapProxy);
}
//SPDX-License-Identifier: Unlicense
pragma solidity ^0.7.6;
import "./ITwapStrategyFactory.sol";
interface ITwapStrategyManager {
function isUserWhiteListed(address _account) external view returns (bool);
function isAllowedToManage(address) external view returns (bool);
function isAllowedToBurn(address) external view returns (bool);
function managementFeeRate() external view returns (uint256); // 1e8 decimals
function performanceFeeRate() external view returns (uint256); // 1e8 decimals
function operator() external view returns (address);
function limit() external view returns (uint256);
function feeTo() external view returns (address);
function factory() external view returns (ITwapStrategyFactory);
function incrementSwapCounter() external;
function twapPricePeriod() external view returns (uint256);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title The interface for the Uniswap V3 Factory
/// @notice The Uniswap V3 Factory facilitates creation of Uniswap V3 pools and control over the protocol fees
interface IUniswapV3Factory {
/// @notice Emitted when the owner of the factory is changed
/// @param oldOwner The owner before the owner was changed
/// @param newOwner The owner after the owner was changed
event OwnerChanged(address indexed oldOwner, address indexed newOwner);
/// @notice Emitted when a pool is created
/// @param token0 The first token of the pool by address sort order
/// @param token1 The second token of the pool by address sort order
/// @param fee The fee collected upon every swap in the pool, denominated in hundredths of a bip
/// @param tickSpacing The minimum number of ticks between initialized ticks
/// @param pool The address of the created pool
event PoolCreated(
address indexed token0,
address indexed token1,
uint24 indexed fee,
int24 tickSpacing,
address pool
);
/// @notice Emitted when a new fee amount is enabled for pool creation via the factory
/// @param fee The enabled fee, denominated in hundredths of a bip
/// @param tickSpacing The minimum number of ticks between initialized ticks for pools created with the given fee
event FeeAmountEnabled(uint24 indexed fee, int24 indexed tickSpacing);
/// @notice Returns the current owner of the factory
/// @dev Can be changed by the current owner via setOwner
/// @return The address of the factory owner
function owner() external view returns (address);
/// @notice Returns the tick spacing for a given fee amount, if enabled, or 0 if not enabled
/// @dev A fee amount can never be removed, so this value should be hard coded or cached in the calling context
/// @param fee The enabled fee, denominated in hundredths of a bip. Returns 0 in case of unenabled fee
/// @return The tick spacing
function feeAmountTickSpacing(uint24 fee) external view returns (int24);
/// @notice Returns the pool address for a given pair of tokens and a fee, or address 0 if it does not exist
/// @dev tokenA and tokenB may be passed in either token0/token1 or token1/token0 order
/// @param tokenA The contract address of either token0 or token1
/// @param tokenB The contract address of the other token
/// @param fee The fee collected upon every swap in the pool, denominated in hundredths of a bip
/// @return pool The pool address
function getPool(
address tokenA,
address tokenB,
uint24 fee
) external view returns (address pool);
/// @notice Creates a pool for the given two tokens and fee
/// @param tokenA One of the two tokens in the desired pool
/// @param tokenB The other of the two tokens in the desired pool
/// @param fee The desired fee for the pool
/// @dev tokenA and tokenB may be passed in either order: token0/token1 or token1/token0. tickSpacing is retrieved
/// from the fee. The call will revert if the pool already exists, the fee is invalid, or the token arguments
/// are invalid.
/// @return pool The address of the newly created pool
function createPool(
address tokenA,
address tokenB,
uint24 fee
) external returns (address pool);
/// @notice Updates the owner of the factory
/// @dev Must be called by the current owner
/// @param _owner The new owner of the factory
function setOwner(address _owner) external;
/// @notice Enables a fee amount with the given tickSpacing
/// @dev Fee amounts may never be removed once enabled
/// @param fee The fee amount to enable, denominated in hundredths of a bip (i.e. 1e-6)
/// @param tickSpacing The spacing between ticks to be enforced for all pools created with the given fee amount
function enableFeeAmount(uint24 fee, int24 tickSpacing) external;
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Callback for IUniswapV3PoolActions#mint
/// @notice Any contract that calls IUniswapV3PoolActions#mint must implement this interface
interface IUniswapV3MintCallback {
/// @notice Called to `msg.sender` after minting liquidity to a position from IUniswapV3Pool#mint.
/// @dev In the implementation you must pay the pool tokens owed for the minted liquidity.
/// The caller of this method must be checked to be a UniswapV3Pool deployed by the canonical UniswapV3Factory.
/// @param amount0Owed The amount of token0 due to the pool for the minted liquidity
/// @param amount1Owed The amount of token1 due to the pool for the minted liquidity
/// @param data Any data passed through by the caller via the IUniswapV3PoolActions#mint call
function uniswapV3MintCallback(
uint256 amount0Owed,
uint256 amount1Owed,
bytes calldata data
) external;
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
import './pool/IUniswapV3PoolImmutables.sol';
import './pool/IUniswapV3PoolState.sol';
import './pool/IUniswapV3PoolDerivedState.sol';
import './pool/IUniswapV3PoolActions.sol';
import './pool/IUniswapV3PoolOwnerActions.sol';
import './pool/IUniswapV3PoolEvents.sol';
/// @title The interface for a Uniswap V3 Pool
/// @notice A Uniswap pool facilitates swapping and automated market making between any two assets that strictly conform
/// to the ERC20 specification
/// @dev The pool interface is broken up into many smaller pieces
interface IUniswapV3Pool is
IUniswapV3PoolImmutables,
IUniswapV3PoolState,
IUniswapV3PoolDerivedState,
IUniswapV3PoolActions,
IUniswapV3PoolOwnerActions,
IUniswapV3PoolEvents
{
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Permissionless pool actions
/// @notice Contains pool methods that can be called by anyone
interface IUniswapV3PoolActions {
/// @notice Sets the initial price for the pool
/// @dev Price is represented as a sqrt(amountToken1/amountToken0) Q64.96 value
/// @param sqrtPriceX96 the initial sqrt price of the pool as a Q64.96
function initialize(uint160 sqrtPriceX96) external;
/// @notice Adds liquidity for the given recipient/tickLower/tickUpper position
/// @dev The caller of this method receives a callback in the form of IUniswapV3MintCallback#uniswapV3MintCallback
/// in which they must pay any token0 or token1 owed for the liquidity. The amount of token0/token1 due depends
/// on tickLower, tickUpper, the amount of liquidity, and the current price.
/// @param recipient The address for which the liquidity will be created
/// @param tickLower The lower tick of the position in which to add liquidity
/// @param tickUpper The upper tick of the position in which to add liquidity
/// @param amount The amount of liquidity to mint
/// @param data Any data that should be passed through to the callback
/// @return amount0 The amount of token0 that was paid to mint the given amount of liquidity. Matches the value in the callback
/// @return amount1 The amount of token1 that was paid to mint the given amount of liquidity. Matches the value in the callback
function mint(
address recipient,
int24 tickLower,
int24 tickUpper,
uint128 amount,
bytes calldata data
) external returns (uint256 amount0, uint256 amount1);
/// @notice Collects tokens owed to a position
/// @dev Does not recompute fees earned, which must be done either via mint or burn of any amount of liquidity.
/// Collect must be called by the position owner. To withdraw only token0 or only token1, amount0Requested or
/// amount1Requested may be set to zero. To withdraw all tokens owed, caller may pass any value greater than the
/// actual tokens owed, e.g. type(uint128).max. Tokens owed may be from accumulated swap fees or burned liquidity.
/// @param recipient The address which should receive the fees collected
/// @param tickLower The lower tick of the position for which to collect fees
/// @param tickUpper The upper tick of the position for which to collect fees
/// @param amount0Requested How much token0 should be withdrawn from the fees owed
/// @param amount1Requested How much token1 should be withdrawn from the fees owed
/// @return amount0 The amount of fees collected in token0
/// @return amount1 The amount of fees collected in token1
function collect(
address recipient,
int24 tickLower,
int24 tickUpper,
uint128 amount0Requested,
uint128 amount1Requested
) external returns (uint128 amount0, uint128 amount1);
/// @notice Burn liquidity from the sender and account tokens owed for the liquidity to the position
/// @dev Can be used to trigger a recalculation of fees owed to a position by calling with an amount of 0
/// @dev Fees must be collected separately via a call to #collect
/// @param tickLower The lower tick of the position for which to burn liquidity
/// @param tickUpper The upper tick of the position for which to burn liquidity
/// @param amount How much liquidity to burn
/// @return amount0 The amount of token0 sent to the recipient
/// @return amount1 The amount of token1 sent to the recipient
function burn(
int24 tickLower,
int24 tickUpper,
uint128 amount
) external returns (uint256 amount0, uint256 amount1);
/// @notice Swap token0 for token1, or token1 for token0
/// @dev The caller of this method receives a callback in the form of IUniswapV3SwapCallback#uniswapV3SwapCallback
/// @param recipient The address to receive the output of the swap
/// @param zeroForOne The direction of the swap, true for token0 to token1, false for token1 to token0
/// @param amountSpecified The amount of the swap, which implicitly configures the swap as exact input (positive), or exact output (negative)
/// @param sqrtPriceLimitX96 The Q64.96 sqrt price limit. If zero for one, the price cannot be less than this
/// value after the swap. If one for zero, the price cannot be greater than this value after the swap
/// @param data Any data to be passed through to the callback
/// @return amount0 The delta of the balance of token0 of the pool, exact when negative, minimum when positive
/// @return amount1 The delta of the balance of token1 of the pool, exact when negative, minimum when positive
function swap(
address recipient,
bool zeroForOne,
int256 amountSpecified,
uint160 sqrtPriceLimitX96,
bytes calldata data
) external returns (int256 amount0, int256 amount1);
/// @notice Receive token0 and/or token1 and pay it back, plus a fee, in the callback
/// @dev The caller of this method receives a callback in the form of IUniswapV3FlashCallback#uniswapV3FlashCallback
/// @dev Can be used to donate underlying tokens pro-rata to currently in-range liquidity providers by calling
/// with 0 amount{0,1} and sending the donation amount(s) from the callback
/// @param recipient The address which will receive the token0 and token1 amounts
/// @param amount0 The amount of token0 to send
/// @param amount1 The amount of token1 to send
/// @param data Any data to be passed through to the callback
function flash(
address recipient,
uint256 amount0,
uint256 amount1,
bytes calldata data
) external;
/// @notice Increase the maximum number of price and liquidity observations that this pool will store
/// @dev This method is no-op if the pool already has an observationCardinalityNext greater than or equal to
/// the input observationCardinalityNext.
/// @param observationCardinalityNext The desired minimum number of observations for the pool to store
function increaseObservationCardinalityNext(uint16 observationCardinalityNext) external;
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Pool state that is not stored
/// @notice Contains view functions to provide information about the pool that is computed rather than stored on the
/// blockchain. The functions here may have variable gas costs.
interface IUniswapV3PoolDerivedState {
/// @notice Returns the cumulative tick and liquidity as of each timestamp `secondsAgo` from the current block timestamp
/// @dev To get a time weighted average tick or liquidity-in-range, you must call this with two values, one representing
/// the beginning of the period and another for the end of the period. E.g., to get the last hour time-weighted average tick,
/// you must call it with secondsAgos = [3600, 0].
/// @dev The time weighted average tick represents the geometric time weighted average price of the pool, in
/// log base sqrt(1.0001) of token1 / token0. The TickMath library can be used to go from a tick value to a ratio.
/// @param secondsAgos From how long ago each cumulative tick and liquidity value should be returned
/// @return tickCumulatives Cumulative tick values as of each `secondsAgos` from the current block timestamp
/// @return secondsPerLiquidityCumulativeX128s Cumulative seconds per liquidity-in-range value as of each `secondsAgos` from the current block
/// timestamp
function observe(uint32[] calldata secondsAgos)
external
view
returns (int56[] memory tickCumulatives, uint160[] memory secondsPerLiquidityCumulativeX128s);
/// @notice Returns a snapshot of the tick cumulative, seconds per liquidity and seconds inside a tick range
/// @dev Snapshots must only be compared to other snapshots, taken over a period for which a position existed.
/// I.e., snapshots cannot be compared if a position is not held for the entire period between when the first
/// snapshot is taken and the second snapshot is taken.
/// @param tickLower The lower tick of the range
/// @param tickUpper The upper tick of the range
/// @return tickCumulativeInside The snapshot of the tick accumulator for the range
/// @return secondsPerLiquidityInsideX128 The snapshot of seconds per liquidity for the range
/// @return secondsInside The snapshot of seconds per liquidity for the range
function snapshotCumulativesInside(int24 tickLower, int24 tickUpper)
external
view
returns (
int56 tickCumulativeInside,
uint160 secondsPerLiquidityInsideX128,
uint32 secondsInside
);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Events emitted by a pool
/// @notice Contains all events emitted by the pool
interface IUniswapV3PoolEvents {
/// @notice Emitted exactly once by a pool when #initialize is first called on the pool
/// @dev Mint/Burn/Swap cannot be emitted by the pool before Initialize
/// @param sqrtPriceX96 The initial sqrt price of the pool, as a Q64.96
/// @param tick The initial tick of the pool, i.e. log base 1.0001 of the starting price of the pool
event Initialize(uint160 sqrtPriceX96, int24 tick);
/// @notice Emitted when liquidity is minted for a given position
/// @param sender The address that minted the liquidity
/// @param owner The owner of the position and recipient of any minted liquidity
/// @param tickLower The lower tick of the position
/// @param tickUpper The upper tick of the position
/// @param amount The amount of liquidity minted to the position range
/// @param amount0 How much token0 was required for the minted liquidity
/// @param amount1 How much token1 was required for the minted liquidity
event Mint(
address sender,
address indexed owner,
int24 indexed tickLower,
int24 indexed tickUpper,
uint128 amount,
uint256 amount0,
uint256 amount1
);
/// @notice Emitted when fees are collected by the owner of a position
/// @dev Collect events may be emitted with zero amount0 and amount1 when the caller chooses not to collect fees
/// @param owner The owner of the position for which fees are collected
/// @param tickLower The lower tick of the position
/// @param tickUpper The upper tick of the position
/// @param amount0 The amount of token0 fees collected
/// @param amount1 The amount of token1 fees collected
event Collect(
address indexed owner,
address recipient,
int24 indexed tickLower,
int24 indexed tickUpper,
uint128 amount0,
uint128 amount1
);
/// @notice Emitted when a position's liquidity is removed
/// @dev Does not withdraw any fees earned by the liquidity position, which must be withdrawn via #collect
/// @param owner The owner of the position for which liquidity is removed
/// @param tickLower The lower tick of the position
/// @param tickUpper The upper tick of the position
/// @param amount The amount of liquidity to remove
/// @param amount0 The amount of token0 withdrawn
/// @param amount1 The amount of token1 withdrawn
event Burn(
address indexed owner,
int24 indexed tickLower,
int24 indexed tickUpper,
uint128 amount,
uint256 amount0,
uint256 amount1
);
/// @notice Emitted by the pool for any swaps between token0 and token1
/// @param sender The address that initiated the swap call, and that received the callback
/// @param recipient The address that received the output of the swap
/// @param amount0 The delta of the token0 balance of the pool
/// @param amount1 The delta of the token1 balance of the pool
/// @param sqrtPriceX96 The sqrt(price) of the pool after the swap, as a Q64.96
/// @param liquidity The liquidity of the pool after the swap
/// @param tick The log base 1.0001 of price of the pool after the swap
event Swap(
address indexed sender,
address indexed recipient,
int256 amount0,
int256 amount1,
uint160 sqrtPriceX96,
uint128 liquidity,
int24 tick
);
/// @notice Emitted by the pool for any flashes of token0/token1
/// @param sender The address that initiated the swap call, and that received the callback
/// @param recipient The address that received the tokens from flash
/// @param amount0 The amount of token0 that was flashed
/// @param amount1 The amount of token1 that was flashed
/// @param paid0 The amount of token0 paid for the flash, which can exceed the amount0 plus the fee
/// @param paid1 The amount of token1 paid for the flash, which can exceed the amount1 plus the fee
event Flash(
address indexed sender,
address indexed recipient,
uint256 amount0,
uint256 amount1,
uint256 paid0,
uint256 paid1
);
/// @notice Emitted by the pool for increases to the number of observations that can be stored
/// @dev observationCardinalityNext is not the observation cardinality until an observation is written at the index
/// just before a mint/swap/burn.
/// @param observationCardinalityNextOld The previous value of the next observation cardinality
/// @param observationCardinalityNextNew The updated value of the next observation cardinality
event IncreaseObservationCardinalityNext(
uint16 observationCardinalityNextOld,
uint16 observationCardinalityNextNew
);
/// @notice Emitted when the protocol fee is changed by the pool
/// @param feeProtocol0Old The previous value of the token0 protocol fee
/// @param feeProtocol1Old The previous value of the token1 protocol fee
/// @param feeProtocol0New The updated value of the token0 protocol fee
/// @param feeProtocol1New The updated value of the token1 protocol fee
event SetFeeProtocol(uint8 feeProtocol0Old, uint8 feeProtocol1Old, uint8 feeProtocol0New, uint8 feeProtocol1New);
/// @notice Emitted when the collected protocol fees are withdrawn by the factory owner
/// @param sender The address that collects the protocol fees
/// @param recipient The address that receives the collected protocol fees
/// @param amount0 The amount of token0 protocol fees that is withdrawn
/// @param amount0 The amount of token1 protocol fees that is withdrawn
event CollectProtocol(address indexed sender, address indexed recipient, uint128 amount0, uint128 amount1);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Pool state that never changes
/// @notice These parameters are fixed for a pool forever, i.e., the methods will always return the same values
interface IUniswapV3PoolImmutables {
/// @notice The contract that deployed the pool, which must adhere to the IUniswapV3Factory interface
/// @return The contract address
function factory() external view returns (address);
/// @notice The first of the two tokens of the pool, sorted by address
/// @return The token contract address
function token0() external view returns (address);
/// @notice The second of the two tokens of the pool, sorted by address
/// @return The token contract address
function token1() external view returns (address);
/// @notice The pool's fee in hundredths of a bip, i.e. 1e-6
/// @return The fee
function fee() external view returns (uint24);
/// @notice The pool tick spacing
/// @dev Ticks can only be used at multiples of this value, minimum of 1 and always positive
/// e.g.: a tickSpacing of 3 means ticks can be initialized every 3rd tick, i.e., ..., -6, -3, 0, 3, 6, ...
/// This value is an int24 to avoid casting even though it is always positive.
/// @return The tick spacing
function tickSpacing() external view returns (int24);
/// @notice The maximum amount of position liquidity that can use any tick in the range
/// @dev This parameter is enforced per tick to prevent liquidity from overflowing a uint128 at any point, and
/// also prevents out-of-range liquidity from being used to prevent adding in-range liquidity to a pool
/// @return The max amount of liquidity per tick
function maxLiquidityPerTick() external view returns (uint128);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Permissioned pool actions
/// @notice Contains pool methods that may only be called by the factory owner
interface IUniswapV3PoolOwnerActions {
/// @notice Set the denominator of the protocol's % share of the fees
/// @param feeProtocol0 new protocol fee for token0 of the pool
/// @param feeProtocol1 new protocol fee for token1 of the pool
function setFeeProtocol(uint8 feeProtocol0, uint8 feeProtocol1) external;
/// @notice Collect the protocol fee accrued to the pool
/// @param recipient The address to which collected protocol fees should be sent
/// @param amount0Requested The maximum amount of token0 to send, can be 0 to collect fees in only token1
/// @param amount1Requested The maximum amount of token1 to send, can be 0 to collect fees in only token0
/// @return amount0 The protocol fee collected in token0
/// @return amount1 The protocol fee collected in token1
function collectProtocol(
address recipient,
uint128 amount0Requested,
uint128 amount1Requested
) external returns (uint128 amount0, uint128 amount1);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Pool state that can change
/// @notice These methods compose the pool's state, and can change with any frequency including multiple times
/// per transaction
interface IUniswapV3PoolState {
/// @notice The 0th storage slot in the pool stores many values, and is exposed as a single method to save gas
/// when accessed externally.
/// @return sqrtPriceX96 The current price of the pool as a sqrt(token1/token0) Q64.96 value
/// tick The current tick of the pool, i.e. according to the last tick transition that was run.
/// This value may not always be equal to SqrtTickMath.getTickAtSqrtRatio(sqrtPriceX96) if the price is on a tick
/// boundary.
/// observationIndex The index of the last oracle observation that was written,
/// observationCardinality The current maximum number of observations stored in the pool,
/// observationCardinalityNext The next maximum number of observations, to be updated when the observation.
/// feeProtocol The protocol fee for both tokens of the pool.
/// Encoded as two 4 bit values, where the protocol fee of token1 is shifted 4 bits and the protocol fee of token0
/// is the lower 4 bits. Used as the denominator of a fraction of the swap fee, e.g. 4 means 1/4th of the swap fee.
/// unlocked Whether the pool is currently locked to reentrancy
function slot0()
external
view
returns (
uint160 sqrtPriceX96,
int24 tick,
uint16 observationIndex,
uint16 observationCardinality,
uint16 observationCardinalityNext,
uint8 feeProtocol,
bool unlocked
);
/// @notice The fee growth as a Q128.128 fees of token0 collected per unit of liquidity for the entire life of the pool
/// @dev This value can overflow the uint256
function feeGrowthGlobal0X128() external view returns (uint256);
/// @notice The fee growth as a Q128.128 fees of token1 collected per unit of liquidity for the entire life of the pool
/// @dev This value can overflow the uint256
function feeGrowthGlobal1X128() external view returns (uint256);
/// @notice The amounts of token0 and token1 that are owed to the protocol
/// @dev Protocol fees will never exceed uint128 max in either token
function protocolFees() external view returns (uint128 token0, uint128 token1);
/// @notice The currently in range liquidity available to the pool
/// @dev This value has no relationship to the total liquidity across all ticks
function liquidity() external view returns (uint128);
/// @notice Look up information about a specific tick in the pool
/// @param tick The tick to look up
/// @return liquidityGross the total amount of position liquidity that uses the pool either as tick lower or
/// tick upper,
/// liquidityNet how much liquidity changes when the pool price crosses the tick,
/// feeGrowthOutside0X128 the fee growth on the other side of the tick from the current tick in token0,
/// feeGrowthOutside1X128 the fee growth on the other side of the tick from the current tick in token1,
/// tickCumulativeOutside the cumulative tick value on the other side of the tick from the current tick
/// secondsPerLiquidityOutsideX128 the seconds spent per liquidity on the other side of the tick from the current tick,
/// secondsOutside the seconds spent on the other side of the tick from the current tick,
/// initialized Set to true if the tick is initialized, i.e. liquidityGross is greater than 0, otherwise equal to false.
/// Outside values can only be used if the tick is initialized, i.e. if liquidityGross is greater than 0.
/// In addition, these values are only relative and must be used only in comparison to previous snapshots for
/// a specific position.
function ticks(int24 tick)
external
view
returns (
uint128 liquidityGross,
int128 liquidityNet,
uint256 feeGrowthOutside0X128,
uint256 feeGrowthOutside1X128,
int56 tickCumulativeOutside,
uint160 secondsPerLiquidityOutsideX128,
uint32 secondsOutside,
bool initialized
);
/// @notice Returns 256 packed tick initialized boolean values. See TickBitmap for more information
function tickBitmap(int16 wordPosition) external view returns (uint256);
/// @notice Returns the information about a position by the position's key
/// @param key The position's key is a hash of a preimage composed by the owner, tickLower and tickUpper
/// @return _liquidity The amount of liquidity in the position,
/// Returns feeGrowthInside0LastX128 fee growth of token0 inside the tick range as of the last mint/burn/poke,
/// Returns feeGrowthInside1LastX128 fee growth of token1 inside the tick range as of the last mint/burn/poke,
/// Returns tokensOwed0 the computed amount of token0 owed to the position as of the last mint/burn/poke,
/// Returns tokensOwed1 the computed amount of token1 owed to the position as of the last mint/burn/poke
function positions(bytes32 key)
external
view
returns (
uint128 _liquidity,
uint256 feeGrowthInside0LastX128,
uint256 feeGrowthInside1LastX128,
uint128 tokensOwed0,
uint128 tokensOwed1
);
/// @notice Returns data about a specific observation index
/// @param index The element of the observations array to fetch
/// @dev You most likely want to use #observe() instead of this method to get an observation as of some amount of time
/// ago, rather than at a specific index in the array.
/// @return blockTimestamp The timestamp of the observation,
/// Returns tickCumulative the tick multiplied by seconds elapsed for the life of the pool as of the observation timestamp,
/// Returns secondsPerLiquidityCumulativeX128 the seconds per in range liquidity for the life of the pool as of the observation timestamp,
/// Returns initialized whether the observation has been initialized and the values are safe to use
function observations(uint256 index)
external
view
returns (
uint32 blockTimestamp,
int56 tickCumulative,
uint160 secondsPerLiquidityCumulativeX128,
bool initialized
);
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
import '@uniswap/v3-core/contracts/libraries/FullMath.sol';
import '@uniswap/v3-core/contracts/libraries/FixedPoint96.sol';
/// @title Liquidity amount functions
/// @notice Provides functions for computing liquidity amounts from token amounts and prices
library LiquidityAmounts {
/// @notice Downcasts uint256 to uint128
/// @param x The uint258 to be downcasted
/// @return y The passed value, downcasted to uint128
function toUint128(uint256 x) private pure returns (uint128 y) {
require((y = uint128(x)) == x);
}
/// @notice Computes the amount of liquidity received for a given amount of token0 and price range
/// @dev Calculates amount0 * (sqrt(upper) * sqrt(lower)) / (sqrt(upper) - sqrt(lower))
/// @param sqrtRatioAX96 A sqrt price representing the first tick boundary
/// @param sqrtRatioBX96 A sqrt price representing the second tick boundary
/// @param amount0 The amount0 being sent in
/// @return liquidity The amount of returned liquidity
function getLiquidityForAmount0(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint256 amount0
) internal pure returns (uint128 liquidity) {
if (sqrtRatioAX96 > sqrtRatioBX96) (sqrtRatioAX96, sqrtRatioBX96) = (sqrtRatioBX96, sqrtRatioAX96);
uint256 intermediate = FullMath.mulDiv(sqrtRatioAX96, sqrtRatioBX96, FixedPoint96.Q96);
return toUint128(FullMath.mulDiv(amount0, intermediate, sqrtRatioBX96 - sqrtRatioAX96));
}
/// @notice Computes the amount of liquidity received for a given amount of token1 and price range
/// @dev Calculates amount1 / (sqrt(upper) - sqrt(lower)).
/// @param sqrtRatioAX96 A sqrt price representing the first tick boundary
/// @param sqrtRatioBX96 A sqrt price representing the second tick boundary
/// @param amount1 The amount1 being sent in
/// @return liquidity The amount of returned liquidity
function getLiquidityForAmount1(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint256 amount1
) internal pure returns (uint128 liquidity) {
if (sqrtRatioAX96 > sqrtRatioBX96) (sqrtRatioAX96, sqrtRatioBX96) = (sqrtRatioBX96, sqrtRatioAX96);
return toUint128(FullMath.mulDiv(amount1, FixedPoint96.Q96, sqrtRatioBX96 - sqrtRatioAX96));
}
/// @notice Computes the maximum amount of liquidity received for a given amount of token0, token1, the current
/// pool prices and the prices at the tick boundaries
/// @param sqrtRatioX96 A sqrt price representing the current pool prices
/// @param sqrtRatioAX96 A sqrt price representing the first tick boundary
/// @param sqrtRatioBX96 A sqrt price representing the second tick boundary
/// @param amount0 The amount of token0 being sent in
/// @param amount1 The amount of token1 being sent in
/// @return liquidity The maximum amount of liquidity received
function getLiquidityForAmounts(
uint160 sqrtRatioX96,
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint256 amount0,
uint256 amount1
) internal pure returns (uint128 liquidity) {
if (sqrtRatioAX96 > sqrtRatioBX96) (sqrtRatioAX96, sqrtRatioBX96) = (sqrtRatioBX96, sqrtRatioAX96);
if (sqrtRatioX96 <= sqrtRatioAX96) {
liquidity = getLiquidityForAmount0(sqrtRatioAX96, sqrtRatioBX96, amount0);
} else if (sqrtRatioX96 < sqrtRatioBX96) {
uint128 liquidity0 = getLiquidityForAmount0(sqrtRatioX96, sqrtRatioBX96, amount0);
uint128 liquidity1 = getLiquidityForAmount1(sqrtRatioAX96, sqrtRatioX96, amount1);
liquidity = liquidity0 < liquidity1 ? liquidity0 : liquidity1;
} else {
liquidity = getLiquidityForAmount1(sqrtRatioAX96, sqrtRatioBX96, amount1);
}
}
/// @notice Computes the amount of token0 for a given amount of liquidity and a price range
/// @param sqrtRatioAX96 A sqrt price representing the first tick boundary
/// @param sqrtRatioBX96 A sqrt price representing the second tick boundary
/// @param liquidity The liquidity being valued
/// @return amount0 The amount of token0
function getAmount0ForLiquidity(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint128 liquidity
) internal pure returns (uint256 amount0) {
if (sqrtRatioAX96 > sqrtRatioBX96) (sqrtRatioAX96, sqrtRatioBX96) = (sqrtRatioBX96, sqrtRatioAX96);
return
FullMath.mulDiv(
uint256(liquidity) << FixedPoint96.RESOLUTION,
sqrtRatioBX96 - sqrtRatioAX96,
sqrtRatioBX96
) / sqrtRatioAX96;
}
/// @notice Computes the amount of token1 for a given amount of liquidity and a price range
/// @param sqrtRatioAX96 A sqrt price representing the first tick boundary
/// @param sqrtRatioBX96 A sqrt price representing the second tick boundary
/// @param liquidity The liquidity being valued
/// @return amount1 The amount of token1
function getAmount1ForLiquidity(
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint128 liquidity
) internal pure returns (uint256 amount1) {
if (sqrtRatioAX96 > sqrtRatioBX96) (sqrtRatioAX96, sqrtRatioBX96) = (sqrtRatioBX96, sqrtRatioAX96);
return FullMath.mulDiv(liquidity, sqrtRatioBX96 - sqrtRatioAX96, FixedPoint96.Q96);
}
/// @notice Computes the token0 and token1 value for a given amount of liquidity, the current
/// pool prices and the prices at the tick boundaries
/// @param sqrtRatioX96 A sqrt price representing the current pool prices
/// @param sqrtRatioAX96 A sqrt price representing the first tick boundary
/// @param sqrtRatioBX96 A sqrt price representing the second tick boundary
/// @param liquidity The liquidity being valued
/// @return amount0 The amount of token0
/// @return amount1 The amount of token1
function getAmountsForLiquidity(
uint160 sqrtRatioX96,
uint160 sqrtRatioAX96,
uint160 sqrtRatioBX96,
uint128 liquidity
) internal pure returns (uint256 amount0, uint256 amount1) {
if (sqrtRatioAX96 > sqrtRatioBX96) (sqrtRatioAX96, sqrtRatioBX96) = (sqrtRatioBX96, sqrtRatioAX96);
if (sqrtRatioX96 <= sqrtRatioAX96) {
amount0 = getAmount0ForLiquidity(sqrtRatioAX96, sqrtRatioBX96, liquidity);
} else if (sqrtRatioX96 < sqrtRatioBX96) {
amount0 = getAmount0ForLiquidity(sqrtRatioX96, sqrtRatioBX96, liquidity);
amount1 = getAmount1ForLiquidity(sqrtRatioAX96, sqrtRatioX96, liquidity);
} else {
amount1 = getAmount1ForLiquidity(sqrtRatioAX96, sqrtRatioBX96, liquidity);
}
}
}
//SPDX-License-Identifier: Unlicense
pragma solidity ^0.7.6;
pragma abicoder v2;
// contracts
import "@openzeppelin/contracts/math/SafeMath.sol";
// libraries
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import "@uniswap/v3-core/contracts/libraries/TickMath.sol";
import "@uniswap/v3-periphery/contracts/libraries/LiquidityAmounts.sol";
library LiquidityHelper {
using SafeMath for uint256;
/**
* @notice Calculates the liquidity amount using current ranges
* @param _pool Pool instance
* @param _tickLower Lower tick
* @param _tickUpper Upper tick
* @param _amount0 Amount to be added for token0
* @param _amount1 Amount to be added for token1
* @return liquidity Liquidity amount derived from token amounts
*/
function getLiquidityForAmounts(
IUniswapV3Pool _pool,
int24 _tickLower,
int24 _tickUpper,
uint256 _amount0,
uint256 _amount1
) public view returns (uint128 liquidity) {
// get sqrtRatios required to calculate liquidity
(uint160 sqrtRatioX96, , , , , , ) = _pool.slot0();
// calculate liquidity needs to be added
liquidity = LiquidityAmounts.getLiquidityForAmounts(
sqrtRatioX96,
TickMath.getSqrtRatioAtTick(_tickLower),
TickMath.getSqrtRatioAtTick(_tickUpper),
_amount0,
_amount1
);
}
/**
* @notice Calculates the liquidity amount using current ranges
* @param _pool Instance of the pool
* @param _tickLower Lower tick
* @param _tickUpper Upper tick
* @param _liquidity Liquidity of the pool
*/
function getAmountsForLiquidity(
IUniswapV3Pool _pool,
int24 _tickLower,
int24 _tickUpper,
uint128 _liquidity
) public view returns (uint256 amount0, uint256 amount1) {
// get sqrtRatios required to calculate liquidity
(uint160 sqrtRatioX96, , , , , , ) = _pool.slot0();
// calculate liquidity needs to be added
(amount0, amount1) = LiquidityAmounts.getAmountsForLiquidity(
sqrtRatioX96,
TickMath.getSqrtRatioAtTick(_tickLower),
TickMath.getSqrtRatioAtTick(_tickUpper),
_liquidity
);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
/**
* @dev Standard math utilities missing in the Solidity language.
*/
library Math {
/**
* @dev Returns the largest of two numbers.
*/
function max(uint256 a, uint256 b) internal pure returns (uint256) {
return a >= b ? a : b;
}
/**
* @dev Returns the smallest of two numbers.
*/
function min(uint256 a, uint256 b) internal pure returns (uint256) {
return a < b ? a : b;
}
/**
* @dev Returns the average of two numbers. The result is rounded towards
* zero.
*/
function average(uint256 a, uint256 b) internal pure returns (uint256) {
// (a + b) / 2 can overflow, so we distribute
return (a / 2) + (b / 2) + ((a % 2 + b % 2) / 2);
}
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
library PositionKey {
/// @dev Returns the key of the position in the core library
function compute(
address owner,
int24 tickLower,
int24 tickUpper
) internal pure returns (bytes32) {
return keccak256(abi.encodePacked(owner, tickLower, tickUpper));
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.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 make it call a
* `private` function that does the actual work.
*/
modifier nonReentrant() {
// On the first call to nonReentrant, _notEntered will be true
require(_status != _ENTERED, "ReentrancyGuard: reentrant call");
// Any calls to nonReentrant after this point will fail
_status = _ENTERED;
_;
// 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
pragma solidity ^0.7.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 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
*/
function toUint128(uint256 value) internal pure returns (uint128) {
require(value < 2**128, "SafeCast: value doesn\'t fit in 128 bits");
return uint128(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
*/
function toUint64(uint256 value) internal pure returns (uint64) {
require(value < 2**64, "SafeCast: value doesn\'t fit in 64 bits");
return uint64(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
*/
function toUint32(uint256 value) internal pure returns (uint32) {
require(value < 2**32, "SafeCast: value doesn\'t fit in 32 bits");
return uint32(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
*/
function toUint16(uint256 value) internal pure returns (uint16) {
require(value < 2**16, "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.
*/
function toUint8(uint256 value) internal pure returns (uint8) {
require(value < 2**8, "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.
*/
function toUint256(int256 value) internal pure returns (uint256) {
require(value >= 0, "SafeCast: value must be positive");
return uint256(value);
}
/**
* @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) {
require(value >= -2**127 && value < 2**127, "SafeCast: value doesn\'t fit in 128 bits");
return int128(value);
}
/**
* @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) {
require(value >= -2**63 && value < 2**63, "SafeCast: value doesn\'t fit in 64 bits");
return int64(value);
}
/**
* @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) {
require(value >= -2**31 && value < 2**31, "SafeCast: value doesn\'t fit in 32 bits");
return int32(value);
}
/**
* @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) {
require(value >= -2**15 && value < 2**15, "SafeCast: value doesn\'t fit in 16 bits");
return int16(value);
}
/**
* @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) {
require(value >= -2**7 && value < 2**7, "SafeCast: value doesn\'t fit in 8 bits");
return int8(value);
}
/**
* @dev Converts an unsigned uint256 into a signed int256.
*
* Requirements:
*
* - input must be less than or equal to maxInt256.
*/
function toInt256(uint256 value) internal pure returns (int256) {
require(value < 2**255, "SafeCast: value doesn't fit in an int256");
return int256(value);
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
import "./IERC20.sol";
import "../../math/SafeMath.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 SafeMath for uint256;
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'
// solhint-disable-next-line max-line-length
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).add(value);
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
function safeDecreaseAllowance(IERC20 token, address spender, uint256 value) internal {
uint256 newAllowance = token.allowance(address(this), spender).sub(value, "SafeERC20: decreased allowance below zero");
_callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));
}
/**
* @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
// solhint-disable-next-line max-line-length
require(abi.decode(returndata, (bool)), "SafeERC20: ERC20 operation did not succeed");
}
}
}
// SPDX-License-Identifier: MIT
pragma solidity ^0.7.0;
/**
* @dev Wrappers over Solidity's arithmetic operations with added overflow
* checks.
*
* Arithmetic operations in Solidity wrap on overflow. This can easily result
* in bugs, because programmers usually assume that an overflow raises an
* error, which is the standard behavior in high level programming languages.
* `SafeMath` restores this intuition by reverting the transaction when 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.
*/
library SafeMath {
/**
* @dev Returns the addition of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryAdd(uint256 a, uint256 b) internal pure returns (bool, uint256) {
uint256 c = a + b;
if (c < a) return (false, 0);
return (true, c);
}
/**
* @dev Returns the substraction of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function trySub(uint256 a, uint256 b) internal pure returns (bool, uint256) {
if (b > a) return (false, 0);
return (true, a - b);
}
/**
* @dev Returns the multiplication of two unsigned integers, with an overflow flag.
*
* _Available since v3.4._
*/
function tryMul(uint256 a, uint256 b) internal pure returns (bool, uint256) {
// Gas optimization: this is cheaper than requiring 'a' not being zero, but the
// benefit is lost if 'b' is also tested.
// See: https://github.com/OpenZeppelin/openzeppelin-contracts/pull/522
if (a == 0) return (true, 0);
uint256 c = a * b;
if (c / a != b) return (false, 0);
return (true, c);
}
/**
* @dev Returns the division of two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryDiv(uint256 a, uint256 b) internal pure returns (bool, uint256) {
if (b == 0) return (false, 0);
return (true, a / b);
}
/**
* @dev Returns the remainder of dividing two unsigned integers, with a division by zero flag.
*
* _Available since v3.4._
*/
function tryMod(uint256 a, uint256 b) internal pure returns (bool, uint256) {
if (b == 0) return (false, 0);
return (true, a % b);
}
/**
* @dev Returns the addition of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `+` operator.
*
* Requirements:
*
* - Addition cannot overflow.
*/
function add(uint256 a, uint256 b) internal pure returns (uint256) {
uint256 c = a + b;
require(c >= a, "SafeMath: addition overflow");
return c;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting on
* overflow (when the result is negative).
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b) internal pure returns (uint256) {
require(b <= a, "SafeMath: subtraction overflow");
return a - b;
}
/**
* @dev Returns the multiplication of two unsigned integers, reverting on
* overflow.
*
* Counterpart to Solidity's `*` operator.
*
* Requirements:
*
* - Multiplication cannot overflow.
*/
function mul(uint256 a, uint256 b) internal pure returns (uint256) {
if (a == 0) return 0;
uint256 c = a * b;
require(c / a == b, "SafeMath: multiplication overflow");
return c;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting on
* division by zero. The result is rounded towards zero.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b) internal pure returns (uint256) {
require(b > 0, "SafeMath: division by zero");
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting when dividing by zero.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b) internal pure returns (uint256) {
require(b > 0, "SafeMath: modulo by zero");
return a % b;
}
/**
* @dev Returns the subtraction of two unsigned integers, reverting with custom message on
* overflow (when the result is negative).
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {trySub}.
*
* Counterpart to Solidity's `-` operator.
*
* Requirements:
*
* - Subtraction cannot overflow.
*/
function sub(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b <= a, errorMessage);
return a - b;
}
/**
* @dev Returns the integer division of two unsigned integers, reverting with custom message on
* division by zero. The result is rounded towards zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryDiv}.
*
* Counterpart to Solidity's `/` operator. Note: this function uses a
* `revert` opcode (which leaves remaining gas untouched) while Solidity
* uses an invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function div(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b > 0, errorMessage);
return a / b;
}
/**
* @dev Returns the remainder of dividing two unsigned integers. (unsigned integer modulo),
* reverting with custom message when dividing by zero.
*
* CAUTION: This function is deprecated because it requires allocating memory for the error
* message unnecessarily. For custom revert reasons use {tryMod}.
*
* Counterpart to Solidity's `%` operator. This function uses a `revert`
* opcode (which leaves remaining gas untouched) while Solidity uses an
* invalid opcode to revert (consuming all remaining gas).
*
* Requirements:
*
* - The divisor cannot be zero.
*/
function mod(uint256 a, uint256 b, string memory errorMessage) internal pure returns (uint256) {
require(b > 0, errorMessage);
return a % b;
}
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.5.0;
/// @title Math library for computing sqrt prices from ticks and vice versa
/// @notice Computes sqrt price for ticks of size 1.0001, i.e. sqrt(1.0001^tick) as fixed point Q64.96 numbers. Supports
/// prices between 2**-128 and 2**128
library TickMath {
/// @dev The minimum tick that may be passed to #getSqrtRatioAtTick computed from log base 1.0001 of 2**-128
int24 internal constant MIN_TICK = -887272;
/// @dev The maximum tick that may be passed to #getSqrtRatioAtTick computed from log base 1.0001 of 2**128
int24 internal constant MAX_TICK = -MIN_TICK;
/// @dev The minimum value that can be returned from #getSqrtRatioAtTick. Equivalent to getSqrtRatioAtTick(MIN_TICK)
uint160 internal constant MIN_SQRT_RATIO = 4295128739;
/// @dev The maximum value that can be returned from #getSqrtRatioAtTick. Equivalent to getSqrtRatioAtTick(MAX_TICK)
uint160 internal constant MAX_SQRT_RATIO = 1461446703485210103287273052203988822378723970342;
/// @notice Calculates sqrt(1.0001^tick) * 2^96
/// @dev Throws if |tick| > max tick
/// @param tick The input tick for the above formula
/// @return sqrtPriceX96 A Fixed point Q64.96 number representing the sqrt of the ratio of the two assets (token1/token0)
/// at the given tick
function getSqrtRatioAtTick(int24 tick) internal pure returns (uint160 sqrtPriceX96) {
uint256 absTick = tick < 0 ? uint256(-int256(tick)) : uint256(int256(tick));
require(absTick <= uint256(MAX_TICK), 'T');
uint256 ratio = absTick & 0x1 != 0 ? 0xfffcb933bd6fad37aa2d162d1a594001 : 0x100000000000000000000000000000000;
if (absTick & 0x2 != 0) ratio = (ratio * 0xfff97272373d413259a46990580e213a) >> 128;
if (absTick & 0x4 != 0) ratio = (ratio * 0xfff2e50f5f656932ef12357cf3c7fdcc) >> 128;
if (absTick & 0x8 != 0) ratio = (ratio * 0xffe5caca7e10e4e61c3624eaa0941cd0) >> 128;
if (absTick & 0x10 != 0) ratio = (ratio * 0xffcb9843d60f6159c9db58835c926644) >> 128;
if (absTick & 0x20 != 0) ratio = (ratio * 0xff973b41fa98c081472e6896dfb254c0) >> 128;
if (absTick & 0x40 != 0) ratio = (ratio * 0xff2ea16466c96a3843ec78b326b52861) >> 128;
if (absTick & 0x80 != 0) ratio = (ratio * 0xfe5dee046a99a2a811c461f1969c3053) >> 128;
if (absTick & 0x100 != 0) ratio = (ratio * 0xfcbe86c7900a88aedcffc83b479aa3a4) >> 128;
if (absTick & 0x200 != 0) ratio = (ratio * 0xf987a7253ac413176f2b074cf7815e54) >> 128;
if (absTick & 0x400 != 0) ratio = (ratio * 0xf3392b0822b70005940c7a398e4b70f3) >> 128;
if (absTick & 0x800 != 0) ratio = (ratio * 0xe7159475a2c29b7443b29c7fa6e889d9) >> 128;
if (absTick & 0x1000 != 0) ratio = (ratio * 0xd097f3bdfd2022b8845ad8f792aa5825) >> 128;
if (absTick & 0x2000 != 0) ratio = (ratio * 0xa9f746462d870fdf8a65dc1f90e061e5) >> 128;
if (absTick & 0x4000 != 0) ratio = (ratio * 0x70d869a156d2a1b890bb3df62baf32f7) >> 128;
if (absTick & 0x8000 != 0) ratio = (ratio * 0x31be135f97d08fd981231505542fcfa6) >> 128;
if (absTick & 0x10000 != 0) ratio = (ratio * 0x9aa508b5b7a84e1c677de54f3e99bc9) >> 128;
if (absTick & 0x20000 != 0) ratio = (ratio * 0x5d6af8dedb81196699c329225ee604) >> 128;
if (absTick & 0x40000 != 0) ratio = (ratio * 0x2216e584f5fa1ea926041bedfe98) >> 128;
if (absTick & 0x80000 != 0) ratio = (ratio * 0x48a170391f7dc42444e8fa2) >> 128;
if (tick > 0) ratio = type(uint256).max / ratio;
// this divides by 1<<32 rounding up to go from a Q128.128 to a Q128.96.
// we then downcast because we know the result always fits within 160 bits due to our tick input constraint
// we round up in the division so getTickAtSqrtRatio of the output price is always consistent
sqrtPriceX96 = uint160((ratio >> 32) + (ratio % (1 << 32) == 0 ? 0 : 1));
}
/// @notice Calculates the greatest tick value such that getRatioAtTick(tick) <= ratio
/// @dev Throws in case sqrtPriceX96 < MIN_SQRT_RATIO, as MIN_SQRT_RATIO is the lowest value getRatioAtTick may
/// ever return.
/// @param sqrtPriceX96 The sqrt ratio for which to compute the tick as a Q64.96
/// @return tick The greatest tick for which the ratio is less than or equal to the input ratio
function getTickAtSqrtRatio(uint160 sqrtPriceX96) internal pure returns (int24 tick) {
// second inequality must be < because the price can never reach the price at the max tick
require(sqrtPriceX96 >= MIN_SQRT_RATIO && sqrtPriceX96 < MAX_SQRT_RATIO, 'R');
uint256 ratio = uint256(sqrtPriceX96) << 32;
uint256 r = ratio;
uint256 msb = 0;
assembly {
let f := shl(7, gt(r, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF))
msb := or(msb, f)
r := shr(f, r)
}
assembly {
let f := shl(6, gt(r, 0xFFFFFFFFFFFFFFFF))
msb := or(msb, f)
r := shr(f, r)
}
assembly {
let f := shl(5, gt(r, 0xFFFFFFFF))
msb := or(msb, f)
r := shr(f, r)
}
assembly {
let f := shl(4, gt(r, 0xFFFF))
msb := or(msb, f)
r := shr(f, r)
}
assembly {
let f := shl(3, gt(r, 0xFF))
msb := or(msb, f)
r := shr(f, r)
}
assembly {
let f := shl(2, gt(r, 0xF))
msb := or(msb, f)
r := shr(f, r)
}
assembly {
let f := shl(1, gt(r, 0x3))
msb := or(msb, f)
r := shr(f, r)
}
assembly {
let f := gt(r, 0x1)
msb := or(msb, f)
}
if (msb >= 128) r = ratio >> (msb - 127);
else r = ratio << (127 - msb);
int256 log_2 = (int256(msb) - 128) << 64;
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(63, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(62, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(61, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(60, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(59, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(58, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(57, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(56, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(55, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(54, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(53, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(52, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(51, f))
r := shr(f, r)
}
assembly {
r := shr(127, mul(r, r))
let f := shr(128, r)
log_2 := or(log_2, shl(50, f))
}
int256 log_sqrt10001 = log_2 * 255738958999603826347141; // 128.128 number
int24 tickLow = int24((log_sqrt10001 - 3402992956809132418596140100660247210) >> 128);
int24 tickHi = int24((log_sqrt10001 + 291339464771989622907027621153398088495) >> 128);
tick = tickLow == tickHi ? tickLow : getSqrtRatioAtTick(tickHi) <= sqrtPriceX96 ? tickHi : tickLow;
}
}
// SPDX-License-Identifier: GPL-2.0-or-later
pragma solidity >=0.6.0;
import '@openzeppelin/contracts/token/ERC20/IERC20.sol';
library TransferHelper {
/// @notice Transfers tokens from the targeted address to the given destination
/// @notice Errors with 'STF' if transfer fails
/// @param token The contract address of the token to be transferred
/// @param from The originating address from which the tokens will be transferred
/// @param to The destination address of the transfer
/// @param value The amount to be transferred
function safeTransferFrom(
address token,
address from,
address to,
uint256 value
) internal {
(bool success, bytes memory data) =
token.call(abi.encodeWithSelector(IERC20.transferFrom.selector, from, to, value));
require(success && (data.length == 0 || abi.decode(data, (bool))), 'STF');
}
/// @notice Transfers tokens from msg.sender to a recipient
/// @dev Errors with ST if transfer fails
/// @param token The contract address of the token which will be transferred
/// @param to The recipient of the transfer
/// @param value The value of the transfer
function safeTransfer(
address token,
address to,
uint256 value
) internal {
(bool success, bytes memory data) = token.call(abi.encodeWithSelector(IERC20.transfer.selector, to, value));
require(success && (data.length == 0 || abi.decode(data, (bool))), 'ST');
}
/// @notice Approves the stipulated contract to spend the given allowance in the given token
/// @dev Errors with 'SA' if transfer fails
/// @param token The contract address of the token to be approved
/// @param to The target of the approval
/// @param value The amount of the given token the target will be allowed to spend
function safeApprove(
address token,
address to,
uint256 value
) internal {
(bool success, bytes memory data) = token.call(abi.encodeWithSelector(IERC20.approve.selector, to, value));
require(success && (data.length == 0 || abi.decode(data, (bool))), 'SA');
}
/// @notice Transfers ETH to the recipient address
/// @dev Fails with `STE`
/// @param to The destination of the transfer
/// @param value The value to be transferred
function safeTransferETH(address to, uint256 value) internal {
(bool success, ) = to.call{value: value}(new bytes(0));
require(success, 'STE');
}
}
//SPDX-License-Identifier: BSL
pragma solidity 0.7.6;
pragma abicoder v2;
// contracts
import "@chainlink/contracts/src/v0.7/Denominations.sol";
import "@openzeppelin/contracts/math/SafeMath.sol";
import "@openzeppelin/contracts/math/Math.sol";
// libraries
import "@uniswap/v3-periphery/contracts/libraries/LiquidityAmounts.sol";
import "@uniswap/v3-periphery/contracts/libraries/PositionKey.sol";
import "@uniswap/v3-core/contracts/libraries/FullMath.sol";
import "@uniswap/v3-core/contracts/libraries/TickMath.sol";
import "../../libraries/CommonMath.sol";
// interfaces
import "@chainlink/contracts/src/v0.7/interfaces/FeedRegistryInterface.sol";
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import "../interfaces/ITwapStrategyFactory.sol";
import "../interfaces/ITwapStrategyManager.sol";
import "../../interfaces/IERC20Minimal.sol";
library TwapOracleLibrary {
uint256 public constant BASE = 1e18;
using SafeMath for uint256;
function normalise(address _token, uint256 _amount) internal view returns (uint256 normalised) {
// return uint256(_amount) * (10**(18 - IERC20Minimal(_token).decimals()));
normalised = _amount;
uint256 _decimals = IERC20Minimal(_token).decimals();
if (_decimals < 18) {
uint256 missingDecimals = uint256(18).sub(_decimals);
normalised = uint256(_amount).mul(10**(missingDecimals));
} else if (_decimals > 18) {
uint256 extraDecimals = _decimals.sub(uint256(18));
normalised = uint256(_amount).div(10**(extraDecimals));
}
}
/**
* @notice Gets latest Uniswap price in the pool, price of token0 represented in token1
* @notice _pool Address of the Uniswap V3 pool
*/
function getUniswapPrice(IUniswapV3Pool _pool) internal view returns (uint256 price) {
(uint160 sqrtPriceX96, , , , , , ) = _pool.slot0();
uint256 priceX192 = uint256(sqrtPriceX96).mul(sqrtPriceX96);
price = FullMath.mulDiv(priceX192, BASE, 1 << 192);
uint256 token0Decimals = IERC20Minimal(_pool.token0()).decimals();
uint256 token1Decimals = IERC20Minimal(_pool.token1()).decimals();
bool decimalCheck = token0Decimals > token1Decimals;
uint256 decimalsDelta = decimalCheck ? token0Decimals - token1Decimals : token1Decimals - token0Decimals;
// normalise the price to 18 decimals
if (token0Decimals == token1Decimals) {
return price;
}
if (decimalCheck) {
price = price.mul(CommonMath.safePower(10, decimalsDelta));
} else {
price = price.div(CommonMath.safePower(10, decimalsDelta));
}
}
/**
* @notice Returns latest Chainlink price, and normalise it
* @param _registry registry
* @param _base Base Asset
* @param _quote Quote Asset
*/
function getChainlinkPrice(
FeedRegistryInterface _registry,
address _base,
address _quote,
uint256 _validPeriod
) internal view returns (uint256 price) {
(, int256 _price, , uint256 updatedAt, ) = _registry.latestRoundData(_base, _quote);
require(block.timestamp.sub(updatedAt) < _validPeriod, "OLD_PRICE");
if (_price <= 0) {
return 0;
}
// normalise the price to 18 decimals
uint256 _decimals = _registry.decimals(_base, _quote);
if (_decimals < 18) {
uint256 missingDecimals = uint256(18).sub(_decimals);
price = uint256(_price).mul(10**(missingDecimals));
} else if (_decimals > 18) {
uint256 extraDecimals = _decimals.sub(uint256(18));
price = uint256(_price).div(10**(extraDecimals));
}
return price;
}
/**
* @notice Gets latest Uniswap price in the pool, price of _token represented in USD
* @param _pool Address of the Uniswap V3 pool
* @param _registry Interface of the Chainlink registry
* @param _priceOf the token we want to convert into USD
* @param _useTwap tif the contract should use uniswap v3 twap to fetch usd price of chainlink
*/
function getPriceInUSD(
ITwapStrategyFactory _factory,
IUniswapV3Pool _pool,
FeedRegistryInterface _registry,
address _priceOf,
bool[2] memory _useTwap,
ITwapStrategyManager _manager
) internal view returns (uint256 price) {
uint256 _period = _manager.twapPricePeriod();
if (_useTwap[0]) {
address _token1 = _pool.token1();
// token0 - twap , token1 - chainlink
uint256 token1ChainlinkPrice = getChainlinkPrice(
_registry,
_token1,
Denominations.USD,
_factory.getHeartBeat(_token1, Denominations.USD)
);
if (_priceOf == _token1) {
price = token1ChainlinkPrice;
} else {
// price of token0 denominated in token1
uint256 _price = consult(address(_pool), uint32(_period));
price = _price.mul(token1ChainlinkPrice).div(BASE);
}
} else {
address _token0 = _pool.token0();
// // token0 - chainlink , token1 - twap
uint256 token0ChainlinkPrice = getChainlinkPrice(
_registry,
_token0,
Denominations.USD,
_factory.getHeartBeat(_token0, Denominations.USD)
);
if (_priceOf == _token0) {
price = token0ChainlinkPrice;
} else {
// price of token0 denominated in token1
uint256 _price = consult(address(_pool), uint32(_period));
_price = 1e36 / _price;
price = _price.mul(token0ChainlinkPrice).div(BASE);
}
}
}
/**
* @notice Checks for price slippage at the time of swap
* @param _pool Address of the pool
* @param _factory Address of the DefiEdge strategy factory
* @param _amountIn Amount to be swapped
* @param _amountOut Amount received after swap
* @param _tokenIn Token to be swapped
* @param _tokenOut Token to which tokenIn should be swapped
* @return true if the swap is allowed, else false
*/
function allowSwap(
IUniswapV3Pool _pool,
ITwapStrategyFactory _factory,
uint256 _amountIn,
uint256 _amountOut,
address _tokenIn,
address _tokenOut,
ITwapStrategyManager _manager,
bool[2] memory _useTwap
) public view returns (bool) {
_amountIn = normalise(_tokenIn, _amountIn);
_amountOut = normalise(_tokenOut, _amountOut);
// get price of token0 Uniswap and convert it to USD
uint256 amountInUSD = _amountIn.mul(
getPriceInUSD(_factory, _pool, FeedRegistryInterface(_factory.chainlinkRegistry()), _tokenIn, _useTwap, _manager)
);
// get price of token0 Uniswap and convert it to USD
uint256 amountOutUSD = _amountOut.mul(
getPriceInUSD(_factory, _pool, FeedRegistryInterface(_factory.chainlinkRegistry()), _tokenOut, _useTwap, _manager)
);
uint256 diff;
diff = amountInUSD.div(amountOutUSD.div(BASE));
uint256 _allowedSlippage = _factory.allowedSlippage(address(_pool));
// check if the price is above deviation
if (diff > (BASE.add(_allowedSlippage)) || diff < (BASE.sub(_allowedSlippage))) {
return false;
}
return true;
}
/**
* @notice Gets time weighted tick to calculate price
* @param _pool Address of the pool
* @param _period Seconds to query data from
*/
function getTick(address _pool, uint32 _period) internal view returns (int24 timeWeightedAverageTick) {
require(_period != 0, "BP");
uint32[] memory secondAgos = new uint32[](2);
secondAgos[0] = _period;
secondAgos[1] = 0;
(int56[] memory tickCumulatives, ) = IUniswapV3Pool(_pool).observe(secondAgos);
int56 tickCumulativesDelta = tickCumulatives[1] - tickCumulatives[0];
timeWeightedAverageTick = int24(tickCumulativesDelta / _period);
// Always round to negative infinity
if (tickCumulativesDelta < 0 && (tickCumulativesDelta % _period != 0)) timeWeightedAverageTick--;
}
/**
* @notice Consults V3 TWAP oracle
* @param _pool Address of the pool
* @param _period Seconds from which the data needs to be queried
* @return price Price of the assets calculated from Uniswap V3 Oracle
*/
function consult(address _pool, uint32 _period) internal view returns (uint256 price) {
int24 tick = getTick(_pool, _period);
uint160 sqrtRatioX96 = TickMath.getSqrtRatioAtTick(tick);
// Calculate price with better precision if it doesn't overflow when multiplied by itself
if (sqrtRatioX96 <= type(uint128).max) {
uint256 ratioX192 = uint256(sqrtRatioX96).mul(sqrtRatioX96);
price = FullMath.mulDiv(ratioX192, BASE, 1 << 192);
} else {
uint256 ratioX128 = FullMath.mulDiv(sqrtRatioX96, sqrtRatioX96, 1 << 64);
price = FullMath.mulDiv(ratioX128, BASE, 1 << 128);
}
uint256 token0Decimals = IERC20Minimal(IUniswapV3Pool(_pool).token0()).decimals();
uint256 token1Decimals = IERC20Minimal(IUniswapV3Pool(_pool).token1()).decimals();
bool decimalCheck = token0Decimals > token1Decimals;
uint256 decimalsDelta = decimalCheck ? token0Decimals - token1Decimals : token1Decimals - token0Decimals;
// normalise the price to 18 decimals
if (token0Decimals == token1Decimals) {
return price;
}
if (decimalCheck) {
price = price.mul(CommonMath.safePower(10, decimalsDelta));
} else {
price = price.div(CommonMath.safePower(10, decimalsDelta));
}
}
}
//SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
pragma abicoder v2;
import "@uniswap/v3-core/contracts/interfaces/IUniswapV3Pool.sol";
import "@openzeppelin/contracts/math/SafeMath.sol";
import "@uniswap/v3-core/contracts/libraries/FullMath.sol";
import "./TwapOracleLibrary.sol";
interface ITwapStrategy {
function pool() external view returns(IUniswapV3Pool);
}
library TwapShareHelper {
using SafeMath for uint256;
uint256 public constant DIVISOR = 100e18;
/**
* @dev Calculates the shares to be given for specific position
* @param _registry Chainlink registry interface
* @param _pool The token0
* @param _amount0 Amount of token0
* @param _amount1 Amount of token1
* @param _totalAmount0 Total amount of token0
* @param _totalAmount1 Total amount of token1
* @param _totalShares Total Number of shares
*/
function calculateShares(
FeedRegistryInterface _registry,
IUniswapV3Pool _pool,
ITwapStrategyManager _manager,
bool[2] memory _useTwap,
uint256 _amount0,
uint256 _amount1,
uint256 _totalAmount0,
uint256 _totalAmount1,
uint256 _totalShares
) public view returns (uint256 share) {
require(_amount0 > 0 && _amount1 > 0, "INSUFFICIENT_AMOUNT");
address _token0 = _pool.token0();
address _token1 = _pool.token1();
_amount0 = TwapOracleLibrary.normalise(_token0, _amount0);
_amount1 = TwapOracleLibrary.normalise(_token1, _amount1);
_totalAmount0 = TwapOracleLibrary.normalise(_token0, _totalAmount0);
_totalAmount1 = TwapOracleLibrary.normalise(_token1, _totalAmount1);
if (_totalShares > 0) {
if (_amount0 < _amount1) {
share = FullMath.mulDiv(_amount1, _totalShares, _totalAmount1);
} else {
share = FullMath.mulDiv(_amount0, _totalShares, _totalAmount0);
}
} else {
// price in USD
(uint256 token0Price, uint256 token1Price) = _getPrice(_pool, _registry, _useTwap, _manager);
share = ((token0Price.mul(_amount0)).add(token1Price.mul(_amount1))).div(DIVISOR);
}
}
/**
* @notice Calculates the fee shares from accumulated fees
* @param _factory Strategy factory address
* @param _manager Strategy manager contract address
* @param _accManagementFee Accumulated management fees in terms of shares, decimal 18
*/
function calculateFeeShares(
ITwapStrategyFactory _factory,
ITwapStrategyManager _manager,
uint256 _accManagementFee
)
public
view
returns (
address managerFeeTo,
address protocolFeeTo,
uint256 managerShare,
uint256 protocolShare
)
{
uint256 protocolFeeRate = _factory.protocolFeeRate();
// calculate the fees for protocol and manager from management fees
if (_accManagementFee > 0) {
protocolShare = FullMath.mulDiv(_accManagementFee, protocolFeeRate, 1e8);
managerShare = _accManagementFee.sub(protocolShare);
}
// moved here for saving bytecode
managerFeeTo = _manager.feeTo();
protocolFeeTo = _factory.feeTo();
}
/**
* @notice Calculates the fee shares from accumulated fees
* @param _factory Strategy factory address
* @param _manager Strategy manager contract address
* @param _fee0 Accumulated token0 fee amount
* @param _fee1 Accumulated token1 fee amount
*/
function calculateFeeTokenShares(
ITwapStrategyFactory _factory,
ITwapStrategyManager _manager,
address _strategy,
uint256 _fee0,
uint256 _fee1
)
public
view
returns (
address managerFeeTo,
address protocolFeeTo,
uint256 managerToken0Amount,
uint256 managerToken1Amount,
uint256 protocolToken0Amount,
uint256 protocolToken1Amount
)
{
// protocol fees
uint256 protocolFeeRate = _factory.protocolFeeRate();
// performance fee to manager
uint256 performanceFeeRate = _manager.performanceFeeRate();
// protocol performance fee
uint256 protocolPerformanceFeeRate = _factory.getProtocolPerformanceFeeRate(address(ITwapStrategy(_strategy).pool()), _strategy);
// if sum of both performance fees is greater than 100% then reduce protocol performance fees and adjust both fees sum to 100% (100% - performanceFeeRate)
if(performanceFeeRate.add(protocolPerformanceFeeRate) > 100e6){
protocolPerformanceFeeRate = uint256(100e6).sub(performanceFeeRate);
}
// calculate the fees for protocol and manager from performance fees
uint256 performanceToken0Amount = FullMath.mulDiv(_fee0, performanceFeeRate, 1e8);
uint256 performanceToken1Amount = FullMath.mulDiv(_fee1, performanceFeeRate, 1e8);
if (performanceToken0Amount > 0) {
protocolToken0Amount = FullMath.mulDiv(performanceToken0Amount, protocolFeeRate, 1e8);
managerToken0Amount = performanceToken0Amount.sub(protocolToken0Amount);
}
if (performanceToken1Amount > 0) {
protocolToken1Amount = FullMath.mulDiv(performanceToken1Amount, protocolFeeRate, 1e8);
managerToken1Amount = performanceToken1Amount.sub(protocolToken1Amount);
}
protocolToken0Amount = protocolToken0Amount.add(FullMath.mulDiv(_fee0, protocolPerformanceFeeRate, 1e8));
protocolToken1Amount = protocolToken1Amount.add(FullMath.mulDiv(_fee1, protocolPerformanceFeeRate, 1e8));
// moved here for saving bytecode
managerFeeTo = _manager.feeTo();
protocolFeeTo = _factory.feeTo();
}
function getOptimalAmounts(
uint256 _amount0,
uint256 _amount1,
uint256 _amount0Min,
uint256 _amount1Min,
uint256 _totalAmount0,
uint256 _totalAmount1
) public pure returns (uint256 amount0, uint256 amount1) {
require(_amount0 > 0 && _amount1 > 0, "INSUFFICIENT_AMOUNT");
if (_totalAmount0 == 0 && _totalAmount1 == 0) {
(amount0, amount1) = (_amount0, _amount1);
} else {
if (_totalAmount0 == 0) {
require(_amount0Min == 0, "INSUFFICIENT_AMOUNT_0");
(amount0, amount1) = (0, _amount1);
return (amount0, amount1);
}
if (_totalAmount1 == 0) {
require(_amount1Min == 0, "INSUFFICIENT_AMOUNT_1");
(amount0, amount1) = (_amount0, 0);
return (amount0, amount1);
}
uint256 amount1Optimal = _amount0.mul(_totalAmount1).div(_totalAmount0);
if (amount1Optimal <= _amount1) {
require(amount1Optimal >= _amount1Min, "INSUFFICIENT_AMOUNT_1");
(amount0, amount1) = (_amount0, amount1Optimal);
} else {
uint256 amount0Optimal = _amount1.mul(_totalAmount0).div(_totalAmount1);
assert(amount0Optimal <= _amount0);
require(amount0Optimal >= _amount0Min, "INSUFFICIENT_AMOUNT_0");
(amount0, amount1) = (amount0Optimal, _amount1);
}
}
}
// to resolve stack too deep error
function _getPrice(
IUniswapV3Pool _pool,
FeedRegistryInterface _registry,
bool[2] memory _useTwap,
ITwapStrategyManager _manager
) internal view returns (uint256 token0Price, uint256 token1Price) {
// price in USD
token0Price = TwapOracleLibrary.getPriceInUSD(_manager.factory(), _pool, _registry, _pool.token0(), _useTwap, _manager);
token1Price = TwapOracleLibrary.getPriceInUSD(_manager.factory(), _pool, _registry, _pool.token1(), _useTwap, _manager);
}
}
//SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
pragma abicoder v2;
// contracts
import "../../ERC20.sol";
// libraries
import "../libraries/TwapShareHelper.sol";
import "../libraries/TwapOracleLibrary.sol";
contract TwapStrategyBase is ERC20, ITwapStrategyBase {
using SafeMath for uint256;
uint256 public constant FEE_PRECISION = 1e8;
bool public override onHold;
uint256 public constant MINIMUM_LIQUIDITY = 1e12;
// store ticks
Tick[] public ticks;
uint256 public override accManagementFeeShares;
ITwapStrategyFactory public override factory; // instance of the strategy factory
IUniswapV3Pool public override pool; // instance of the Uniswap V3 pool
IERC20 internal token0;
IERC20 internal token1;
FeedRegistryInterface internal chainlinkRegistry;
ITwapStrategyManager public override manager; // instance of manager contract
uint256 public constant MAX_TICK_LENGTH = 20;
bool[2] public override useTwap; // use uniswap v3 pool to fetch price in usd - (true => use uniswap v3 price, false - use chainlink price)
uint256 public reserve0; // reserve for token0 balance
uint256 public reserve1; // reserve for token1 balance
// Modifiers
modifier onlyOperator() {
require(manager.isAllowedToManage(msg.sender), "N");
_;
}
/**
* @dev Replaces old ticks with new ticks
* @param _ticks New ticks
*/
function isInvalidTicks(Tick[] memory _ticks) internal pure returns (bool invalid) {
for (uint256 i = 0; i < _ticks.length; i++) {
int24 tickLower = _ticks[i].tickLower;
int24 tickUpper = _ticks[i].tickUpper;
// check that two tick upper and tick lowers are not in array cannot be same
for (uint256 j = 0; j < i; j++) {
if (tickLower == _ticks[j].tickLower) {
if (tickUpper == _ticks[j].tickUpper) {
invalid = true;
return invalid;
}
// require(tickUpper != _ticks[j].tickUpper, "TS");
}
}
}
}
/**
* @dev Checks if it's valid strategy or not
*/
modifier onlyValidStrategy() {
// check if strategy is in denylist
require(!factory.denied(address(this)), "DL");
_;
}
/**
* @dev checks if caller is governance
*/
function onlyGovernance() internal view returns(bool isGov){
if(msg.sender == factory.governance()){
isGov = true;
}
}
/**
* @notice Updates the shares of the user
* @param _amount0 Amount of token0
* @param _amount1 Amount of token1
* @param _totalAmount0 Total amount0 in the specific strategy
* @param _totalAmount1 Total amount1 in the specific strategy
* @param _user address where shares should be issued
*/
function issueShare(
uint256 _amount0,
uint256 _amount1,
uint256 _totalAmount0,
uint256 _totalAmount1,
address _user
) internal returns (uint256 share) {
uint256 _shareTotalSupply = totalSupply();
// calculate number of shares
share = TwapShareHelper.calculateShares(
chainlinkRegistry,
pool,
manager,
useTwap,
_amount0,
_amount1,
_totalAmount0,
_totalAmount1,
_shareTotalSupply
);
uint256 managerShare;
uint256 managementFeeRate = manager.managementFeeRate();
if (_shareTotalSupply == 0) {
share = share.sub(MINIMUM_LIQUIDITY);
_mint(address(0), MINIMUM_LIQUIDITY);
}
// strategy owner fees
if (managementFeeRate > 0) {
managerShare = share.mul(managementFeeRate).div(FEE_PRECISION);
accManagementFeeShares = accManagementFeeShares.add(managerShare);
share = share.sub(managerShare);
}
// issue shares
_mint(_user, share);
}
function totalSupply() public view override returns (uint256) {
return _totalSupply.add(accManagementFeeShares);
}
/**
* @notice Claims the fee for protocol and management
* Protocol receives X percentage from manager fee
*/
function claimFee() external override {
(address managerFeeTo, address protocolFeeTo, uint256 managerShare, uint256 protocolShare) = TwapShareHelper.calculateFeeShares(
factory,
manager,
accManagementFeeShares
);
if (managerShare > 0) {
_mint(managerFeeTo, managerShare);
}
if (protocolShare > 0) {
_mint(protocolFeeTo, protocolShare);
}
// set the variables to 0
accManagementFeeShares = 0;
emit ClaimFee(managerShare, protocolShare);
}
/**
* @notice Returns the current ticks
*/
function getTicks() public view returns (Tick[] memory) {
return ticks;
}
}
//SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
// libraries
import "@openzeppelin/contracts/math/SafeMath.sol";
// interfaces
import "../interfaces/ITwapStrategyFactory.sol";
import "../interfaces/ITwapStrategyBase.sol";
import "@openzeppelin/contracts/access/AccessControl.sol";
contract TwapStrategyManager is AccessControl, ITwapStrategyManager {
using SafeMath for uint256;
event FeeChanged(uint256 tier);
event FeeToChanged(address feeTo);
event OperatorProposed(address indexed operator);
event OperatorChanged(address indexed operator);
event LimitChanged(uint256 limit);
event MaxSwapLimitChanged(uint256 limit);
event ClaimFee(uint256 managerFee, uint256 protocolFee);
event PerformanceFeeChanged(uint256 performanceFeeRate);
event StrategyModeUpdated(bool status); // true - private, false - public
event EmergencyActivated();
uint256 public constant MIN_FEE = 20e6; // minimum 20%
uint256 public constant MIN_DEVIATION = 2e17; // minimum 20%
ITwapStrategyFactory public override factory;
address public override operator;
address public pendingOperator;
address public override feeTo;
// fee to take when user adds the liquidity
uint256 public override managementFeeRate; // 1e8 is 100%
// fees for the manager
uint256 public override performanceFeeRate; // 1e8 is 100%
// max number of shares to be minted
// if set 0, allows unlimited deposits
uint256 public override limit;
// number of times user can perform swap in a day
uint256 public maxAllowedSwap = 5;
// current swap counter
uint256 public swapCounter = 0;
// tracks timestamp of the last swap happened
uint256 public lastSwapTimestamp = 0;
bool public isStrategyPrivate = false; // if strategy is private or public
bytes32 public constant MANAGER_ROLE = keccak256("MANAGER_ROLE"); // can only rebalance and swap
bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE"); // can control everything
bytes32 public constant BURNER_ROLE = keccak256("BURNER_ROLE"); /// only can burn the liquidity
bytes32 public constant USER_WHITELIST_ROLE = keccak256("USER_WHITELIST_ROLE"); /// user have access to strategy - mint & burn
constructor(
ITwapStrategyFactory _factory,
address _operator,
address _feeTo,
uint256 _managementFeeRate,
uint256 _performanceFeeRate,
uint256 _limit
) {
require(_managementFeeRate <= MIN_FEE); // should be less than 20%
require(_performanceFeeRate <= MIN_FEE); // should be less than 20%
factory = _factory;
operator = _operator;
feeTo = _feeTo;
managementFeeRate = _managementFeeRate;
performanceFeeRate = _performanceFeeRate;
limit = _limit;
_setupRole(ADMIN_ROLE, _operator);
_setupRole(USER_WHITELIST_ROLE, _operator);
_setRoleAdmin(MANAGER_ROLE, ADMIN_ROLE);
_setRoleAdmin(BURNER_ROLE, ADMIN_ROLE);
_setRoleAdmin(USER_WHITELIST_ROLE, ADMIN_ROLE);
}
// Modifiers
modifier onlyOperator() {
require(hasRole(ADMIN_ROLE, msg.sender), "N");
_;
}
// Modifiers
modifier onlyGovernance() {
require(msg.sender == factory.governance(), "N");
_;
}
modifier onlyStrategy() {
require(msg.sender == strategy(), "N");
_;
}
function isUserWhiteListed(address _account) public view override returns (bool) {
return isStrategyPrivate ? hasRole(USER_WHITELIST_ROLE, _account) : true;
}
function isAllowedToManage(address _account) public view override returns (bool) {
return hasRole(ADMIN_ROLE, _account) || hasRole(MANAGER_ROLE, _account);
}
function isAllowedToBurn(address _account) public view override returns (bool) {
return hasRole(ADMIN_ROLE, _account) || hasRole(MANAGER_ROLE, _account) || hasRole(BURNER_ROLE, _account);
}
/**
* @notice Returns latest twap price period
* @dev If default price of the twap is not setup for the strategy,
return default value from the factory
*/
function twapPricePeriod() public view override returns (uint256) {
uint256 twapPeriodByPool = factory.twapPricePeriod(address(ITwapStrategyBase(strategy()).pool()));
return twapPeriodByPool > 0 ? twapPeriodByPool : factory.defaultTwapPricePeriod();
}
function strategy() public view returns (address) {
return factory.strategyByManager(address(this));
}
/**
* @notice Changes the fee
* @dev 1000000 is 1%
* @param _fee Fee tier from indexes 0 to 2
*/
function changeManagementFeeRate(uint256 _fee) public onlyOperator {
require(_fee <= MIN_FEE); // should be less than 20%
managementFeeRate = _fee;
emit FeeChanged(managementFeeRate);
}
/**
* @notice changes address where the operator is receiving the fee
* @param _newFeeTo New address where fees should be received
*/
function changeFeeTo(address _newFeeTo) external onlyOperator {
feeTo = _newFeeTo;
emit FeeToChanged(feeTo);
}
/**
* @notice Change the operator
* @param _operator Address of the new operator
*/
function changeOperator(address _operator) external onlyOperator {
require(_operator != operator);
pendingOperator = _operator;
emit OperatorProposed(pendingOperator);
}
/**
* @notice Change the operator
*/
function acceptOperator() external {
require(msg.sender == pendingOperator);
operator = pendingOperator;
pendingOperator = address(0);
emit OperatorChanged(operator);
}
/**
* @notice Change strategy limit in terms of share
* @param _limit Number of shares the strategy can mint, 0 means unlimited
*/
function changeLimit(uint256 _limit) external onlyOperator {
limit = _limit;
emit LimitChanged(limit);
}
/**
* @notice Manager can set the performance fee
* @param _performanceFeeRate New performance fee, should not be more than 20%
*/
function changePerformanceFeeRate(uint256 _performanceFeeRate) external onlyOperator {
require(_performanceFeeRate <= factory.maximumManagerPerformanceFeeRate()); // should be less than max cap set in factory
performanceFeeRate = _performanceFeeRate;
emit PerformanceFeeChanged(performanceFeeRate);
}
/**
* @notice Governance can set the performance fee upto 100%
* @param _performanceFeeRate New performance fee
*/
function changePerformanceFeeRateGov(uint256 _performanceFeeRate) external onlyGovernance {
require(_performanceFeeRate <= 100e6); // should be less than 100%
performanceFeeRate = _performanceFeeRate;
emit PerformanceFeeChanged(performanceFeeRate);
}
/**
* @notice Manager can update strategy mode - public, private
* @param _isPrivate true - private strategy, false - public strategy
*/
function updateStrategyMode(bool _isPrivate) external onlyOperator {
isStrategyPrivate = _isPrivate;
emit StrategyModeUpdated(isStrategyPrivate);
}
/**
* @notice Track total swap performed in a day and revert if maximum swap limit reached.
* Can only be called by strategy contract
*/
function incrementSwapCounter() external override onlyStrategy {
uint256 currentDay = block.timestamp / 1 days;
uint256 swapDay = lastSwapTimestamp / 1 days;
if (currentDay == swapDay) {
// last swap happened on same day
uint256 _counter = swapCounter;
require(maxAllowedSwap > _counter, "LR");
lastSwapTimestamp = block.timestamp;
swapCounter = _counter + 1;
} else {
// last swap happened on other day
swapCounter = 1;
lastSwapTimestamp = block.timestamp;
}
}
/**
* @notice Change strategy maximum swap limit for a day
* @param _limit Maximum number of swap that can be performed in a day
*/
function changeMaxSwapLimit(uint256 _limit) external onlyGovernance {
maxAllowedSwap = _limit;
emit MaxSwapLimitChanged(maxAllowedSwap);
}
}
//SPDX-License-Identifier: BSL
pragma solidity ^0.7.6;
pragma abicoder v2;
// contracts
import "@openzeppelin/contracts/utils/SafeCast.sol";
import "./TwapStrategyBase.sol";
// libraries
import "../../libraries/LiquidityHelper.sol";
import "@uniswap/v3-periphery/contracts/libraries/TransferHelper.sol";
import "@openzeppelin/contracts/token/ERC20/SafeERC20.sol";
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
// interfaces
import "@uniswap/v3-core/contracts/interfaces/callback/IUniswapV3MintCallback.sol";
import "../../interfaces/ISwapProxy.sol";
contract UniswapV3TwapLiquidityManager is TwapStrategyBase, ReentrancyGuard, IUniswapV3MintCallback {
using SafeMath for uint256;
using SafeCast for uint256;
using SafeERC20 for IERC20;
event Sync(uint256 reserve0, uint256 reserve1);
event Swap(uint256 amountIn, uint256 amountOut, bool _zeroForOne);
event FeesClaim(address indexed strategy, uint256 amount0, uint256 amount1);
struct MintCallbackData {
address payer;
IUniswapV3Pool pool;
}
// to handle stake too deep error inside swap function
struct LocalVariables_Balances {
uint256 tokenInBalBefore;
uint256 tokenOutBalBefore;
uint256 tokenInBalAfter;
uint256 tokenOutBalAfter;
uint256 shareSupplyBefore;
}
/**
* @notice Mints liquidity from V3 Pool
* @param _tickLower Lower tick
* @param _tickUpper Upper tick
* @param _amount0 Amount of token0
* @param _amount1 Amount of token1
* @param _payer Address which is adding the liquidity
*/
function mintLiquidity(
int24 _tickLower,
int24 _tickUpper,
uint256 _amount0,
uint256 _amount1,
address _payer
) internal returns (uint256 amount0, uint256 amount1) {
uint128 liquidity = LiquidityHelper.getLiquidityForAmounts(pool, _tickLower, _tickUpper, _amount0, _amount1);
// add liquidity to Uniswap pool
(amount0, amount1) = pool.mint(
address(this),
_tickLower,
_tickUpper,
liquidity,
abi.encode(MintCallbackData({payer: _payer, pool: pool}))
);
}
/**
* @notice Burns liquidity in the given range
* @param _tickLower Lower Tick
* @param _tickUpper Upper Tick
* @param _shares The amount of liquidity to be burned based on shares
*/
function burnLiquidity(
int24 _tickLower,
int24 _tickUpper,
uint256 _shares,
uint128 _currentLiquidity
)
internal
returns (
uint256 tokensBurned0,
uint256 tokensBurned1,
uint256 fee0,
uint256 fee1
)
{
uint256 collect0;
uint256 collect1;
if (_shares > 0) {
(_currentLiquidity, , , , ) = pool.positions(PositionKey.compute(address(this), _tickLower, _tickUpper));
if (_currentLiquidity > 0) {
uint256 liquidity = FullMath.mulDiv(_currentLiquidity, _shares, totalSupply());
(tokensBurned0, tokensBurned1) = pool.burn(_tickLower, _tickUpper, liquidity.toUint128());
}
} else {
(tokensBurned0, tokensBurned1) = pool.burn(_tickLower, _tickUpper, _currentLiquidity);
}
// collect fees
(collect0, collect1) = pool.collect(address(this), _tickLower, _tickUpper, type(uint128).max, type(uint128).max);
fee0 = collect0 > tokensBurned0 ? uint256(collect0).sub(tokensBurned0) : 0;
fee1 = collect1 > tokensBurned1 ? uint256(collect1).sub(tokensBurned1) : 0;
reserve0 = reserve0.add(collect0);
reserve1 = reserve1.add(collect1);
}
/**
* @notice Splits and transfers the performance fee
* @param _fee0 Amount of accumulated fee for token0
* @param _fee1 Amount of accumulated fee for token1
*/
function _transferPerformanceFees(uint256 _fee0, uint256 _fee1) internal {
(
address managerFeeTo,
address protocolFeeTo,
uint256 managerToken0Amount,
uint256 managerToken1Amount,
uint256 protocolToken0Amount,
uint256 protocolToken1Amount
) = TwapShareHelper.calculateFeeTokenShares(factory, manager, address(this), _fee0, _fee1);
if (managerToken0Amount > 0) {
TransferHelper.safeTransfer(address(token0), managerFeeTo, managerToken0Amount);
reserve0 = reserve0.sub(managerToken0Amount);
}
if (managerToken1Amount > 0) {
TransferHelper.safeTransfer(address(token1), managerFeeTo, managerToken1Amount);
reserve1 = reserve1.sub(managerToken1Amount);
}
if (protocolToken0Amount > 0) {
TransferHelper.safeTransfer(address(token0), protocolFeeTo, protocolToken0Amount);
reserve0 = reserve0.sub(protocolToken0Amount);
}
if (protocolToken1Amount > 0) {
TransferHelper.safeTransfer(address(token1), protocolFeeTo, protocolToken1Amount);
reserve1 = reserve1.sub(protocolToken1Amount);
}
emit FeesClaim(address(this), _fee0, _fee1);
}
/**
* @notice Burns all the liquidity and collects fees
*/
function burnAllLiquidity() internal returns (uint256 totalFee0, uint256 totalFee1) {
for (uint256 _tickIndex = 0; _tickIndex < ticks.length; _tickIndex++) {
Tick storage tick = ticks[_tickIndex];
(uint128 currentLiquidity, , , , ) = pool.positions(PositionKey.compute(address(this), tick.tickLower, tick.tickUpper));
if (currentLiquidity > 0) {
(, , uint256 fee0, uint256 fee1) = burnLiquidity(tick.tickLower, tick.tickUpper, 0, currentLiquidity);
totalFee0 = totalFee0.add(fee0);
totalFee1 = totalFee1.add(fee1);
}
}
}
/**
* @notice Burn liquidity from specific tick, used for limit orders
* @param _tickIndex Index of tick which needs to be burned
* @return amount0 Amount of token0's liquidity burned
* @return amount1 Amount of token1's liquidity burned
* @return fee0 Fee of token0 accumulated in the position which is being burned
* @return fee1 Fee of token1 accumulated in the position which is being burned
*/
function burnLiquiditySingle(uint256 _tickIndex)
public
nonReentrant
returns (
uint256 amount0,
uint256 amount1,
uint256 fee0,
uint256 fee1
)
{
require(manager.isAllowedToBurn(msg.sender), "N");
(amount0, amount1, fee0, fee1) = _burnLiquiditySingle(_tickIndex);
if (fee0 > 0 || fee1 > 0) {
_transferPerformanceFees(fee0, fee1);
}
// shift the index element at last of array
ticks[_tickIndex] = ticks[ticks.length - 1];
// remove last element
ticks.pop();
}
/**
* @notice Burn liquidity from specific tick
* @param _tickIndex Index of tick which needs to be burned
*/
function _burnLiquiditySingle(uint256 _tickIndex)
internal
returns (
uint256 amount0,
uint256 amount1,
uint256 fee0,
uint256 fee1
)
{
Tick storage tick = ticks[_tickIndex];
(uint128 currentLiquidity, , , , ) = pool.positions(PositionKey.compute(address(this), tick.tickLower, tick.tickUpper));
if (currentLiquidity > 0) {
(amount0, amount1, fee0, fee1) = burnLiquidity(tick.tickLower, tick.tickUpper, 0, currentLiquidity);
}
}
/**
* @notice Swap the funds to 1Inch
* @param zeroToOne swap direction - true if swapping token0 to token1 else false
* @param amountIn amount of token to swap
* @param isOneInchSwap true if swap is happening from one inch
* @param data Swap data to perform exchange from 1inch
*/
function swap(bool zeroToOne, uint256 amountIn, bool isOneInchSwap, bytes calldata data) public onlyOperator onlyValidStrategy nonReentrant {
_swap(zeroToOne, amountIn, isOneInchSwap, data);
}
/**
* @notice Swap the funds to 1Inch
* @param data Swap data to perform exchange from 1inch
*/
function _swap(bool zeroToOne, uint256 amountIn, bool isOneInchSwap, bytes calldata data) internal {
LocalVariables_Balances memory balances;
address swapProxy = factory.swapProxy();
IERC20 srcToken;
IERC20 dstToken;
if (zeroToOne) {
token0.safeIncreaseAllowance(swapProxy, amountIn);
srcToken = token0;
dstToken = token1;
} else {
token1.safeIncreaseAllowance(swapProxy, amountIn);
srcToken = token1;
dstToken = token0;
}
balances.tokenInBalBefore = srcToken.balanceOf(address(this));
balances.tokenOutBalBefore = dstToken.balanceOf(address(this));
balances.shareSupplyBefore = totalSupply();
if(isOneInchSwap){
ISwapProxy(swapProxy).aggregatorSwap(data);
} else {
// Interact with 1inch through contract call with data
(bool success, bytes memory returnData) = address(swapProxy).call(data);
// Verify return status and data
if (!success) {
uint256 length = returnData.length;
if (length < 68) {
// If the returnData length is less than 68, then the transaction failed silently.
revert("swap");
} else {
// Look for revert reason and bubble it up if present
uint256 t;
assembly {
returnData := add(returnData, 4)
t := mload(returnData) // Save the content of the length slot
mstore(returnData, sub(length, 4)) // Set proper length
}
string memory reason = abi.decode(returnData, (string));
assembly {
mstore(returnData, t) // Restore the content of the length slot
}
revert(reason);
}
}
}
require(balances.shareSupplyBefore == totalSupply(), "MS");
balances.tokenInBalAfter = srcToken.balanceOf(address(this));
balances.tokenOutBalAfter = dstToken.balanceOf(address(this));
uint256 amountInFinal = balances.tokenInBalBefore.sub(balances.tokenInBalAfter);
uint256 amountOutFinal = balances.tokenOutBalAfter.sub(balances.tokenOutBalBefore);
// revoke approval after swap & update reserves
if (zeroToOne) {
token0.safeApprove(swapProxy, 0);
reserve0 = reserve0.sub(amountInFinal);
reserve1 = reserve1.add(amountOutFinal);
} else {
token1.safeApprove(swapProxy, 0);
reserve0 = reserve0.add(amountOutFinal);
reserve1 = reserve1.sub(amountInFinal);
}
// used to limit number of swaps a manager can do per day
manager.incrementSwapCounter();
require(
TwapOracleLibrary.allowSwap(pool, factory, amountInFinal, amountOutFinal, address(srcToken), address(dstToken), manager, useTwap),
"S"
);
}
/**
* @dev Callback for Uniswap V3 pool.
*/
function uniswapV3MintCallback(
uint256 amount0,
uint256 amount1,
bytes calldata data
) external override {
require(msg.sender == address(pool));
MintCallbackData memory decoded = abi.decode(data, (MintCallbackData));
// check if the callback is received from Uniswap V3 Pool
if (decoded.payer == address(this)) {
// transfer tokens already in the contract
if (amount0 > 0) {
TransferHelper.safeTransfer(address(token0), msg.sender, amount0);
reserve0 = reserve0.sub(amount0);
}
if (amount1 > 0) {
TransferHelper.safeTransfer(address(token1), msg.sender, amount1);
reserve1 = reserve1.sub(amount1);
}
}
}
/**
* @notice Get's assets under management with realtime fees
* @param _includeFee Whether to include pool fees in AUM or not. (passing true will also collect fees from pool)
*/
function getAUMWithFees(bool _includeFee)
external
returns (
uint256 amount0,
uint256 amount1,
uint256 totalFee0,
uint256 totalFee1
)
{
// get fees accumulated in each tick
for (uint256 i = 0; i < ticks.length; i++) {
Tick memory tick = ticks[i];
// get current liquidity from the pool
(uint128 currentLiquidity, , , , ) = pool.positions(PositionKey.compute(address(this), tick.tickLower, tick.tickUpper));
if (currentLiquidity > 0) {
// calculate current positions in the pool from currentLiquidity
(uint256 position0, uint256 position1) = LiquidityHelper.getAmountsForLiquidity(
pool,
tick.tickLower,
tick.tickUpper,
currentLiquidity
);
amount0 = amount0.add(position0);
amount1 = amount1.add(position1);
}
// collect fees
if (_includeFee && currentLiquidity > 0) {
// update fees earned in Uniswap pool
// Uniswap recalculates the fees and updates the variables when amount is passed as 0
pool.burn(tick.tickLower, tick.tickUpper, 0);
(uint256 fee0, uint256 fee1) = pool.collect(
address(this),
tick.tickLower,
tick.tickUpper,
type(uint128).max,
type(uint128).max
);
totalFee0 = totalFee0.add(fee0);
totalFee1 = totalFee1.add(fee1);
emit FeesClaim(address(this), totalFee0, totalFee1);
}
}
reserve0 = reserve0.add(totalFee0);
reserve1 = reserve1.add(totalFee1);
if (_includeFee && (totalFee0 > 0 || totalFee1 > 0)) {
// transfer performance fees
_transferPerformanceFees(totalFee0, totalFee1);
}
// get unused amounts
amount0 = amount0.add(reserve0);
amount1 = amount1.add(reserve1);
}
// force balances to match reserves
function skim(address to) external onlyOperator {
TransferHelper.safeTransfer(address(token0), to, token0.balanceOf(address(this)).sub(reserve0));
TransferHelper.safeTransfer(address(token1), to, token1.balanceOf(address(this)).sub(reserve1));
}
// force reserves to match balances
function sync() external onlyOperator {
reserve0 = token0.balanceOf(address(this));
reserve1 = token1.balanceOf(address(this));
emit Sync(reserve0, reserve1);
}
}
{
"compilationTarget": {
"contracts/twap/DefiEdgeTwapStrategyFactory.sol": "DefiEdgeTwapStrategyFactory"
},
"evmVersion": "istanbul",
"libraries": {},
"metadata": {
"bytecodeHash": "ipfs"
},
"optimizer": {
"enabled": true,
"runs": 1
},
"remappings": []
}
[{"inputs":[{"internalType":"address","name":"_governance","type":"address"},{"internalType":"contract IDefiEdgeTwapStrategyDeployer","name":"_deployerProxy","type":"address"},{"internalType":"contract FeedRegistryInterface","name":"_chainlinkRegistry","type":"address"},{"internalType":"contract IUniswapV3Factory","name":"_uniswapV3factory","type":"address"},{"internalType":"uint256","name":"_allowedSlippage","type":"uint256"},{"internalType":"uint256","name":"_allowedDeviation","type":"uint256"}],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"pool","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"ChangeAllowedSlippage","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"pool","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"ChangeAllowedSwapDeviation","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"_feeRate","type":"uint256"}],"name":"ChangeDefaultMaxManagerPerformanceFee","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"fee","type":"uint256"}],"name":"ChangeProtocolFee","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"strategyOrPool","type":"address"},{"indexed":false,"internalType":"uint256","name":"_feeRate","type":"uint256"}],"name":"ChangeProtocolPerformanceFee","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"ChangeStrategyCreationFee","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"newSwapProxy","type":"address"}],"name":"ChangeSwapProxy","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"to","type":"address"},{"indexed":false,"internalType":"uint256","name":"amount","type":"uint256"}],"name":"ClaimFees","type":"event"},{"anonymous":false,"inputs":[],"name":"EmergencyFrozen","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"strategy","type":"address"},{"indexed":true,"internalType":"address","name":"creater","type":"address"}],"name":"NewStrategy","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"bool","name":"status","type":"bool"}],"name":"StrategyStatusChanged","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"address","name":"pool","type":"address"},{"indexed":false,"internalType":"uint256","name":"period","type":"uint256"}],"name":"TwapPricePeriodChanged","type":"event"},{"inputs":[],"name":"MAX_DECIMAL","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MAX_PROTOCOL_PERFORMANCE_FEES_RATE","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"acceptGovernance","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_pool","type":"address"}],"name":"allowedSlippage","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_pool","type":"address"}],"name":"allowedSwapDeviation","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"chainlinkRegistry","outputs":[{"internalType":"contract FeedRegistryInterface","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_pool","type":"address"},{"internalType":"uint256","name":"_allowedSlippage","type":"uint256"}],"name":"changeAllowedSlippage","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_pool","type":"address"},{"internalType":"uint256","name":"_allowedSwapDeviation","type":"uint256"}],"name":"changeAllowedSwapDeviation","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_pool","type":"address"},{"internalType":"uint256","name":"_twapPricePeriod","type":"uint256"}],"name":"changeDefaultTwapPeriod","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_allowedSlippage","type":"uint256"},{"internalType":"uint256","name":"_allowedSwapDeviation","type":"uint256"}],"name":"changeDefaultValues","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_fee","type":"uint256"}],"name":"changeFeeForStrategyCreation","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_feeTo","type":"address"}],"name":"changeFeeTo","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_governance","type":"address"}],"name":"changeGovernance","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_fee","type":"uint256"}],"name":"changeMaxManagerPerformanceFeeRate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"_fee","type":"uint256"}],"name":"changeProtocolFeeRate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"pool","type":"address"},{"internalType":"address","name":"strategy","type":"address"},{"internalType":"uint256","name":"_feeRate","type":"uint256"}],"name":"changeProtocolPerformanceFeeRate","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_swapProxy","type":"address"}],"name":"changeSwapProxy","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_to","type":"address"}],"name":"claimFees","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"components":[{"internalType":"address","name":"operator","type":"address"},{"internalType":"address","name":"feeTo","type":"address"},{"internalType":"uint256","name":"managementFeeRate","type":"uint256"},{"internalType":"uint256","name":"performanceFeeRate","type":"uint256"},{"internalType":"uint256","name":"limit","type":"uint256"},{"internalType":"contract IUniswapV3Pool","name":"pool","type":"address"},{"internalType":"bool[2]","name":"useTwap","type":"bool[2]"},{"components":[{"internalType":"int24","name":"tickLower","type":"int24"},{"internalType":"int24","name":"tickUpper","type":"int24"}],"internalType":"struct ITwapStrategyBase.Tick[]","name":"ticks","type":"tuple[]"}],"internalType":"struct ITwapStrategyFactory.CreateStrategyParams","name":"params","type":"tuple"}],"name":"createStrategy","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[],"name":"defaultAllowedSlippage","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"defaultAllowedSwapDeviation","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"defaultProtocolPerformanceFeeRate","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"defaultTwapPricePeriod","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"denied","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_strategy","type":"address"},{"internalType":"bool","name":"_status","type":"bool"}],"name":"deny","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"deployerProxy","outputs":[{"internalType":"contract IDefiEdgeTwapStrategyDeployer","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"feeTo","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"freezeEmergency","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"freezeEmergencyFunctions","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"address","name":"_base","type":"address"},{"internalType":"address","name":"_quote","type":"address"}],"name":"getHeartBeat","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"pool","type":"address"},{"internalType":"address","name":"strategy","type":"address"}],"name":"getProtocolPerformanceFeeRate","outputs":[{"internalType":"uint256","name":"_feeRate","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"governance","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"isValidStrategy","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"maximumManagerPerformanceFeeRate","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"pendingGovernance","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"protocolFeeRate","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"protocolPerformanceFeeRateByPool","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"protocolPerformanceFeeRateByStrategy","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"_base","type":"address"},{"internalType":"address","name":"_quote","type":"address"},{"internalType":"uint256","name":"_period","type":"uint256"}],"name":"setMinHeartbeat","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[{"internalType":"uint256","name":"","type":"uint256"}],"name":"strategyByIndex","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"strategyByManager","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"strategyCreationFee","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"swapProxy","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"totalIndex","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"address","name":"","type":"address"}],"name":"twapPricePeriod","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"uniswapV3Factory","outputs":[{"internalType":"contract IUniswapV3Factory","name":"","type":"address"}],"stateMutability":"view","type":"function"}]