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

Conversation

ernestognw
Copy link
Member

Fixes L-09

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

Copy link

changeset-bot bot commented Nov 20, 2024

⚠️ No Changeset found

Latest commit: 3803803

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ernestognw ernestognw requested a review from a team November 20, 2024 17:00
contracts/interfaces/draft-IERC7579.sol Outdated Show resolved Hide resolved
contracts/interfaces/draft-IERC7579.sol Outdated Show resolved Hide resolved
@@ -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).

@@ -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).

/**
* @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.

/**
* @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.

Comment on lines +109 to +111
* @dev Smart Account execution according to ERC-7579.
*
* To implement ERC-7579 modules, smart accounts must implement this interface.
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants