lukso-network · CJ42 · Nov 22, 2024 · Nov 22, 2024 · Nov 22, 2024 · Nov 25, 2024
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -21,7 +21,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: '18.18.1'
+          node-version: '20.x'
           cache: 'yarn'
 
       - name: Install ⚙️
@@ -44,7 +44,7 @@ jobs:
 
       - uses: actions/setup-node@v4
         with:
-          node-version: '18.18.1'
+          node-version: '20.x'
           cache: 'yarn'
 
       - name: Install ⚙️

diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml
@@ -1,10 +1,12 @@
 # This workflow checks for common grammar and spelling mistake in markdown docs files.
 name: Spellcheck
-on: workflow_dispatch
+on:
+  pull_request:
+    branches: [main]
 
 jobs:
   build:
-    name: Spellcheck
+    name: Check Grammar and Spelling errors
     runs-on: ubuntu-latest
     steps:
       - name: Checkout 🛎️
@@ -15,12 +17,13 @@ jobs:
       - name: Install ⚙️
         run: yarn install --frozen-lockfile
 
-      - name: Spellcheck 📝
-        uses: rojopolis/spellcheck-github-actions@0.33.0
+      - name: Check spelling errors in code snippets 🔍
+        uses: codespell-project/actions-codespell@v2
         with:
-          source_files: docs/**/*.md docs/**/*.mdx
-          task_name: Markdown
-          output_file: spellcheck-output.txt
+          check_filenames: true
+          check_hidden: true
+          skip: yarn.lock,./node_modules/**/*,./node_modules/.*,./yarn/**/*,./.yarn/**/*
+          ignore_words_list: datas
 
       - name: Output Spellcheck Results 📝
         uses: actions/upload-artifact@v3

diff --git a/CONTIBRUTING.md b/CONTIBRUTING.md
@@ -75,5 +75,5 @@ description: 'LUKSO ecosystem feature requests: developer events, hackathons, gr
 
 ```markdown
 [Global Page](`./install-up-browser-extension`)
-[Internal Documentation Page](`../standards/indroduction.md`)
+[Internal Documentation Page](`../standards/introduction.md`)
 ```
@@ -7,7 +7,7 @@
 | **LSP0ERC725Account**             | `0x24871b3d` | Interface of the [LSP-0-ERC725Account] standard, an account based smart contract that represents an identity on-chain.                                   |
 | **LSP1UniversalReceiver**         | `0x6bb56a14` | Interface of the LSP1 - Universal Receiver standard, an entry function for a contract to receive arbitrary information.                                  |
 | **LSP1UniversalReceiverDelegate** | `0xa245bbda` | Interface of the LSP1 - Universal Receiver Delegate standard.                                                                                            |
-| **LSP6KeyManager**                | `0x23f34c62` | Interface of the LSP6 - Key Manager standard, a contract acting as a controller of an ERC725 Account using predfined permissions.                        |
+| **LSP6KeyManager**                | `0x23f34c62` | Interface of the LSP6 - Key Manager standard, a contract acting as a controller of an ERC725 Account using predefined permissions.                       |
 | **LSP7DigitalAsset**              | `0xb3c4928f` | Interface of the LSP7 - Digital Asset standard, a fungible digital asset.                                                                                |
 | **LSP8IdentifiableDigitalAsset**  | `0x3a271706` | Interface of the LSP8 - Identifiable Digital Asset standard, a non-fungible digital asset.                                                               |
 | **LSP9Vault**                     | `0x28af17e6` | Interface of LSP9 - Vault standard, a blockchain vault that can hold assets and interact with other smart contracts.                                     |

@@ -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:
 

@@ -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
 
 <br/>
@@ -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
 

@@ -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
 
 <br/>
 

@@ -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.
 
 :::
 

@@ -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.
 
 :::
 

@@ -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
 

@@ -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
 

@@ -339,13 +339,13 @@ error PrimaryContractProxyInitFailureError(bytes errorData);
 
 _Failed to deploy & initialise the Primary Contract Proxy. Error: `errorData`._
 
-Reverts when the deployment & intialisation of the contract has failed.
+Reverts when the deployment & initialisation of the contract has failed.
 
 #### Parameters
 
 | Name        |  Type   | Description                                                                   |
 | ----------- | :-----: | ----------------------------------------------------------------------------- |
-| `errorData` | `bytes` | Potentially information about why the deployment & intialisation have failed. |
+| `errorData` | `bytes` | Potentially information about why the deployment & initialisation have failed. |
 
 <br/>
 
@@ -366,13 +366,13 @@ error SecondaryContractProxyInitFailureError(bytes errorData);
 
 _Failed to deploy & initialise the Secondary Contract Proxy. Error: `errorData`._
 
-Reverts when the deployment & intialisation of the secondary contract has failed.
+Reverts when the deployment & initialisation of the secondary contract has failed.
 
 #### Parameters
 
 | Name        |  Type   | Description                                                                   |
 | ----------- | :-----: | ----------------------------------------------------------------------------- |
-| `errorData` | `bytes` | Potentially information about why the deployment & intialisation have failed. |
+| `errorData` | `bytes` | Potentially information about why the deployment & initialisation have failed. |
 
 <br/>
 

@@ -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. |
 
 <br/>
 
@@ -392,13 +392,13 @@ 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. |
 
 <br/>
 <!-- GLOBAL LINKS -->

@@ -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
 

@@ -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`. |
 
 <br/>
 

@@ -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`.       |
 
 <br/>
 
@@ -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
 

@@ -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`.       |
 
 <br/>
 
@@ -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