Skip to content

Commit 450b833

Browse files
Amxxarr00ernestognw
authored
Group typo fixes #2 (#5561)
Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: ernestognw <ernestognw@gmail.com>
1 parent 1873ecb commit 450b833

File tree

14 files changed

+33
-41
lines changed

14 files changed

+33
-41
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
#### Custom error changes
88

99
- Replace `GovernorAlreadyOverridenVote` with `GovernorAlreadyOverriddenVote`.
10+
- Replace `AccessControlNonRevokable` with `AccessControlNonRevocable`.
1011

1112
## 5.2.0 (2025-01-08)
1213

contracts/interfaces/draft-IERC4337.sol

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ pragma solidity ^0.8.20;
2121
* - `paymasterData` (`bytes`): Data for paymaster (only if paymaster exists)
2222
* - `signature` (`bytes`): Data passed into the account to verify authorization
2323
*
24-
* When passed to on-chain contacts, the following packed version is used.
24+
* When passed to on-chain contracts, the following packed version is used.
2525
* - `sender` (`address`)
2626
* - `nonce` (`uint256`)
2727
* - `initCode` (`bytes`): concatenation of factory address and factoryData (or empty)
@@ -164,13 +164,13 @@ interface IEntryPoint is IEntryPointNonces, IEntryPointStake {
164164

165165
/**
166166
* @dev Executes a batch of user operations.
167-
* @param beneficiary Address to which gas is refunded up completing the execution.
167+
* @param beneficiary Address to which gas is refunded upon completing the execution.
168168
*/
169169
function handleOps(PackedUserOperation[] calldata ops, address payable beneficiary) external;
170170

171171
/**
172172
* @dev Executes a batch of aggregated user operations per aggregator.
173-
* @param beneficiary Address to which gas is refunded up completing the execution.
173+
* @param beneficiary Address to which gas is refunded upon completing the execution.
174174
*/
175175
function handleAggregatedOps(
176176
UserOpsPerAggregator[] calldata opsPerAggregator,

contracts/interfaces/draft-IERC7579.sol

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ uint256 constant MODULE_TYPE_HOOK = 4;
1515
interface IERC7579Module {
1616
/**
1717
* @dev This function is called by the smart account during installation of the module
18-
* @param data arbitrary data that may be required on the module during `onInstall` initialization
18+
* @param data arbitrary data that may be passed to the module during `onInstall` initialization
1919
*
2020
* MUST revert on error (e.g. if module is already enabled)
2121
*/
2222
function onInstall(bytes calldata data) external;
2323

2424
/**
2525
* @dev This function is called by the smart account during uninstallation of the module
26-
* @param data arbitrary data that may be required on the module during `onUninstall` de-initialization
26+
* @param data arbitrary data that may be passed to the module during `onUninstall` de-initialization
2727
*
2828
* MUST revert on error
2929
*/
@@ -186,7 +186,7 @@ interface IERC7579ModuleConfig {
186186
* @dev Installs a Module of a certain type on the smart account
187187
* @param moduleTypeId the module type ID according to the ERC-7579 spec
188188
* @param module the module address
189-
* @param initData arbitrary data that may be required on the module during `onInstall`
189+
* @param initData arbitrary data that may be passed to the module during `onInstall`
190190
* initialization.
191191
*
192192
* MUST implement authorization control
@@ -200,8 +200,8 @@ interface IERC7579ModuleConfig {
200200
* @dev Uninstalls a Module of a certain type on the smart account
201201
* @param moduleTypeId the module type ID according the ERC-7579 spec
202202
* @param module the module address
203-
* @param deInitData arbitrary data that may be required on the module during `onInstall`
204-
* initialization.
203+
* @param deInitData arbitrary data that may be passed to the module during `onUninstall`
204+
* deinitialization.
205205
*
206206
* MUST implement authorization control
207207
* MUST call `onUninstall` on the module with the `deInitData` parameter if provided
@@ -214,7 +214,7 @@ interface IERC7579ModuleConfig {
214214
* @dev Returns whether a module is installed on the smart account
215215
* @param moduleTypeId the module type ID according the ERC-7579 spec
216216
* @param module the module address
217-
* @param additionalContext arbitrary data that may be required to determine if the module is installed
217+
* @param additionalContext arbitrary data that may be passed to determine if the module is installed
218218
*
219219
* MUST return true if the module is installed and false otherwise
220220
*/

contracts/mocks/docs/access-control/AccessControlModified.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ pragma solidity ^0.8.20;
55
import {AccessControl} from "../../../access/AccessControl.sol";
66

77
contract AccessControlModified is AccessControl {
8-
error AccessControlNonRevokable();
8+
error AccessControlNonRevocable();
99

1010
// Override the revokeRole function
1111
function revokeRole(bytes32, address) public pure override {
12-
revert AccessControlNonRevokable();
12+
revert AccessControlNonRevocable();
1313
}
1414
}

contracts/mocks/token/ERC20ForceApproveMock.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
44

55
import {ERC20} from "../../token/ERC20/ERC20.sol";
66

7-
// contract that replicate USDT (0xdac17f958d2ee523a2206206994597c13d831ec7) approval behavior
7+
// contract that replicates USDT (0xdac17f958d2ee523a2206206994597c13d831ec7) approval behavior
88
abstract contract ERC20ForceApproveMock is ERC20 {
99
function approve(address spender, uint256 amount) public virtual override returns (bool) {
1010
require(amount == 0 || allowance(msg.sender, spender) == 0, "USDT approval failure");

contracts/token/ERC20/ERC20.sol

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ abstract contract ERC20 is Context, IERC20, IERC20Metadata, IERC20Errors {
3939
/**
4040
* @dev Sets the values for {name} and {symbol}.
4141
*
42-
* All two of these values are immutable: they can only be set once during
43-
* construction.
42+
* Both values are immutable: they can only be set once during construction.
4443
*/
4544
constructor(string memory name_, string memory symbol_) {
4645
_name = name_;

contracts/token/ERC20/README.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ This set of interfaces, contracts, and utilities are all related to the https://
77

88
TIP: For an overview of ERC-20 tokens and a walk through on how to create a token contract read our xref:ROOT:erc20.adoc[ERC-20 guide].
99

10-
There are a few core contracts that implement the behavior specified in the ERC:
10+
There are a few core contracts that implement the behavior specified in the ERC-20 standard:
1111

1212
* {IERC20}: the interface all ERC-20 implementations should conform to.
13-
* {IERC20Metadata}: the extended ERC-20 interface including the <<ERC20-name,`name`>>, <<ERC20-symbol,`symbol`>> and <<ERC20-decimals,`decimals`>> functions.
14-
* {ERC20}: the implementation of the ERC-20 interface, including the <<ERC20-name,`name`>>, <<ERC20-symbol,`symbol`>> and <<ERC20-decimals,`decimals`>> optional standard extension to the base interface.
13+
* {IERC20Metadata}: the extended ERC-20 interface including the <<ERC20-name--,`name`>>, <<ERC20-symbol--,`symbol`>> and <<ERC20-decimals--,`decimals`>> functions.
14+
* {ERC20}: the implementation of the ERC-20 interface, including the <<ERC20-name--,`name`>>, <<ERC20-symbol--,`symbol`>> and <<ERC20-decimals--,`decimals`>> optional extensions to the standard interface.
1515
1616
Additionally there are multiple custom extensions, including:
1717

@@ -30,9 +30,9 @@ Finally, there are some utilities to interact with ERC-20 contracts in various w
3030

3131
* {SafeERC20}: a wrapper around the interface that eliminates the need to handle boolean return values.
3232
33-
Other utilities that support ERC-20 assets can be found in codebase:
33+
Other utilities that support ERC-20 assets can be found in the codebase:
3434

35-
* ERC-20 tokens can be timelocked (held tokens for a beneficiary until a specified time) or vested (released following a given schedule) using a {VestingWallet}.
35+
* ERC-20 tokens can be timelocked (held for a beneficiary until a specified time) or vested (released following a given schedule) using a {VestingWallet}.
3636
3737
NOTE: This core set of contracts is designed to be unopinionated, allowing developers to access the internal functions in ERC-20 (such as <<ERC20-_mint-address-uint256-,`_mint`>>) and expose them as external functions in the way they prefer.
3838

contracts/utils/TransientSlot.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ pragma solidity ^0.8.24;
3232
*/
3333
library TransientSlot {
3434
/**
35-
* @dev UDVT that represents a slot holding a address.
35+
* @dev UDVT that represents a slot holding an address.
3636
*/
3737
type AddressSlot is bytes32;
3838

docs/modules/ROOT/pages/utilities.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ At a high level, signatures are a set of cryptographic algorithms that allow for
1212

1313
==== Ethereum Signatures (secp256k1)
1414

15-
xref:api:utils.adoc#ECDSA[`ECDSA`] provides functions for recovering and managing Ethereum account ECDSA signatures. These are often generated via https://web3js.readthedocs.io/en/v1.7.3/web3-eth.html#sign[`web3.eth.sign`], and are a 65 byte array (of type `bytes` in Solidity) arranged the following way: `[[v (1)], [r (32)], [s (32)]]`.
15+
xref:api:utils.adoc#ECDSA[`ECDSA`] provides functions for recovering and managing Ethereum account ECDSA signatures. These are often generated via https://web3js.readthedocs.io/en/v1.7.3/web3-eth.html#sign[`web3.eth.sign`], and form a 65-byte array (of type `bytes` in Solidity) arranged the following way: `[[v (1)], [r (32)], [s (32)]]`.
1616

1717
The data signer can be recovered with xref:api:utils.adoc#ECDSA-recover-bytes32-bytes-[`ECDSA.recover`], and its address compared to verify the signature. Most wallets will hash the data to sign and add the prefix `\x19Ethereum Signed Message:\n`, so when attempting to recover the signer of an Ethereum signed message hash, you'll want to use xref:api:utils.adoc#MessageHashUtils-toEthSignedMessageHash-bytes32-[`toEthSignedMessageHash`].
1818

@@ -197,7 +197,7 @@ The `Enumerable*` structures are similar to mappings in that they store and remo
197197

198198
Building an on-chain Merkle Tree allows developers to keep track of the history of roots in a decentralized manner. For these cases, the xref:api:utils.adoc#MerkleTree[`MerkleTree`] includes a predefined structure with functions to manipulate the tree (e.g. pushing values or resetting the tree).
199199

200-
The Merkle Tree does not keep track of the roots purposely, so that developers can choose their tracking mechanism. Setting up and using a Merkle Tree in Solidity is as simple as follows:
200+
The Merkle Tree does not keep track of the roots intentionally, so that developers can choose their tracking mechanism. Setting up and using a Merkle Tree in Solidity is as simple as follows:
201201

202202
NOTE: Functions are exposed without access control for demonstration purposes
203203

@@ -243,7 +243,7 @@ function _hashFn(bytes32 a, bytes32 b) internal view returns(bytes32) {
243243

244244
=== Using a Heap
245245

246-
A https://en.wikipedia.org/wiki/Binary_heap[binary heap] is a data structure that always store the most important element at its peak and it can be used as a priority queue.
246+
A https://en.wikipedia.org/wiki/Binary_heap[binary heap] is a data structure that always stores the most important element at its peak and it can be used as a priority queue.
247247

248248
To define what is most important in a heap, these frequently take comparator functions that tell the binary heap whether a value has more relevance than another.
249249

@@ -358,7 +358,7 @@ This is especially useful for building URL-safe tokenURIs for both xref:api:toke
358358

359359
Here is an example to send JSON Metadata through a Base64 Data URI using an ERC-721:
360360

361-
[source, solidity]
361+
[source,solidity]
362362
----
363363
include::api:example$utilities/Base64NFT.sol[]
364364
----

hardhat/ignore-unreachable-warnings.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// with hardhat-ignore-warnings we are not able to selectively ignore them without potentially ignoring relevant
44
// warnings that we don't want to miss.
55
// Thus, we need to handle these warnings separately. We force Hardhat to compile them in a separate compilation job and
6-
// then ignore the warnings about unreachable code that come from that compilation job.
6+
// then ignore the warnings about unreachable code coming from that compilation job.
77

88
const { task } = require('hardhat/config');
99
const {

0 commit comments

Comments
 (0)