Grammar and Spelling Pass 1

remedcu · remedcu · commit 8aae94072a88 · 2025-04-09T14:58:39.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ coverage.json
 yarn-error.log
 typechain-types
 .vscode
+.cache
 
 # Certora Formal Verification related files
 .certora_internal
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -107,8 +107,9 @@ Documentation
 - [Error codes](docs/error_codes.md)
 - [Coding guidelines](docs/guidelines.md)
 
-Audits/ Formal Verification
+Audits / Formal Verification
 ---------
+- [for Version 1.5.0 by Certora](docs/audit_1_5_0.md)
 - [for Version 1.4.0/1.4.1 by Ackee Blockchain](docs/audit_1_4_0.md)
 - [for Version 1.3.0 by G0 Group](docs/audit_1_3_0.md)
 - [for Version 1.2.0 by G0 Group](docs/audit_1_2_0.md)
diff --git a/contracts/base/OwnerManager.sol b/contracts/base/OwnerManager.sol
@@ -71,7 +71,7 @@ abstract contract OwnerManager is SelfAuthorized, IOwnerManager {
      * @inheritdoc IOwnerManager
      */
     function removeOwner(address prevOwner, address owner, uint256 _threshold) public override authorized {
-        // Only allow to remove an owner, if threshold can still be reached.
+        // Only allow the removal of an owner if the threshold can still be reached.
         // Here we do pre-decrement as it is cheaper and allows us to check if the threshold is still reachable.
         if (--ownerCount < _threshold) revertWithError("GS201");
         // Validate owner address and check that it corresponds to owner index.
diff --git a/contracts/handler/CompatibilityFallbackHandler.sol b/contracts/handler/CompatibilityFallbackHandler.sol
@@ -50,7 +50,7 @@ contract CompatibilityFallbackHandler is TokenCallbackHandler, ISignatureValidat
 
     /**
      * @notice Implementation of updated EIP-1271 signature validation method.
-     * @param _dataHash Hash of the data signed on the behalf of address(msg.sender)
+     * @param _dataHash Hash of the data signed on behalf of the address(msg.sender)
      * @param _signature Signature byte array associated with _dataHash
      * @return Updated EIP1271 magic value if signature is valid, otherwise 0x0
      */
diff --git a/contracts/handler/HandlerContext.sol b/contracts/handler/HandlerContext.sol
@@ -11,8 +11,8 @@ pragma solidity >=0.7.0 <0.9.0;
 abstract contract HandlerContext {
     /**
      * @notice Allows fetching the original caller address.
-     * @dev This is only reliable in combination with a FallbackManager that supports this (e.g. Safe contract >=1.3.0).
-     *      When using this functionality make sure that the linked _manager (aka msg.sender) supports this.
+     * @dev This is only reliable with a FallbackManager supporting this (e.g. Safe contract >=1.3.0).
+     *      When using this functionality, ensure that the linked _manager (aka msg.sender) supports this.
      *      This function does not rely on a trusted forwarder. Use the returned value only to
      *      check information against the calling manager.
      * @return sender Original caller address.
diff --git a/contracts/handler/extensible/ExtensibleBase.sol b/contracts/handler/extensible/ExtensibleBase.sol
@@ -65,7 +65,7 @@ abstract contract ExtensibleBase is HandlerContext {
 
     /**
      * Dry code to get the Safe and the original `msg.sender` from the FallbackManager
-     * @return safe The safe whose FallbackManager is making this call
+     * @return safe The Safe whose FallbackManager is making this call
      * @return sender The original `msg.sender` (as received by the FallbackManager)
      */
     function _getContext() internal view returns (ISafe safe, address sender) {
@@ -75,7 +75,7 @@ abstract contract ExtensibleBase is HandlerContext {
 
     /**
      * Get the context and the method handler applicable to the current call
-     * @return safe The safe whose FallbackManager is making this call
+     * @return safe The Safe whose FallbackManager is making this call
      * @return sender The original `msg.sender` (as received by the FallbackManager)
      * @return isStatic Whether the method is static (`view`) or not
      * @return handler the address of the handler contract
diff --git a/contracts/interfaces/ERC777TokensRecipient.sol b/contracts/interfaces/ERC777TokensRecipient.sol
@@ -4,7 +4,7 @@ pragma solidity >=0.7.0 <0.9.0;
 /**
  * @title ERC777TokensRecipient
  * @dev Interface for contracts that will be called with the ERC777 token's `tokensReceived` method.
- * The contract receiving the tokens must implement this interface in order to receive the tokens.
+ * The contract receiving the tokens must implement this interface to receive the tokens.
  */
 interface ERC777TokensRecipient {
     /**
diff --git a/contracts/interfaces/ISafe.sol b/contracts/interfaces/ISafe.sol
@@ -8,7 +8,7 @@ import {IModuleManager} from "./IModuleManager.sol";
 import {IOwnerManager} from "./IOwnerManager.sol";
 
 /**
- * @title ISafe - A multisignature wallet interface with support for confirmations using signed messages based on EIP-712.
+ * @title ISafe - A multi signature wallet interface with support for confirmations using signed messages based on EIP-712.
  * @author @safe-global/safe-protocol
  */
 interface ISafe is IModuleManager, IGuardManager, IOwnerManager, IFallbackManager {
diff --git a/contracts/interfaces/ISignatureValidator.sol b/contracts/interfaces/ISignatureValidator.sol
@@ -10,7 +10,7 @@ contract ISignatureValidatorConstants {
 abstract contract ISignatureValidator is ISignatureValidatorConstants {
     /**
      * @notice EIP1271 method to validate a signature.
-     * @param _hash Hash of the data signed on the behalf of address(this).
+     * @param _hash Hash of the data signed on behalf of the address(this).
      * @param _signature Signature byte array associated with _data.
      *
      * MUST return the bytes4 magic value 0x1626ba7e when function passes.
diff --git a/contracts/interfaces/ViewStorageAccessible.sol b/contracts/interfaces/ViewStorageAccessible.sol
@@ -6,7 +6,7 @@ pragma solidity >=0.5.0 <0.9.0;
 interface ViewStorageAccessible {
     /**
      * @dev Same as `simulate` on StorageAccessible. Marked as view so that it can be called from external contracts
-     * that want to run simulations from within view functions. Will revert if the invoked simulation attempts to change state.
+     * that want to run simulations from within view functions. It will revert if the invoked simulation attempts to change state.
      */
     function simulate(address targetContract, bytes calldata calldataPayload) external view returns (bytes memory);
 }
diff --git a/contracts/libraries/ErrorMessage.sol b/contracts/libraries/ErrorMessage.sol
@@ -11,7 +11,7 @@ abstract contract ErrorMessage {
     /**
      * @notice Function which uses assembly to revert with the passed error message.
      * @param error The error string to revert with.
-     * @dev Currently it is expected that the `error` string is at max 5 bytes of length. Ex: "GSXXX"
+     * @dev Currently, the `error` string is expected to be at max 5 bytes of length. Ex: "GSXXX"
      */
     function revertWithError(bytes5 error) internal pure {
         /* solhint-disable no-inline-assembly */
diff --git a/contracts/libraries/SignMessageLib.sol b/contracts/libraries/SignMessageLib.sol
@@ -17,7 +17,7 @@ contract SignMessageLib is SafeStorage {
     /**
      * @notice Marks a message (`_data`) as signed.
      * @dev Can be verified using EIP-1271 validation method by passing the pre-image of the message hash and empty bytes as the signature.
-     * @param _data Arbitrary length data that should be marked as signed on the behalf of address(this).
+     * @param _data Arbitrary length data that should be marked as signed on behalf of the address(this).
      */
     function signMessage(bytes calldata _data) external {
         bytes32 msgHash = getMessageHash(_data);
diff --git a/contracts/proxies/SafeProxy.sol b/contracts/proxies/SafeProxy.sol
@@ -11,7 +11,7 @@ interface IProxy {
 }
 
 /**
- * @title SafeProxy - Generic proxy contract allows to execute all transactions applying the code of a master contract.
+ * @title SafeProxy - A generic proxy contract allows the execution of all transactions by applying the code of a master contract.
  * @author Stefan George - <stefan@gnosis.io>
  * @author Richard Meissner - <richard@gnosis.io>
  */
diff --git a/contracts/proxies/SafeProxyFactory.sol b/contracts/proxies/SafeProxyFactory.sol
@@ -12,7 +12,7 @@ contract SafeProxyFactory {
     event ProxyCreation(SafeProxy indexed proxy, address singleton);
     event ProxyCreationL2(SafeProxy indexed proxy, address singleton, bytes initializer, uint256 saltNonce);
 
-    /// @dev Allows to retrieve the creation code used for the Proxy deployment. With this it is easily possible to calculate predicted address.
+    /// @dev Allows the creation code used for the Proxy deployment to be retrieved. With this, it is easily possible to calculate the predicted address.
     function proxyCreationCode() public pure returns (bytes memory) {
         return type(SafeProxy).creationCode;
     }
@@ -55,7 +55,7 @@ contract SafeProxyFactory {
      * @param saltNonce Nonce that will be used to generate the salt to calculate the address of the new proxy contract.
      */
     function createProxyWithNonce(address _singleton, bytes memory initializer, uint256 saltNonce) public returns (SafeProxy proxy) {
-        // If the initializer changes the proxy address should change too. Hashing the initializer data is cheaper than just concatenating it
+        // If the initializer changes, the proxy address should change too. Hashing the initializer data is cheaper than just concatenating it
         bytes32 salt = keccak256(abi.encodePacked(keccak256(initializer), saltNonce));
         proxy = deployProxy(_singleton, initializer, salt);
         emit ProxyCreation(proxy, _singleton);
diff --git a/contracts/test/Token.sol b/contracts/test/Token.sol
diff --git a/tests_deprecated/gnosisSafeNestedSafes.js b/tests_deprecated/gnosisSafeNestedSafes.js
diff --git a/tests_deprecated/gnosisSafeTransactionExecution.js b/tests_deprecated/gnosisSafeTransactionExecution.js
diff --git a/tests_deprecated/utils/execution.js b/tests_deprecated/utils/execution.js
diff --git a/tests_deprecated/utils/general.js b/tests_deprecated/utils/general.js

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ contract ISignatureValidatorConstants {`
`10`	`10`	`abstract contract ISignatureValidator is ISignatureValidatorConstants {`
`11`	`11`	`/**`
`12`	`12`	`* @notice EIP1271 method to validate a signature.`
`13`		`- * @param _hash Hash of the data signed on the behalf of address(this).`
	`13`	`+ * @param _hash Hash of the data signed on behalf of the address(this).`
`14`	`14`	`* @param _signature Signature byte array associated with _data.`
`15`	`15`	`*`
`16`	`16`	`* MUST return the bytes4 magic value 0x1626ba7e when function passes.`