ISubmodule
Inherits: IVersioned
Title: ISubmodule
forge-lint: disable-start(mixed-case-function)
Interface for Bophades submodules
Submodules are isolated components of a module that can be upgraded independently
Functions
PARENT
5 byte identifier for the parent module
function PARENT() external pure returns (Keycode);
Returns
| Name | Type | Description |
|---|---|---|
<none> | Keycode | The keycode of the parent module |
SUBKEYCODE
20 byte identifier for the submodule. First 5 bytes must match PARENT()
function SUBKEYCODE() external pure returns (SubKeycode);
Returns
| Name | Type | Description |
|---|---|---|
<none> | SubKeycode | The subkeycode of this submodule |
INIT
Initialization function for the submodule
This function is called when the submodule is installed or upgraded by the module
MUST BE GATED BY onlyParent. Used to encompass any initialization or upgrade logic
function INIT() external;