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

chore: update comments #119

Merged
merged 1 commit into from
Jan 25, 2024
Merged
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
5 changes: 3 additions & 2 deletions src/interfaces/IPlugin.sol
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ enum ManifestAssociatedFunctionType {
NONE,
// Function belongs to this plugin.
SELF,
// Function belongs to an external plugin provided as a dependency during plugin installation.
// Function belongs to an external plugin provided as a dependency during plugin installation. Plugins MAY depend
// on external validation functions. It MUST NOT depend on external hooks, or installation will fail.
DEPENDENCY,
// Resolves to a magic value to always bypass runtime validation for a given function.
// This is only assignable on runtime validation functions. If it were to be used on a user op validation function,
Expand Down Expand Up @@ -71,7 +72,7 @@ struct PluginMetadata {
// The author field SHOULD be a username representing the identity of the user or organization
// that created this plugin.
string author;
// String desciptions of the relative sensitivity of specific functions. The selectors MUST be selectors for
// String descriptions of the relative sensitivity of specific functions. The selectors MUST be selectors for
// functions implemented by this plugin.
SelectorPermission[] permissionDescriptors;
}
Expand Down
1 change: 1 addition & 0 deletions src/interfaces/IPluginManager.sol
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

pragma solidity ^0.8.22;

// Treats the first 20 bytes as an address, and the last byte as a function identifier.
type FunctionReference is bytes21;

/// @title Plugin Manager Interface
Expand Down
4 changes: 2 additions & 2 deletions src/interfaces/IStandardExecutor.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ pragma solidity ^0.8.22;
struct Call {
// The target address for the account to call.
address target;
// The value sent with the call.
// The value to send with the call.
uint256 value;
// The calldata for the call.
bytes data;
Expand All @@ -20,7 +20,7 @@ interface IStandardExecutor {
/// @notice Standard execute method.
/// @dev If the target is a plugin, the call SHOULD revert.
/// @param target The target address for the account to call.
/// @param value The value sent with the call.
/// @param value The value to send with the call.
/// @param data The calldata for the call.
/// @return The return data from the call.
function execute(address target, uint256 value, bytes calldata data) external payable returns (bytes memory);
Expand Down