added note for deprecated versions of AbstractPortal and AbstractModule

Consensys · Nov 26, 2024 · 0a585bc · 0a585bc
1 parent 82c02bb
commit 0a585bc
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 4 deletions.
diff --git a/contracts/src/abstracts/AbstractModule.sol b/contracts/src/abstracts/AbstractModule.sol
@@ -7,7 +7,7 @@ import { IERC165 } from "@openzeppelin/contracts/utils/introspection/IERC165.sol
 /**
  * @title Abstract Module
  * @author Consensys
- * @notice Defines the minimal Module interface
+ * @notice Deprecated. Use the AbstractModuleV2 contract instead.
  */
 abstract contract AbstractModule is IERC165 {
   /// @notice Error thrown when someone else than the portal's owner is trying to revoke

diff --git a/contracts/src/abstracts/AbstractPortal.sol b/contracts/src/abstracts/AbstractPortal.sol
@@ -13,9 +13,7 @@ import { IPortal } from "../interfaces/IPortal.sol";
 /**
  * @title Abstract Portal
  * @author Consensys
- * @notice This contract is an abstracts contract with basic Portal logic
- *         to be inherited. We strongly encourage all Portals to implement
- *         this contract.
+ * @notice Deprecated. Use the AbstractPortalV2 contract instead.
  */
 abstract contract AbstractPortal is IPortal {
   IRouter public router;