Audit-4: Comments on Shell (#1318)

* Comments on Shell * Update contracts/src/Shell.sol Co-authored-by: Vincent Geddes <[email protected]> --------- Co-authored-by: Vincent Geddes <[email protected]>
Snowfork · Oct 25, 2024 · 5fc0337 · 5fc0337
1 parent 0c0e046
commit 5fc0337
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/contracts/src/Shell.sol b/contracts/src/Shell.sol
@@ -8,6 +8,13 @@ import {IUpgradable} from "./interfaces/IUpgradable.sol";
 import {IShell} from "./interfaces/IShell.sol";
 import {ERC1967} from "./utils/ERC1967.sol";
 
+/**
+ * @title Shell
+ * Only used in the initial deployment of the GatewayProxy, which was deployed along
+ * with this Shell as its logic contract. The Shell was then upgraded using a trusted
+ * operator to the full Gateway contract. Currently this code is no longer in use but is
+ * kept around for archival purposes.
+ */
 contract Shell is IShell, IUpgradable, IInitializable {
     address public immutable OPERATOR;