OpenZeppelin

2.1.2

Escrow

contract Escrow

is Secondary

Base escrow contract, holds funds destinated to a payee until they withdraw them. The contract that uses the escrow as its payment method should be its primary, and provide public methods redirecting to the escrow's deposit and withdraw.

Source: payment/Escrow.sol

Index

Reference

Events

  • Deposited

    event Deposited(address payee, uint256 weiAmount)
    Parameters:
    payee - address
    weiAmount - uint256

  • Withdrawn

    event Withdrawn(address payee, uint256 weiAmount)
    Parameters:
    payee - address
    weiAmount - uint256

Functions

  • deposit

    function deposit(address payee) public payable

    Stores the sent amount as credit to be withdrawn.

    Modifiers:
    onlyPrimary
    Parameters:
    payee - The destination address of the funds.

  • depositsOf

    function depositsOf(address payee) public view returns (uint256)
    Parameters:
    payee - address
    Returns:
    uint256

  • withdraw

    function withdraw(address payee) public

    Withdraw accumulated balance for a payee.

    Modifiers:
    onlyPrimary
    Parameters:
    payee - The address whose funds will be withdrawn and transferred to.