Skip to content

Commit

Permalink
add natspec for endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
zerosnacks committed Feb 6, 2024
1 parent 4e49ae6 commit cd26c83
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions src/ReflexEndpoint.sol
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ import {IReflexEndpoint} from "./interfaces/IReflexEndpoint.sol";
/**
* @title Reflex Endpoint
*
* @dev `Endpoints` are trusted contracts that receive calls and forward them to the `Dispatcher` using `CALL`.
* The forwarded calldata is appended with the `msg.sender` of the original call.
* `Endpoints` are commonly deployed by the `Installer` upon registering of a module
* and by multi-module factories upon instance creation.
*
* @dev Execution takes place within the Dispatcher's storage context, not the endpoints'.
* @dev Non-upgradeable, extendable.
*/
Expand Down
2 changes: 1 addition & 1 deletion src/ReflexInstaller.sol
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {ReflexModule} from "./ReflexModule.sol";
* @dev The `Installer` manages the ownership of the Reflex layer and the registration of modules.
* The owner has the ability to add modules and upgrade existing modules.
* The transferral of ownership is a two-step process, where the new owner must accept the ownership transfer.
* The `Installer` is also a module itself with an endpoint and can be upgraded.
* The `Installer` is also a module itself with an `Endpoint` and can be upgraded.
*
* @dev Execution takes place within the Dispatcher's storage context.
* @dev Upgradeable, extendable.
Expand Down

0 comments on commit cd26c83

Please sign in to comment.