Skip to content

Commit

Permalink
docs(world): add natspec to module errors (#2390)
Browse files Browse the repository at this point in the history
  • Loading branch information
yonadaa authored Mar 7, 2024
1 parent 5873393 commit d66e2bc
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion packages/world/src/IModuleErrors.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,21 @@ pragma solidity >=0.8.24;
* This ensures that all errors are included in the IWorldKernel ABI for proper decoding in the frontend.
*/
interface IModuleErrors {
/// @dev Errors to represent non-support of specific installation types.
/**
* @notice Error raised if installing in root is not supported.
*/
error Module_RootInstallNotSupported();
/**
* @notice Error raised if installing in non-root is not supported.
*/
error Module_NonRootInstallNotSupported();
/**
* @notice Error raised if the provided module is already installed.
*/
error Module_AlreadyInstalled();
/**
* @notice Error raised if the provided module is missing a dependency.
* @param dependency The address of the dependency.
*/
error Module_MissingDependency(address dependency);
}

0 comments on commit d66e2bc

Please sign in to comment.