Skip to content

Commit

Permalink
chore: fix spelling errors caught by CI
Browse files Browse the repository at this point in the history
  • Loading branch information
CJ42 committed Nov 25, 2024
1 parent 0f73ade commit 9a09a49
Show file tree
Hide file tree
Showing 66 changed files with 120 additions and 100 deletions.
1 change: 1 addition & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/_interface_ids_table.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ function _cleanStorage(
) internal nonpayable;
```

Remove the guardians choice after a successfull recovery process
Remove the guardians choice after a successful recovery process
To avoid keeping unnecessary state

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/contracts/LSP6KeyManager/LSP6KeyManager.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

<br/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/contracts/deployed-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading

0 comments on commit 9a09a49

Please sign in to comment.