refactor(contracts-rfq): reorganise imports (#3409)

* refactor: separate imports * refactor: sort imports * refactor: imports in test files
synapsecns · Nov 24, 2024 · b59c9d0 · b59c9d0
1 parent 2e16814
commit b59c9d0
Show file tree

Hide file tree

Showing 21 changed files with 42 additions and 23 deletions.
diff --git a/packages/contracts-rfq/contracts/Admin.sol b/packages/contracts-rfq/contracts/Admin.sol
@@ -3,8 +3,8 @@ pragma solidity ^0.8.20;
 
 import {AccessControlEnumerable} from "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
 
-import {UniversalTokenLib} from "./libs/UniversalToken.sol";
 import {IAdmin} from "./interfaces/IAdmin.sol";
+import {UniversalTokenLib} from "./libs/UniversalToken.sol";
 
 contract Admin is IAdmin, AccessControlEnumerable {
     using UniversalTokenLib for address;

diff --git a/packages/contracts-rfq/contracts/AdminV2.sol b/packages/contracts-rfq/contracts/AdminV2.sol
@@ -1,11 +1,15 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
+// ════════════════════════════════════════════════ INTERFACES ═════════════════════════════════════════════════════
+
 import {IAdminV2} from "./interfaces/IAdminV2.sol";
 import {IAdminV2Errors} from "./interfaces/IAdminV2Errors.sol";
 
+// ═════════════════════════════════════════════ EXTERNAL IMPORTS ══════════════════════════════════════════════════
+
 import {AccessControlEnumerable} from "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
-import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {IERC20, SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 
 /// @title AdminV2

diff --git a/packages/contracts-rfq/contracts/FastBridge.sol b/packages/contracts-rfq/contracts/FastBridge.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.20;
 
-import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {IERC20, SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 import "./libs/Errors.sol";
 import {UniversalTokenLib} from "./libs/UniversalToken.sol";

diff --git a/packages/contracts-rfq/contracts/FastBridgeV2.sol b/packages/contracts-rfq/contracts/FastBridgeV2.sol
@@ -1,17 +1,22 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
-import {BridgeTransactionV2Lib} from "./libs/BridgeTransactionV2.sol";
+// ════════════════════════════════════════════════ INTERFACES ═════════════════════════════════════════════════════
 
-import {AdminV2} from "./AdminV2.sol";
 import {IFastBridge} from "./interfaces/IFastBridge.sol";
 import {IFastBridgeV2} from "./interfaces/IFastBridgeV2.sol";
 import {IFastBridgeV2Errors} from "./interfaces/IFastBridgeV2Errors.sol";
 import {IZapRecipient} from "./interfaces/IZapRecipient.sol";
 
+// ═════════════════════════════════════════════ INTERNAL IMPORTS ══════════════════════════════════════════════════
+
+import {AdminV2} from "./AdminV2.sol";
+import {BridgeTransactionV2Lib} from "./libs/BridgeTransactionV2.sol";
 import {MulticallTarget} from "./utils/MulticallTarget.sol";
 
-import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+// ═════════════════════════════════════════════ EXTERNAL IMPORTS ══════════════════════════════════════════════════
+
+import {IERC20, SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
 
 /// @title FastBridgeV2

diff --git a/packages/contracts-rfq/contracts/libs/UniversalToken.sol b/packages/contracts-rfq/contracts/libs/UniversalToken.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.20;
 
 import {TokenNotContract} from "./Errors.sol";
 
-import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {IERC20, SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 library UniversalTokenLib {
     using SafeERC20 for IERC20;

diff --git a/packages/contracts-rfq/contracts/zaps/TokenZapV1.sol b/packages/contracts-rfq/contracts/zaps/TokenZapV1.sol
@@ -1,11 +1,18 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
+// ════════════════════════════════════════════════ INTERFACES ═════════════════════════════════════════════════════
+
 import {IZapRecipient} from "../interfaces/IZapRecipient.sol";
+
+// ═════════════════════════════════════════════ INTERNAL IMPORTS ══════════════════════════════════════════════════
+
 import {ZapDataV1} from "../libs/ZapDataV1.sol";
 
+// ═════════════════════════════════════════════ EXTERNAL IMPORTS ══════════════════════════════════════════════════
+
+import {IERC20, SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import {Address} from "@openzeppelin/contracts/utils/Address.sol";
-import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 /// @title TokenZapV1
 /// @notice Facilitates atomic token operations known as "Zaps," allowing to execute predefined actions

diff --git a/packages/contracts-rfq/foundry.toml b/packages/contracts-rfq/foundry.toml
@@ -17,6 +17,7 @@ ignore = ["contracts/legacy/**/*.sol"]
 line_length = 120
 multiline_func_header = 'all'
 number_underscore = 'thousands'
+sort_imports = true
 
 [rpc_endpoints]
 arbitrum = "${ARBITRUM_RPC}"

diff --git a/packages/contracts-rfq/test/FastBridgeMock.sol b/packages/contracts-rfq/test/FastBridgeMock.sol
@@ -2,8 +2,9 @@
 pragma solidity ^0.8.20;
 
 import {Admin} from "../contracts/Admin.sol";
-import {IFastBridge} from "../contracts/interfaces/IFastBridge.sol";
+
 import {FastBridge} from "../contracts/FastBridge.sol";
+import {IFastBridge} from "../contracts/interfaces/IFastBridge.sol";
 
 contract FastBridgeMock is IFastBridge, Admin {
     // @dev the block the contract was deployed at

diff --git a/packages/contracts-rfq/test/FastBridgeV2.Src.RefundV1.t.sol b/packages/contracts-rfq/test/FastBridgeV2.Src.RefundV1.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {FastBridgeV2SrcTest, BridgeTransactionV2Lib, IFastBridgeV2} from "./FastBridgeV2.Src.t.sol";
+import {BridgeTransactionV2Lib, FastBridgeV2SrcTest, IFastBridgeV2} from "./FastBridgeV2.Src.t.sol";
 
 // solhint-disable func-name-mixedcase, ordering
 contract FastBridgeV2SrcRefundV1Test is FastBridgeV2SrcTest {

diff --git a/packages/contracts-rfq/test/FastBridgeV2.t.sol b/packages/contracts-rfq/test/FastBridgeV2.t.sol
@@ -8,14 +8,14 @@ import {IFastBridge} from "../contracts/interfaces/IFastBridge.sol";
 // solhint-disable-next-line no-unused-import
 import {IFastBridgeV2} from "../contracts/interfaces/IFastBridgeV2.sol";
 
-import {IFastBridgeV2Errors} from "../contracts/interfaces/IFastBridgeV2Errors.sol";
 import {FastBridgeV2} from "../contracts/FastBridgeV2.sol";
+import {IFastBridgeV2Errors} from "../contracts/interfaces/IFastBridgeV2Errors.sol";
 
 import {MockERC20} from "./MockERC20.sol";
 
 import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
 import {Test} from "forge-std/Test.sol";
-import {stdStorage, StdStorage} from "forge-std/Test.sol";
+import {StdStorage, stdStorage} from "forge-std/Test.sol";
 
 // solhint-disable no-empty-blocks, max-states-count, ordering
 abstract contract FastBridgeV2Test is Test, IFastBridgeV2Errors {

diff --git a/packages/contracts-rfq/test/MulticallTarget.t.sol b/packages/contracts-rfq/test/MulticallTarget.t.sol
@@ -2,7 +2,7 @@
 pragma solidity ^0.8.4;
 
 import {IMulticallTarget} from "../contracts/interfaces/IMulticallTarget.sol";
-import {MulticallTargetHarness, MulticallTarget} from "./harnesses/MulticallTargetHarness.sol";
+import {MulticallTarget, MulticallTargetHarness} from "./harnesses/MulticallTargetHarness.sol";
 
 import {Test} from "forge-std/Test.sol";
 

diff --git a/packages/contracts-rfq/test/UniversalTokenLib.t.sol b/packages/contracts-rfq/test/UniversalTokenLib.t.sol
@@ -2,9 +2,10 @@
 pragma solidity ^0.8.17;
 
 import {TokenNotContract} from "../contracts/libs/Errors.sol";
-import {UniversalTokenLibHarness} from "./UniversalTokenLibHarness.sol";
+
 import {MockERC20} from "./MockERC20.sol";
 import {MockRevertingRecipient} from "./MockRevertingRecipient.sol";
+import {UniversalTokenLibHarness} from "./UniversalTokenLibHarness.sol";
 
 import {Test} from "forge-std/Test.sol";
 

diff --git a/packages/contracts-rfq/test/integration/FastBridge.MulticallTarget.t.sol b/packages/contracts-rfq/test/integration/FastBridge.MulticallTarget.t.sol
@@ -3,7 +3,7 @@ pragma solidity 0.8.20;
 
 import {FastBridge} from "../../contracts/FastBridge.sol";
 
-import {MulticallTargetIntegrationTest, IFastBridge} from "./MulticallTarget.t.sol";
+import {IFastBridge, MulticallTargetIntegrationTest} from "./MulticallTarget.t.sol";
 
 contract FastBridgeMulticallTargetTest is MulticallTargetIntegrationTest {
     function deployAndConfigureFastBridge() public override returns (address) {

diff --git a/packages/contracts-rfq/test/integration/FastBridgeV2.MulticallTarget.t.sol b/packages/contracts-rfq/test/integration/FastBridgeV2.MulticallTarget.t.sol
@@ -4,7 +4,7 @@ pragma solidity 0.8.24;
 import {FastBridgeV2, IFastBridgeV2} from "../../contracts/FastBridgeV2.sol";
 import {BridgeTransactionV2Lib} from "../../contracts/libs/BridgeTransactionV2.sol";
 
-import {MulticallTargetIntegrationTest, IFastBridge} from "./MulticallTarget.t.sol";
+import {IFastBridge, MulticallTargetIntegrationTest} from "./MulticallTarget.t.sol";
 
 contract FastBridgeV2MulticallTargetTest is MulticallTargetIntegrationTest {
     function deployAndConfigureFastBridge() public override returns (address) {

diff --git a/packages/contracts-rfq/test/integration/FastBridgeV2.TokenZapV1.Dst.t.sol b/packages/contracts-rfq/test/integration/FastBridgeV2.TokenZapV1.Dst.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
-import {TokenZapV1IntegrationTest, VaultManyArguments, IFastBridge, IFastBridgeV2} from "./TokenZapV1.t.sol";
+import {IFastBridge, IFastBridgeV2, TokenZapV1IntegrationTest, VaultManyArguments} from "./TokenZapV1.t.sol";
 
 // solhint-disable func-name-mixedcase, ordering
 contract FastBridgeV2TokenZapV1DstTest is TokenZapV1IntegrationTest {

diff --git a/packages/contracts-rfq/test/integration/FastBridgeV2.TokenZapV1.Src.t.sol b/packages/contracts-rfq/test/integration/FastBridgeV2.TokenZapV1.Src.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
-import {TokenZapV1IntegrationTest, IFastBridge, IFastBridgeV2} from "./TokenZapV1.t.sol";
+import {IFastBridge, IFastBridgeV2, TokenZapV1IntegrationTest} from "./TokenZapV1.t.sol";
 
 // solhint-disable func-name-mixedcase, ordering
 contract FastBridgeV2TokenZapV1SrcTest is TokenZapV1IntegrationTest {

diff --git a/packages/contracts-rfq/test/integration/TokenZapV1.t.sol b/packages/contracts-rfq/test/integration/TokenZapV1.t.sol
@@ -6,8 +6,8 @@ import {BridgeTransactionV2Lib} from "../../contracts/libs/BridgeTransactionV2.s
 import {ZapDataV1} from "../../contracts/libs/ZapDataV1.sol";
 import {TokenZapV1} from "../../contracts/zaps/TokenZapV1.sol";
 
-import {VaultManyArguments} from "../mocks/VaultManyArguments.sol";
 import {MockERC20} from "../MockERC20.sol";
+import {VaultManyArguments} from "../mocks/VaultManyArguments.sol";
 
 import {Test} from "forge-std/Test.sol";
 

diff --git a/packages/contracts-rfq/test/libs/ZapDataV1.t.sol b/packages/contracts-rfq/test/libs/ZapDataV1.t.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.24;
 
-import {ZapDataV1Harness, ZapDataV1} from "../harnesses/ZapDataV1Harness.sol";
+import {ZapDataV1, ZapDataV1Harness} from "../harnesses/ZapDataV1Harness.sol";
 
 import {Test} from "forge-std/Test.sol";
 

diff --git a/packages/contracts-rfq/test/mocks/VaultMock.sol b/packages/contracts-rfq/test/mocks/VaultMock.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.20;
 
-import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {IERC20, SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 /// @notice Vault mock for testing purposes. DO NOT USE IN PRODUCTION.
 abstract contract VaultMock {

diff --git a/packages/contracts-rfq/test/zaps/TokenZapV1.GasBench.t.sol b/packages/contracts-rfq/test/zaps/TokenZapV1.GasBench.t.sol
@@ -3,8 +3,8 @@ pragma solidity 0.8.24;
 
 import {TokenZapV1} from "../../contracts/zaps/TokenZapV1.sol";
 
-import {SimpleVaultMock} from "../mocks/SimpleVaultMock.sol";
 import {MockERC20} from "../MockERC20.sol";
+import {SimpleVaultMock} from "../mocks/SimpleVaultMock.sol";
 
 import {Test} from "forge-std/Test.sol";
 

diff --git a/packages/contracts-rfq/test/zaps/TokenZapV1.t.sol b/packages/contracts-rfq/test/zaps/TokenZapV1.t.sol
@@ -4,8 +4,8 @@ pragma solidity 0.8.24;
 import {ZapDataV1} from "../../contracts/libs/ZapDataV1.sol";
 import {TokenZapV1} from "../../contracts/zaps/TokenZapV1.sol";
 
-import {VaultManyArguments} from "../mocks/VaultManyArguments.sol";
 import {MockERC20} from "../MockERC20.sol";
+import {VaultManyArguments} from "../mocks/VaultManyArguments.sol";
 
 import {Test} from "forge-std/Test.sol";