Browse Source

Improve general documentation for 5.2 (#5310)

Ernesto García 10 months ago
parent
commit
ccb39d2765

+ 1 - 1
contracts/governance/utils/VotesExtended.sol

@@ -13,7 +13,7 @@ abstract contract VotesExtended is Votes {
     using Checkpoints for Checkpoints.Trace160;
     using Checkpoints for Checkpoints.Trace208;
 
-    mapping(address delegatee => Checkpoints.Trace160) private _delegateCheckpoints;
+    mapping(address delegator => Checkpoints.Trace160) private _delegateCheckpoints;
     mapping(address account => Checkpoints.Trace208) private _balanceOfCheckpoints;
 
     /**

+ 3 - 3
contracts/interfaces/draft-IERC4337.sol

@@ -27,7 +27,7 @@ pragma solidity ^0.8.20;
  * - `callData` (`bytes`)
  * - `accountGasLimits` (`bytes32`): concatenation of verificationGas (16 bytes) and callGas (16 bytes)
  * - `preVerificationGas` (`uint256`)
- * - `gasFees` (`bytes32`): concatenation of maxPriorityFee (16 bytes) and maxFeePerGas (16 bytes)
+ * - `gasFees` (`bytes32`): concatenation of maxPriorityFeePerGas (16 bytes) and maxFeePerGas (16 bytes)
  * - `paymasterAndData` (`bytes`): concatenation of paymaster fields (or empty)
  * - `signature` (`bytes`)
  */
@@ -38,8 +38,8 @@ struct PackedUserOperation {
     bytes callData;
     bytes32 accountGasLimits; // `abi.encodePacked(verificationGasLimit, callGasLimit)` 16 bytes each
     uint256 preVerificationGas;
-    bytes32 gasFees; // `abi.encodePacked(maxPriorityFee, maxFeePerGas)` 16 bytes each
-    bytes paymasterAndData; // `abi.encodePacked(paymaster, paymasterVerificationGasLimit, paymasterPostOpGasLimit, paymasterData)`
+    bytes32 gasFees; // `abi.encodePacked(maxPriorityFeePerGas, maxFeePerGas)` 16 bytes each
+    bytes paymasterAndData; // `abi.encodePacked(paymaster, paymasterVerificationGasLimit, paymasterPostOpGasLimit, paymasterData)` (20 bytes, 16 bytes, 16 bytes, dynamic)
     bytes signature;
 }
 

+ 2 - 2
contracts/proxy/Clones.sol

@@ -163,8 +163,8 @@ library Clones {
      * access the arguments within the implementation, use {fetchCloneArgs}.
      *
      * This function uses the create2 opcode and a `salt` to deterministically deploy the clone. Using the same
-     * `implementation` and `salt` multiple times will revert, since the clones cannot be deployed twice at the same
-     * address.
+     * `implementation`, `args` and `salt` multiple time will revert, since the clones cannot be deployed twice
+     * at the same address.
      */
     function cloneDeterministicWithImmutableArgs(
         address implementation,

+ 2 - 2
contracts/utils/NoncesKeyed.sol

@@ -35,8 +35,8 @@ abstract contract NoncesKeyed is Nonces {
      * @dev Same as {_useNonce} but checking that `nonce` is the next valid for `owner`.
      *
      * This version takes the key and the nonce in a single uint256 parameter:
-     * - use the first 8 bytes for the key
-     * - use the last 24 bytes for the nonce
+     * - use the first 24 bytes for the key
+     * - use the last 8 bytes for the nonce
      */
     function _useCheckedNonce(address owner, uint256 keyNonce) internal virtual override {
         (uint192 key, ) = _unpack(keyNonce);