Skip to content

Commit

Permalink
fix: grammar issues
Browse files Browse the repository at this point in the history
  • Loading branch information
b00ste committed Nov 26, 2024
1 parent 6b159ca commit 6414b4d
Show file tree
Hide file tree
Showing 29 changed files with 65 additions and 65 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ Which is is not the intended output.

3. `@return` tag is mandatory if the function has any return value.

4. Make sure to use one of the custom tags below to document any additional informations of different kinds:
4. Make sure to use one of the custom tags below to document any additional information of different kinds:

- Use `@custom:requirements` for all the requirements to use a function.
- Use `@custom:events` for all the emited events during the function execution.
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 @@ -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

Expand Down 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 Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ function _getExtensionAndForwardValue(

Returns the extension mapped to a specific function selector
If no extension was found, return the address(0)
To be overrided.
Up to the implementor contract to return an extension based on a function selector
To be overridden.
Up to the implementer contract to return an extension based on a function selector

<br/>

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -365,13 +365,13 @@ error PrimaryContractProxyInitFailureError(bytes errorData);

_Failed to deploy & initialize the Primary Contract Proxy. Error: `errorData`._

Reverts when the deployment & intialization of the contract has failed.
Reverts when the deployment & initialization of the contract has failed.

#### Parameters

| Name | Type | Description |
| ----------- | :-----: | ----------------------------------------------------------------------------- |
| `errorData` | `bytes` | Potentially information about why the deployment & intialization have failed. |
| `errorData` | `bytes` | Potentially information about why the deployment & initialization have failed. |

<br/>

Expand All @@ -392,12 +392,12 @@ error SecondaryContractProxyInitFailureError(bytes errorData);

_Failed to deploy & initialize the Secondary Contract Proxy. Error: `errorData`._

Reverts when the deployment & intialization of the secondary contract has failed.
Reverts when the deployment & initialization of the secondary contract has failed.

#### Parameters

| Name | Type | Description |
| ----------- | :-----: | ----------------------------------------------------------------------------- |
| `errorData` | `bytes` | Potentially information about why the deployment & intialization have failed. |
| `errorData` | `bytes` | Potentially information about why the deployment & initialization have failed. |

<br/>
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
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 Expand Up @@ -401,7 +401,7 @@ function lsp20VerifyCall(

| Name | Type | Description |
| ---- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `0` | `bytes4` | MUST return the first 3 bytes of `lsp20VerifyCall(address,uint256,bytes)` function selector if the call to the function is allowed, concatened with a byte that determines if the lsp20VerifyCallResult function should be called after the original function call. The byte that invoke the lsp20VerifyCallResult function is strictly `0x01`. |
| `0` | `bytes4` | MUST return the first 3 bytes of `lsp20VerifyCall(address,uint256,bytes)` function selector if the call to the function is allowed, concatenated with a byte that determines if the lsp20VerifyCallResult function should be called after the original function call. The byte that invoke the lsp20VerifyCallResult function is strictly `0x01`. |

<br/>

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

Expand Down Expand Up @@ -937,7 +937,7 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw
| --------------- | :-------: | ------------------------------------------------------------------- |
| `operator` | `address` | The address of the operator to decrease the allowance of. |
| `tokenOwner` | `address` | The address that granted an allowance on its balance to `operator`. |
| `amountToSpend` | `uint256` | The amount of tokens to substract in allowance of `operator`. |
| `amountToSpend` | `uint256` | The amount of tokens to subtract in allowance of `operator`. |

<br/>

Expand Down Expand Up @@ -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

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

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

Expand Down Expand Up @@ -962,7 +962,7 @@ Spend `amountToSpend` from the `operator`'s authorized on behalf of the `tokenOw
| --------------- | :-------: | ------------------------------------------------------------------- |
| `operator` | `address` | The address of the operator to decrease the allowance of. |
| `tokenOwner` | `address` | The address that granted an allowance on its balance to `operator`. |
| `amountToSpend` | `uint256` | The amount of tokens to substract in allowance of `operator`. |
| `amountToSpend` | `uint256` | The amount of tokens to subtract in allowance of `operator`. |

<br/>

Expand Down Expand Up @@ -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

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

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

Expand Down Expand Up @@ -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`. |

<br/>

Expand Down Expand Up @@ -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

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

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

Expand Down Expand Up @@ -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`. |

<br/>

Expand Down Expand Up @@ -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

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

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

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

Expand Down
Loading

0 comments on commit 6414b4d

Please sign in to comment.