ISettingsFacet
Interface for the SettingsFacet contract.
The SettingsFacet contract manages the settings of the project. It is used to store and retrieve the settings flags and data.
Functions
Section titled “Functions”settingsFlags
Section titled “settingsFlags”Returns the settings flags
function settingsFlags() external view returns (SettingsFlags memory flags);Returns
| Name | Type | Description |
|---|---|---|
flags | SettingsFlags | The current settings flags |
settingsData
Section titled “settingsData”Returns the settings data
function settingsData() external view returns (SettingsData memory data);Returns
| Name | Type | Description |
|---|---|---|
data | SettingsData | The current settings data |
certificateManager
Section titled “certificateManager”Returns the address of the certificate manager contract.
function certificateManager() external view returns (address nftManagerAddress);Returns
| Name | Type | Description |
|---|---|---|
nftManagerAddress | address | The address of the certificate manager contract. |
depositTokenAddress
Section titled “depositTokenAddress”Returns the address of the deposit token contract.
Returns address(0x0) if there’s no deposit token set.
function depositTokenAddress() external view returns (address tokenAddress);Returns
| Name | Type | Description |
|---|---|---|
tokenAddress | address | The address of the deposit token contract. |
updateSettings
Section titled “updateSettings”Updates the settings with the given flags and data.
The caller must have the MANAGER role.
The settings will be validated before updating.
function updateSettings(SettingsFlags calldata flags, SettingsData calldata data) external;Parameters
| Name | Type | Description |
|---|---|---|
flags | SettingsFlags | The new settings flags |
data | SettingsData | The new settings data |