IPCVGuardian
IPCVGuardian
an interface for defining how the PCVGuardian functions
any implementation of this contract should be granted the roles of Guardian and PCVController in order to work correctly
Methods
addWhitelistAddress
function addWhitelistAddress(address pcvDeposit) external nonpayable
governor-only method to whitelist a pcvDeposit address to withdraw funds from
Parameters
| Name | Type | Description |
|---|
| pcvDeposit | address | the address to whitelist |
addWhitelistAddresses
function addWhitelistAddresses(address[] whitelistAddresses) external nonpayable
batch version of addWhitelistAddress
Parameters
| Name | Type | Description |
|---|
| whitelistAddresses | address[] | the pcvDespoit addresses to whitelist, as calldata |
getWhitelistAddresses
function getWhitelistAddresses() external view returns (address[])
returns all whitelisted addresses
Returns
| Name | Type | Description |
|---|
| _0 | address[] | undefined |
isWhitelistAddress
function isWhitelistAddress(address pcvDeposit) external view returns (bool)
returns true if the pcvDeposit address is whitelisted
Parameters
| Name | Type | Description |
|---|
| pcvDeposit | address | the address to check |
Returns
| Name | Type | Description |
|---|
| _0 | bool | undefined |
removeWhitelistAddress
function removeWhitelistAddress(address pcvDeposit) external nonpayable
governor-or-guardian-only method to remove pcvDeposit address from the whitelist to withdraw funds from
Parameters
| Name | Type | Description |
|---|
| pcvDeposit | address | the address to un-whitelist |
removeWhitelistAddresses
function removeWhitelistAddresses(address[] whitelistAddresses) external nonpayable
batch version of removeWhitelistAddress
Parameters
| Name | Type | Description |
|---|
| whitelistAddresses | address[] | the addresses to un-whitelist |
withdrawAllERC20ToSafeAddress
function withdrawAllERC20ToSafeAddress(address pcvDeposit, address token) external nonpayable
governor-or-guardian-or-pcv-guard method to withdraw all of an ERC20 balance from a pcv deposit, by calling the withdrawERC20() method on it
Parameters
| Name | Type | Description |
|---|
| pcvDeposit | address | the deposit to pull funds from |
| token | address | the address of the token to withdraw |
withdrawAllToSafeAddress
function withdrawAllToSafeAddress(address pcvDeposit) external nonpayable
governor-or-guardian-or-pcv-guard method to withdraw all at once funds from a pcv deposit, by calling the withdraw() method on it
Parameters
| Name | Type | Description |
|---|
| pcvDeposit | address | the address of the pcv deposit contract |
withdrawERC20ToSafeAddress
function withdrawERC20ToSafeAddress(address pcvDeposit, address token, uint256 amount) external nonpayable
governor-or-guardian-or-pcv-guard method to withdraw an ERC20 from a pcv deposit, by calling the withdrawERC20() method on it
Parameters
| Name | Type | Description |
|---|
| pcvDeposit | address | the deposit to pull funds from |
| token | address | the address of the token to withdraw |
| amount | uint256 | the amount of funds to withdraw |
withdrawToSafeAddress
function withdrawToSafeAddress(address pcvDeposit, uint256 amount) external nonpayable
governor-or-guardian-or-pcv-guard method to withdraw funds from a pcv deposit, by calling the withdraw() method on it
Parameters
| Name | Type | Description |
|---|
| pcvDeposit | address | the address of the pcv deposit contract |
| amount | uint256 | the amount to withdraw |
Events
PCVGuardianERC20Withdrawal
event PCVGuardianERC20Withdrawal(address indexed pcvDeposit, address indexed token, uint256 amount)
Parameters
| Name | Type | Description |
|---|
pcvDeposit indexed | address | undefined |
token indexed | address | undefined |
| amount | uint256 | undefined |
PCVGuardianWithdrawal
event PCVGuardianWithdrawal(address indexed pcvDeposit, uint256 amount)
Parameters
| Name | Type | Description |
|---|
pcvDeposit indexed | address | undefined |
| amount | uint256 | undefined |
WhitelistAddressAdded
event WhitelistAddressAdded(address indexed pcvDeposit)
Parameters
| Name | Type | Description |
|---|
pcvDeposit indexed | address | undefined |
WhitelistAddressRemoved
event WhitelistAddressRemoved(address indexed pcvDeposit)
Parameters
| Name | Type | Description |
|---|
pcvDeposit indexed | address | undefined |