clean

succinctlabs · Apr 3, 2024 · a42cb1b · a42cb1b
1 parent 495ae7b
commit a42cb1b
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/contracts/src/VectorX.sol b/contracts/src/VectorX.sol
@@ -8,7 +8,8 @@ import {ISuccinctGateway} from "@succinctx/interfaces/ISuccinctGateway.sol";
 /// @notice VectorX is a light client for Avail's consensus.
 /// @dev The light client tracks both the state of Avail's Grandpa consensus and Vector, Avail's
 ///     data commitment solution.
-/// @dev Please ensure that all new storage variables are placed after existing storage variables.
+/// @dev Ensure that all new storage variables are placed after existing storage variables to avoid
+/// storage corruption during upgrades.
 contract VectorX is IVectorX, TimelockedUpgradeable {
     /// @notice Indicator of if the contract is frozen.
     bool public frozen;