UNPKG

@b0dhidharma/yswaps

Version:
38 lines 162 kB
{ "language": "Solidity", "sources": { "contracts/utils/CollectableDustWithTokensManagement.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity >=0.8.4 <0.9.0;\n\nimport '@openzeppelin/contracts/token/ERC20/IERC20.sol';\nimport '@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol';\nimport '@lbertenasco/contract-utils/interfaces/utils/ICollectableDust.sol';\n\nimport '../libraries/CommonErrors.sol';\n\ninterface ICollectableDustWithTokensManagement is ICollectableDust {\n error ManagingMoreThanBalance();\n error SubtractingMoreThanManaged();\n error TakingManagedFunds();\n}\n\nabstract contract CollectableDustWithTokensManagement is ICollectableDustWithTokensManagement {\n using SafeERC20 for IERC20;\n\n mapping(address => uint256) internal _tokensUnderManagement;\n\n function _addTokenUnderManagement(address _token, uint256 _amount) internal {\n if (_tokensUnderManagement[_token] + _amount > IERC20(_token).balanceOf(address(this))) revert ManagingMoreThanBalance();\n _tokensUnderManagement[_token] += _amount;\n }\n\n function _subTokenUnderManagement(address _token, uint256 _amount) internal {\n if (_tokensUnderManagement[_token] < _amount) revert SubtractingMoreThanManaged();\n _tokensUnderManagement[_token] -= _amount;\n }\n\n function _sendDust(\n address _to,\n address _token,\n uint256 _amount\n ) internal {\n if (_to == address(0)) revert CommonErrors.ZeroAddress();\n if (_amount > IERC20(_token).balanceOf(address(this)) - _tokensUnderManagement[_token]) revert TakingManagedFunds();\n IERC20(_token).safeTransfer(_to, _amount);\n emit DustSent(_to, _token, _amount);\n }\n}\n" }, "@openzeppelin/contracts/token/ERC20/IERC20.sol": { "content": "// SPDX-License-Identifier: MIT\n\npragma solidity ^0.8.0;\n\n/**\n * @dev Interface of the ERC20 standard as defined in the EIP.\n */\ninterface IERC20 {\n /**\n * @dev Returns the amount of tokens in existence.\n */\n function totalSupply() external view returns (uint256);\n\n /**\n * @dev Returns the amount of tokens owned by `account`.\n */\n function balanceOf(address account) external view returns (uint256);\n\n /**\n * @dev Moves `amount` tokens from the caller's account to `recipient`.\n *\n * Returns a boolean value indicating whether the operation succeeded.\n *\n * Emits a {Transfer} event.\n */\n function transfer(address recipient, uint256 amount) external returns (bool);\n\n /**\n * @dev Returns the remaining number of tokens that `spender` will be\n * allowed to spend on behalf of `owner` through {transferFrom}. This is\n * zero by default.\n *\n * This value changes when {approve} or {transferFrom} are called.\n */\n function allowance(address owner, address spender) external view returns (uint256);\n\n /**\n * @dev Sets `amount` as the allowance of `spender` over the caller's tokens.\n *\n * Returns a boolean value indicating whether the operation succeeded.\n *\n * IMPORTANT: Beware that changing an allowance with this method brings the risk\n * that someone may use both the old and the new allowance by unfortunate\n * transaction ordering. One possible solution to mitigate this race\n * condition is to first reduce the spender's allowance to 0 and set the\n * desired value afterwards:\n * https://github.com/ethereum/EIPs/issues/20#issuecomment-263524729\n *\n * Emits an {Approval} event.\n */\n function approve(address spender, uint256 amount) external returns (bool);\n\n /**\n * @dev Moves `amount` tokens from `sender` to `recipient` using the\n * allowance mechanism. `amount` is then deducted from the caller's\n * allowance.\n *\n * Returns a boolean value indicating whether the operation succeeded.\n *\n * Emits a {Transfer} event.\n */\n function transferFrom(\n address sender,\n address recipient,\n uint256 amount\n ) external returns (bool);\n\n /**\n * @dev Emitted when `value` tokens are moved from one account (`from`) to\n * another (`to`).\n *\n * Note that `value` may be zero.\n */\n event Transfer(address indexed from, address indexed to, uint256 value);\n\n /**\n * @dev Emitted when the allowance of a `spender` for an `owner` is set by\n * a call to {approve}. `value` is the new allowance.\n */\n event Approval(address indexed owner, address indexed spender, uint256 value);\n}\n" }, "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol": { "content": "// SPDX-License-Identifier: MIT\n\npragma solidity ^0.8.0;\n\nimport \"../IERC20.sol\";\nimport \"../../../utils/Address.sol\";\n\n/**\n * @title SafeERC20\n * @dev Wrappers around ERC20 operations that throw on failure (when the token\n * contract returns false). Tokens that return no value (and instead revert or\n * throw on failure) are also supported, non-reverting calls are assumed to be\n * successful.\n * To use this library you can add a `using SafeERC20 for IERC20;` statement to your contract,\n * which allows you to call the safe operations as `token.safeTransfer(...)`, etc.\n */\nlibrary SafeERC20 {\n using Address for address;\n\n function safeTransfer(\n IERC20 token,\n address to,\n uint256 value\n ) internal {\n _callOptionalReturn(token, abi.encodeWithSelector(token.transfer.selector, to, value));\n }\n\n function safeTransferFrom(\n IERC20 token,\n address from,\n address to,\n uint256 value\n ) internal {\n _callOptionalReturn(token, abi.encodeWithSelector(token.transferFrom.selector, from, to, value));\n }\n\n /**\n * @dev Deprecated. This function has issues similar to the ones found in\n * {IERC20-approve}, and its usage is discouraged.\n *\n * Whenever possible, use {safeIncreaseAllowance} and\n * {safeDecreaseAllowance} instead.\n */\n function safeApprove(\n IERC20 token,\n address spender,\n uint256 value\n ) internal {\n // safeApprove should only be called when setting an initial allowance,\n // or when resetting it to zero. To increase and decrease it, use\n // 'safeIncreaseAllowance' and 'safeDecreaseAllowance'\n require(\n (value == 0) || (token.allowance(address(this), spender) == 0),\n \"SafeERC20: approve from non-zero to non-zero allowance\"\n );\n _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, value));\n }\n\n function safeIncreaseAllowance(\n IERC20 token,\n address spender,\n uint256 value\n ) internal {\n uint256 newAllowance = token.allowance(address(this), spender) + value;\n _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));\n }\n\n function safeDecreaseAllowance(\n IERC20 token,\n address spender,\n uint256 value\n ) internal {\n unchecked {\n uint256 oldAllowance = token.allowance(address(this), spender);\n require(oldAllowance >= value, \"SafeERC20: decreased allowance below zero\");\n uint256 newAllowance = oldAllowance - value;\n _callOptionalReturn(token, abi.encodeWithSelector(token.approve.selector, spender, newAllowance));\n }\n }\n\n /**\n * @dev Imitates a Solidity high-level call (i.e. a regular function call to a contract), relaxing the requirement\n * on the return value: the return value is optional (but if data is returned, it must not be false).\n * @param token The token targeted by the call.\n * @param data The call data (encoded using abi.encode or one of its variants).\n */\n function _callOptionalReturn(IERC20 token, bytes memory data) private {\n // We need to perform a low level call here, to bypass Solidity's return data size checking mechanism, since\n // we're implementing it ourselves. We use {Address.functionCall} to perform this call, which verifies that\n // the target address contains contract code and also asserts for success in the low-level call.\n\n bytes memory returndata = address(token).functionCall(data, \"SafeERC20: low-level call failed\");\n if (returndata.length > 0) {\n // Return data is optional\n require(abi.decode(returndata, (bool)), \"SafeERC20: ERC20 operation did not succeed\");\n }\n }\n}\n" }, "@lbertenasco/contract-utils/interfaces/utils/ICollectableDust.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity 0.8.4;\n\ninterface ICollectableDust {\n event DustSent(address _to, address token, uint256 amount);\n\n function sendDust(address _to, address _token, uint256 _amount) external;\n}\n" }, "contracts/libraries/CommonErrors.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity >=0.8.4 <0.9.0;\n\nlibrary CommonErrors {\n error ZeroAddress();\n error NotAuthorized();\n error ZeroAmount();\n error ZeroSlippage();\n error IncorrectSwapInformation();\n}\n" }, "@openzeppelin/contracts/utils/Address.sol": { "content": "// SPDX-License-Identifier: MIT\n\npragma solidity ^0.8.0;\n\n/**\n * @dev Collection of functions related to the address type\n */\nlibrary Address {\n /**\n * @dev Returns true if `account` is a contract.\n *\n * [IMPORTANT]\n * ====\n * It is unsafe to assume that an address for which this function returns\n * false is an externally-owned account (EOA) and not a contract.\n *\n * Among others, `isContract` will return false for the following\n * types of addresses:\n *\n * - an externally-owned account\n * - a contract in construction\n * - an address where a contract will be created\n * - an address where a contract lived, but was destroyed\n * ====\n */\n function isContract(address account) internal view returns (bool) {\n // This method relies on extcodesize, which returns 0 for contracts in\n // construction, since the code is only stored at the end of the\n // constructor execution.\n\n uint256 size;\n assembly {\n size := extcodesize(account)\n }\n return size > 0;\n }\n\n /**\n * @dev Replacement for Solidity's `transfer`: sends `amount` wei to\n * `recipient`, forwarding all available gas and reverting on errors.\n *\n * https://eips.ethereum.org/EIPS/eip-1884[EIP1884] increases the gas cost\n * of certain opcodes, possibly making contracts go over the 2300 gas limit\n * imposed by `transfer`, making them unable to receive funds via\n * `transfer`. {sendValue} removes this limitation.\n *\n * https://diligence.consensys.net/posts/2019/09/stop-using-soliditys-transfer-now/[Learn more].\n *\n * IMPORTANT: because control is transferred to `recipient`, care must be\n * taken to not create reentrancy vulnerabilities. Consider using\n * {ReentrancyGuard} or the\n * https://solidity.readthedocs.io/en/v0.5.11/security-considerations.html#use-the-checks-effects-interactions-pattern[checks-effects-interactions pattern].\n */\n function sendValue(address payable recipient, uint256 amount) internal {\n require(address(this).balance >= amount, \"Address: insufficient balance\");\n\n (bool success, ) = recipient.call{value: amount}(\"\");\n require(success, \"Address: unable to send value, recipient may have reverted\");\n }\n\n /**\n * @dev Performs a Solidity function call using a low level `call`. A\n * plain `call` is an unsafe replacement for a function call: use this\n * function instead.\n *\n * If `target` reverts with a revert reason, it is bubbled up by this\n * function (like regular Solidity function calls).\n *\n * Returns the raw returned data. To convert to the expected return value,\n * use https://solidity.readthedocs.io/en/latest/units-and-global-variables.html?highlight=abi.decode#abi-encoding-and-decoding-functions[`abi.decode`].\n *\n * Requirements:\n *\n * - `target` must be a contract.\n * - calling `target` with `data` must not revert.\n *\n * _Available since v3.1._\n */\n function functionCall(address target, bytes memory data) internal returns (bytes memory) {\n return functionCall(target, data, \"Address: low-level call failed\");\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`], but with\n * `errorMessage` as a fallback revert reason when `target` reverts.\n *\n * _Available since v3.1._\n */\n function functionCall(\n address target,\n bytes memory data,\n string memory errorMessage\n ) internal returns (bytes memory) {\n return functionCallWithValue(target, data, 0, errorMessage);\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],\n * but also transferring `value` wei to `target`.\n *\n * Requirements:\n *\n * - the calling contract must have an ETH balance of at least `value`.\n * - the called Solidity function must be `payable`.\n *\n * _Available since v3.1._\n */\n function functionCallWithValue(\n address target,\n bytes memory data,\n uint256 value\n ) internal returns (bytes memory) {\n return functionCallWithValue(target, data, value, \"Address: low-level call with value failed\");\n }\n\n /**\n * @dev Same as {xref-Address-functionCallWithValue-address-bytes-uint256-}[`functionCallWithValue`], but\n * with `errorMessage` as a fallback revert reason when `target` reverts.\n *\n * _Available since v3.1._\n */\n function functionCallWithValue(\n address target,\n bytes memory data,\n uint256 value,\n string memory errorMessage\n ) internal returns (bytes memory) {\n require(address(this).balance >= value, \"Address: insufficient balance for call\");\n require(isContract(target), \"Address: call to non-contract\");\n\n (bool success, bytes memory returndata) = target.call{value: value}(data);\n return verifyCallResult(success, returndata, errorMessage);\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],\n * but performing a static call.\n *\n * _Available since v3.3._\n */\n function functionStaticCall(address target, bytes memory data) internal view returns (bytes memory) {\n return functionStaticCall(target, data, \"Address: low-level static call failed\");\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],\n * but performing a static call.\n *\n * _Available since v3.3._\n */\n function functionStaticCall(\n address target,\n bytes memory data,\n string memory errorMessage\n ) internal view returns (bytes memory) {\n require(isContract(target), \"Address: static call to non-contract\");\n\n (bool success, bytes memory returndata) = target.staticcall(data);\n return verifyCallResult(success, returndata, errorMessage);\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-}[`functionCall`],\n * but performing a delegate call.\n *\n * _Available since v3.4._\n */\n function functionDelegateCall(address target, bytes memory data) internal returns (bytes memory) {\n return functionDelegateCall(target, data, \"Address: low-level delegate call failed\");\n }\n\n /**\n * @dev Same as {xref-Address-functionCall-address-bytes-string-}[`functionCall`],\n * but performing a delegate call.\n *\n * _Available since v3.4._\n */\n function functionDelegateCall(\n address target,\n bytes memory data,\n string memory errorMessage\n ) internal returns (bytes memory) {\n require(isContract(target), \"Address: delegate call to non-contract\");\n\n (bool success, bytes memory returndata) = target.delegatecall(data);\n return verifyCallResult(success, returndata, errorMessage);\n }\n\n /**\n * @dev Tool to verifies that a low level call was successful, and revert if it wasn't, either by bubbling the\n * revert reason using the provided one.\n *\n * _Available since v4.3._\n */\n function verifyCallResult(\n bool success,\n bytes memory returndata,\n string memory errorMessage\n ) internal pure returns (bytes memory) {\n if (success) {\n return returndata;\n } else {\n // Look for revert reason and bubble it up if present\n if (returndata.length > 0) {\n // The easiest way to bubble the revert reason is using memory via assembly\n\n assembly {\n let returndata_size := mload(returndata)\n revert(add(32, returndata), returndata_size)\n }\n } else {\n revert(errorMessage);\n }\n }\n }\n}\n" }, "@lbertenasco/contract-utils/contracts/utils/CollectableDust.sol": { "content": "\n// SPDX-License-Identifier: MIT\n\npragma solidity 0.8.4;\n\nimport '@openzeppelin/contracts/utils/structs/EnumerableSet.sol';\nimport '@openzeppelin/contracts/token/ERC20/IERC20.sol';\nimport \"@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol\";\n\nimport '../../interfaces/utils/ICollectableDust.sol';\n\nabstract\ncontract CollectableDust is ICollectableDust {\n using SafeERC20 for IERC20;\n using EnumerableSet for EnumerableSet.AddressSet;\n\n address public constant ETH_ADDRESS = 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE;\n EnumerableSet.AddressSet internal protocolTokens;\n\n constructor() {}\n\n function _addProtocolToken(address _token) internal {\n require(!protocolTokens.contains(_token), 'collectable-dust/token-is-part-of-the-protocol');\n protocolTokens.add(_token);\n }\n\n function _removeProtocolToken(address _token) internal {\n require(protocolTokens.contains(_token), 'collectable-dust/token-not-part-of-the-protocol');\n protocolTokens.remove(_token);\n }\n\n function _sendDust(\n address _to,\n address _token,\n uint256 _amount\n ) internal {\n require(_to != address(0), 'collectable-dust/cant-send-dust-to-zero-address');\n require(!protocolTokens.contains(_token), 'collectable-dust/token-is-part-of-the-protocol');\n if (_token == ETH_ADDRESS) {\n payable(_to).transfer(_amount);\n } else {\n IERC20(_token).safeTransfer(_to, _amount);\n }\n emit DustSent(_to, _token, _amount);\n }\n}\n" }, "@openzeppelin/contracts/utils/structs/EnumerableSet.sol": { "content": "// SPDX-License-Identifier: MIT\n\npragma solidity ^0.8.0;\n\n/**\n * @dev Library for managing\n * https://en.wikipedia.org/wiki/Set_(abstract_data_type)[sets] of primitive\n * types.\n *\n * Sets have the following properties:\n *\n * - Elements are added, removed, and checked for existence in constant time\n * (O(1)).\n * - Elements are enumerated in O(n). No guarantees are made on the ordering.\n *\n * ```\n * contract Example {\n * // Add the library methods\n * using EnumerableSet for EnumerableSet.AddressSet;\n *\n * // Declare a set state variable\n * EnumerableSet.AddressSet private mySet;\n * }\n * ```\n *\n * As of v3.3.0, sets of type `bytes32` (`Bytes32Set`), `address` (`AddressSet`)\n * and `uint256` (`UintSet`) are supported.\n */\nlibrary EnumerableSet {\n // To implement this library for multiple types with as little code\n // repetition as possible, we write it in terms of a generic Set type with\n // bytes32 values.\n // The Set implementation uses private functions, and user-facing\n // implementations (such as AddressSet) are just wrappers around the\n // underlying Set.\n // This means that we can only create new EnumerableSets for types that fit\n // in bytes32.\n\n struct Set {\n // Storage of set values\n bytes32[] _values;\n // Position of the value in the `values` array, plus 1 because index 0\n // means a value is not in the set.\n mapping(bytes32 => uint256) _indexes;\n }\n\n /**\n * @dev Add a value to a set. O(1).\n *\n * Returns true if the value was added to the set, that is if it was not\n * already present.\n */\n function _add(Set storage set, bytes32 value) private returns (bool) {\n if (!_contains(set, value)) {\n set._values.push(value);\n // The value is stored at length-1, but we add 1 to all indexes\n // and use 0 as a sentinel value\n set._indexes[value] = set._values.length;\n return true;\n } else {\n return false;\n }\n }\n\n /**\n * @dev Removes a value from a set. O(1).\n *\n * Returns true if the value was removed from the set, that is if it was\n * present.\n */\n function _remove(Set storage set, bytes32 value) private returns (bool) {\n // We read and store the value's index to prevent multiple reads from the same storage slot\n uint256 valueIndex = set._indexes[value];\n\n if (valueIndex != 0) {\n // Equivalent to contains(set, value)\n // To delete an element from the _values array in O(1), we swap the element to delete with the last one in\n // the array, and then remove the last element (sometimes called as 'swap and pop').\n // This modifies the order of the array, as noted in {at}.\n\n uint256 toDeleteIndex = valueIndex - 1;\n uint256 lastIndex = set._values.length - 1;\n\n if (lastIndex != toDeleteIndex) {\n bytes32 lastvalue = set._values[lastIndex];\n\n // Move the last value to the index where the value to delete is\n set._values[toDeleteIndex] = lastvalue;\n // Update the index for the moved value\n set._indexes[lastvalue] = valueIndex; // Replace lastvalue's index to valueIndex\n }\n\n // Delete the slot where the moved value was stored\n set._values.pop();\n\n // Delete the index for the deleted slot\n delete set._indexes[value];\n\n return true;\n } else {\n return false;\n }\n }\n\n /**\n * @dev Returns true if the value is in the set. O(1).\n */\n function _contains(Set storage set, bytes32 value) private view returns (bool) {\n return set._indexes[value] != 0;\n }\n\n /**\n * @dev Returns the number of values on the set. O(1).\n */\n function _length(Set storage set) private view returns (uint256) {\n return set._values.length;\n }\n\n /**\n * @dev Returns the value stored at position `index` in the set. O(1).\n *\n * Note that there are no guarantees on the ordering of values inside the\n * array, and it may change when more values are added or removed.\n *\n * Requirements:\n *\n * - `index` must be strictly less than {length}.\n */\n function _at(Set storage set, uint256 index) private view returns (bytes32) {\n return set._values[index];\n }\n\n /**\n * @dev Return the entire set in an array\n *\n * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed\n * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that\n * this function has an unbounded cost, and using it as part of a state-changing function may render the function\n * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.\n */\n function _values(Set storage set) private view returns (bytes32[] memory) {\n return set._values;\n }\n\n // Bytes32Set\n\n struct Bytes32Set {\n Set _inner;\n }\n\n /**\n * @dev Add a value to a set. O(1).\n *\n * Returns true if the value was added to the set, that is if it was not\n * already present.\n */\n function add(Bytes32Set storage set, bytes32 value) internal returns (bool) {\n return _add(set._inner, value);\n }\n\n /**\n * @dev Removes a value from a set. O(1).\n *\n * Returns true if the value was removed from the set, that is if it was\n * present.\n */\n function remove(Bytes32Set storage set, bytes32 value) internal returns (bool) {\n return _remove(set._inner, value);\n }\n\n /**\n * @dev Returns true if the value is in the set. O(1).\n */\n function contains(Bytes32Set storage set, bytes32 value) internal view returns (bool) {\n return _contains(set._inner, value);\n }\n\n /**\n * @dev Returns the number of values in the set. O(1).\n */\n function length(Bytes32Set storage set) internal view returns (uint256) {\n return _length(set._inner);\n }\n\n /**\n * @dev Returns the value stored at position `index` in the set. O(1).\n *\n * Note that there are no guarantees on the ordering of values inside the\n * array, and it may change when more values are added or removed.\n *\n * Requirements:\n *\n * - `index` must be strictly less than {length}.\n */\n function at(Bytes32Set storage set, uint256 index) internal view returns (bytes32) {\n return _at(set._inner, index);\n }\n\n /**\n * @dev Return the entire set in an array\n *\n * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed\n * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that\n * this function has an unbounded cost, and using it as part of a state-changing function may render the function\n * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.\n */\n function values(Bytes32Set storage set) internal view returns (bytes32[] memory) {\n return _values(set._inner);\n }\n\n // AddressSet\n\n struct AddressSet {\n Set _inner;\n }\n\n /**\n * @dev Add a value to a set. O(1).\n *\n * Returns true if the value was added to the set, that is if it was not\n * already present.\n */\n function add(AddressSet storage set, address value) internal returns (bool) {\n return _add(set._inner, bytes32(uint256(uint160(value))));\n }\n\n /**\n * @dev Removes a value from a set. O(1).\n *\n * Returns true if the value was removed from the set, that is if it was\n * present.\n */\n function remove(AddressSet storage set, address value) internal returns (bool) {\n return _remove(set._inner, bytes32(uint256(uint160(value))));\n }\n\n /**\n * @dev Returns true if the value is in the set. O(1).\n */\n function contains(AddressSet storage set, address value) internal view returns (bool) {\n return _contains(set._inner, bytes32(uint256(uint160(value))));\n }\n\n /**\n * @dev Returns the number of values in the set. O(1).\n */\n function length(AddressSet storage set) internal view returns (uint256) {\n return _length(set._inner);\n }\n\n /**\n * @dev Returns the value stored at position `index` in the set. O(1).\n *\n * Note that there are no guarantees on the ordering of values inside the\n * array, and it may change when more values are added or removed.\n *\n * Requirements:\n *\n * - `index` must be strictly less than {length}.\n */\n function at(AddressSet storage set, uint256 index) internal view returns (address) {\n return address(uint160(uint256(_at(set._inner, index))));\n }\n\n /**\n * @dev Return the entire set in an array\n *\n * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed\n * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that\n * this function has an unbounded cost, and using it as part of a state-changing function may render the function\n * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.\n */\n function values(AddressSet storage set) internal view returns (address[] memory) {\n bytes32[] memory store = _values(set._inner);\n address[] memory result;\n\n assembly {\n result := store\n }\n\n return result;\n }\n\n // UintSet\n\n struct UintSet {\n Set _inner;\n }\n\n /**\n * @dev Add a value to a set. O(1).\n *\n * Returns true if the value was added to the set, that is if it was not\n * already present.\n */\n function add(UintSet storage set, uint256 value) internal returns (bool) {\n return _add(set._inner, bytes32(value));\n }\n\n /**\n * @dev Removes a value from a set. O(1).\n *\n * Returns true if the value was removed from the set, that is if it was\n * present.\n */\n function remove(UintSet storage set, uint256 value) internal returns (bool) {\n return _remove(set._inner, bytes32(value));\n }\n\n /**\n * @dev Returns true if the value is in the set. O(1).\n */\n function contains(UintSet storage set, uint256 value) internal view returns (bool) {\n return _contains(set._inner, bytes32(value));\n }\n\n /**\n * @dev Returns the number of values on the set. O(1).\n */\n function length(UintSet storage set) internal view returns (uint256) {\n return _length(set._inner);\n }\n\n /**\n * @dev Returns the value stored at position `index` in the set. O(1).\n *\n * Note that there are no guarantees on the ordering of values inside the\n * array, and it may change when more values are added or removed.\n *\n * Requirements:\n *\n * - `index` must be strictly less than {length}.\n */\n function at(UintSet storage set, uint256 index) internal view returns (uint256) {\n return uint256(_at(set._inner, index));\n }\n\n /**\n * @dev Return the entire set in an array\n *\n * WARNING: This operation will copy the entire storage to memory, which can be quite expensive. This is designed\n * to mostly be used by view accessors that are queried without any gas fees. Developers should keep in mind that\n * this function has an unbounded cost, and using it as part of a state-changing function may render the function\n * uncallable if the set grows to a point where copying to memory consumes too much gas to fit in a block.\n */\n function values(UintSet storage set) internal view returns (uint256[] memory) {\n bytes32[] memory store = _values(set._inner);\n uint256[] memory result;\n\n assembly {\n result := store\n }\n\n return result;\n }\n}\n" }, "contracts/TradeFactory/TradeFactory.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity >=0.8.4 <0.9.0;\n\nimport '@lbertenasco/contract-utils/contracts/utils/CollectableDust.sol';\n\nimport './TradeFactoryPositionsHandler.sol';\nimport './TradeFactoryExecutor.sol';\n\ninterface ITradeFactory is ITradeFactoryExecutor, ITradeFactoryPositionsHandler {}\n\ncontract TradeFactory is TradeFactoryExecutor, CollectableDust, ITradeFactory {\n constructor(\n address _masterAdmin,\n address _swapperAdder,\n address _swapperSetter,\n address _strategyAdder,\n address _tradesModifier,\n address _tradesSettler,\n address _mechanicsRegistry\n )\n TradeFactoryAccessManager(_masterAdmin)\n TradeFactoryPositionsHandler(_strategyAdder, _tradesModifier)\n TradeFactorySwapperHandler(_swapperAdder, _swapperSetter)\n TradeFactoryExecutor(_tradesSettler, _mechanicsRegistry)\n {}\n\n // Collectable Dust\n function sendDust(\n address _to,\n address _token,\n uint256 _amount\n ) external virtual override onlyRole(MASTER_ADMIN) {\n _sendDust(_to, _token, _amount);\n }\n}\n" }, "contracts/TradeFactory/TradeFactoryPositionsHandler.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity >=0.8.4 <0.9.0;\n\nimport '@openzeppelin/contracts/utils/structs/EnumerableSet.sol';\nimport './TradeFactorySwapperHandler.sol';\nimport '../Swapper.sol';\n\ninterface ITradeFactoryPositionsHandler {\n struct Trade {\n uint256 _id;\n address _strategy;\n address _swapper;\n address _tokenIn;\n address _tokenOut;\n uint256 _amountIn;\n uint256 _maxSlippage;\n uint256 _deadline;\n }\n\n event TradeCreated(\n uint256 indexed _id,\n address _strategy,\n address _swapper,\n address _tokenIn,\n address _tokenOut,\n uint256 _amountIn,\n uint256 _maxSlippage,\n uint256 _deadline\n );\n\n event TradesCanceled(address indexed _strategy, uint256[] _ids);\n\n event TradesSwapperChanged(uint256[] _ids, address _newSwapper);\n\n event TradesMerged(uint256 indexed _anchorTrade, uint256[] _ids);\n\n error InvalidTrade();\n\n error InvalidDeadline();\n\n function pendingTradesById(uint256)\n external\n view\n returns (\n uint256 _id,\n address _strategy,\n address _swapper,\n address _tokenIn,\n address _tokenOut,\n uint256 _amountIn,\n uint256 _maxSlippage,\n uint256 _deadline\n );\n\n function pendingTradesIds() external view returns (uint256[] memory _pendingIds);\n\n function pendingTradesIds(address _strategy) external view returns (uint256[] memory _pendingIds);\n\n function create(\n address _tokenIn,\n address _tokenOut,\n uint256 _amountIn,\n uint256 _maxSlippage,\n uint256 _deadline\n ) external returns (uint256 _id);\n\n function cancelPendingTrades(uint256[] calldata _ids) external;\n\n function changePendingTradesSwapper(uint256[] calldata _ids, address _swapper) external;\n\n function mergePendingTrades(uint256 _anchorTradeId, uint256[] calldata _toMergeIds) external;\n}\n\nabstract contract TradeFactoryPositionsHandler is ITradeFactoryPositionsHandler, TradeFactorySwapperHandler {\n using EnumerableSet for EnumerableSet.UintSet;\n using EnumerableSet for EnumerableSet.AddressSet;\n\n bytes32 public constant STRATEGY = keccak256('STRATEGY');\n bytes32 public constant STRATEGY_ADDER = keccak256('STRATEGY_ADDER');\n bytes32 public constant TRADES_MODIFIER = keccak256('TRADES_MODIFIER');\n\n uint256 private _tradeCounter = 1;\n\n mapping(uint256 => Trade) public override pendingTradesById;\n\n EnumerableSet.UintSet internal _pendingTradesIds;\n\n mapping(address => EnumerableSet.UintSet) internal _pendingTradesByOwner;\n\n constructor(address _strategyAdder, address _tradesModifier) {\n if (_strategyAdder == address(0) || _tradesModifier == address(0)) revert CommonErrors.ZeroAddress();\n _setRoleAdmin(STRATEGY, STRATEGY_ADDER);\n _setRoleAdmin(STRATEGY_ADDER, MASTER_ADMIN);\n _setupRole(STRATEGY_ADDER, _strategyAdder);\n _setRoleAdmin(TRADES_MODIFIER, MASTER_ADMIN);\n _setupRole(TRADES_MODIFIER, _tradesModifier);\n }\n\n function pendingTradesIds() external view override returns (uint256[] memory _pendingIds) {\n _pendingIds = _pendingTradesIds.values();\n }\n\n function pendingTradesIds(address _strategy) external view override returns (uint256[] memory _pendingIds) {\n _pendingIds = _pendingTradesByOwner[_strategy].values();\n }\n\n function create(\n address _tokenIn,\n address _tokenOut,\n uint256 _amountIn,\n uint256 _maxSlippage,\n uint256 _deadline\n ) external override onlyRole(STRATEGY) returns (uint256 _id) {\n if (strategyAsyncSwapper[msg.sender] == address(0)) revert InvalidSwapper();\n if (_tokenIn == address(0) || _tokenOut == address(0)) revert CommonErrors.ZeroAddress();\n if (_amountIn == 0) revert CommonErrors.ZeroAmount();\n if (_maxSlippage == 0) revert CommonErrors.ZeroSlippage();\n if (_deadline <= block.timestamp) revert InvalidDeadline();\n _id = _tradeCounter;\n Trade memory _trade = Trade(\n _tradeCounter,\n msg.sender,\n strategyAsyncSwapper[msg.sender],\n _tokenIn,\n _tokenOut,\n _amountIn,\n _maxSlippage,\n _deadline\n );\n pendingTradesById[_trade._id] = _trade;\n _pendingTradesByOwner[msg.sender].add(_trade._id);\n _pendingTradesIds.add(_trade._id);\n _tradeCounter += 1;\n emit TradeCreated(\n _trade._id,\n _trade._strategy,\n _trade._swapper,\n _trade._tokenIn,\n _trade._tokenOut,\n _trade._amountIn,\n _trade._maxSlippage,\n _trade._deadline\n );\n }\n\n function cancelPendingTrades(uint256[] calldata _ids) external override onlyRole(STRATEGY) {\n for (uint256 i; i < _ids.length; i++) {\n if (!_pendingTradesIds.contains(_ids[i])) revert InvalidTrade();\n if (pendingTradesById[_ids[i]]._strategy != msg.sender) revert CommonErrors.NotAuthorized();\n _removePendingTrade(msg.sender, _ids[i]);\n }\n emit TradesCanceled(msg.sender, _ids);\n }\n\n // onlyStrategyHandler or master admin ?\n function changePendingTradesSwapper(uint256[] calldata _ids, address _swapper) external override onlyRole(TRADES_MODIFIER) {\n if (ISwapper(_swapper).SWAPPER_TYPE() != ISwapper.SwapperType.ASYNC) revert NotAsyncSwapper();\n if (!_swappers.contains(_swapper)) revert InvalidSwapper();\n for (uint256 i; i < _ids.length; i++) {\n if (!_pendingTradesIds.contains(_ids[i])) revert InvalidTrade();\n pendingTradesById[_ids[i]]._swapper = _swapper;\n }\n emit TradesSwapperChanged(_ids, _swapper);\n }\n\n function mergePendingTrades(uint256 _anchorTradeId, uint256[] calldata _toMergeIds) external override onlyRole(TRADES_MODIFIER) {\n Trade storage _anchorTrade = pendingTradesById[_anchorTradeId];\n for (uint256 i; i < _toMergeIds.length; i++) {\n Trade storage _trade = pendingTradesById[_toMergeIds[i]];\n if (\n _anchorTrade._id == _trade._id ||\n _anchorTrade._strategy != _trade._strategy ||\n _anchorTrade._tokenIn != _trade._tokenIn ||\n _anchorTrade._tokenOut != _trade._tokenOut\n ) revert InvalidTrade();\n _anchorTrade._amountIn += _trade._amountIn;\n _removePendingTrade(_trade._strategy, _trade._id);\n }\n emit TradesMerged(_anchorTradeId, _toMergeIds);\n }\n\n function _removePendingTrade(address _strategy, uint256 _id) internal {\n _pendingTradesByOwner[_strategy].remove(_id);\n _pendingTradesIds.remove(_id);\n delete pendingTradesById[_id];\n }\n}\n" }, "contracts/TradeFactory/TradeFactoryExecutor.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity >=0.8.4 <0.9.0;\n\nimport '@openzeppelin/contracts/utils/math/Math.sol';\nimport '@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol';\nimport '@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol';\nimport '@openzeppelin/contracts/utils/structs/EnumerableSet.sol';\n\nimport '@lbertenasco/contract-utils/contracts/utils/Machinery.sol';\n\nimport '../OTCPool.sol';\n\nimport './TradeFactoryPositionsHandler.sol';\n\ninterface ITradeFactoryExecutor {\n event SyncTradeExecuted(\n address indexed _strategy,\n address indexed _swapper,\n address _tokenIn,\n address _tokenOut,\n uint256 _amountIn,\n uint256 _maxSlippage,\n bytes _data,\n uint256 _receivedAmount\n );\n\n event AsyncTradeExecuted(uint256 indexed _id, uint256 _receivedAmount);\n\n event AsyncTradesMatched(\n uint256 indexed _firstTradeId,\n uint256 indexed _secondTradeId,\n uint256 _consumedFirstTrade,\n uint256 _consumedSecondTrade\n );\n\n event AsyncOTCTradesExecuted(uint256[] _ids, uint256 _rateTokenInToOut);\n\n event AsyncTradeExpired(uint256 indexed _id);\n\n event SwapperAndTokenEnabled(address indexed _swapper, address _token);\n\n error OngoingTrade();\n\n error ExpiredTrade();\n\n error ZeroRate();\n\n function execute(\n address _tokenIn,\n address _tokenOut,\n uint256 _amountIn,\n uint256 _maxSlippage,\n bytes calldata _data\n ) external returns (uint256 _receivedAmount);\n\n function execute(uint256 _id, bytes calldata _data) external returns (uint256 _receivedAmount);\n\n function expire(uint256 _id) external returns (uint256 _freedAmount);\n}\n\nabstract contract TradeFactoryExecutor is ITradeFactoryExecutor, TradeFactoryPositionsHandler, Machinery {\n using SafeERC20 for IERC20;\n using EnumerableSet for EnumerableSet.UintSet;\n using EnumerableSet for EnumerableSet.AddressSet;\n\n bytes32 public constant TRADES_SETTLER = keccak256('TRADES_SETTLER');\n\n constructor(address _tradesSettler, address _mechanicsRegistry) Machinery(_mechanicsRegistry) {\n _setRoleAdmin(TRADES_SETTLER, MASTER_ADMIN);\n _setupRole(TRADES_SETTLER, _tradesSettler);\n }\n\n // Machinery\n function setMechanicsRegistry(address _mechanicsRegistry) external virtual override onlyRole(MASTER_ADMIN) {\n _setMechanicsRegistry(_mechanicsRegistry);\n }\n\n function execute(\n address _tokenIn,\n address _tokenOut,\n uint256 _amountIn,\n uint256 _maxSlippage,\n bytes calldata _data\n ) external override onlyRole(STRATEGY) returns (uint256 _receivedAmount) {\n address _swapper = strategySyncSwapper[msg.sender];\n if (_tokenIn == address(0) || _tokenOut == address(0)) revert CommonErrors.ZeroAddress();\n if (_amountIn == 0) revert CommonErrors.ZeroAmount();\n if (_maxSlippage == 0) revert CommonErrors.ZeroSlippage();\n IERC20(_tokenIn).safeTransferFrom(msg.sender, _swapper, _amountIn);\n _receivedAmount = ISwapper(_swapper).swap(msg.sender, _tokenIn, _tokenOut, _amountIn, _maxSlippage, _data);\n emit SyncTradeExecuted(msg.sender, _swapper, _tokenIn, _tokenOut, _amountIn, _maxSlippage, _data, _receivedAmount);\n }\n\n // TradeFactoryExecutor\n function execute(uint256 _id, bytes calldata _data) external override onlyMechanic returns (uint256 _receivedAmount) {\n if (!_pendingTradesIds.contains(_id)) revert InvalidTrade();\n Trade storage _trade = pendingTradesById[_id];\n if (block.timestamp > _trade._deadline) revert ExpiredTrade();\n if (!_swappers.contains(_trade._swapper)) revert InvalidSwapper();\n IERC20(_trade._tokenIn).safeTransferFrom(_trade._strategy, _trade._swapper, _trade._amountIn);\n _receivedAmount = ISwapper(_trade._swapper).swap(\n _trade._strategy,\n _trade._tokenIn,\n _trade._tokenOut,\n _trade._amountIn,\n _trade._maxSlippage,\n _data\n );\n _removePendingTrade(_trade._strategy, _id);\n emit AsyncTradeExecuted(_id, _receivedAmount);\n }\n\n function expire(uint256 _id) external override onlyMechanic returns (uint256 _freedAmount) {\n if (!_pendingTradesIds.contains(_id)) revert InvalidTrade();\n Trade storage _trade = pendingTradesById[_id];\n if (block.timestamp < _trade._deadline) revert OngoingTrade();\n _freedAmount = _trade._amountIn;\n // We have to take tokens from strategy, to decrease the allowance\n IERC20(_trade._tokenIn).safeTransferFrom(_trade._strategy, address(this), _trade._amountIn);\n // Send tokens back to strategy\n IERC20(_trade._tokenIn).safeTransfer(_trade._strategy, _trade._amountIn);\n // Remove trade\n _removePendingTrade(_trade._strategy, _id);\n emit AsyncTradeExpired(_id);\n }\n\n function execute(uint256[] calldata _ids, uint256 _rateTokenInToOut) external onlyMechanic {\n if (_rateTokenInToOut == 0) revert ZeroRate();\n address _tokenIn = pendingTradesById[_ids[0]]._tokenIn;\n address _tokenOut = pendingTradesById[_ids[0]]._tokenOut;\n uint256 _magnitudeIn = 10**IERC20Metadata(_tokenIn).decimals();\n for (uint256 i; i < _ids.length; i++) {\n Trade storage _trade = pendingTradesById[_ids[i]];\n if (i > 0 && (_trade._tokenIn != _tokenIn || _trade._tokenOut != _tokenOut)) revert InvalidTrade();\n if (block.timestamp > _trade._deadline) revert ExpiredTrade();\n if ((strategyPermissions[_trade._strategy] & _OTC_MASK) != _OTC_MASK) revert CommonErrors.NotAuthorized();\n uint256 _consumedOut = (_trade._amountIn * _rateTokenInToOut) / _magnitudeIn;\n IERC20(_trade._tokenIn).safeTransferFrom(_trade._strategy, IOTCPool(otcPool).governor(), _trade._amountIn);\n IOTCPool(otcPool).take(_trade._tokenOut, _consumedOut, _trade._strategy);\n _removePendingTrade(_trade._strategy, _trade._id);\n }\n emit AsyncOTCTradesExecuted(_ids, _rateTokenInToOut);\n }\n\n function execute(\n uint256 _firstTradeId,\n uint256 _secondTradeId,\n uint256 _consumedFirstTrade,\n uint256 _consumedSecondTrade\n ) external onlyRole(TRADES_SETTLER) returns (uint256 _receivedAmountAnchorTrade, uint256 _receivedAmountAgainstTrade) {\n Trade storage _firstTrade = pendingTradesById[_firstTradeId];\n Trade storage _secondTrade = pendingTradesById[_secondTradeId];\n if (_firstTrade._tokenIn != _secondTrade._tokenOut || _firstTrade._tokenOut != _secondTrade._tokenIn) revert InvalidTrade();\n if (block.timestamp > _firstTrade._deadline || block.timestamp > _secondTrade._deadline) revert ExpiredTrade();\n if (\n (strategyPermissions[_firstTrade._strategy] & _COW_MASK) != _COW_MASK ||\n (strategyPermissions[_secondTrade._strategy] & _COW_MASK) != _COW_MASK\n ) revert CommonErrors.NotAuthorized();\n\n IERC20(_firstTrade._tokenIn).safeTransferFrom(_firstTrade._strategy, _secondTrade._strategy, _consumedFirstTrade);\n IERC20(_secondTrade._tokenIn).safeTransferFrom(_secondTrade._strategy, _firstTrade._strategy, _consumedSecondTrade);\n\n if (_consumedFirstTrade != _firstTrade._amountIn) {\n _firstTrade._amountIn -= _consumedFirstTrade;\n } else {\n _removePendingTrade(_firstTrade._strategy, _firstTradeId);\n }\n\n if (_consumedSecondTrade != _secondTrade._amountIn) {\n _secondTrade._amountIn -= _consumedSecondTrade;\n } else {\n _removePendingTrade(_secondTrade._strategy, _secondTradeId);\n }\n\n emit AsyncTradesMatched(_firstTradeId, _secondTradeId, _consumedFirstTrade, _consumedSecondTrade);\n }\n}\n" }, "contracts/TradeFactory/TradeFactorySwapperHandler.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity >=0.8.4 <0.9.0;\n\nimport '@openzeppelin/contracts/access/AccessControl.sol';\nimport '@openzeppelin/contracts/utils/structs/EnumerableSet.sol';\n\nimport '../Swapper.sol';\n\nimport './TradeFactoryAccessManager.sol';\n\ninterface ITradeFactorySwapperHandler {\n event SyncStrategySwapperSet(address indexed _strategy, address _swapper);\n event AsyncStrategySwapperSet(address indexed _strategy, address _swapper);\n event StrategyPermissionsSet(address indexed _strategy, bytes1 _permissions);\n event OTCPoolSet(address _otcPool);\n event SwappersAdded(address[] _swappers);\n event SwappersRemoved(address[] _swapper);\n\n error NotAsyncSwapper();\n error NotSyncSwapper();\n error InvalidSwapper();\n error InvalidPermissions();\n error SwapperInUse();\n\n function strategySyncSwapper(address _strategy) external view returns (address _swapper);\n\n function strategyAsyncSwapper(address _strategy) external view returns (address _swapper);\n\n function strategyPermissions(address _strategy) external view returns (bytes1 _permissions);\n\n function swappers() external view returns (address[] memory _swappersList);\n\n function isSwapper(address _swapper) external view returns (bool _isSwapper);\n\n function swapperStrategies(address _swapper) external view returns (address[] memory _strategies);\n\n function setStrategyPermissions(address _strategy, bytes1 _permissions) external;\n\n function setOTCPool(address _otcPool) external;\n\n function setStrategySyncSwapper(address _strategy, address _swapper) external;\n\n function setStrategyAsyncSwapper(address _strategy, address _swapper) external;\n\n function addSwappers(address[] memory __swappers) external;\n\n function removeSwappers(address[] memory __swappers) external;\n}\n\nabstract contract TradeFactorySwapperHandler is ITradeFactorySwapperHandler, TradeFactoryAccessManager {\n using EnumerableSet for EnumerableSet.AddressSet;\n\n bytes32 public constant SWAPPER_ADDER = keccak256('SWAPPER_ADDER');\n bytes32 public constant SWAPPER_SETTER = keccak256('SWAPPER_SETTER');\n\n bytes1 internal constant _OTC_MASK = 0x01;\n bytes1 internal constant _COW_MASK = 0x02;\n\n // OTC Handler\n address public otcPool;\n // swappers list\n EnumerableSet.AddressSet internal _swappers;\n // swapper -> strategy list (useful to know if we can safely deprecate a swapper)\n mapping(address => EnumerableSet.AddressSet) internal _swapperStrategies;\n // strategy -> async swapper\n mapping(address => address) public override strategyAsyncSwapper;\n // strategy -> sync swapper\n mapping(address => address) public override strategySyncSwapper;\n // strategy -> permissions\n // permissions[_OTC_PERMISSION_INDEX] => OTC\n // permissions[_COW_PERMISSION_INDEX] => COW\n mapping(address => bytes1) public override strategyPermissions;\n\n constructor(address _swapperAdder, address _swapperSetter) {\n if (_swapperAdder == address(0) || _swapperSetter == address(0)) reve