chore(SC-940): Move extensions to separate folder (#278)

* chore: move files to extension, and add some comments * chore: AmountCalculator to libraries to have consistent order structure * chore: apply suggestions on comments from code review Co-authored-by: zZoMROT <[email protected]> * chore: Apply suggestions on comments from code review --------- Co-authored-by: zZoMROT <[email protected]>
1inch · Oct 16, 2023 · 97eff07 · 97eff07
1 parent 033d094
commit 97eff07
Show file tree

Hide file tree

Showing 12 changed files with 10 additions and 6 deletions.
diff --git a/contracts/OrderLib.sol b/contracts/OrderLib.sol
@@ -8,7 +8,7 @@ import "@1inch/solidity-utils/contracts/libraries/AddressLib.sol";
 import "./interfaces/IOrderMixin.sol";
 import "./libraries/MakerTraitsLib.sol";
 import "./libraries/ExtensionLib.sol";
-import "./helpers/AmountCalculator.sol";
+import "./libraries/AmountCalculatorLib.sol";
 import "./interfaces/IAmountGetter.sol";
 
 /**
@@ -96,7 +96,7 @@ import "./interfaces/IAmountGetter.sol";
         bytes calldata data = extension.makingAmountData();
         if (data.length == 0) {
             // Linear proportion
-            return AmountCalculator.getMakingAmount(order.makingAmount, order.takingAmount, requestedTakingAmount);
+            return AmountCalculatorLib.getMakingAmount(order.makingAmount, order.takingAmount, requestedTakingAmount);
         }
         return IAmountGetter(address(bytes20(data))).getMakingAmount(
             order,
@@ -130,7 +130,7 @@ import "./interfaces/IAmountGetter.sol";
         bytes calldata data = extension.takingAmountData();
         if (data.length == 0) {
             // Linear proportion
-            return AmountCalculator.getTakingAmount(order.makingAmount, order.takingAmount, requestedMakingAmount);
+            return AmountCalculatorLib.getTakingAmount(order.makingAmount, order.takingAmount, requestedMakingAmount);
         }
         return IAmountGetter(address(bytes20(data))).getTakingAmount(
             order,

diff --git a/contracts/helpers/DutchAuctionCalculator.sol → ...cts/extensions/DutchAuctionCalculator.sol b/contracts/helpers/DutchAuctionCalculator.sol → ...cts/extensions/DutchAuctionCalculator.sol
@@ -5,6 +5,8 @@ pragma solidity 0.8.19;
 import "@openzeppelin/contracts/utils/math/Math.sol";
 import "../interfaces/IAmountGetter.sol";
 
+/// @title A helper that implements price decay over time from max to min
+/// @notice The contract implements Dutch auction price calculation for 1inch limit orders, it is used by 1inch Fusion
 contract DutchAuctionCalculator is IAmountGetter {
     using Math for uint256;
 

diff --git a/contracts/helpers/ERC1155Proxy.sol → contracts/extensions/ERC1155Proxy.sol b/contracts/helpers/ERC1155Proxy.sol → contracts/extensions/ERC1155Proxy.sol
diff --git a/contracts/helpers/ERC721Proxy.sol → contracts/extensions/ERC721Proxy.sol b/contracts/helpers/ERC721Proxy.sol → contracts/extensions/ERC721Proxy.sol
diff --git a/contracts/helpers/ERC721ProxySafe.sol → contracts/extensions/ERC721ProxySafe.sol b/contracts/helpers/ERC721ProxySafe.sol → contracts/extensions/ERC721ProxySafe.sol
diff --git a/contracts/helpers/ETHOrders.sol → contracts/extensions/ETHOrders.sol b/contracts/helpers/ETHOrders.sol → contracts/extensions/ETHOrders.sol
@@ -9,7 +9,7 @@ import "@1inch/solidity-utils/contracts/OnlyWethReceiver.sol";
 import "../interfaces/IPostInteraction.sol";
 import "../OrderLib.sol";
 
-/// @title ETH limit orders contract
+/// @title Extension that will allow to create limit order that sell ETH. ETH must be deposited into the contract.
 contract ETHOrders is IPostInteraction, OnlyWethReceiver {
     using SafeERC20 for IWETH;
     using OrderLib for IOrderMixin.Order;

diff --git a/contracts/helpers/ImmutableOwner.sol → contracts/extensions/ImmutableOwner.sol b/contracts/helpers/ImmutableOwner.sol → contracts/extensions/ImmutableOwner.sol
diff --git a/contracts/helpers/OrderIdInvalidator.sol → contracts/extensions/OrderIdInvalidator.sol b/contracts/helpers/OrderIdInvalidator.sol → contracts/extensions/OrderIdInvalidator.sol
diff --git a/contracts/helpers/PrioirityFeeLimiter.sol → contracts/extensions/PrioirityFeeLimiter.sol b/contracts/helpers/PrioirityFeeLimiter.sol → contracts/extensions/PrioirityFeeLimiter.sol
diff --git a/contracts/helpers/RangeAmountCalculator.sol → ...acts/extensions/RangeAmountCalculator.sol b/contracts/helpers/RangeAmountCalculator.sol → ...acts/extensions/RangeAmountCalculator.sol
diff --git a/contracts/helpers/WethUnwrapper.sol → contracts/extensions/WethUnwrapper.sol b/contracts/helpers/WethUnwrapper.sol → contracts/extensions/WethUnwrapper.sol
@@ -6,6 +6,8 @@ import "@1inch/solidity-utils/contracts/OnlyWethReceiver.sol";
 import "@1inch/solidity-utils/contracts/interfaces/IWETH.sol";
 import "@1inch/solidity-utils/contracts/libraries/SafeERC20.sol";
 
+/// @title The extension to unwrap WETH and do payout in ETH in limit order postInteraction
+/// @notice The feature was embedded into TakerTraits, so it is obsolete and will be removed
 contract WethUnwrapper is OnlyWethReceiver {
     using SafeERC20 for IWETH;
 

diff --git a/contracts/helpers/AmountCalculator.sol → contracts/libraries/AmountCalculatorLib.sol b/contracts/helpers/AmountCalculator.sol → contracts/libraries/AmountCalculatorLib.sol
@@ -2,8 +2,8 @@
 
 pragma solidity 0.8.19;
 
-/// @title A helper contract for calculations related to order amounts
-library AmountCalculator {
+/// @title The helper library to calculate linearly taker amount from maker amount and vice versa.
+library AmountCalculatorLib {
     /// @notice Calculates maker amount
     /// @return Result Floored maker amount
     function getMakingAmount(uint256 orderMakerAmount, uint256 orderTakerAmount, uint256 swapTakerAmount) internal pure returns(uint256) {