From 566b63dc29ea59fa01ef1bc05a8d002e3b7f20ad Mon Sep 17 00:00:00 2001 From: CJ42 Date: Mon, 25 Nov 2024 15:34:47 +0700 Subject: [PATCH] chore: fix spelling errors caught by CI --- .github/workflows/spellcheck.yml | 1 + CONTIBRUTING.md | 2 +- docs/contracts/_interface_ids_table.mdx | 2 +- .../LSP0ERC725Account/LSP0ERC725Account.md | 2 +- .../LSP11BasicSocialRecovery.md | 6 +++--- .../LSP17ContractExtension/LSP17Extendable.md | 4 ++-- .../LSP1UniversalReceiverDelegateUP.md | 4 ++-- .../LSP1UniversalReceiverDelegateUP.md | 4 ++-- .../LSP1UniversalReceiverDelegateVault.md | 6 +++--- .../LSP1UniversalReceiverDelegateVault.md | 6 +++--- .../LSP23LinkedContractsFactory.md | 8 ++++---- .../LSP23LinkedContractsFactory.md | 8 ++++---- .../LSP25MultiChannelNonce.md | 2 +- .../LSP6KeyManager/LSP6KeyManager.md | 4 ++-- .../LSP7DigitalAsset/LSP7DigitalAsset.md | 8 ++++---- .../extensions/LSP7Burnable.md | 8 ++++---- .../extensions/LSP7CappedSupply.md | 8 ++++---- .../extensions/LSP7CompatibleERC20.md | 8 ++++---- .../presets/LSP7CompatibleERC20Mintable.md | 8 ++++---- .../LSP7DigitalAsset/presets/LSP7Mintable.md | 8 ++++---- .../LSP8IdentifiableDigitalAsset.md | 6 +++--- .../extensions/LSP8Burnable.md | 6 +++--- .../extensions/LSP8CappedSupply.md | 6 +++--- .../extensions/LSP8CompatibleERC721.md | 6 +++--- .../extensions/LSP8Enumerable.md | 4 ++-- .../presets/LSP8CompatibleERC721Mintable.md | 6 +++--- .../presets/LSP8Mintable.md | 6 +++--- .../contracts/LSP9Vault/LSP9Vault.md | 2 +- docs/contracts/contracts/UniversalProfile.md | 2 +- .../UniversalProfile/UniversalProfile.md | 2 +- docs/contracts/deployed-contracts.md | 2 +- docs/contracts/introduction.md | 8 ++++---- docs/contracts/libraries/LSP1Utils.md | 2 +- docs/contracts/overview/KeyManager.md | 4 ++-- docs/contracts/overview/LSP1Delegate.md | 2 +- docs/contracts/type-ids.md | 2 +- docs/faq/lukso/project-differentiation.md | 2 +- docs/faq/lukso/project-origins.md | 2 +- docs/faq/network/node-setup.md | 4 ++-- docs/faq/onboarding/lukso-standards.md | 2 +- .../cascade-and-sense-support.md | 2 +- .../metadata-management/read-asset-data.md | 4 ++-- .../digital-assets/nft/read-nft-metadata.md | 6 +++--- docs/learn/migrate/migrate-erc20-to-lsp7.md | 2 +- docs/learn/migrate/migrate-erc721-to-lsp8.md | 2 +- .../deploy-multichain-contracts.md | 6 +++--- docs/learn/overview.md | 2 +- .../extend-profile-functionalities.md | 8 ++++---- .../connect-profile/connect-up.md | 2 +- .../interactions/transfer-lyx.md | 4 ++-- .../interactions/transfer-tokens-and-nfts.md | 6 +++--- .../key-manager/execute-relay-transactions.md | 4 ++-- .../key-manager/grant-permissions.md | 2 +- .../metadata/read-profile-data.md | 4 ++-- .../create-receiver-forwarder.md | 8 ++++---- docs/learn/vault/edit-vault-data.md | 8 ++++---- docs/networks/mainnet/running-a-node.md | 2 +- docs/networks/testnet/running-a-node.md | 2 +- .../access-control/lsp14-ownable-2-step.md | 6 +++--- .../access-control/lsp6-key-manager.md | 6 +++--- docs/standards/accounts/lsp0-erc725account.md | 2 +- .../accounts/lsp17-contract-extension.md | 2 +- .../accounts/lsp25-execute-relay-call.md | 2 +- .../factories/lsp16-universal-factory.md | 6 +++--- .../lsp23-linked-contracts-factory.md | 2 +- docs/standards/introduction.md | 2 +- docs/standards/metadata/lsp2-json-schema.md | 2 +- .../tokens/LSP4-Digital-Asset-Metadata.md | 2 +- docs/standards/tokens/LSP7-Digital-Asset.md | 2 +- docs/tools/libraries/erc725js/methods.md | 2 +- .../lsp-utils/LSP23LinkedContractsFactory.md | 2 +- .../libraries/lsp-utils/LSP5ReceivedAssets.md | 2 +- .../libraries/lsp-utils/LSP6KeyManager.md | 6 +++--- docs/tools/services/rpc-api.md | 2 +- spellcheck.log | 19 +++++++++++++++++++ src/components/ContractCardsGallery/index.tsx | 2 +- src/components/StandardsGallery/index.tsx | 2 +- 77 files changed, 174 insertions(+), 154 deletions(-) create mode 100644 spellcheck.log diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index 61754cce3b..64b9cc2bab 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -23,6 +23,7 @@ jobs: 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 index 8ee44e779e..214f61858d 100644 --- 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`) ``` diff --git a/docs/contracts/_interface_ids_table.mdx b/docs/contracts/_interface_ids_table.mdx index d20fb1a5d3..8411b09e52 100644 --- a/docs/contracts/_interface_ids_table.mdx +++ b/docs/contracts/_interface_ids_table.mdx @@ -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. | diff --git a/docs/contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md b/docs/contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md index b74a1505fa..4388617865 100644 --- a/docs/contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md +++ b/docs/contracts/contracts/LSP0ERC725Account/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/docs/contracts/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md b/docs/contracts/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md index eefb5e73dc..7c4e4dff39 100644 --- a/docs/contracts/contracts/LSP11BasicSocialRecovery/LSP11BasicSocialRecovery.md +++ b/docs/contracts/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/docs/contracts/contracts/LSP17ContractExtension/LSP17Extendable.md b/docs/contracts/contracts/LSP17ContractExtension/LSP17Extendable.md index de2356e293..69354f8011 100644 --- a/docs/contracts/contracts/LSP17ContractExtension/LSP17Extendable.md +++ b/docs/contracts/contracts/LSP17ContractExtension/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/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP.md b/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP.md index 1c4bb0da9e..b08ec1df24 100644 --- a/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP.md +++ b/docs/contracts/contracts/LSP1UniversalReceiver/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/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md b/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md index 4dde9b462a..62b70d1109 100644 --- a/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/LSP1UniversalReceiverDelegateUP.md +++ b/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateUP/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/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault.md b/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault.md index 4e0e203335..f2e555a2b8 100644 --- a/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault.md +++ b/docs/contracts/contracts/LSP1UniversalReceiver/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/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md b/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md index 368b822868..6307e90bed 100644 --- a/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/LSP1UniversalReceiverDelegateVault.md +++ b/docs/contracts/contracts/LSP1UniversalReceiver/LSP1UniversalReceiverDelegateVault/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/docs/contracts/contracts/LSP23LinkedContractsDeployment/LSP23LinkedContractsFactory.md b/docs/contracts/contracts/LSP23LinkedContractsDeployment/LSP23LinkedContractsFactory.md index c8fb6f8468..8133416476 100644 --- a/docs/contracts/contracts/LSP23LinkedContractsDeployment/LSP23LinkedContractsFactory.md +++ b/docs/contracts/contracts/LSP23LinkedContractsDeployment/LSP23LinkedContractsFactory.md @@ -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. |
@@ -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. |
diff --git a/docs/contracts/contracts/LSP23LinkedContractsFactory/LSP23LinkedContractsFactory.md b/docs/contracts/contracts/LSP23LinkedContractsFactory/LSP23LinkedContractsFactory.md index cc815d3f98..36cb1030b8 100644 --- a/docs/contracts/contracts/LSP23LinkedContractsFactory/LSP23LinkedContractsFactory.md +++ b/docs/contracts/contracts/LSP23LinkedContractsFactory/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,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. |
diff --git a/docs/contracts/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md b/docs/contracts/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md index 773a9dbf73..25cc351bb6 100644 --- a/docs/contracts/contracts/LSP25ExecuteRelayCall/LSP25MultiChannelNonce.md +++ b/docs/contracts/contracts/LSP25ExecuteRelayCall/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/docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md b/docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md index 85613ad425..cacf6db911 100644 --- a/docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md +++ b/docs/contracts/contracts/LSP6KeyManager/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/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md b/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md index 4fabf13e16..fd98e976ee 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/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/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md index d5ecec050c..8ef79de142 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7Burnable.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/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/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md index 5c0d299173..3aa92fd57d 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CappedSupply.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/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/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md index 7917357227..d378bc992a 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/extensions/LSP7CompatibleERC20.md @@ -308,7 +308,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 @@ -1061,7 +1061,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`. |
@@ -1091,7 +1091,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 @@ -1116,7 +1116,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/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md b/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md index 0161d72f22..1f0e5b8d75 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7CompatibleERC20Mintable.md @@ -315,7 +315,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 @@ -1101,7 +1101,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`. |
@@ -1131,7 +1131,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 @@ -1156,7 +1156,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/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md b/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md index 99fde2ae22..9e8388e4b1 100644 --- a/docs/contracts/contracts/LSP7DigitalAsset/presets/LSP7Mintable.md +++ b/docs/contracts/contracts/LSP7DigitalAsset/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/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md index 45152088eb..fc2b0ea465 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/LSP8IdentifiableDigitalAsset.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/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/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Burnable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Burnable.md index 3d623117a9..9f703d2e4b 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Burnable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/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/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CappedSupply.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CappedSupply.md index 9841715d8b..ee12adcddc 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CappedSupply.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/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/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md index 7357fc5c76..8fcc8c1a74 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8CompatibleERC721.md @@ -1112,7 +1112,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. |
@@ -1462,7 +1462,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 @@ -1487,7 +1487,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/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Enumerable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Enumerable.md index 37095361cf..db685e7a88 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/extensions/LSP8Enumerable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/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/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md index 7571dd9830..4caa1d5224 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8CompatibleERC721Mintable.md @@ -1156,7 +1156,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. |
@@ -1506,7 +1506,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 @@ -1531,7 +1531,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/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.md b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.md index bdaaa1fce3..e665e656af 100644 --- a/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/presets/LSP8Mintable.md +++ b/docs/contracts/contracts/LSP8IdentifiableDigitalAsset/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/docs/contracts/contracts/LSP9Vault/LSP9Vault.md b/docs/contracts/contracts/LSP9Vault/LSP9Vault.md index ded563c24c..7b74a92fb3 100644 --- a/docs/contracts/contracts/LSP9Vault/LSP9Vault.md +++ b/docs/contracts/contracts/LSP9Vault/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/docs/contracts/contracts/UniversalProfile.md b/docs/contracts/contracts/UniversalProfile.md index 0af3ab61c4..1af69dc7ab 100644 --- a/docs/contracts/contracts/UniversalProfile.md +++ b/docs/contracts/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/docs/contracts/contracts/UniversalProfile/UniversalProfile.md b/docs/contracts/contracts/UniversalProfile/UniversalProfile.md index 289bba5c56..4257ec4e56 100644 --- a/docs/contracts/contracts/UniversalProfile/UniversalProfile.md +++ b/docs/contracts/contracts/UniversalProfile/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/docs/contracts/deployed-contracts.md b/docs/contracts/deployed-contracts.md index a595db9ac2..5ae0aa66ce 100644 --- a/docs/contracts/deployed-contracts.md +++ b/docs/contracts/deployed-contracts.md @@ -13,7 +13,7 @@ Check our guide [**_🏭 Deploy Universal Profile + its Key Manager with LSP23 F ::: -Below is a list of contracts deployed on the LUKSO Mainnet for production usage. These contracts are deployed with `CREATE2` using the Nick Factory, so that they can be re-deployed at different addresses accross multiple chains. +Below is a list of contracts deployed on the LUKSO Mainnet for production usage. These contracts are deployed with `CREATE2` using the Nick Factory, so that they can be re-deployed at different addresses across multiple chains. ## 🏭 Factory contracts diff --git a/docs/contracts/introduction.md b/docs/contracts/introduction.md index 2016aa8e5f..007294e522 100644 --- a/docs/contracts/introduction.md +++ b/docs/contracts/introduction.md @@ -157,10 +157,10 @@ The **LSP16 Universal Factory** or **LSP23 Linked Contract Deployment** can help The `@lukso/lsp-smart-contracts` repository contains two types of contracts: -| Type | Description | Example | -| ---------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------- | -| **Standard contracts** | One contract deployed per user. Deployed and initialized via a `constructor`. | `LSP0ERC725Account.sol` | -| **Base contracts** | Deploy one contract for all users. To be used as base contract behind proxies. Initialized via a `initalize(...)` function. | `LSP0ERC725AccountInit.sol` | +| Type | Description | Example | +| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------- | +| **Standard contracts** | One contract deployed per user. Deployed and initialized via a `constructor`. | `LSP0ERC725Account.sol` | +| **Base contracts** | Deploy one contract for all users. To be used as base contract behind proxies. Initialized via a `initialize(...)` function. | `LSP0ERC725AccountInit.sol` | ## LSP Recipes diff --git a/docs/contracts/libraries/LSP1Utils.md b/docs/contracts/libraries/LSP1Utils.md index b57da1178d..d0302372ea 100644 --- a/docs/contracts/libraries/LSP1Utils.md +++ b/docs/contracts/libraries/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/docs/contracts/overview/KeyManager.md b/docs/contracts/overview/KeyManager.md index ef182255fe..ed2ab68eb2 100644 --- a/docs/contracts/overview/KeyManager.md +++ b/docs/contracts/overview/KeyManager.md @@ -23,7 +23,7 @@ You can then grant partial access to any address so that they can use your Unive | Example | Description | Permissions | | :-------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------- | | Treasury & Funds Manager | Allow certain addresses to transfer your native tokens (or any LSP7 tokens) to certain specific addresses (_e.g: allow a crypto accountant or treasury manager to manage your funds on your behalf, allow a video game dApp to transfer the game tokens, etc..._) | `SUPER_TRANSFERVALUE`
or `TRANSFERVALUE` + Allowed Calls on specific addresses
or `CALL` + Allowed Calls on certain token addresses. | -| Brand Manager | Allow certain addresses representating Marketing managers to either manage the metadata (and branding) of your Universal Profile, or the metadata of any NFT collections created by your Universal Profile. | `SETDATA` + Allowed ERC725Y Data Keys to manage the UP
`CALL` + Allowed Calls on specific NFT collection contract addresses. | +| Brand Manager | Allow certain addresses representing Marketing managers to either manage the metadata (and branding) of your Universal Profile, or the metadata of any NFT collections created by your Universal Profile. | `SETDATA` + Allowed ERC725Y Data Keys to manage the UP
`CALL` + Allowed Calls on specific NFT collection contract addresses. | | Metadata Manager | Allow certain dApps to store some user settings related to the dApp under the Universal Profile's storage, and allow each specific dApp to update these specific data only. | `SETDATA` + Allowed ERC725Y Data Keys | | Universal Receiver Delegate | Allow your Universal Receiver Delegate to operate automatically when receiving tokens or NFTs (_e.g: add / remove them in your received assets, automatically transfer a certain percentage of tokens received into a saving vault, save certain valuable NFTs into a vault, etc..._) | | | Social Recovery | Plug a service to gain you back access to your 🆙 if you have a lost access to your main controller private key / address. | `ADDCONTROLLER` | @@ -72,7 +72,7 @@ If controller has `CALL` permission but has no `AllowedCalls`, controller will n ::: -Key Manager allows for restricting controller addresses to be able to call specific functions on specific addresses which should be of a specific standard. In order to achieve such functionallity one could encode a set of type calls, addresses, standards and functions to [`bytes[CompactBytesArray]`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-2-ERC725YJSONSchema.md#bytesncompactbytesarray), and store them under the [Allowed Calls](../../standards/access-control/lsp6-key-manager.md#allowed-calls) data key. +Key Manager allows for restricting controller addresses to be able to call specific functions on specific addresses which should be of a specific standard. In order to achieve such functionality one could encode a set of type calls, addresses, standards and functions to [`bytes[CompactBytesArray]`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-2-ERC725YJSONSchema.md#bytesncompactbytesarray), and store them under the [Allowed Calls](../../standards/access-control/lsp6-key-manager.md#allowed-calls) data key. _E.g._ diff --git a/docs/contracts/overview/LSP1Delegate.md b/docs/contracts/overview/LSP1Delegate.md index 9dac7ebef0..9e61b9738f 100644 --- a/docs/contracts/overview/LSP1Delegate.md +++ b/docs/contracts/overview/LSP1Delegate.md @@ -14,7 +14,7 @@ There are two default implementations of the LSP1 Delegate contracts available, ## Routing -The Universal Profile implementation allows for attaching multiple instances of Universal Receiver Delegate to it. This is due to LSP1 Routing. You could have a single General Purpose Unviersal Receiver Delegate and multiple instances of Specific Unviersal Receiver Delegate. +The Universal Profile implementation allows for attaching multiple instances of Universal Receiver Delegate to it. This is due to LSP1 Routing. You could have a single General Purpose Universal Receiver Delegate and multiple instances of Specific Universal Receiver Delegate. A General Purpose Universal Receiver Delegate has its address stored under the [LSP1UniversalReceiverDelegate Singleton](/standards/accounts/lsp1-universal-receiver-delegate.md#lsp1universalreceiverdelegate-singleton) data key. This contract will be called on any LSP1 hook, meaning that it can potentially react on any [TypeID](../type-ids.md#universal-receiver-type-ids). diff --git a/docs/contracts/type-ids.md b/docs/contracts/type-ids.md index 3f0f6f4490..36d85a4819 100644 --- a/docs/contracts/type-ids.md +++ b/docs/contracts/type-ids.md @@ -9,7 +9,7 @@ The **LSP1 type Ids** listed below correspond to unique identifiers used across They are used by various smart contracts to notify sender and recipients contracts implementing LSP1 about various incoming or outgoing information. For instance, notify a sender that some LSP7 tokens are being transferred from its balance, or a recipient about receiving some LSP7 tokens. -The type Ids listed below cna be exported and accessed from the `@lukso/lsp-smart-contracts` package as follow: +The type Ids listed below can be exported and accessed from the `@lukso/lsp-smart-contracts` package as follow: ```js import { LSP1_TYPE_IDS } from "@lukso/lsp-smart-contracts"; diff --git a/docs/faq/lukso/project-differentiation.md b/docs/faq/lukso/project-differentiation.md index 0fb708bef7..f24750ad1f 100644 --- a/docs/faq/lukso/project-differentiation.md +++ b/docs/faq/lukso/project-differentiation.md @@ -12,7 +12,7 @@ The [Ethereum Name Service](https://docs.ens.domains/) (ENS) and Universal Profi ENS is a **naming system** for accounts on the Ethereum blockchain. It functions similarly to the internet's domain name system (DNS), enabling users to replace long, complex blockchain addresses with verifiable human-friendly names. Name services make it easier for users to send transactions and interact with smart contracts without remembering their account addresses. Users can even add additional information, such as social media links, email addresses, keywords, or profile pictures. -Universal Profiles, on the other hand, are **accounts acting as the center for your user profile, persona and blockchain interactions**. They can have extensive and editable informations directly embedded on them (on the smart contract that represents the Universal Profile) while also being able to interact with on-chain applications, just as regular wallets. In comparison, information associated to an ENS name is stored and maintained within a global ENS registry service. +Universal Profiles, on the other hand, are **accounts acting as the center for your user profile, persona and blockchain interactions**. They can have extensive and editable information directly embedded on them (on the smart contract that represents the Universal Profile) while also being able to interact with on-chain applications, just as regular wallets. In comparison, information associated to an ENS name is stored and maintained within a global ENS registry service. While name services are convenient for transferring assets, they are **not as fitting to maintain an on-chain persona**. The domains can not be secured with multiple keys, have limited attachable information, and require payments to keep your domain names. If the subscription expires, all historical transactions no longer bear this name, meaning **users would lose their** verifiable information and **reputation** connected to the name. Anyone else could rebuy the domain and assume the identity associated with it. Universal Profiles can tackle such concerns, as they have convenience features such as **permission management and rotatable keys**. However, Universal Profiles are accounts and have regular blockchain addresses. diff --git a/docs/faq/lukso/project-origins.md b/docs/faq/lukso/project-origins.md index 3ce259e77c..cf441a523c 100644 --- a/docs/faq/lukso/project-origins.md +++ b/docs/faq/lukso/project-origins.md @@ -42,7 +42,7 @@ The official address of the Genesis Deposit Contract is [`0x42000421dd80d1e90e56 The deposit contract called the external LYXe [ERC777](https://ethereum.org/de/developers/docs/standards/tokens/erc-777/) token contract to lock the deposit amounts. To prepare the genesis files of the mainnet launch featured a freeze. Therefore, the deposit contract featured checks if a public key has been registered, preventing duplicate deposits. Only static deposit amounts of 32 LYX were allowed. -The freeze also came with a delay function to allow people to have time still after the LUKSO team triggered it. Each validator that went through the Genesis Launchpad stored not only the LYXe token but also a vote for the initial coin supply of the mainnet. The additional data was stored on-chain to have a publically verifiable source of the initial LYX supply and distribution. +The freeze also came with a delay function to allow people to have time still after the LUKSO team triggered it. Each validator that went through the Genesis Launchpad stored not only the LYXe token but also a vote for the initial coin supply of the mainnet. The additional data was stored on-chain to have a publicly verifiable source of the initial LYX supply and distribution. ## How was the token supply of LUKSO determined? diff --git a/docs/faq/network/node-setup.md b/docs/faq/network/node-setup.md index 63632af2e9..b4b1057020 100644 --- a/docs/faq/network/node-setup.md +++ b/docs/faq/network/node-setup.md @@ -30,7 +30,7 @@ Currently, LUKSO officially supports Geth, Erigon, Lighthouse, and Prysm. All cl ## Should I run an archive or a full node? -A full node downloads the entire blockchain and validates all blocks and transactions against the network's consensus rules. It stores the **current state of the network, including account balances, contracts, storage, and other informatio**n. However, it does not keep all historical states. If you need to check the balance of an account at a specific block height in the past, a full node cannot provide this information directly. +A full node downloads the entire blockchain and validates all blocks and transactions against the network's consensus rules. It stores the **current state of the network, including account balances, contracts, storage, and other information**. However, it does not keep all historical states. If you need to check the balance of an account at a specific block height in the past, a full node cannot provide this information directly. An archive node is a particular type of full node. It also downloads the entire blockchain and validates all blocks and transactions like a full node. In addition to the current state of the network, it **also stores all historical states since the genesis block**. Keeping the entire historical state makes an archive node much more storage extensive than a full node, but it allows you to query any historical state directly on the node. @@ -72,7 +72,7 @@ You can further read about setting up automation within the [service guide](http Yes, running multiple nodes from the same home network is possible. What matters is the public IP of the node devices, which will be different. However, when you run multiple nodes in one network, you must modify and forward the ports they use, so they do not communicate over the same channel and block each other. -## Is there a way to save time on synching during the node setup? +## Is there a way to save time on syncing during the node setup? Yes. You can use the LUKSO checkpoint synchronization service to **dramatically speed up the process of synchronizing** the consensus client. If enabled, your node will begin syncing from a recently finalized consensus checkpoint instead of genesis. It will then download the rest of the blockchain data while your consensus runs. The shortcut is ideal for fresh installations, validator migration, or recovery. diff --git a/docs/faq/onboarding/lukso-standards.md b/docs/faq/onboarding/lukso-standards.md index 841508c480..ecd59cd23a 100644 --- a/docs/faq/onboarding/lukso-standards.md +++ b/docs/faq/onboarding/lukso-standards.md @@ -30,7 +30,7 @@ With LSPs, the mission is to have standards that facilitate using tools that abs ## What's the recommended language for LSP development? -If you want to build on the LUKSO blockchain, the recommended programming language is Solidity. It is the implementation language of LSPs, the most commonly used language for the EVM, and the default implementation langauge for LSPs. +If you want to build on the LUKSO blockchain, the recommended programming language is Solidity. It is the implementation language of LSPs, the most commonly used language for the EVM, and the default implementation language for LSPs. ## Why are LSPs not proposed as ERCs? diff --git a/docs/learn/digital-assets/metadata-management/cascade-and-sense-support.md b/docs/learn/digital-assets/metadata-management/cascade-and-sense-support.md index e9acc41d68..991d9be523 100644 --- a/docs/learn/digital-assets/metadata-management/cascade-and-sense-support.md +++ b/docs/learn/digital-assets/metadata-management/cascade-and-sense-support.md @@ -72,7 +72,7 @@ if (result) { ### Retrieve activation ticket transaction id -To get activation ticket transaction status and id, you can use `retrieveTxId` funciton of provider. +To get activation ticket transaction status and id, you can use `retrieveTxId` function of provider. ``` const { result_id } = await provider.uploadToCascade(file); diff --git a/docs/learn/digital-assets/metadata-management/read-asset-data.md b/docs/learn/digital-assets/metadata-management/read-asset-data.md index 0a693382dd..54abd1a0c3 100644 --- a/docs/learn/digital-assets/metadata-management/read-asset-data.md +++ b/docs/learn/digital-assets/metadata-management/read-asset-data.md @@ -67,7 +67,7 @@ Optionally, you can also find a full list of interface IDs on the [Contracts > I ::: -First, we need to check if the contract is a digital asset, as either an LSP7 or an LSP8 smart contract. To do so, we will do the same way as shown in the [**Interface Detection**](../../standard-detection.md#interface-detection) guide: call the `supportsInterface(bytes4)` function in te smart contract, checking for various interface IDs. +First, we need to check if the contract is a digital asset, as either an LSP7 or an LSP8 smart contract. To do so, we will do the same way as shown in the [**Interface Detection**](../../standard-detection.md#interface-detection) guide: call the `supportsInterface(bytes4)` function in the smart contract, checking for various interface IDs. @@ -384,6 +384,6 @@ Based on the [token type](#detect-the-token-type), the information of the [LSP4 :::tip Token ID Entries -- If your asset is a Token (`tokenType = 0`), individual metadata **cant be set**, due to the lack of token IDs. +- If your asset is a Token (`tokenType = 0`), individual metadata **can't be set**, due to the lack of token IDs. - If your asset is an NFT (`tokenType = 1`), individual metadata **may be set in addition** to the global token information. - If your asset is a Collection (`tokenType = 2`), the token ID-specific medatada is **mandatory**. diff --git a/docs/learn/digital-assets/nft/read-nft-metadata.md b/docs/learn/digital-assets/nft/read-nft-metadata.md index 671d13481c..c280aa386c 100644 --- a/docs/learn/digital-assets/nft/read-nft-metadata.md +++ b/docs/learn/digital-assets/nft/read-nft-metadata.md @@ -389,7 +389,7 @@ Assets created with LSP versions below 🛠️ [`@lukso/lsp-smart-contracts`](.. ::: -You can fetch the [`LSP8TokenMetadataBaseURI`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenmetadatabaseuri) and build the correct metadata link by concatinating the [formatted](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenidformat) token ID. Based on the [`LSP8TokenIDFormat`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenidformat), the Base URI can either be: +You can fetch the [`LSP8TokenMetadataBaseURI`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenmetadatabaseuri) and build the correct metadata link by concatenating the [formatted](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenidformat) token ID. Based on the [`LSP8TokenIDFormat`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenidformat), the Base URI can either be: - **equal across all token IDs**: To fetch the global Base URI, use the [`getData(...)`](../../../contracts/contracts/ERC725/ERC725.md#getdata) function of the asset to receive the [ERC725Y data storage](/standards/erc725.md#erc725y-generic-data-keyvalue-store). This applies if the [`LSP8TokenIDFormat`](#preparing-the-token-ids) is `0, 1, 2, or 4`. - **mixed across all token IDs**: To fetch the individual Base URI, use the [`getDataFromTokenID(...)`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#getdatafortokenid) function using a specific token ID. This has to be done if the [`LSP8TokenIDFormat`](#preparing-the-token-ids) is `100, 101, 102, or 104`. @@ -501,7 +501,7 @@ function generateMetadataLink(link: string) { // Use your default IPFS Gateway address return link; } - // If link has custom protocoll, adjust the link + // If link has custom protocol, adjust the link if (link.startsWith('ipfs://')) { // Use your default IPFS Gateway address return `https://api.universalprofile.cloud/ipfs/${link.slice(7)}`; @@ -529,7 +529,7 @@ if (metadataJsonLink) { -If you retrieved the metadata using [`LSP8TokenMetadataBaseURI`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenmetadatabaseuri), the URL will always be generated by combining the Base URL with previously prepared token ID as Byte32 Hex String. You can simply concatinate them to retrieve the full link. However, the token ID needs to be decoded first. +If you retrieved the metadata using [`LSP8TokenMetadataBaseURI`](https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-8-IdentifiableDigitalAsset.md#lsp8tokenmetadatabaseuri), the URL will always be generated by combining the Base URL with previously prepared token ID as Byte32 Hex String. You can simply concatenate them to retrieve the full link. However, the token ID needs to be decoded first.
How to decode a tokenID from Byte32 Hex String according to LSP8TokenIdFormat diff --git a/docs/learn/migrate/migrate-erc20-to-lsp7.md b/docs/learn/migrate/migrate-erc20-to-lsp7.md index 726e90f1e8..e4affb74dd 100644 --- a/docs/learn/migrate/migrate-erc20-to-lsp7.md +++ b/docs/learn/migrate/migrate-erc20-to-lsp7.md @@ -303,7 +303,7 @@ See the [**Metadata Management**](../digital-assets/metadata-management/edit-tok LSP7 allows for more flexible and extensible metadata. The [`LSP4Metadata`](../../standards/tokens/LSP4-Digital-Asset-Metadata.md#lsp4metadata) is a JSON object that can contain many information about the token, including: -- 🌐 **official link to websites** (_e.g: project website, social medias, community channels, etc..._). +- 🌐 **official link to websites** (_e.g: project website, social media, community channels, etc..._). - 🖼️ **images** (token icon and backgrounds) to display the token in dApps, explorers, or decentralised exchanges. - 🏷️ **custom attributes** (can be displayed as badges on UIs). diff --git a/docs/learn/migrate/migrate-erc721-to-lsp8.md b/docs/learn/migrate/migrate-erc721-to-lsp8.md index a61e608eff..15e15ade44 100644 --- a/docs/learn/migrate/migrate-erc721-to-lsp8.md +++ b/docs/learn/migrate/migrate-erc721-to-lsp8.md @@ -306,7 +306,7 @@ See the [**Metadata Management**](../digital-assets/metadata-management/edit-tok The [`LSP4Metadata`](../../standards/tokens/LSP4-Digital-Asset-Metadata.md#lsp4metadata) is a JSON object that can contain many information about the token, including: -- 🌐 **official link to websites** (_e.g: project website, social medias, community channels, etc..._). +- 🌐 **official link to websites** (_e.g: project website, social media, community channels, etc..._). - 🖼️ **images** (token icon and backgrounds) to display the token in dApps, explorers, or decentralised exchanges. - 🏷️ **custom attributes** (for each specific NFTs for instance, can be displayed as badges on UIs). diff --git a/docs/learn/other-guides/deploy-multichain-contracts.md b/docs/learn/other-guides/deploy-multichain-contracts.md index ca7dcdebf7..f0dc044f01 100644 --- a/docs/learn/other-guides/deploy-multichain-contracts.md +++ b/docs/learn/other-guides/deploy-multichain-contracts.md @@ -138,7 +138,7 @@ console.log('LSP16UniversalFactory exists: ', isLSP16FactoryDeployed); If `Nick Factory` doesn't exist, we'll need to deploy it: ```js title="main.js" -// The private key should not be comitted to a public GitHub repository. +// The private key should not be committed to a public GitHub repository. const signer = new ethers.Wallet('', provider); if (!isNickFactoryDeployed) { @@ -400,7 +400,7 @@ The code will run, just need to: - Replace `` with a private key containing funds. - Add the full bytecode when deploying the `LSP16UniversalFactory` from `Nick Factory`. -> **Note:** The private key should not be comitted to a public GitHub repository. +> **Note:** The private key should not be committed to a public GitHub repository. ```js title="main.js" import { ethers } from 'ethers'; @@ -431,7 +431,7 @@ async function main() { console.log('Nick Factory exists: ', isNickFactoryDeployed); console.log('LSP16UniversalFactory exists: ', isLSP16FactoryDeployed); - // The private key should not be comitted to a public GitHub repository + // The private key should not be committed to a public GitHub repository const signer = new ethers.Wallet('', provider); if (!isNickFactoryDeployed) { diff --git a/docs/learn/overview.md b/docs/learn/overview.md index 893d9df495..6c51971293 100644 --- a/docs/learn/overview.md +++ b/docs/learn/overview.md @@ -72,7 +72,7 @@ LUKSO is a Layer 1 EVM chain that uses an unmodified version of Ethereum. It can - + diff --git a/docs/learn/universal-profile/advanced-guides/extend-profile-functionalities.md b/docs/learn/universal-profile/advanced-guides/extend-profile-functionalities.md index 208f659b70..c797467744 100644 --- a/docs/learn/universal-profile/advanced-guides/extend-profile-functionalities.md +++ b/docs/learn/universal-profile/advanced-guides/extend-profile-functionalities.md @@ -204,7 +204,7 @@ const TipMeFactory = new ethers.ContractFactory( const tipMeContract = await TipMeFactory.deploy(); await tipMeContract.deployTransaction.wait(); -const tipMeExtensionAddress = tipMeContract.addres; +const tipMeExtensionAddress = tipMeContract.address; console.log('Contract deployed at:', tipMeExtensionAddress); ``` @@ -371,7 +371,7 @@ main(); ## Extending InterfaceIds -Extending `interfaceIds` is crucial for Universal Profiles, as many protocols check for support of specific `interfaceIds` before executing calls to certain functions. Extending interfaceIds typically follows a similar approach to extending functions, with the main distinction being the existance of the `supportsInterface` function. +Extending `interfaceIds` is crucial for Universal Profiles, as many protocols check for support of specific `interfaceIds` before executing calls to certain functions. Extending interfaceIds typically follows a similar approach to extending functions, with the main distinction being the existence of the `supportsInterface` function. ### Step 1: Create a Contract Supporting a Specific InterfaceId @@ -443,7 +443,7 @@ const supportsInterfaceFactory = new ethers.ContractFactory( const supportsInterfaceContract = await supportsInterfaceFactory.deploy(); await supportsInterfaceContract.deployTransaction.wait(); -const supportsInterfaceExtensionAddress = supportsInterfaceContract.addres; +const supportsInterfaceExtensionAddress = supportsInterfaceContract.address; console.log('Contract deployed at:', tipMeExtensionAddress); ``` @@ -535,7 +535,7 @@ async function main() { const supportsInterfaceContract = await supportsInterfaceFactory.deploy(); await supportsInterfaceContract.deployTransaction.wait(); - const supportsInterfaceExtensionAddress = supportsInterfaceContract.addres; + const supportsInterfaceExtensionAddress = supportsInterfaceContract.address; const supportsInterfaceInterface = new ethers.Interface(SupportsInterfaceABI); const supportsInterfaceFunctionSelector = diff --git a/docs/learn/universal-profile/connect-profile/connect-up.md b/docs/learn/universal-profile/connect-profile/connect-up.md index 07b70854a0..3b0d437f46 100644 --- a/docs/learn/universal-profile/connect-profile/connect-up.md +++ b/docs/learn/universal-profile/connect-profile/connect-up.md @@ -131,7 +131,7 @@ Both libraries come with built-in UI elements and allow you to support multiple
  • Customizable Connection Window
  • Remains connection on Page Refresh
  • Lists supported EIP-1193 Extensions
    • -
  • Automatically detects EIP-6963 Extensions
    • +
  • Automatically detects EIP-6963 Extensions
  • Requires Wallet Connect Account ID
    • diff --git a/docs/learn/universal-profile/interactions/transfer-lyx.md b/docs/learn/universal-profile/interactions/transfer-lyx.md index 162d050c91..c0394d4f4e 100644 --- a/docs/learn/universal-profile/interactions/transfer-lyx.md +++ b/docs/learn/universal-profile/interactions/transfer-lyx.md @@ -12,11 +12,11 @@ import TabItem from '@theme/TabItem';
    Transfering 0.5 LYXt between two Universal Profiles
    -Transfering 0.5 LYXt between two Universal Profiles. +Transferring 0.5 LYXt between two Universal Profiles.

    diff --git a/docs/learn/universal-profile/interactions/transfer-tokens-and-nfts.md b/docs/learn/universal-profile/interactions/transfer-tokens-and-nfts.md index 02c44b9e70..c22900a73a 100644 --- a/docs/learn/universal-profile/interactions/transfer-tokens-and-nfts.md +++ b/docs/learn/universal-profile/interactions/transfer-tokens-and-nfts.md @@ -12,10 +12,10 @@ import TabItem from '@theme/TabItem';
    Transfering 1,000 CHILL tokens or a Chillwhale NFT between two Universal Profiles
    -Transfering 1,000 CHILL tokens between two Universal Profiles. +Transferring 1,000 CHILL tokens between two Universal Profiles.

    @@ -66,7 +66,7 @@ Call the [LSP7 `transfer(address,address,uint256,bool,bytes)`](../../../contract > Since most tokens have 18 [`decimals()`](../../../contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#decimals), make sure to specify the `amount` with 18 decimals place. For instance, if you want to transfer 8 tokens the `amount` parameter will be: `8_000_000_000_000_000_000` ✅, not `8` ❌. -> Otherwise, the transfer might have occured but you might not see the balance of the recipient updated, since you transferred only a tiny small amount (`8` for a token with 18 decimals is basically 1 / 1e18). To do so easily, use one of number utility function from _ethers.js_ or _web3.js_. +> Otherwise, the transfer might have occurred but you might not see the balance of the recipient updated, since you transferred only a tiny small amount (`8` for a token with 18 decimals is basically 1 / 1e18). To do so easily, use one of number utility function from _ethers.js_ or _web3.js_. diff --git a/docs/learn/universal-profile/key-manager/execute-relay-transactions.md b/docs/learn/universal-profile/key-manager/execute-relay-transactions.md index b8024200ca..aad4d302cb 100644 --- a/docs/learn/universal-profile/key-manager/execute-relay-transactions.md +++ b/docs/learn/universal-profile/key-manager/execute-relay-transactions.md @@ -422,7 +422,7 @@ You can find more information about `executeRelayCall` within the [LSP6 Contract ::: -To execute a previously signed transaction, the relayer will need all the following informations: +To execute a previously signed transaction, the relayer will need all the following information: - `signature` generated in **step 2.3**. - `nonce` of the signing controller. @@ -430,7 +430,7 @@ To execute a previously signed transaction, the relayer will need all the follow - `abiPayload` as abi-encoded function call to execute on the 🆙. - `keyManagerAddress` associated with the Universal Profile we want to execute on. -The relayer can now call the [`executeRelayCall`](../../../contracts/contracts/LSP6KeyManager/LSP6KeyManager.md#executerelaycall) function on the Key Manager (`keyManagerAddress`) of the profile, passing all these informations as function arguments. +The relayer can now call the [`executeRelayCall`](../../../contracts/contracts/LSP6KeyManager/LSP6KeyManager.md#executerelaycall) function on the Key Manager (`keyManagerAddress`) of the profile, passing all these information as function arguments. diff --git a/docs/learn/universal-profile/key-manager/grant-permissions.md b/docs/learn/universal-profile/key-manager/grant-permissions.md index 0a5a31fec7..76098203be 100644 --- a/docs/learn/universal-profile/key-manager/grant-permissions.md +++ b/docs/learn/universal-profile/key-manager/grant-permissions.md @@ -267,4 +267,4 @@ console.log( Finally, to test the actual permissions, you can do this guide using a `beneficiaryAddress` that you have control over. -You can try the [**Edit Universal Profile**](../metadata/edit-profile.md) guide, using this new 3rd party address that you have control over to test if it can successfull edit the profile details. This will give you guarantee that this `beneficiaryAddress` has the `SETDATA` permission working. +You can try the [**Edit Universal Profile**](../metadata/edit-profile.md) guide, using this new 3rd party address that you have control over to test if it can successful edit the profile details. This will give you guarantee that this `beneficiaryAddress` has the `SETDATA` permission working. diff --git a/docs/learn/universal-profile/metadata/read-profile-data.md b/docs/learn/universal-profile/metadata/read-profile-data.md index 1005e7b8fc..0bda80e8e1 100644 --- a/docs/learn/universal-profile/metadata/read-profile-data.md +++ b/docs/learn/universal-profile/metadata/read-profile-data.md @@ -40,7 +40,7 @@ npm install @erc725/erc725.js The parameters to provide to the erc725 instance are: - [Schema](https://github.com/ERC725Alliance/erc725.js/tree/develop/schemas): specifies which data keys will be used to retrieve data from the Universal Profile. -- Univeral Profile address: the address of the Universal Profile you want to retrieve data from. +- Universal Profile address: the address of the Universal Profile you want to retrieve data from. - Optional only for retrieving decoded data: RPC provider (web3, ethereum, ethers) or plain RPC url of [mainnet](../../../networks/mainnet/parameters.md) or [testnet](../../../networks/testnet/parameters.md) networks. ```js title="Creating an erc725 instance to read data from a Universal Profile" @@ -59,7 +59,7 @@ const erc725js = new ERC725( ## Get all profile data -Use the `await erc725js.getData()` functon from _erc725.js_ without passing any parameter. +Use the `await erc725js.getData()` function from _erc725.js_ without passing any parameter. ```js title="Get all profile data" import { ERC725 } from '@erc725/erc725.js'; diff --git a/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md b/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md index 045af55904..8c6b9878ba 100644 --- a/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md +++ b/docs/learn/universal-profile/universal-receiver/create-receiver-forwarder.md @@ -31,7 +31,7 @@ This guide is working with version above 0.14.0 of the [`@lukso/lsp-smart-contra ::: -In order to follow this guide, you will need the followings: +In order to follow this guide, you will need the following: 1. Download and install the [UP Browser extension](/install-up-browser-extension). 2. Fund the main EOA controller of your 🆙 (See **[Step 1](#step-1---enable-your-controller-to-add-a-universal-receiver) bullet point 3** to retrieve its address) using the [Testnet Faucet](https://faucet.testnet.lukso.network/). @@ -210,7 +210,7 @@ contract LSP1Forwarder is ERC165, ILSP1Delegate { return "Token not in allowlist"; } - // extract data (we only need the amount that was transfered / minted) + // extract data (we only need the amount that was transferred / minted) (, , , uint256 amount, ) = abi.decode( data, (address, address, address, uint256, bytes) @@ -395,7 +395,7 @@ contract LSP1Forwarder is ERC165, ILSP1Delegate { return "Token not in allowlist"; } - // extract data (we only need the amount that was transfered / minted) + // extract data (we only need the amount that was transferred / minted) (, , , uint256 amount, ) = abi.decode( data, (address, address, address, uint256, bytes) @@ -691,7 +691,7 @@ console.log('✅ LSP1 Forwarder contract authorized on My USDC Token for UP 🫡 Now that all the pieces are connected, we can try it out! -The expected behaviour is that **everytime the UP on which the custom LSP1 Forwarder contract has been set receives an allowed token (either through `transfer` or `mint`), it will automatically send a percentage to the specified recipient.** +The expected behaviour is that **every time the UP on which the custom LSP1 Forwarder contract has been set receives an allowed token (either through `transfer` or `mint`), it will automatically send a percentage to the specified recipient.** Here are the test data: diff --git a/docs/learn/vault/edit-vault-data.md b/docs/learn/vault/edit-vault-data.md index 6faf91226d..3b206ab89b 100644 --- a/docs/learn/vault/edit-vault-data.md +++ b/docs/learn/vault/edit-vault-data.md @@ -363,7 +363,7 @@ const updateVaultURD = async (vaultURDAddress) => { }); }; -// update the curent Vault's URD +// update the current Vault's URD await updateVaultURD(vaultURDAddress); ``` @@ -395,7 +395,7 @@ const updateVaultURD = async (vaultURDAddress) => { ); }; -// update the curent Vault's URD +// update the current Vault's URD await updateVaultURD(vaultURDAddress); ``` @@ -477,7 +477,7 @@ const updateVaultURD = async (vaultURDAddress) => { // deploy a new Vault URD and retrieve its address const vaultURDAddress = await deployVaultURD(); -// update the curent Vault's URD +// update the current Vault's URD await updateVaultURD(vaultURDAddress); ``` @@ -543,7 +543,7 @@ const updateVaultURD = async (vaultURDAddress) => { // deploy a new Vault URD and retrieve its address const vaultURDAddress = await deployVaultURD(); -// update the curent Vault's URD +// update the current Vault's URD await updateVaultURD(vaultURDAddress); ``` diff --git a/docs/networks/mainnet/running-a-node.md b/docs/networks/mainnet/running-a-node.md index e22c2b69e1..f3be589849 100644 --- a/docs/networks/mainnet/running-a-node.md +++ b/docs/networks/mainnet/running-a-node.md @@ -25,7 +25,7 @@ Anyone is welcome to participate in the LUKSO network by running her/his own nod A map fo the LUKSO mainnet network with genesis validators.
    Map of the LUKSO genesis validators from the execution stats website - 19.09.23. diff --git a/docs/networks/testnet/running-a-node.md b/docs/networks/testnet/running-a-node.md index becbf88296..eb2b7b7947 100644 --- a/docs/networks/testnet/running-a-node.md +++ b/docs/networks/testnet/running-a-node.md @@ -8,7 +8,7 @@ description: 'Run a Testnet LUKSO node with one of the three options: Dappnode, :::info -Running a testnet node is very similar to running a mainnet node. Therefore, we recommand you to read the [mainnet version](../mainnet/running-a-node.md) first and to adjust the commands with the instructions provided here. +Running a testnet node is very similar to running a mainnet node. Therefore, we recommend you to read the [mainnet version](../mainnet/running-a-node.md) first and to adjust the commands with the instructions provided here. ::: diff --git a/docs/standards/access-control/lsp14-ownable-2-step.md b/docs/standards/access-control/lsp14-ownable-2-step.md index 8f972d4860..b9cdab3a2f 100644 --- a/docs/standards/access-control/lsp14-ownable-2-step.md +++ b/docs/standards/access-control/lsp14-ownable-2-step.md @@ -66,7 +66,7 @@ The hook is executed whenever the owner _initiates the process of transferring o #### Accept Ownership Hooks These hooks are designed to _notify the previous and new owner_ when ownership of the contract has been fully transferred. One hook notifies the previous owner and the second one notifies the new owner. -Each hook is executed whenever the _new owner confirms the process of tranferring ownership_. +Each hook is executed whenever the _new owner confirms the process of transferring ownership_. - The hook that notifies the previous owner is only executed if the previous owner is a contract that **implements LSP1**. - The hook that notifies the new owner is only executed if the new owner is a contract that **implements LSP1**. @@ -77,8 +77,8 @@ Each hook is executed whenever the _new owner confirms the process of tranferrin The control of the contract is refully renounced _once the owner of the contract confirmes the ownership renouncement_. The 2 steps of ownership renouncement are described below: -1. The owner initiates the process of ownerhsip renouncement via the ['renounceOwnership()'](../../contracts/contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#renounceownership) function. +1. The owner initiates the process of ownership renouncement via the ['renounceOwnership()'](../../contracts/contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#renounceownership) function. -2. After waiting for 200 blocks to pass from the intiation of the ownership renouncement process the owner has a window of 200 block for confirming the renouncement via ['renounceOwnership()'](../../contracts/contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#renounceownership). If the owner doesn't confirm in that window of time, the process cannot be confirmed and the owner must start again if it was intended to renounce ownership. +2. After waiting for 200 blocks to pass from the initiation of the ownership renouncement process the owner has a window of 200 block for confirming the renouncement via ['renounceOwnership()'](../../contracts/contracts/LSP14Ownable2Step/LSP14Ownable2Step.md#renounceownership). If the owner doesn't confirm in that window of time, the process cannot be confirmed and the owner must start again if it was intended to renounce ownership. ![Renounce Ownership](/img/standards/lsp14/renounce-ownership.jpeg) diff --git a/docs/standards/access-control/lsp6-key-manager.md b/docs/standards/access-control/lsp6-key-manager.md index d3a30546ec..50ed3e4c58 100644 --- a/docs/standards/access-control/lsp6-key-manager.md +++ b/docs/standards/access-control/lsp6-key-manager.md @@ -63,7 +63,7 @@ While the Key Manager allows for a very fine-grained control over the Universal **Good practices:** -1. Split the permissions over the Universal Profile accross different devices, hardware wallets or a combination of both. +1. Split the permissions over the Universal Profile across different devices, hardware wallets or a combination of both. 2. Make sure to double or triple check when granting permissions to 3rd parties (other Universal Profiles, DApps, etc.). ::: @@ -93,7 +93,7 @@ The `ADDCONTROLLER` permission enables to grant permissions to new addresses tha The `ADDCONTROLLER` permission is needed to: -- Give a new address some permission(s) by setting its permissions under `AddressPermissions:Permissions:` (this is also refered to _"adding a new controller"_) +- Give a new address some permission(s) by setting its permissions under `AddressPermissions:Permissions:` (this is also referred to _"adding a new controller"_) - Add a new controller address in the list of `AddressPermissions[index]` at a specific `index`. - Increase the length of the `AddressPermissions[]` Array length (to describe that a new controller has been added). @@ -775,7 +775,7 @@ A CompactBytesArray for these 3 different ERC725Y Data Keys would look like this } ``` -Below is an example use case. An ERC725Account can allow some applications to add/edit informations on its storage via `setData(...)`. The account can restrict such Dapps and protocols to edit the data keys that are only relevant to the logic of their applications. +Below is an example use case. An ERC725Account can allow some applications to add/edit information on its storage via `setData(...)`. The account can restrict such Dapps and protocols to edit the data keys that are only relevant to the logic of their applications. ![LSP6 Allowed ERC725YDataKeys overview](/img/standards/lsp6/lsp6-allowed-erc725ydatakeys-overview.jpeg) diff --git a/docs/standards/accounts/lsp0-erc725account.md b/docs/standards/accounts/lsp0-erc725account.md index 1e6eb76749..e9113e2d77 100644 --- a/docs/standards/accounts/lsp0-erc725account.md +++ b/docs/standards/accounts/lsp0-erc725account.md @@ -1,7 +1,7 @@ --- sidebar_label: 'LSP0 - ERC725 Account' sidebar_position: 2 -descriotion: LUKSO's LSP0 - ERC725 Account. +description: LUKSO's LSP0 - ERC725 Account. --- # LSP0 - ERC725 Account diff --git a/docs/standards/accounts/lsp17-contract-extension.md b/docs/standards/accounts/lsp17-contract-extension.md index 474f36e0f7..dcd0ddb5d0 100644 --- a/docs/standards/accounts/lsp17-contract-extension.md +++ b/docs/standards/accounts/lsp17-contract-extension.md @@ -70,7 +70,7 @@ The 52 bytes of additional calldata appended to the call to the extension contra While contracts can deploy and customize their own extensions, many smart contracts **share almost the same logic** for certain functions. In this case, the same extensions can be re-used by different contracts supporting LSP17. -For example, **_smart contract A & B_** are two independant contracts that implement different functions but share the same logic for verifying signatures. Therefore, they can use the same extension for signature validation for the `isValidSignature(..)` function. +For example, **_smart contract A & B_** are two independent contracts that implement different functions but share the same logic for verifying signatures. Therefore, they can use the same extension for signature validation for the `isValidSignature(..)` function. ![Two contracts sharing the same LSP17 Extension](/img/standards/lsp17/ShareExtension.jpeg) diff --git a/docs/standards/accounts/lsp25-execute-relay-call.md b/docs/standards/accounts/lsp25-execute-relay-call.md index 86931d5ed3..dad1d1b464 100644 --- a/docs/standards/accounts/lsp25-execute-relay-call.md +++ b/docs/standards/accounts/lsp25-execute-relay-call.md @@ -1,7 +1,7 @@ --- title: LSP25 - Execute Relay Call sidebar_position: 9 -description: Learn about meta transactions using the LSP25 Execute Relay Call standards and how to use multi-channel nonces to dispatch transactions that are order independant or not. +description: Learn about meta transactions using the LSP25 Execute Relay Call standards and how to use multi-channel nonces to dispatch transactions that are order independent or not. --- # LSP25 - Execute Relay Call diff --git a/docs/standards/factories/lsp16-universal-factory.md b/docs/standards/factories/lsp16-universal-factory.md index 31d01ebeab..3e7555039c 100644 --- a/docs/standards/factories/lsp16-universal-factory.md +++ b/docs/standards/factories/lsp16-universal-factory.md @@ -21,7 +21,7 @@ LSP16 introduces a universal factory for deploying smart contracts using the CRE ## Introduction -The use of different blockchain networks has brought with it a unique challenge: ensuring that an entity or user controlling an address on one chain can have the same control on another chain. For Externally Owned Accounts, this is known, as possesing the private key of the address means control over it regardless of the chain. +The use of different blockchain networks has brought with it a unique challenge: ensuring that an entity or user controlling an address on one chain can have the same control on another chain. For Externally Owned Accounts, this is known, as possessing the private key of the address means control over it regardless of the chain. ![EOA Control](/img/standards/lsp16/EOA-Control.jpeg) @@ -35,7 +35,7 @@ Therefore, it's preferable to opt for a situation that can allow for the creatio ## What does this standard represent? -This standard defines a contract called **Universal Factory** which provide a way to deploy the same contracts at the same addresses accross different chains given few requirements. +This standard defines a contract called **Universal Factory** which provide a way to deploy the same contracts at the same addresses across different chains given few requirements. ![UniversalFactory](/img/standards/lsp16/UniversalFactory.jpeg) @@ -57,7 +57,7 @@ For initializable contracts, the initialization data is included into the salt t Additionally, it ensures that the same bytecode and salt will create the same contract address on different chains, given that the UniversalFactory contract was deployed on the same address on each chain. -For a contract to be replicated at the same address accross different chain, it should be deployed using the same: +For a contract to be replicated at the same address across different chain, it should be deployed using the same: - Bytecode - Salt diff --git a/docs/standards/factories/lsp23-linked-contracts-factory.md b/docs/standards/factories/lsp23-linked-contracts-factory.md index d2e7251fe8..bab9a2cb7b 100644 --- a/docs/standards/factories/lsp23-linked-contracts-factory.md +++ b/docs/standards/factories/lsp23-linked-contracts-factory.md @@ -18,7 +18,7 @@ LSP 23 simplifies the deployment of interdependent smart contracts by providing Deploying smart contracts that are interdependent can be a complex process. Often, two or more contracts need each other's addresses at deployment, creating a circular dependency that can be challenging to resolve. -![Circular Depedency](/img/standards/lsp23/circular-dependency.jpeg) +![Circular Dependency](/img/standards/lsp23/circular-dependency.jpeg) The LSP23 Linked Contracts Factory addresses this issue by providing a unified interface for deploying linked contracts with an optional post-deployment execution. This standard simplifies the deployment of complex contract systems, making it easier for developers to deploy interdependent contracts without the need for manual intervention. diff --git a/docs/standards/introduction.md b/docs/standards/introduction.md index 052cceedea..03356eeaca 100644 --- a/docs/standards/introduction.md +++ b/docs/standards/introduction.md @@ -1,6 +1,6 @@ --- title: 'Introduction' -description: Introduction to LSPs (LUKSO Standars Proposals). +description: Introduction to LSPs (LUKSO Standard Proposals). --- import StandardsGallery from '@site/src/components/StandardsGallery'; diff --git a/docs/standards/metadata/lsp2-json-schema.md b/docs/standards/metadata/lsp2-json-schema.md index 4b7257bf6a..1a095a171f 100644 --- a/docs/standards/metadata/lsp2-json-schema.md +++ b/docs/standards/metadata/lsp2-json-schema.md @@ -58,7 +58,7 @@ By introducing a schema, we can represent contract storage in the same way acros LSP2 introduces new ways to encode data, depending on its type. From a single entry to multiple entries (like arrays or maps). -A data key in the contract storage can be defined as a JSON object with properties that describe the key. The schema includes informations about the data key itself, as well as its value to explain what this data represents. +A data key in the contract storage can be defined as a JSON object with properties that describe the key. The schema includes information about the data key itself, as well as its value to explain what this data represents. - the data `key` itself: the `bytes32` hex value used when calling [`setData`](../../contracts/contracts/ERC725/ERC725.md#setdata) or [`setDataBatch`](../../contracts/contracts/ERC725/ERC725.md#setdatabatch) on the smart contract. - the data key `name`: human readable version diff --git a/docs/standards/tokens/LSP4-Digital-Asset-Metadata.md b/docs/standards/tokens/LSP4-Digital-Asset-Metadata.md index eed696a810..a5728da5e4 100644 --- a/docs/standards/tokens/LSP4-Digital-Asset-Metadata.md +++ b/docs/standards/tokens/LSP4-Digital-Asset-Metadata.md @@ -162,7 +162,7 @@ LSP4 defines 3 default token types (see [table above](./LSP4-Digital-Asset-Metad } ``` -The value attached to this data key repesents the type of token of the digital asset. The defaults values are: +The value attached to this data key represents the type of token of the digital asset. The defaults values are: - 0 (Token) - 1 (NFT) diff --git a/docs/standards/tokens/LSP7-Digital-Asset.md b/docs/standards/tokens/LSP7-Digital-Asset.md index 8a3a7dafb1..1f0a6ffc33 100644 --- a/docs/standards/tokens/LSP7-Digital-Asset.md +++ b/docs/standards/tokens/LSP7-Digital-Asset.md @@ -61,7 +61,7 @@ To ensure a flexible and generic asset representation, the token contract should :::caution -When LSP7 assets are transfered, the LSP7 contract will notify the token sender and recipient using [`_notifyTokenSender(...)`](../../contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_notifytokensender) and [`_notifyTokenReceiver(...)`](../../contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_notifytokenreceiver). +When LSP7 assets are transferred, the LSP7 contract will notify the token sender and recipient using [`_notifyTokenSender(...)`](../../contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_notifytokensender) and [`_notifyTokenReceiver(...)`](../../contracts/contracts/LSP7DigitalAsset/LSP7DigitalAsset.md#_notifytokenreceiver). **These methods will make external calls** to the [`universalReceiver(...)`](../../contracts/contracts/LSP0ERC725Account/LSP0ERC725Account.md#universalreceiver) functions of both the sender and recipient. diff --git a/docs/tools/libraries/erc725js/methods.md b/docs/tools/libraries/erc725js/methods.md index 1b3b3a0fa7..2a2d561e58 100644 --- a/docs/tools/libraries/erc725js/methods.md +++ b/docs/tools/libraries/erc725js/methods.md @@ -2730,7 +2730,7 @@ The encoded permission (32bytes hex). | Name | Type | Description | | :------------------- | :----- | :------------------------------------------------------------------------------------------------- | -| `decodedPermissions` | Object | An object specifying whether default LSP6 permissions are included in provided hexademical string. | +| `decodedPermissions` | Object | An object specifying whether default LSP6 permissions are included in provided hexadecimal string. | #### Example diff --git a/docs/tools/libraries/lsp-utils/LSP23LinkedContractsFactory.md b/docs/tools/libraries/lsp-utils/LSP23LinkedContractsFactory.md index 2781cf5230..4f72a5ac9b 100644 --- a/docs/tools/libraries/lsp-utils/LSP23LinkedContractsFactory.md +++ b/docs/tools/libraries/lsp-utils/LSP23LinkedContractsFactory.md @@ -13,7 +13,7 @@ Deploy Universal Profile with Key Manager using LSP23 Linked Contracts Factory. | Name | Type | Description | | :---------------------- | :------------------- | :-------------------------------------------------------------------------------- | | `signer` | `Signer` \| `Wallet` | The signer used to deploy the contracts, needs to have native token for gas fees. | -| `mainController` | `BytesLike` | The main controller for the Unviersal Profile. | +| `mainController` | `BytesLike` | The main controller for the Universal Profile. | | `additionalDataKeys` | `BytesLike`[] | Data keys that you want to set on deployment. | | `additionalDataValues` | `BytesLike`[] | Data values that you want to set on deployment. | | `additionalControllers` | `LSP6Controller`[] | Additional controllers for the deployed Universal Profile. | diff --git a/docs/tools/libraries/lsp-utils/LSP5ReceivedAssets.md b/docs/tools/libraries/lsp-utils/LSP5ReceivedAssets.md index f0e09e9494..fc296746be 100644 --- a/docs/tools/libraries/lsp-utils/LSP5ReceivedAssets.md +++ b/docs/tools/libraries/lsp-utils/LSP5ReceivedAssets.md @@ -12,7 +12,7 @@ Generate an array of Data Key/Value pairs to be set on the receiver address afte | Name | Type | Description | | :----------------- | :----------------- | :---------------------------------------------------------------------- | -| `erc725YContract` | `UniversalProfile` | The contract instance of the asset reciever. | +| `erc725YContract` | `UniversalProfile` | The contract instance of the asset receiver. | | `assetAddress` | `BytesLike` | The address of the asset being received (_e.g: an LSP7 or LSP8 token_). | | `assetInterfaceId` | `BytesLike` | The interfaceID of the asset being received. | diff --git a/docs/tools/libraries/lsp-utils/LSP6KeyManager.md b/docs/tools/libraries/lsp-utils/LSP6KeyManager.md index e117d47956..9c73ef08fa 100644 --- a/docs/tools/libraries/lsp-utils/LSP6KeyManager.md +++ b/docs/tools/libraries/lsp-utils/LSP6KeyManager.md @@ -27,7 +27,7 @@ v0.0.1 **`Throws`** -When teh bytes value of either `startingTimestamp` or `endingTimestamp` exceeds 16 bytes. +When the bytes value of either `startingTimestamp` or `endingTimestamp` exceeds 16 bytes. **`See`** @@ -169,7 +169,7 @@ Decode a hex value, containing a `BitArray` of permissions. The `AddressPermissi | Name | Type | Description | | :------------------------ | :------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `permissions` | `BytesLike` | A hex value, containing a BitArray of permissions. | -| `decodedPermissionsType?` | `"bigint"` \| `"boolean"` \| `"BytesLike"` \| `"LSP6PermissionName"` | Optional param, defaults to `LSP6PermissionName`. Can be used to specfiy the type of the return array. Options: - `BytesLike` - `bigint` - `boolean` - `LSP6PermissionName` | +| `decodedPermissionsType?` | `"bigint"` \| `"boolean"` \| `"BytesLike"` \| `"LSP6PermissionName"` | Optional param, defaults to `LSP6PermissionName`. Can be used to specify the type of the return array. Options: - `BytesLike` - `bigint` - `boolean` - `LSP6PermissionName` | #### Returns @@ -287,7 +287,7 @@ encodeAllowedCalls( ▸ **encodeAllowedERC725YDataKeys**(`dataKeys`): `string` -Enocde a list of data keys as `{ "valueType": "bytes[CompactBytesArray]" }`. The result can be user for `AddressPermissions:AllowedERC725YDataKeys:
    ` +Encode a list of data keys as `{ "valueType": "bytes[CompactBytesArray]" }`. The result can be user for `AddressPermissions:AllowedERC725YDataKeys:
    ` #### Parameters diff --git a/docs/tools/services/rpc-api.md b/docs/tools/services/rpc-api.md index 3c9fe8e997..ced5287f88 100644 --- a/docs/tools/services/rpc-api.md +++ b/docs/tools/services/rpc-api.md @@ -69,7 +69,7 @@ It requests that the user provides an Ethereum address that should sign the tran #### Returns -`string` - on a successful call the method returns a signature, a string representing hex encoded bytes or an error with code `4001` - if the user rejects the requets +`string` - on a successful call the method returns a signature, a string representing hex encoded bytes or an error with code `4001` - if the user rejects the requests ### personal_sign diff --git a/spellcheck.log b/spellcheck.log new file mode 100644 index 0000000000..f47dcd27d1 --- /dev/null +++ b/spellcheck.log @@ -0,0 +1,19 @@ + + +Error: ./docs/contracts/contracts/UniversalProfile.md:336: datas ==> data +Error: ./docs/contracts/contracts/UniversalProfile.md:340: datas ==> data +Error: ./docs/contracts/contracts/UniversalProfile.md:373: datas ==> data + + + + + + + + + + + + + + diff --git a/src/components/ContractCardsGallery/index.tsx b/src/components/ContractCardsGallery/index.tsx index f65f9c45b3..9ffc26c295 100644 --- a/src/components/ContractCardsGallery/index.tsx +++ b/src/components/ContractCardsGallery/index.tsx @@ -14,7 +14,7 @@ const Contracts_AccountsInteraction = [ url: '/contracts/overview/LSP1Delegate', urlABI: '/contracts/contracts/LSP6KeyManager', description: - 'Allows to react on transfers and informations received (token transfers, notifications, etc...)', + 'Allows to react on transfers and information received (token transfers, notifications, etc...)', }, { diff --git a/src/components/StandardsGallery/index.tsx b/src/components/StandardsGallery/index.tsx index 1f3c3a1269..2bc534a789 100644 --- a/src/components/StandardsGallery/index.tsx +++ b/src/components/StandardsGallery/index.tsx @@ -109,7 +109,7 @@ const STANDARDS = [ title: '💸 LSP18', name: 'Royalties', link: 'https://github.com/lukso-network/LIPs/blob/main/LSPs/LSP-18-Royalties.md', - text: 'Set of data keys to store informations about royalty recipient addresses and their claimable percentage.', + text: 'Set of data keys to store information about royalty recipient addresses and their claimable percentage.', }, { title: '🔄 LSP20',