From 5fc0337cc77e1706a9f00a1c41379054387556bd Mon Sep 17 00:00:00 2001 From: Ron Date: Fri, 25 Oct 2024 11:44:44 +0800 Subject: [PATCH] Audit-4: Comments on Shell (#1318) * Comments on Shell * Update contracts/src/Shell.sol Co-authored-by: Vincent Geddes <117534+vgeddes@users.noreply.github.com> --------- Co-authored-by: Vincent Geddes <117534+vgeddes@users.noreply.github.com> --- contracts/src/Shell.sol | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/contracts/src/Shell.sol b/contracts/src/Shell.sol index 146632afec..c440c6c6bc 100644 --- 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;