Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: typos after spellchecker #1196

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -802,7 +802,7 @@ Emitted when calling an address `target` (EOA or contract) with `value`.

| Name | Type | Description |
| ----------------------------- | :-------: | ---------------------------------------------------------------------------------------------------- |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICALL` or `DELEGATECALL`). |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICCALL` or `DELEGATECALL`). |
| `target` **`indexed`** | `address` | The address to call. `target` will be unused if a contract is created (operation types 1 and 2). |
| `value` | `uint256` | The amount of native tokens transferred along the call (in Wei). |
| `selector` **`indexed`** | `bytes4` | The first 4 bytes (= function selector) of the data sent with the call. |
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/contracts/ERC725/ERC725.md
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,7 @@ Emitted when calling an address `target` (EOA or contract) with `value`.

| Name | Type | Description |
| ----------------------------- | :-------: | ---------------------------------------------------------------------------------------------------- |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICALL` or `DELEGATECALL`). |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICCALL` or `DELEGATECALL`). |
| `target` **`indexed`** | `address` | The address to call. `target` will be unused if a contract is created (operation types 1 and 2). |
| `value` | `uint256` | The amount of native tokens transferred along the call (in Wei). |
| `selector` **`indexed`** | `bytes4` | The first 4 bytes (= function selector) of the data sent with the call. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1370,7 +1370,7 @@ Emitted when calling an address `target` (EOA or contract) with `value`.

