From d9d74289580d3845ba0b14115e39057a6fc997f1 Mon Sep 17 00:00:00 2001 From: clarencepenz Date: Mon, 26 Feb 2024 04:05:39 +0100 Subject: [PATCH] docs: updated docs grammars to improve readability --- .../LSP11BasicSocialRecovery/ILSP11BasicSocialRecovery.sol | 6 +++--- .../LSP11BasicSocialRecoveryCore.sol | 4 ++-- contracts/LSP14Ownable2Step/LSP14Ownable2Step.sol | 2 +- contracts/LSP17Extensions/Extension4337.sol | 2 +- contracts/LSP20CallVerification/ILSP20CallVerifier.sol | 2 +- .../LSP23LinkedContractsFactory.sol | 2 +- contracts/Mocks/KeyManager/KeyManagerInternalsTester.sol | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/contracts/LSP11BasicSocialRecovery/ILSP11BasicSocialRecovery.sol b/contracts/LSP11BasicSocialRecovery/ILSP11BasicSocialRecovery.sol index 1a9bd23e9..4259c2b72 100644 --- a/contracts/LSP11BasicSocialRecovery/ILSP11BasicSocialRecovery.sol +++ b/contracts/LSP11BasicSocialRecovery/ILSP11BasicSocialRecovery.sol @@ -33,7 +33,7 @@ interface ILSP11BasicSocialRecovery { event SecretHashChanged(bytes32 indexed secretHash); /** - * @notice Emitted when a guardian select a new potentiel controller address for the target + * @notice Emitted when a guardian select a new potential controller address for the target * @param recoveryCounter The current recovery process counter * @param guardian The address of the guardian * @param addressSelected The address selected by the guardian @@ -119,7 +119,7 @@ interface ILSP11BasicSocialRecovery { * * Requirements: * - * - The guardians count should be higher or equal to the guardain threshold + * - The guardians count should be higher or equal to the guardian threshold */ function removeGuardian(address currentGuardian) external; @@ -147,7 +147,7 @@ interface ILSP11BasicSocialRecovery { function setGuardiansThreshold(uint256 guardiansThreshold) external; /** - * @dev select an address to be a potentiel controller address if he reaches + * @dev select an address to be a potential controller address if he reaches * the guardian threshold and provide the correct secret string * * Requirements: diff --git a/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecoveryCore.sol b/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecoveryCore.sol index 0ce82e03c..364837475 100644 --- a/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecoveryCore.sol +++ b/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecoveryCore.sol @@ -49,7 +49,7 @@ abstract contract LSP11BasicSocialRecoveryCore is // The guardians threshold uint256 internal _guardiansThreshold; - // The number of successfull recovery processes + // The number of successful recovery processes uint256 internal _recoveryCounter; // The secret hash to be set by the owner @@ -321,7 +321,7 @@ abstract contract LSP11BasicSocialRecoveryCore is } /** - * @dev Remove the guardians choice after a successfull recovery process + * @dev Remove the guardians choice after a successful recovery process * To avoid keeping unnecessary state */ function _cleanStorage( diff --git a/contracts/LSP14Ownable2Step/LSP14Ownable2Step.sol b/contracts/LSP14Ownable2Step/LSP14Ownable2Step.sol index 561e27c83..2a969f318 100644 --- a/contracts/LSP14Ownable2Step/LSP14Ownable2Step.sol +++ b/contracts/LSP14Ownable2Step/LSP14Ownable2Step.sol @@ -48,7 +48,7 @@ abstract contract LSP14Ownable2Step is ILSP14Ownable2Step, OwnableUnset { uint256 public constant RENOUNCE_OWNERSHIP_CONFIRMATION_PERIOD = 200; /** - * @dev The block number saved when initiating the process of renouncing ownerhsip. + * @dev The block number saved when initiating the process of renouncing ownership. */ uint256 internal _renounceOwnershipStartedAt; diff --git a/contracts/LSP17Extensions/Extension4337.sol b/contracts/LSP17Extensions/Extension4337.sol index 5a8d38cb4..9d311e3ff 100644 --- a/contracts/LSP17Extensions/Extension4337.sol +++ b/contracts/LSP17Extensions/Extension4337.sol @@ -14,7 +14,7 @@ import { import {LSP14Ownable2Step} from "../LSP14Ownable2Step/LSP14Ownable2Step.sol"; import {LSP17Extension} from "../LSP17ContractExtension/LSP17Extension.sol"; -// librairies +// libraries import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol"; import {LSP6Utils} from "../LSP6KeyManager/LSP6Utils.sol"; diff --git a/contracts/LSP20CallVerification/ILSP20CallVerifier.sol b/contracts/LSP20CallVerification/ILSP20CallVerifier.sol index f23eee193..da711dcb1 100644 --- a/contracts/LSP20CallVerification/ILSP20CallVerifier.sol +++ b/contracts/LSP20CallVerification/ILSP20CallVerifier.sol @@ -9,7 +9,7 @@ pragma solidity ^0.8.4; interface ILSP20CallVerifier { /** * @return returnedStatus MUST return the first 3 bytes of `lsp20VerifyCall(address,uint256,bytes)` function selector if the call to - * the function is allowed, concatened with a byte that determines if the lsp20VerifyCallResult function should + * the function is allowed, concatenated with a byte that determines if the lsp20VerifyCallResult function should * be called after the original function call. The byte that invoke the lsp20VerifyCallResult function is strictly `0x01`. * * @param requestor The address that requested to make the call to `target`. diff --git a/contracts/LSP23LinkedContractsFactory/LSP23LinkedContractsFactory.sol b/contracts/LSP23LinkedContractsFactory/LSP23LinkedContractsFactory.sol index 4239a1f29..f77a1e6b7 100644 --- a/contracts/LSP23LinkedContractsFactory/LSP23LinkedContractsFactory.sol +++ b/contracts/LSP23LinkedContractsFactory/LSP23LinkedContractsFactory.sol @@ -378,7 +378,7 @@ contract LSP23LinkedContractsFactory is ILSP23LinkedContractsFactory { * - the secondary contract addPrimaryContractAddress boolean * - the secondary contract extra initialization params (if any) * - the postDeploymentModule address - * - the callda to the post deployment module + * - the calldata to the post deployment module * */ primaryContractProxyGeneratedSalt = keccak256( diff --git a/contracts/Mocks/KeyManager/KeyManagerInternalsTester.sol b/contracts/Mocks/KeyManager/KeyManagerInternalsTester.sol index a6edba89f..f70e7d77b 100644 --- a/contracts/Mocks/KeyManager/KeyManagerInternalsTester.sol +++ b/contracts/Mocks/KeyManager/KeyManagerInternalsTester.sol @@ -117,7 +117,7 @@ contract KeyManagerInternalTester is LSP6KeyManager { super._verifyPermissions(_target, from, false, payload); // This event is emitted just for a sake of not marking this function as `view`, - // as Hardhat has a bug that does not catch error that occured from failed `abi.decode` + // as Hardhat has a bug that does not catch error that occurred from failed `abi.decode` // inside view functions. // See these issues in the Github repository of Hardhat: // - https://github.com/NomicFoundation/hardhat/issues/3084