IEthPoolEscrow
Author: StakeWise
Defines the interface for the PoolEscrow contract on Ethereum
Copied from https://github.com/stakewise/contracts/blob/master/contracts/interfaces/IPoolEscrow.sol
Functions
owner
Function for retrieving the address of the current owner
function owner() external view returns (address);
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The address of the current owner |
futureOwner
Function for retrieving the address of the future owner
function futureOwner() external view returns (address);
Returns
| Name | Type | Description |
|---|---|---|
<none> | address | The address of the future owner |
commitOwnershipTransfer
Commit contract ownership transfer to a new account (newOwner). Can only be called by the current owner.
function commitOwnershipTransfer(address newOwner) external;
Parameters
| Name | Type | Description |
|---|---|---|
newOwner | address | The address the ownership is planned to be transferred to |
applyOwnershipTransfer
Apply contract ownership transfer to a new account (futureOwner). Can only be called by the future owner.
function applyOwnershipTransfer() external;
withdraw
Withdraw balance for a payee, forwarding all gas to the recipient. Can only be called by the current owner.
WARNING: Forwarding all gas opens the door to reentrancy vulnerabilities. Make sure you trust the recipient, or are either following the checks-effects-interactions pattern or using ReentrancyGuard.
function withdraw(address payable payee, uint256 amount) external;
Parameters
| Name | Type | Description |
|---|---|---|
payee | address payable | The address where the funds will be transferred to |
amount | uint256 | The amount of ether to transfer to payee |
Events
Withdrawn
Event for tracking withdrawn ether
event Withdrawn(address indexed sender, address indexed payee, uint256 amount);
Parameters
| Name | Type | Description |
|---|---|---|
sender | address | The address of the transaction sender |
payee | address | The address where the funds were transferred to |
amount | uint256 | The amount of ether transferred to payee |
OwnershipTransferCommitted
Event for tracking ownership transfer commits
event OwnershipTransferCommitted(address indexed currentOwner, address indexed futureOwner);
Parameters
| Name | Type | Description |
|---|---|---|
currentOwner | address | The address of the current owner |
futureOwner | address | The address the ownership is planned to be transferred to |
OwnershipTransferApplied
Event for tracking ownership transfers
event OwnershipTransferApplied(address indexed previousOwner, address indexed newOwner);
Parameters
| Name | Type | Description |
|---|---|---|
previousOwner | address | The address the ownership was transferred from |
newOwner | address | The address the ownership was transferred to |