From 6414b4d137ac2b24a598f1f8a5acc3b94e9501aa Mon Sep 17 00:00:00 2001 From: b00ste Date: Tue, 26 Nov 2024 14:51:02 +0200 Subject: [PATCH] fix: grammar issues --- CONTRIBUTING.md | 2 +- .../LSP0ERC725Account/contracts/LSP0ERC725Account.md | 2 +- .../LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md | 6 +++--- .../LSP17ContractExtension/contracts/LSP17Extendable.md | 4 ++-- .../contracts/LSP1UniversalReceiverDelegateUP.md | 4 ++-- .../contracts/LSP1UniversalReceiverDelegateVault.md | 6 +++--- .../contracts/LSP23LinkedContractsFactory.md | 8 ++++---- .../contracts/LSP25MultiChannelNonce.md | 2 +- .../contracts/LSP6KeyManager/contracts/LSP6KeyManager.md | 4 ++-- .../LSP7DigitalAsset/contracts/LSP7DigitalAsset.md | 8 ++++---- .../LSP7DigitalAsset/contracts/extensions/LSP7Burnable.md | 8 ++++---- .../contracts/extensions/LSP7CappedSupply.md | 8 ++++---- .../LSP7DigitalAsset/contracts/presets/LSP7Mintable.md | 8 ++++---- .../contracts/LSP8IdentifiableDigitalAsset.md | 6 +++--- .../contracts/extensions/LSP8Burnable.md | 6 +++--- .../contracts/extensions/LSP8CappedSupply.md | 6 +++--- .../contracts/extensions/LSP8Enumerable.md | 4 ++-- .../contracts/presets/LSP8Mintable.md | 6 +++--- .../docs/contracts/LSP9Vault/contracts/LSP9Vault.md | 2 +- .../UniversalProfile/contracts/UniversalProfile.md | 2 +- .../LSP1UniversalReceiver/contracts/LSP1Utils.md | 2 +- .../lsp0-contracts/contracts/LSP0ERC725AccountCore.sol | 2 +- packages/lsp1-contracts/contracts/LSP1Utils.sol | 2 +- .../contracts/LSP17Extendable.sol | 4 ++-- .../contracts/LSP17ExtendableInitAbstract.sol | 4 ++-- packages/lsp23-contracts/contracts/LSP23Errors.sol | 8 ++++---- .../lsp25-contracts/contracts/LSP25MultiChannelNonce.sol | 2 +- .../contracts/Mocks/KeyManagerInternalsTester.sol | 2 +- packages/lsp9-contracts/contracts/LSP9VaultCore.sol | 2 +- 29 files changed, 65 insertions(+), 65 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2806c9f43..7b64e6b93 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -145,7 +145,7 @@ Which is is not the intended output. 3. `@return` tag is mandatory if the function has any return value. -4. Make sure to use one of the custom tags below to document any additional informations of different kinds: +4. Make sure to use one of the custom tags below to document any additional information of different kinds: - Use `@custom:requirements` for all the requirements to use a function. - Use `@custom:events` for all the emited events during the function execution. diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP0ERC725Account/contracts/LSP0ERC725Account.md b/packages/lsp-smart-contracts/docs/contracts/LSP0ERC725Account/contracts/LSP0ERC725Account.md index 8ba13d64b..c9c5e6b2e 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP0ERC725Account/contracts/LSP0ERC725Account.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP0ERC725Account/contracts/LSP0ERC725Account.md @@ -847,7 +847,7 @@ function universalReceiver( ) external payable returns (bytes returnedValues); ``` -_Notifying the contract by calling its `universalReceiver` function with the following informations: typeId: `typeId`; data: `data`._ +_Notifying the contract by calling its `universalReceiver` function with the following information: typeId: `typeId`; data: `data`._ Achieves the goal of [LSP-1-UniversalReceiver] by allowing the account to be notified about incoming/outgoing transactions and enabling reactions to these actions. The reaction is achieved by having two external contracts ([LSP1UniversalReceiverDelegate]) that react on the whole transaction and on the specific typeId, respectively. The function performs the following steps: diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md b/packages/lsp-smart-contracts/docs/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md index 0bb2c8512..4ea49a9ee 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md @@ -353,7 +353,7 @@ Leaves the contract without owner. It will not be possible to call `onlyOwner` f function selectNewController(address addressSelected) external nonpayable; ``` -select an address to be a potentiel controller address if he reaches the guardian threshold and provide the correct secret string Requirements: +select an address to be a potential controller address if he reaches the guardian threshold and provide the correct secret string Requirements: - only guardians can select an address @@ -559,7 +559,7 @@ function _cleanStorage( ) internal nonpayable; ``` -Remove the guardians choice after a successfull recovery process +Remove the guardians choice after a successful recovery process To avoid keeping unnecessary state
@@ -745,7 +745,7 @@ event SelectedNewController( ); ``` -_Emitted when a guardian select a new potentiel controller address for the target_ +_Emitted when a guardian select a new potential controller address for the target_ #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP17ContractExtension/contracts/LSP17Extendable.md b/packages/lsp-smart-contracts/docs/contracts/LSP17ContractExtension/contracts/LSP17Extendable.md index 35b71173d..917cda0a5 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP17ContractExtension/contracts/LSP17Extendable.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP17ContractExtension/contracts/LSP17Extendable.md @@ -88,8 +88,8 @@ function _getExtensionAndForwardValue( Returns the extension mapped to a specific function selector If no extension was found, return the address(0) -To be overrided. -Up to the implementor contract to return an extension based on a function selector +To be overridden. +Up to the implementer contract to return an extension based on a function selector
diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateUP.md b/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateUP.md index c14868d52..7900ad01d 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateUP.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateUP.md @@ -96,8 +96,8 @@ See [`IERC165-supportsInterface`](#ierc165-supportsinterface). :::info -- If some issues occured with generating the `dataKeys` or `dataValues` the `returnedMessage` will be an error message, otherwise it will be empty. -- If an error occured when trying to use `setDataBatch(dataKeys,dataValues)`, it will return the raw error data back to the caller. +- If some issues occurred with generating the `dataKeys` or `dataValues` the `returnedMessage` will be an error message, otherwise it will be empty. +- If an error occurred when trying to use `setDataBatch(dataKeys,dataValues)`, it will return the raw error data back to the caller. ::: diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateVault.md b/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateVault.md index d0356d3bd..21e75e7b2 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateVault.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP1UniversalReceiver/contracts/LSP1UniversalReceiverDelegateVault.md @@ -94,8 +94,8 @@ See [`IERC165-supportsInterface`](#ierc165-supportsinterface). :::info -- If some issues occured with generating the `dataKeys` or `dataValues` the `returnedMessage` will be an error message, otherwise it will be empty. -- If an error occured when trying to use `setDataBatch(dataKeys,dataValues)`, it will return the raw error data back to the caller. +- If some issues occurred with generating the `dataKeys` or `dataValues` the `returnedMessage` will be an error message, otherwise it will be empty. +- If an error occurred when trying to use `setDataBatch(dataKeys,dataValues)`, it will return the raw error data back to the caller. ::: @@ -194,7 +194,7 @@ function _setDataBatchWithoutReverting( ) internal nonpayable returns (bytes); ``` -Calls `bytes4(keccak256(setDataBatch(bytes32[],bytes[])))` without checking for `bool succes`, but it returns all the data back. +Calls `bytes4(keccak256(setDataBatch(bytes32[],bytes[])))` without checking for `bool success`, but it returns all the data back. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP23LinkedContractsFactory/contracts/LSP23LinkedContractsFactory.md b/packages/lsp-smart-contracts/docs/contracts/LSP23LinkedContractsFactory/contracts/LSP23LinkedContractsFactory.md index f1044092b..ccaf7be87 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP23LinkedContractsFactory/contracts/LSP23LinkedContractsFactory.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP23LinkedContractsFactory/contracts/LSP23LinkedContractsFactory.md @@ -365,13 +365,13 @@ error PrimaryContractProxyInitFailureError(bytes errorData); _Failed to deploy & initialize the Primary Contract Proxy. Error: `errorData`._ -Reverts when the deployment & intialization of the contract has failed. +Reverts when the deployment & initialization of the contract has failed. #### Parameters | Name | Type | Description | | ----------- | :-----: | ----------------------------------------------------------------------------- | -| `errorData` | `bytes` | Potentially information about why the deployment & intialization have failed. | +| `errorData` | `bytes` | Potentially information about why the deployment & initialization have failed. |
@@ -392,12 +392,12 @@ error SecondaryContractProxyInitFailureError(bytes errorData); _Failed to deploy & initialize the Secondary Contract Proxy. Error: `errorData`._ -Reverts when the deployment & intialization of the secondary contract has failed. +Reverts when the deployment & initialization of the secondary contract has failed. #### Parameters | Name | Type | Description | | ----------- | :-----: | ----------------------------------------------------------------------------- | -| `errorData` | `bytes` | Potentially information about why the deployment & intialization have failed. | +| `errorData` | `bytes` | Potentially information about why the deployment & initialization have failed. |
diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP25ExecuteRelayCall/contracts/LSP25MultiChannelNonce.md b/packages/lsp-smart-contracts/docs/contracts/LSP25ExecuteRelayCall/contracts/LSP25MultiChannelNonce.md index e8c211075..0ebf8547e 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP25ExecuteRelayCall/contracts/LSP25MultiChannelNonce.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP25ExecuteRelayCall/contracts/LSP25MultiChannelNonce.md @@ -16,7 +16,7 @@ > Implementation of the multi channel nonce and the signature verification defined in the LSP25 standard. -This contract can be used as a backbone for other smart contracts to implement meta-transactions via the LSP25 Execute Relay Call interface. It contains a storage of nonces for signer addresses across various channel IDs, enabling these signers to submit signed transactions that order-independant. (transactions that do not need to be submitted one after the other in a specific order). Finally, it contains internal functions to verify signatures for specific calldata according the signature format specified in the LSP25 standard. +This contract can be used as a backbone for other smart contracts to implement meta-transactions via the LSP25 Execute Relay Call interface. It contains a storage of nonces for signer addresses across various channel IDs, enabling these signers to submit signed transactions that order-independent. (transactions that do not need to be submitted one after the other in a specific order). Finally, it contains internal functions to verify signatures for specific calldata according the signature format specified in the LSP25 standard. ## Internal Methods diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP6KeyManager/contracts/LSP6KeyManager.md b/packages/lsp-smart-contracts/docs/contracts/LSP6KeyManager/contracts/LSP6KeyManager.md index 4bbcfeb3b..2549ba168 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP6KeyManager/contracts/LSP6KeyManager.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP6KeyManager/contracts/LSP6KeyManager.md @@ -286,7 +286,7 @@ Same as [`executeRelayCall`](#executerelaycall) but execute a batch of signed ca A signer can choose its channel number arbitrarily. The recommended practice is to: - use `channelId == 0` for transactions for which the ordering of execution matters.abi _Example: you have two transactions A and B, and transaction A must be executed first and complete successfully before transaction B should be executed)._ -- use any other `channelId` number for transactions that you want to be order independant (out-of-order execution, execution _"in parallel"_). \_Example: you have two transactions A and B. You want transaction B to be executed a) without having to wait for transaction A to complete, or b) regardless if transaction A completed successfully or not. +- use any other `channelId` number for transactions that you want to be order independent (out-of-order execution, execution _"in parallel"_). \_Example: you have two transactions A and B. You want transaction B to be executed a) without having to wait for transaction A to complete, or b) regardless if transaction A completed successfully or not. ::: @@ -401,7 +401,7 @@ function lsp20VerifyCall( | Name | Type | Description | | ---- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `0` | `bytes4` | 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 be called after the original function call. The byte that invoke the lsp20VerifyCallResult function is strictly `0x01`. | +| `0` | `bytes4` | MUST return the first 3 bytes of `lsp20VerifyCall(address,uint256,bytes)` function selector if the call to 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`. |
diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/LSP7DigitalAsset.md b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/LSP7DigitalAsset.md index 2bbcd5109..f0e6459ca 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/LSP7DigitalAsset.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/LSP7DigitalAsset.md @@ -234,7 +234,7 @@ Allows a caller to batch different function calls in one call. Perform a `delega function decimals() external view returns (uint8); ``` -Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned wiil be `0`. Otherwise `18` is the common value. +Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned will be `0`. Otherwise `18` is the common value. #### Returns @@ -937,7 +937,7 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw | --------------- | :-------: | ------------------------------------------------------------------- | | `operator` | `address` | The address of the operator to decrease the allowance of. | | `tokenOwner` | `address` | The address that granted an allowance on its balance to `operator`. | -| `amountToSpend` | `uint256` | The amount of tokens to substract in allowance of `operator`. | +| `amountToSpend` | `uint256` | The amount of tokens to subtract in allowance of `operator`. |
@@ -1001,7 +1001,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1026,7 +1026,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7Burnable.md b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7Burnable.md index d5ecec050..8ef79de14 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7Burnable.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7Burnable.md @@ -259,7 +259,7 @@ See internal [`_burn`](#_burn) function for details. function decimals() external view returns (uint8); ``` -Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned wiil be `0`. Otherwise `18` is the common value. +Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned will be `0`. Otherwise `18` is the common value. #### Returns @@ -962,7 +962,7 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw | --------------- | :-------: | ------------------------------------------------------------------- | | `operator` | `address` | The address of the operator to decrease the allowance of. | | `tokenOwner` | `address` | The address that granted an allowance on its balance to `operator`. | -| `amountToSpend` | `uint256` | The amount of tokens to substract in allowance of `operator`. | +| `amountToSpend` | `uint256` | The amount of tokens to subtract in allowance of `operator`. |
@@ -1026,7 +1026,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1051,7 +1051,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7CappedSupply.md b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7CappedSupply.md index 5c0d29917..3aa92fd57 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7CappedSupply.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/extensions/LSP7CappedSupply.md @@ -232,7 +232,7 @@ Allows a caller to batch different function calls in one call. Perform a `delega function decimals() external view returns (uint8); ``` -Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned wiil be `0`. Otherwise `18` is the common value. +Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned will be `0`. Otherwise `18` is the common value. #### Returns @@ -936,7 +936,7 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw | --------------- | :-------: | ------------------------------------------------------------------- | | `operator` | `address` | The address of the operator to decrease the allowance of. | | `tokenOwner` | `address` | The address that granted an allowance on its balance to `operator`. | -| `amountToSpend` | `uint256` | The amount of tokens to substract in allowance of `operator`. | +| `amountToSpend` | `uint256` | The amount of tokens to subtract in allowance of `operator`. |
@@ -1000,7 +1000,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1025,7 +1025,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/presets/LSP7Mintable.md b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/presets/LSP7Mintable.md index 99fde2ae2..9e8388e4b 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/presets/LSP7Mintable.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP7DigitalAsset/contracts/presets/LSP7Mintable.md @@ -265,7 +265,7 @@ Allows a caller to batch different function calls in one call. Perform a `delega function decimals() external view returns (uint8); ``` -Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned wiil be `0`. Otherwise `18` is the common value. +Returns the number of decimals used to get its user representation. If the asset contract has been set to be non-divisible via the `isNonDivisible_` parameter in the `constructor`, the decimals returned will be `0`. Otherwise `18` is the common value. #### Returns @@ -1001,7 +1001,7 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw | --------------- | :-------: | ------------------------------------------------------------------- | | `operator` | `address` | The address of the operator to decrease the allowance of. | | `tokenOwner` | `address` | The address that granted an allowance on its balance to `operator`. | -| `amountToSpend` | `uint256` | The amount of tokens to substract in allowance of `operator`. | +| `amountToSpend` | `uint256` | The amount of tokens to subtract in allowance of `operator`. |
@@ -1065,7 +1065,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1090,7 +1090,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/LSP8IdentifiableDigitalAsset.md b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/LSP8IdentifiableDigitalAsset.md index 941c24d42..29b7ac90e 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/LSP8IdentifiableDigitalAsset.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/LSP8IdentifiableDigitalAsset.md @@ -769,7 +769,7 @@ Transfer a given `tokenId` token from the `from` address to the `to` address. If | `from` | `address` | The address that owns the given `tokenId`. | | `to` | `address` | The address that will receive the `tokenId`. | | `tokenId` | `bytes32` | The token ID to transfer. | -| `force` | `bool` | When set to `true`, the `to` address CAN be any addres. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | +| `force` | `bool` | When set to `true`, the `to` address CAN be any address. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | | `data` | `bytes` | Any additional data the caller wants included in the emitted event, and sent in the hooks of the `from` and `to` addresses. |
@@ -1185,7 +1185,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1210,7 +1210,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient via LSP1** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient via LSP1** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Burnable.md b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Burnable.md index 85ee7412a..f80b0ef68 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Burnable.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Burnable.md @@ -795,7 +795,7 @@ Transfer a given `tokenId` token from the `from` address to the `to` address. If | `from` | `address` | The address that owns the given `tokenId`. | | `to` | `address` | The address that will receive the `tokenId`. | | `tokenId` | `bytes32` | The token ID to transfer. | -| `force` | `bool` | When set to `true`, the `to` address CAN be any addres. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | +| `force` | `bool` | When set to `true`, the `to` address CAN be any address. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | | `data` | `bytes` | Any additional data the caller wants included in the emitted event, and sent in the hooks of the `from` and `to` addresses. |
@@ -1211,7 +1211,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1236,7 +1236,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient via LSP1** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient via LSP1** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8CappedSupply.md b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8CappedSupply.md index c51417558..6d6fb055e 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8CappedSupply.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8CappedSupply.md @@ -794,7 +794,7 @@ Transfer a given `tokenId` token from the `from` address to the `to` address. If | `from` | `address` | The address that owns the given `tokenId`. | | `to` | `address` | The address that will receive the `tokenId`. | | `tokenId` | `bytes32` | The token ID to transfer. | -| `force` | `bool` | When set to `true`, the `to` address CAN be any addres. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | +| `force` | `bool` | When set to `true`, the `to` address CAN be any address. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | | `data` | `bytes` | Any additional data the caller wants included in the emitted event, and sent in the hooks of the `from` and `to` addresses. |
@@ -1185,7 +1185,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1210,7 +1210,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient via LSP1** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient via LSP1** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Enumerable.md b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Enumerable.md index b4a762395..ec72874c1 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Enumerable.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/extensions/LSP8Enumerable.md @@ -800,7 +800,7 @@ Transfer a given `tokenId` token from the `from` address to the `to` address. If | `from` | `address` | The address that owns the given `tokenId`. | | `to` | `address` | The address that will receive the `tokenId`. | | `tokenId` | `bytes32` | The token ID to transfer. | -| `force` | `bool` | When set to `true`, the `to` address CAN be any addres. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | +| `force` | `bool` | When set to `true`, the `to` address CAN be any address. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | | `data` | `bytes` | Any additional data the caller wants included in the emitted event, and sent in the hooks of the `from` and `to` addresses. |
@@ -1238,7 +1238,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient via LSP1** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient via LSP1** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/presets/LSP8Mintable.md b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/presets/LSP8Mintable.md index 3482a11cd..f9ad95b53 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/presets/LSP8Mintable.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP8IdentifiableDigitalAsset/contracts/presets/LSP8Mintable.md @@ -835,7 +835,7 @@ Transfer a given `tokenId` token from the `from` address to the `to` address. If | `from` | `address` | The address that owns the given `tokenId`. | | `to` | `address` | The address that will receive the `tokenId`. | | `tokenId` | `bytes32` | The token ID to transfer. | -| `force` | `bool` | When set to `true`, the `to` address CAN be any addres. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | +| `force` | `bool` | When set to `true`, the `to` address CAN be any address. When set to `false`, the `to` address MUST be a contract that supports the LSP1 UniversalReceiver standard. | | `data` | `bytes` | Any additional data the caller wants included in the emitted event, and sent in the hooks of the `from` and `to` addresses. |
@@ -1251,7 +1251,7 @@ function _beforeTokenTransfer( ``` Hook that is called before any token transfer, including minting and burning. -Allows to run custom logic before updating balances and notifiying sender/recipient by overriding this function. +Allows to run custom logic before updating balances and notifying sender/recipient by overriding this function. #### Parameters @@ -1276,7 +1276,7 @@ function _afterTokenTransfer( ``` Hook that is called after any token transfer, including minting and burning. -Allows to run custom logic after updating balances, but **before notifiying sender/recipient via LSP1** by overriding this function. +Allows to run custom logic after updating balances, but **before notifying sender/recipient via LSP1** by overriding this function. #### Parameters diff --git a/packages/lsp-smart-contracts/docs/contracts/LSP9Vault/contracts/LSP9Vault.md b/packages/lsp-smart-contracts/docs/contracts/LSP9Vault/contracts/LSP9Vault.md index f66fbb91d..6d7de77fe 100644 --- a/packages/lsp-smart-contracts/docs/contracts/LSP9Vault/contracts/LSP9Vault.md +++ b/packages/lsp-smart-contracts/docs/contracts/LSP9Vault/contracts/LSP9Vault.md @@ -764,7 +764,7 @@ function universalReceiver( ) external payable returns (bytes returnedValues); ``` -_Notifying the contract by calling its `universalReceiver` function with the following informations: typeId: `typeId`; data: `data`._ +_Notifying the contract by calling its `universalReceiver` function with the following information: typeId: `typeId`; data: `data`._ Achieves the goal of [LSP-1-UniversalReceiver] by allowing the account to be notified about incoming/outgoing transactions and enabling reactions to these actions. The reaction is achieved by having two external contracts ([LSP1UniversalReceiverDelegate]) that react on the whole transaction and on the specific typeId, respectively. The function performs the following steps: diff --git a/packages/lsp-smart-contracts/docs/contracts/UniversalProfile/contracts/UniversalProfile.md b/packages/lsp-smart-contracts/docs/contracts/UniversalProfile/contracts/UniversalProfile.md index 593901c01..db67c9f3f 100644 --- a/packages/lsp-smart-contracts/docs/contracts/UniversalProfile/contracts/UniversalProfile.md +++ b/packages/lsp-smart-contracts/docs/contracts/UniversalProfile/contracts/UniversalProfile.md @@ -776,7 +776,7 @@ function universalReceiver( ) external payable returns (bytes returnedValues); ``` -_Notifying the contract by calling its `universalReceiver` function with the following informations: typeId: `typeId`; data: `data`._ +_Notifying the contract by calling its `universalReceiver` function with the following information: typeId: `typeId`; data: `data`._ Achieves the goal of [LSP-1-UniversalReceiver] by allowing the account to be notified about incoming/outgoing transactions and enabling reactions to these actions. The reaction is achieved by having two external contracts ([LSP1UniversalReceiverDelegate]) that react on the whole transaction and on the specific typeId, respectively. The function performs the following steps: diff --git a/packages/lsp-smart-contracts/docs/libraries/LSP1UniversalReceiver/contracts/LSP1Utils.md b/packages/lsp-smart-contracts/docs/libraries/LSP1UniversalReceiver/contracts/LSP1Utils.md index b57da1178..d0302372e 100644 --- a/packages/lsp-smart-contracts/docs/libraries/LSP1UniversalReceiver/contracts/LSP1Utils.md +++ b/packages/lsp-smart-contracts/docs/libraries/LSP1UniversalReceiver/contracts/LSP1Utils.md @@ -16,7 +16,7 @@ > LSP1 Utility library. -LSP1Utils is a library of utility functions that can be used to notify the `universalReceiver` function of a contract that implements LSP1 and retrieve informations related to LSP1 `typeId`. Based on LSP1 Universal Receiver standard. +LSP1Utils is a library of utility functions that can be used to notify the `universalReceiver` function of a contract that implements LSP1 and retrieve information related to LSP1 `typeId`. Based on LSP1 Universal Receiver standard. ## Internal Methods diff --git a/packages/lsp0-contracts/contracts/LSP0ERC725AccountCore.sol b/packages/lsp0-contracts/contracts/LSP0ERC725AccountCore.sol index 9ea51e2f8..c38d7f971 100644 --- a/packages/lsp0-contracts/contracts/LSP0ERC725AccountCore.sol +++ b/packages/lsp0-contracts/contracts/LSP0ERC725AccountCore.sol @@ -424,7 +424,7 @@ abstract contract LSP0ERC725AccountCore is } /** - * @notice Notifying the contract by calling its `universalReceiver` function with the following informations: typeId: `typeId`; data: `data`. + * @notice Notifying the contract by calling its `universalReceiver` function with the following information: typeId: `typeId`; data: `data`. * * @dev Achieves the goal of [LSP-1-UniversalReceiver] by allowing the account to be notified about incoming/outgoing transactions and enabling reactions to these actions. * The reaction is achieved by having two external contracts ([LSP1UniversalReceiverDelegate]) that react on the whole transaction and on the specific typeId, respectively. diff --git a/packages/lsp1-contracts/contracts/LSP1Utils.sol b/packages/lsp1-contracts/contracts/LSP1Utils.sol index 6b541115e..f47162d76 100644 --- a/packages/lsp1-contracts/contracts/LSP1Utils.sol +++ b/packages/lsp1-contracts/contracts/LSP1Utils.sol @@ -21,7 +21,7 @@ import { * @title LSP1 Utility library. * @author Jean Cavallera , Yamen Merhi , Daniel Afteni * @dev LSP1Utils is a library of utility functions that can be used to notify the `universalReceiver` function of a contract - * that implements LSP1 and retrieve informations related to LSP1 `typeId`. + * that implements LSP1 and retrieve information related to LSP1 `typeId`. * Based on LSP1 Universal Receiver standard. */ library LSP1Utils { diff --git a/packages/lsp17contractextension-contracts/contracts/LSP17Extendable.sol b/packages/lsp17contractextension-contracts/contracts/LSP17Extendable.sol index 21d7d4c63..121654745 100644 --- a/packages/lsp17contractextension-contracts/contracts/LSP17Extendable.sol +++ b/packages/lsp17contractextension-contracts/contracts/LSP17Extendable.sol @@ -59,8 +59,8 @@ abstract contract LSP17Extendable is ERC165 { /** * @dev Returns the extension mapped to a specific function selector * If no extension was found, return the address(0) - * To be overrided. - * Up to the implementor contract to return an extension based on a function selector + * To be overridden. + * Up to the implementer contract to return an extension based on a function selector */ function _getExtensionAndForwardValue( bytes4 functionSelector diff --git a/packages/lsp17contractextension-contracts/contracts/LSP17ExtendableInitAbstract.sol b/packages/lsp17contractextension-contracts/contracts/LSP17ExtendableInitAbstract.sol index 99290b21a..565cdd0f4 100644 --- a/packages/lsp17contractextension-contracts/contracts/LSP17ExtendableInitAbstract.sol +++ b/packages/lsp17contractextension-contracts/contracts/LSP17ExtendableInitAbstract.sol @@ -61,8 +61,8 @@ abstract contract LSP17ExtendableInitAbstract is ERC165Upgradeable { /** * @dev Returns the extension mapped to a specific function selector * If no extension was found, return the address(0) - * To be overrided. - * Up to the implementor contract to return an extension based on a function selector + * To be overridden. + * Up to the implementer contract to return an extension based on a function selector */ function _getExtensionAndForwardValue( bytes4 functionSelector diff --git a/packages/lsp23-contracts/contracts/LSP23Errors.sol b/packages/lsp23-contracts/contracts/LSP23Errors.sol index c1a661ae8..28eacd929 100644 --- a/packages/lsp23-contracts/contracts/LSP23Errors.sol +++ b/packages/lsp23-contracts/contracts/LSP23Errors.sol @@ -8,17 +8,17 @@ pragma solidity ^0.8.4; error InvalidValueSum(); /** - * @dev Reverts when the deployment & intialization of the contract has failed. + * @dev Reverts when the deployment & initialization of the contract has failed. * @notice Failed to deploy & initialize the Primary Contract Proxy. Error: `errorData`. * - * @param errorData Potentially information about why the deployment & intialization have failed. + * @param errorData Potentially information about why the deployment & initialization have failed. */ error PrimaryContractProxyInitFailureError(bytes errorData); /** - * @dev Reverts when the deployment & intialization of the secondary contract has failed. + * @dev Reverts when the deployment & initialization of the secondary contract has failed. * @notice Failed to deploy & initialize the Secondary Contract Proxy. Error: `errorData`. * - * @param errorData Potentially information about why the deployment & intialization have failed. + * @param errorData Potentially information about why the deployment & initialization have failed. */ error SecondaryContractProxyInitFailureError(bytes errorData); diff --git a/packages/lsp25-contracts/contracts/LSP25MultiChannelNonce.sol b/packages/lsp25-contracts/contracts/LSP25MultiChannelNonce.sol index 7e43cb9d9..03e6316e3 100644 --- a/packages/lsp25-contracts/contracts/LSP25MultiChannelNonce.sol +++ b/packages/lsp25-contracts/contracts/LSP25MultiChannelNonce.sol @@ -15,7 +15,7 @@ import {RelayCallBeforeStartTime, RelayCallExpired} from "./LSP25Errors.sol"; * @author Jean Cavallera (CJ42) * @dev This contract can be used as a backbone for other smart contracts to implement meta-transactions via the LSP25 Execute Relay Call interface. * - * It contains a storage of nonces for signer addresses across various channel IDs, enabling these signers to submit signed transactions that order-independant. + * It contains a storage of nonces for signer addresses across various channel IDs, enabling these signers to submit signed transactions that order-independent. * (transactions that do not need to be submitted one after the other in a specific order). * * Finally, it contains internal functions to verify signatures for specific calldata according the signature format specified in the LSP25 standard. diff --git a/packages/lsp6-contracts/contracts/Mocks/KeyManagerInternalsTester.sol b/packages/lsp6-contracts/contracts/Mocks/KeyManagerInternalsTester.sol index e48ccaa55..7e13c43b4 100644 --- a/packages/lsp6-contracts/contracts/Mocks/KeyManagerInternalsTester.sol +++ b/packages/lsp6-contracts/contracts/Mocks/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 diff --git a/packages/lsp9-contracts/contracts/LSP9VaultCore.sol b/packages/lsp9-contracts/contracts/LSP9VaultCore.sol index 7f0754286..e5abaf67d 100644 --- a/packages/lsp9-contracts/contracts/LSP9VaultCore.sol +++ b/packages/lsp9-contracts/contracts/LSP9VaultCore.sol @@ -315,7 +315,7 @@ contract LSP9VaultCore is } /** - * @notice Notifying the contract by calling its `universalReceiver` function with the following informations: typeId: `typeId`; data: `data`. + * @notice Notifying the contract by calling its `universalReceiver` function with the following information: typeId: `typeId`; data: `data`. * * @dev Achieves the goal of [LSP-1-UniversalReceiver] by allowing the account to be notified about incoming/outgoing transactions and enabling reactions to these actions. * The reaction is achieved by having two external contracts ([LSP1UniversalReceiverDelegate]) that react on the whole transaction and on the specific typeId, respectively.