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

Add missing docstrings #5311

Open
wants to merge 5 commits into
base: master
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 @@ -35,7 +35,10 @@ abstract contract GovernorCountingOverridable is GovernorVotes {
mapping(address voter => VoteReceipt) voteReceipt;
}

event VoteReduced(address indexed voter, uint256 proposalId, uint8 support, uint256 weight);
/// @dev The vote was reduced by `weight` after an override over the `delegate` by the original token holder
event VoteReduced(address indexed delegate, uint256 proposalId, uint8 support, uint256 weight);

/// @dev A delegated vote on `proposalId` was overridden by `weight`
event OverrideVoteCast(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason);

error GovernorAlreadyOverridenVote(address account);
Expand Down
27 changes: 27 additions & 0 deletions contracts/interfaces/draft-IERC7579.sol
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ uint256 constant MODULE_TYPE_EXECUTOR = 2;
uint256 constant MODULE_TYPE_FALLBACK = 3;
uint256 constant MODULE_TYPE_HOOK = 4;

/// @dev Minimal configuration interface for ERC-7579 modules
interface IERC7579Module {
/**
* @dev This function is called by the smart account during installation of the module
Expand All @@ -36,6 +37,11 @@ interface IERC7579Module {
function isModuleType(uint256 moduleTypeId) external view returns (bool);
}

/**
* @dev ERC-7579 Validator.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* @dev ERC-7579 Validator.
* @dev ERC-7579 Validation module (type 1).

*
* A module that implements logic to validate user operations and signatures.
*/
interface IERC7579Validator is IERC7579Module {
/**
* @dev Validates a UserOperation
Expand Down Expand Up @@ -63,6 +69,12 @@ interface IERC7579Validator is IERC7579Module {
) external view returns (bytes4);
}

/**
* @dev ERC-7579 Executor.
Copy link
Collaborator

@Amxx Amxx Nov 22, 2024

Choose a reason for hiding this comment

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

This is IERC7579Hook.

Hooks module are type id 4 and Execution modules are type id 2. So I'm guessing there is a confusion here

Suggested change
* @dev ERC-7579 Executor.
* @dev ERC-7579 Hooks module (type 4).

*
* A module that implements logic to execute before and after the account executes a user operation,
* either individually or batched.
*/
interface IERC7579Hook is IERC7579Module {
/**
* @dev Called by the smart account before execution
Expand Down Expand Up @@ -93,6 +105,11 @@ struct Execution {
bytes callData;
}

/**
* @dev Smart Account execution according to ERC-7579.
*
* To implement ERC-7579 modules, smart accounts must implement this interface.
Comment on lines +109 to +111
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* @dev Smart Account execution according to ERC-7579.
*
* To implement ERC-7579 modules, smart accounts must implement this interface.
* @dev ERC-7579 Execution.
*
* Accounts should implement this interface so that the Entrypoint and ERC-7579 modules can execute operations.

*/
interface IERC7579Execution {
/**
* @dev Executes a transaction on behalf of the account.
Expand All @@ -119,6 +136,11 @@ interface IERC7579Execution {
) external returns (bytes[] memory returnData);
}

/**
* @dev ERC-7579 Account Config.
*
* Exposes information that identifies the account, supported modules and capabilities.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* Exposes information that identifies the account, supported modules and capabilities.
* Accounts should implement this interface to exposes information that identifies the account, supported modules and capabilities.

*/
interface IERC7579AccountConfig {
/**
* @dev Returns the account id of the smart account
Expand Down Expand Up @@ -148,6 +170,11 @@ interface IERC7579AccountConfig {
function supportsModule(uint256 moduleTypeId) external view returns (bool);
}

/**
* @dev ERC-7579 Module Config.
*
* Allows an account to install and uninstall modules.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* Allows an account to install and uninstall modules.
* Accounts should implement this interface to allows installing and uninstalling modules.

*/
interface IERC7579ModuleConfig {
event ModuleInstalled(uint256 moduleTypeId, address module);
event ModuleUninstalled(uint256 moduleTypeId, address module);
Expand Down