From c8b7e288c25c1f419f54d74e22ff72a13dab3ca4 Mon Sep 17 00:00:00 2001 From: adam Date: Wed, 4 Sep 2024 17:40:27 -0400 Subject: [PATCH] fix: add doc and remove unused constant --- src/helpers/ModuleEntityLib.sol | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/src/helpers/ModuleEntityLib.sol b/src/helpers/ModuleEntityLib.sol index 4f184c37..dda2c4e4 100644 --- a/src/helpers/ModuleEntityLib.sol +++ b/src/helpers/ModuleEntityLib.sol @@ -2,27 +2,29 @@ pragma solidity ^0.8.20; import {ModuleEntity} from "../interfaces/IModularAccount.sol"; +// ModuleEntity is a packed representation of a module function +// Layout: +// 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA________________________ // Address +// 0x________________________________________BBBBBBBB________________ // Entity ID +// 0x________________________________________________0000000000000000 // unused library ModuleEntityLib { - // Magic value for hooks that should always revert. - ModuleEntity internal constant _PRE_HOOK_ALWAYS_DENY = ModuleEntity.wrap(bytes24(uint192(2))); - function pack(address addr, uint32 entityId) internal pure returns (ModuleEntity) { return ModuleEntity.wrap(bytes24(bytes20(addr)) | bytes24(uint192(entityId))); } - function unpack(ModuleEntity fr) internal pure returns (address addr, uint32 entityId) { - bytes24 underlying = ModuleEntity.unwrap(fr); + function unpack(ModuleEntity moduleEntity) internal pure returns (address addr, uint32 entityId) { + bytes24 underlying = ModuleEntity.unwrap(moduleEntity); addr = address(bytes20(underlying)); entityId = uint32(bytes4(underlying << 160)); } - function isEmpty(ModuleEntity fr) internal pure returns (bool) { - return ModuleEntity.unwrap(fr) == bytes24(0); + function isEmpty(ModuleEntity moduleEntity) internal pure returns (bool) { + return ModuleEntity.unwrap(moduleEntity) == bytes24(0); } - function notEmpty(ModuleEntity fr) internal pure returns (bool) { - return ModuleEntity.unwrap(fr) != bytes24(0); + function notEmpty(ModuleEntity moduleEntity) internal pure returns (bool) { + return ModuleEntity.unwrap(moduleEntity) != bytes24(0); } function eq(ModuleEntity a, ModuleEntity b) internal pure returns (bool) {