Merge pull request #21 from spherex-collab/N03

N03
spherex-xyz · Jul 31, 2023 · 6f77a96 · 6f77a96
2 parents cfdd63c + ed86e8a
commit 6f77a96
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git a/src/ISphereXEngine.sol b/src/ISphereXEngine.sol
@@ -5,8 +5,8 @@ pragma solidity ^0.8.17;
 
 import {IERC165} from "openzeppelin-contracts/utils/introspection/IERC165.sol";
 /**
- * @title Interface for SphereXEngine - defenitions of core functionality
- * @author SphereX Technolegies ltd
+ * @title Interface for SphereXEngine - definitions of core functionality
+ * @author SphereX Technologies ltd
  * @notice This interface is imported by SphereXProtected, so that SphereXProtected can call functions from SphereXEngine
  * @dev Full docs of these functions can be found in SphereXEngine
  */

diff --git a/src/SphereXEngine.sol b/src/SphereXEngine.sol
@@ -217,7 +217,7 @@ contract SphereXEngine is ISphereXEngine, AccessControlDefaultAdminRules {
      * @param num id of function to add. Should be positive
      * @param sender For future use
      * @param data For future use
-     * @return result in the future will return insturction on what storage slots to gather, but not used for now
+     * @return result in the future will return instruction on what storage slots to gather, but not used for now
      */
     function sphereXValidatePre(int256 num, address sender, bytes calldata data)
         external

diff --git a/src/SphereXProtected.sol b/src/SphereXProtected.sol
@@ -37,7 +37,7 @@ abstract contract SphereXProtected {
 
     /**
      * @dev used when the client doesn't use a proxy
-     * @notice constructor visibality is required to support all compiler versions
+     * @notice constructor visibility is required to support all compiler versions
      */
     constructor() internal {
         __SphereXProtected_init();
@@ -64,7 +64,7 @@ abstract contract SphereXProtected {
     }
 
     /**
-     * Stores a new address in an abitrary slot
+     * Stores a new address in an arbitrary slot
      * @param slot where to store the address
      * @param newAddress address to store in given slot
      */
@@ -160,7 +160,7 @@ abstract contract SphereXProtected {
     /**
      *
      * @param newSphereXEngine new address of the spherex engine
-     * @dev this is also used to actually enable the defence
+     * @dev this is also used to actually enable the defense
      * (because as long is this address is 0, the protection is disabled).
      */
     function changeSphereXEngine(address newSphereXEngine) external onlyOperator {
@@ -236,7 +236,7 @@ abstract contract SphereXProtected {
      * @dev internal function for engine communication. We use it to reduce contract size.
      *  Should be called after the code of a function.
      * @param num function identifier
-     * @param gas the gas saved before the original function nody run
+     * @param gas the gas saved before the original function body run
      */
     function _sphereXValidateInternalPost(int256 num, uint256 gas) private returnsIfNotActivated {
         _sphereXEngine().sphereXValidateInternalPost(num, gas - gasleft());
@@ -261,7 +261,7 @@ abstract contract SphereXProtected {
     }
 
     /**
-     *  @dev Modifier to be incorporated in all public rotected non-view functions
+     *  @dev Modifier to be incorporated in all public protected non-view functions
      */
     modifier sphereXGuardPublic(int256 num, bytes4 selector) {
         ModifierLocals memory locals = _sphereXValidatePre(num, msg.sig == selector);