refactor: move existing timelocks to timelocks folder; update README …

…and tests
snapshot-labs · Jun 29, 2023 · caad1d9 · caad1d9
1 parent c3b5e3d
commit caad1d9
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,11 @@ src
 │  ├─ WhitelistVotingStrategy.sol — "Strategy that gives predetermined voting power for members in a whitelist, otherwise zero"
 │  └─ VanillaVotingStrategy.sol — "Vanilla Strategy"
 ├─ execution-strategies
+│  ├─ timelocks
+│  |  ├─ CompTimelockCompatibleExecutionStrategy.sol - "Strategy that provides compatibility with existing Comp Timelock contracts"
+│  |  ├─ OptimisticCompTimelockCompatibleExecutionStrategy.sol - "Optimistic strategy that provides compatibility with existing Comp Timelock contracts"
+│  |  ├─ OptimisticTimelockExecutionStrategy.sol - "Optimstic strategy that can be used to execute proposal transactions according to a timelock delay"
+│  |  └─ TimelockExecutionStrategy.sol - "Strategy that can be used to execute proposal transactions according to a timelock delay"
 │  ├─ AvatarExecutionStrategy.sol - "Strategy that allows proposal transactions to be executed from an Avatar contract"
 │  ├─ TimelockExecutionStrategy.sol - "Strategy that can be used to execute proposal transactions according to a timelock delay"
 │  ├─ CompTimelockCompatibleExecutionStrategy.sol - "Strategy that provides compatibility with existing Comp Timelock contracts"

diff --git a/...mpTimelockCompatibleExecutionStrategy.sol → ...mpTimelockCompatibleExecutionStrategy.sol b/...mpTimelockCompatibleExecutionStrategy.sol → ...mpTimelockCompatibleExecutionStrategy.sol
@@ -2,10 +2,10 @@
 
 pragma solidity ^0.8.18;
 
-import { ICompTimelock } from "../interfaces/ICompTimelock.sol";
-import { SimpleQuorumExecutionStrategy } from "./SimpleQuorumExecutionStrategy.sol";
-import { SpaceManager } from "../utils/SpaceManager.sol";
-import { MetaTransaction, Proposal, ProposalStatus, TRUE, FALSE } from "../types.sol";
+import { ICompTimelock } from "../../interfaces/ICompTimelock.sol";
+import { SimpleQuorumExecutionStrategy } from "../SimpleQuorumExecutionStrategy.sol";
+import { SpaceManager } from "../../utils/SpaceManager.sol";
+import { MetaTransaction, Proposal, ProposalStatus, TRUE, FALSE } from "../../types.sol";
 import { Enum } from "@gnosis.pm/safe-contracts/contracts/common/Enum.sol";
 
 /// @title Comp Timelock Execution Strategy

diff --git a/...-strategies/TimelockExecutionStrategy.sol → ...s/timelocks/TimelockExecutionStrategy.sol b/...-strategies/TimelockExecutionStrategy.sol → ...s/timelocks/TimelockExecutionStrategy.sol
@@ -2,9 +2,9 @@
 
 pragma solidity ^0.8.18;
 
-import { SimpleQuorumExecutionStrategy } from "./SimpleQuorumExecutionStrategy.sol";
-import { SpaceManager } from "../utils/SpaceManager.sol";
-import { MetaTransaction, Proposal, ProposalStatus } from "../types.sol";
+import { SimpleQuorumExecutionStrategy } from "../SimpleQuorumExecutionStrategy.sol";
+import { SpaceManager } from "../../utils/SpaceManager.sol";
+import { MetaTransaction, Proposal, ProposalStatus } from "../../types.sol";
 import { Enum } from "@gnosis.pm/safe-contracts/contracts/common/Enum.sol";
 import { IERC1155Receiver } from "@openzeppelin/contracts/interfaces/IERC1155Receiver.sol";
 import { IERC721Receiver } from "@openzeppelin/contracts/interfaces/IERC721Receiver.sol";

diff --git a/test/CompTimelockExecutionStrategy.t.sol b/test/CompTimelockExecutionStrategy.t.sol
@@ -16,7 +16,7 @@ import {
 } from "../src/types.sol";
 import {
     CompTimelockCompatibleExecutionStrategy
-} from "../src/execution-strategies/CompTimelockCompatibleExecutionStrategy.sol";
+} from "../src/execution-strategies/timelocks/CompTimelockCompatibleExecutionStrategy.sol";
 import { MockImplementation } from "./mocks/MockImplementation.sol";
 import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 import { TestERC1155 } from "./mocks/TestERC1155.sol";

diff --git a/test/TimelockExecutionStrategy.t.sol b/test/TimelockExecutionStrategy.t.sol
@@ -14,7 +14,7 @@ import {
     TRUE,
     FALSE
 } from "../src/types.sol";
-import { TimelockExecutionStrategy } from "../src/execution-strategies/TimelockExecutionStrategy.sol";
+import { TimelockExecutionStrategy } from "../src/execution-strategies/timelocks/TimelockExecutionStrategy.sol";
 import { MockImplementation } from "./mocks/MockImplementation.sol";
 import { ERC1967Proxy } from "@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol";
 import { TestERC1155 } from "./mocks/TestERC1155.sol";