VaultWhitelist
Inherits: Initializable ↗, VaultAdmin →, IVaultWhitelist
Defines the whitelisting functionality for the Vault.
Events
WhitelistUpdated
Event emitted on whitelist update
event WhitelistUpdated(address indexed caller, address indexed account, bool approved);
Parameters
| Name | Type | Description |
|---|---|---|
caller | address | The address of the function caller |
account | address | The address of the account updated |
approved | bool | Whether account is approved or not |
WhitelisterUpdated
Event emitted when whitelister address is updated
event WhitelisterUpdated(address indexed caller, address indexed whitelister);
Parameters
| Name | Type | Description |
|---|---|---|
caller | address | The address of the function caller |
whitelister | address | The address of the new whitelister |
Functions
whitelister
Whitelister address
function whitelister() external view returns (address);
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The address of the whitelister |
whitelistedAccounts
Checks whether account is whitelisted or not
function whitelistedAccounts(address account) external view returns (bool);
Parameters
| Name | Type | Description |
|---|---|---|
account | address | The account to check |
Returns
| Name | Type | Description |
|---|---|---|
<none> | bool | true for the whitelisted account, false otherwise |
updateWhitelist
Add or remove account from the whitelist. Can only be called by the whitelister.
function updateWhitelist(address account, bool approved) external override;
Parameters
| Name | Type | Description |
|---|---|---|
account | address | The account to add or remove from the whitelist |
approved | bool | Whether account should be whitelisted or not |
setWhitelister
Used to update the whitelister. Can only be called by the Vault admin.
function setWhitelister(address _whitelister) external override;
Parameters
| Name | Type | Description |
|---|---|---|
_whitelister | address | The address of the new whitelister |