| Name | Type | Description |
| ----------------------------- | :-------: | ---------------------------------------------------------------------------------------------------- |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICALL` or `DELEGATECALL`). |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICCALL` or `DELEGATECALL`). |
| `target` **`indexed`** | `address` | The address to call. `target` will be unused if a contract is created (operation types 1 and 2). |
| `value` | `uint256` | The amount of native tokens transferred along the call (in Wei). |
| `selector` **`indexed`** | `bytes4` | The first 4 bytes (= function selector) of the data sent with the call. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ See [`IERC165-supportsInterface`](#ierc165-supportsinterface).

:::caution Warning

When the data stored in the ERC725Y storage of the LSP0 contract is corrupted (\_e.g: ([LSP-5-ReceivedAssets]'s Array length not 16 bytes long, the token received is already registered in `LSP5ReceivetAssets[]`, the token being sent is not sent as full balance, etc...), the function call will still pass and return (**not revert!**) and not modify any data key on the storage of the [LSP-0-ERC725Account].
When the data stored in the ERC725Y storage of the LSP0 contract is corrupted (\_e.g: ([LSP-5-ReceivedAssets]'s Array length not 16 bytes long, the token received is already registered in `LSP5ReceivedAssets[]`, the token being sent is not sent as full balance, etc...), the function call will still pass and return (**not revert!**) and not modify any data key on the storage of the [LSP-0-ERC725Account].

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ See [`IERC165-supportsInterface`](#ierc165-supportsinterface).

:::caution Warning

When the data stored in the ERC725Y storage of the LSP0 contract is corrupted (\_e.g: ([LSP-5-ReceivedAssets]'s Array length not 16 bytes long, the token received is already registered in `LSP5ReceivetAssets[]`, the token being sent is not sent as full balance, etc...), the function call will still pass and return (**not revert!**) and not modify any data key on the storage of the [LSP-0-ERC725Account].
When the data stored in the ERC725Y storage of the LSP0 contract is corrupted (\_e.g: ([LSP-5-ReceivedAssets]'s Array length not 16 bytes long, the token received is already registered in `LSP5ReceivedAssets[]`, the token being sent is not sent as full balance, etc...), the function call will still pass and return (**not revert!**) and not modify any data key on the storage of the [LSP-0-ERC725Account].

:::

Expand Down
4 changes: 2 additions & 2 deletions docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ function executeBatch(
) external payable returns (bytes[]);
```

\*Executing the following batch of payloads and sensind on the linked contract.
\*Executing the following batch of payloads and sending on the linked contract.

- payloads: `payloads`

Expand Down Expand Up @@ -241,7 +241,7 @@ function executeRelayCallBatch(

_Executing a batch of relay calls (= meta-transactions)._

Same as [`executeRelayCall`](#executerelaycall) but execute a batch of signed calldata payloads (abi-encoded function calls) in a single transaction. The `signatures` can be from multiple controllers, not necessarely the same controller, as long as each of these controllers that signed have the right permissions related to the calldata `payload` they signed.
Same as [`executeRelayCall`](#executerelaycall) but execute a batch of signed calldata payloads (abi-encoded function calls) in a single transaction. The `signatures` can be from multiple controllers, not necessarily the same controller, as long as each of these controllers that signed have the right permissions related to the calldata `payload` they signed.

<blockquote>

Expand Down
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Anything under the contracts/contracts folder is a Markdown file autogenerated from the Natspec comments in the Solidity code of the smart contracts repositories:

Therefore, the changes under this folder should not be made here in the docs repository but under these repositories mentioned above. Otherwise, the next time we update the contracts autogenerated docs, the typos will be back.

Original file line number Diff line number Diff line change
Expand Up @@ -634,7 +634,7 @@ function tokenSupplyCap() external view returns (uint256);

_The maximum supply amount of tokens allowed to exist is `_TOKEN_SUPPLY_CAP`._

Get the maximum number of tokens that can exist to circulate. Once [`totalSupply`](#totalsupply) reaches reaches [`totalSuuplyCap`](#totalsuuplycap), it is not possible to mint more tokens.
Get the maximum number of tokens that can exist to circulate. Once [`totalSupply`](#totalsupply) reaches reaches [`totalSupplyCap`](#totalsuuplycap), it is not possible to mint more tokens.

#### Returns

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -729,7 +729,7 @@ function tokenSupplyCap() external view returns (uint256);

_The maximum supply amount of tokens allowed to exist is `_TOKEN_SUPPLY_CAP`._

Get the maximum number of tokens that can exist to circulate. Once [`totalSupply`](#totalsupply) reaches reaches [`totalSuuplyCap`](#totalsuuplycap), it is not possible to mint more tokens.
Get the maximum number of tokens that can exist to circulate. Once [`totalSupply`](#totalsupply) reaches reaches [`totalSupplyCap`](#totalsuuplycap), it is not possible to mint more tokens.

#### Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/contracts/LSP9Vault/LSP9Vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -1280,7 +1280,7 @@ Emitted when calling an address `target` (EOA or contract) with `value`.

| Name | Type | Description |
| ----------------------------- | :-------: | ---------------------------------------------------------------------------------------------------- |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICALL` or `DELEGATECALL`). |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICCALL` or `DELEGATECALL`). |
| `target` **`indexed`** | `address` | The address to call. `target` will be unused if a contract is created (operation types 1 and 2). |
| `value` | `uint256` | The amount of native tokens transferred along the call (in Wei). |
| `selector` **`indexed`** | `bytes4` | The first 4 bytes (= function selector) of the data sent with the call. |
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/contracts/UniversalProfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -1289,7 +1289,7 @@ Emitted when calling an address `target` (EOA or contract) with `value`.

| Name | Type | Description |
| ----------------------------- | :-------: | ---------------------------------------------------------------------------------------------------- |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICALL` or `DELEGATECALL`). |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICCALL` or `DELEGATECALL`). |
| `target` **`indexed`** | `address` | The address to call. `target` will be unused if a contract is created (operation types 1 and 2). |
| `value` | `uint256` | The amount of native tokens transferred along the call (in Wei). |
| `selector` **`indexed`** | `bytes4` | The first 4 bytes (= function selector) of the data sent with the call. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1299,7 +1299,7 @@ Emitted when calling an address `target` (EOA or contract) with `value`.

| Name | Type | Description |
| ----------------------------- | :-------: | ---------------------------------------------------------------------------------------------------- |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICALL` or `DELEGATECALL`). |
| `operationType` **`indexed`** | `uint256` | The low-level call opcode used to call the `target` address (`CALL`, `STATICCALL` or `DELEGATECALL`). |
| `target` **`indexed`** | `address` | The address to call. `target` will be unused if a contract is created (operation types 1 and 2). |
| `value` | `uint256` | The amount of native tokens transferred along the call (in Wei). |
| `selector` **`indexed`** | `bytes4` | The first 4 bytes (= function selector) of the data sent with the call. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ sidebar_position: 2

# Customize transfer behaviour

The `LSP8IdenfitiableDigitalAsset` contract implementation includes the `_beforeTokenTransfer` and `_afterTokenTransfer` functions that offer the ability to specify custom logic that can run before or after the token transfer has happen (= before or after the balances in the contract state have been updated).
The `LSP8IdentifiableDigitalAsset` contract implementation includes the `_beforeTokenTransfer` and `_afterTokenTransfer` functions that offer the ability to specify custom logic that can run before or after the token transfer has happen (= before or after the balances in the contract state have been updated).
2 changes: 1 addition & 1 deletion docs/faq/lukso/feature-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Yes, developers have several options for financial support when building on LUKS

## Will LUKSO be listed on additional exchanges?

At the moment, LUKSO is available on [KuCoin](https://www.kucoin.com/de), [Crypto.com](https://crypto.com/), and [Gate.io](https://www.gate.io/). As the network continues to expand, additionl exchanges may consider joining. It is important to note that this decision is entirely at the discretion of the exchanges.
At the moment, LUKSO is available on [KuCoin](https://www.kucoin.com/de), [Crypto.com](https://crypto.com/), and [Gate.io](https://www.gate.io/). As the network continues to expand, additional exchanges may consider joining. It is important to note that this decision is entirely at the discretion of the exchanges.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's strange that spellcheck did not flag that


## Will there be a Mobile Application for Universal Profiles?

Expand Down
4 changes: 2 additions & 2 deletions docs/faq/network/blockchain-architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The LUKSO Mainnet is up to date with [every Ethereum fork](https://ethereum.org/
Having a variety of clients in a blockchain network and improving our client diversity is critically important. Client diversity refers to utilizing different software clients in a blockchain network developed by various teams and in other programming languages to improve the following:

- **Security and Resilience**: Client diversity increases the robustness of the network. If there's a bug in one client, it doesn't bring down the entire network because other clients can continue to operate. This decentralization and redundancy is a fundamental aspect of blockchain security and resilience.
- **Decentralization and Governanc**e: Client diversity promotes decentralization in the development and governance of the Ethereum network. It prevents any team or entity from having too much influence over the network's growth.
- **Decentralization and Governance**: Client diversity promotes decentralization in the development and governance of the Ethereum network. It prevents any team or entity from having too much influence over the network's growth.

For Ethereum, **client diversity has proven essential** in maintaining the network's robustness during several incidents. One of the most notable incidents were the [Shanghai DoS Attacks in 2016](https://blog.ethereum.org/2016/09/22/ethereum-network-currently-undergoing-dos-attack), the [OpenEthereum Consensus Bug in 2020](https://www.coindesk.com/tech/2020/08/27/buggy-code-release-knocks-13-of-ethereum-nodes-offline/), and the [Prysm Client Incident in 2023](https://offchain.medium.com/post-mortem-report-ethereum-mainnet-finality-05-11-2023-95e271dfd8b2). You can find an overview of these bugs within the [extended client section](https://docs.luksoverse.io/docs/mainnet/complete-node-guide/blockchain-clients/client-setups) by the community.

Expand Down Expand Up @@ -87,7 +87,7 @@ An epoch in PoS is a fixed period during which slots occur. It is a larger time
Epochs provide several vital functions:

- **Validator Shuffling**: At the start of each epoch, a random selection process determines the active validators and assigns them to slots. This is done to ensure that the system remains decentralized and that no single validator can predict far in advance when they will be selected.
- **Rewards and Penaltie**s: At the end of each epoch, rewards and penalties are calculated for validators. Validators that correctly proposed and attested to blocks receive rewards, while those who behaved maliciously or were offline are penalized.
- **Rewards and Penalties**: At the end of each epoch, rewards and penalties are calculated for validators. Validators that correctly proposed and attested to blocks receive rewards, while those who behaved maliciously or were offline are penalized.
- **Finality**: An epoch also plays a role in achieving finality. Finality refers to the point at which a block cannot be changed or removed from the blockchain. The finality is achieved in every epoch.

## What are slots?
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/network/staking.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ No. Rewards are given out for each validator key separately and do not increase

## Are LYX/LYXt locked after they have been deposited?

No, validators are not locked after depositing their stake. The locking **only occurred for genesis deposits** before the Shappella fork went live on the LUKSO mainnet. Please remember that the deposited LYX can only be exited from the network after they have been activated, which may take up to 24h. In addition, the exit process may also **take up to multiple hours** until it is picked up from the consensus. Please also note that it requires setting withdrawal credentials to withdraw your funds to an account.
No, validators are not locked after depositing their stake. The locking **only occurred for genesis deposits** before the Shapella fork went live on the LUKSO mainnet. Please remember that the deposited LYX can only be exited from the network after they have been activated, which may take up to 24h. In addition, the exit process may also **take up to multiple hours** until it is picked up from the consensus. Please also note that it requires setting withdrawal credentials to withdraw your funds to an account.

## Are there different types of withdrawals for validators?

Expand Down
2 changes: 1 addition & 1 deletion docs/faq/network/validators.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ If you plan to become a validator for testnet, please contact `testnet-validator

## What happens when my validator is offline?

In Proof of Stake, validators can be penalized for being offline. The **penalties for an offline validator are dynamically adjusted** based on the total amount of offline validators and their offline duration. You can find rough estemates within the [staking section](./staking.md) of the FAQ.
In Proof of Stake, validators can be penalized for being offline. The **penalties for an offline validator are dynamically adjusted** based on the total amount of offline validators and their offline duration. You can find rough estimates within the [staking section](./staking.md) of the FAQ.

This mechanism **incentivizes validators to stay online** and actively participate in the network's consensus process. Validators are expected to be online to propose and attest to blocks. If a validator is offline, they're not fulfilling their role, so their balance slowly leaks over time. The inactivity penalty is proportional to the square of the time the validator has been offline, meaning the penalty accelerates the longer the validator is offline.

Expand Down
2 changes: 1 addition & 1 deletion docs/faq/onboarding/lukso-standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ With LSPs, the mission is to have standards that facilitate using tools that abs
- Assets can be **anchored** directly to the blockchain **account's storage** using [LSP1](/standards/accounts/lsp1-universal-receiver), abandoning complex data fetching.
- Token IDs have an increased size and can map any serial number (for digital or physical products) on-chain, which also allows NFC integration.
- Developers and users can safely utilize **events from asset contracts**, regulate allowlists and blocklists, customize UI and app workflows, or create consensus for asset transfers using LSP1 Delegate.
- Assets have **built-in security for sending assets** to accounts without recovery, utiliszing account abstraction with their force parameter in [LSP7](/standards/tokens/LSP7-Digital-Asset) and [LSP8](/standards/tokens/LSP8-Identifiable-Digital-Asset).
- Assets have **built-in security for sending assets** to accounts without recovery, utilizing account abstraction with their force parameter in [LSP7](/standards/tokens/LSP7-Digital-Asset) and [LSP8](/standards/tokens/LSP8-Identifiable-Digital-Asset).
- Attached data can always be verified through hash integration in the [LSP2](/standards/metadata/lsp2-json-schema) schema.
- Assets can be **organized and managed in vaults** using [LSP9](/standards/accounts/lsp9-vault). Here, multiple services and games can have permissioned access for updating the asset data of user accounts.
- For NFTs, individual token IDs from a collection can have **separate metadata**, upgrades, creators, and behaviors, instead of just being limited to the logic of the mint contract.
Expand Down
Loading
Loading