Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Escrows #1014

Merged
merged 15 commits into from
Jul 3, 2018
Merged

Escrows #1014

Show file tree
Hide file tree
Changes from 13 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions contracts/Bounty.sol
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ contract Bounty is PullPayment, Destructible {
}

/**
* @dev Sends the contract funds to the researcher that proved the contract is broken.
* @dev Transfers the contract funds to the researcher that proved the contract is broken.
* @param target contract
*/
function claim(Target target) public {
address researcher = researchers[target];
require(researcher != address(0));
// Check Target contract invariants
require(!target.checkInvariant());
asyncSend(researcher, address(this).balance);
asyncTransfer(researcher, address(this).balance);
claimed = true;
}

Expand Down
24 changes: 12 additions & 12 deletions contracts/crowdsale/distribution/RefundableCrowdsale.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,30 @@ pragma solidity ^0.4.24;

import "../../math/SafeMath.sol";
import "./FinalizableCrowdsale.sol";
import "./utils/RefundVault.sol";
import "../../payment/RefundEscrow.sol";
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think RefundEscrow is very much crowdsale-specific so it should be with the crowdsale stuff. Potentially in this same file. Thoughts?

Copy link
Contributor Author

@nventuro nventuro Jun 18, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disagree: a RefundEscrow is a payment method, a crowdsale typically using it doesn't make it crowdsale-specific. As an example, platforms like Amazon or eBay also offer refunds and act as an escrow themselves, and could extend their payment systems to add support for multiple payers.



/**
* @title RefundableCrowdsale
* @dev Extension of Crowdsale contract that adds a funding goal, and
* the possibility of users getting a refund if goal is not met.
* Uses a RefundVault as the crowdsale's vault.
*/
contract RefundableCrowdsale is FinalizableCrowdsale {
using SafeMath for uint256;

// minimum amount of funds to be raised in weis
uint256 public goal;

// refund vault used to hold funds while crowdsale is running
RefundVault public vault;
// refund escrow used to hold funds while crowdsale is running
RefundEscrow private escrow;

/**
* @dev Constructor, creates RefundVault.
* @dev Constructor, creates RefundEscrow.
* @param _goal Funding goal
*/
constructor(uint256 _goal) public {
require(_goal > 0);
vault = new RefundVault(wallet);
escrow = new RefundEscrow(wallet);
goal = _goal;
}

Expand All @@ -38,7 +37,7 @@ contract RefundableCrowdsale is FinalizableCrowdsale {
require(isFinalized);
require(!goalReached());

vault.refund(msg.sender);
escrow.withdraw(msg.sender);
}

/**
Expand All @@ -50,23 +49,24 @@ contract RefundableCrowdsale is FinalizableCrowdsale {
}

/**
* @dev vault finalization task, called when owner calls finalize()
* @dev escrow finalization task, called when owner calls finalize()
*/
function finalization() internal {
if (goalReached()) {
vault.close();
escrow.close();
escrow.beneficiaryWithdraw();
} else {
vault.enableRefunds();
escrow.enableRefunds();
}

super.finalization();
}

/**
* @dev Overrides Crowdsale fund forwarding, sending funds to vault.
* @dev Overrides Crowdsale fund forwarding, sending funds to escrow.
*/
function _forwardFunds() internal {
vault.deposit.value(msg.value)(msg.sender);
escrow.deposit.value(msg.value)(msg.sender);
}

}
66 changes: 0 additions & 66 deletions contracts/crowdsale/distribution/utils/RefundVault.sol

This file was deleted.

18 changes: 18 additions & 0 deletions contracts/mocks/ConditionalEscrowMock.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
pragma solidity ^0.4.24;


import "../payment/ConditionalEscrow.sol";


// mock class using ConditionalEscrow
contract ConditionalEscrowMock is ConditionalEscrow {
mapping(address => bool) public allowed;

function setAllowed(address _payee, bool _allowed) public {
allowed[_payee] = _allowed;
}

function withdrawalAllowed(address _payee) public view returns (bool) {
return allowed[_payee];
}
}
6 changes: 3 additions & 3 deletions contracts/mocks/PullPaymentMock.sol
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ contract PullPaymentMock is PullPayment {

constructor() public payable { }

// test helper function to call asyncSend
function callSend(address dest, uint256 amount) public {
asyncSend(dest, amount);
// test helper function to call asyncTransfer
function callTransfer(address dest, uint256 amount) public {
asyncTransfer(dest, amount);
}

}
22 changes: 22 additions & 0 deletions contracts/payment/ConditionalEscrow.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
pragma solidity ^0.4.23;

import "./Escrow.sol";


/**
* @title ConditionalEscrow
* @dev Base abstract escrow to only allow withdrawal if a condition is met.
*/
contract ConditionalEscrow is Escrow {
/**
* @dev Returns whether an address is allowed to withdraw their funds. To be
* implemented by derived contracts.
* @param _payee The destination address of the funds.
*/
function withdrawalAllowed(address _payee) public view returns (bool);

function withdraw(address _payee) public {
require(withdrawalAllowed(_payee));
super.withdraw(_payee);
}
}
49 changes: 49 additions & 0 deletions contracts/payment/Escrow.sol
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
pragma solidity ^0.4.23;

import "../math/SafeMath.sol";


/**
* @title Escrow
* @dev Base escrow contract, holds funds destinated to a payee until they
* withdraw them.
*/
contract Escrow {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add Deposited and Withdrawn events. (I'm open to other names.)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would make the Refunded event a bit redundant (since it will also emit an identical Withdrawn): do we want to remove it?

using SafeMath for uint256;

event Deposited(address indexed payee, uint256 weiAmount);
event Withdrawn(address indexed payee, uint256 weiAmount);

mapping(address => uint256) private deposits;

function depositsOf(address _payee) public view returns (uint256) {
return deposits[_payee];
}

/**
* @dev Called by the payer to store the sent amount as credit to be pulled.
* @param _payee The destination address of the funds.
*/
function deposit(address _payee) payable public {
uint256 amount = msg.value;
deposits[_payee] = deposits[_payee].add(amount);

emit Deposited(_payee, amount);
}

/**
* @dev Withdraw accumulated balance for a payee. Any address can trigger a
* withdrawal.
* @param _payee The address whose funds will be withdrawn and transferred to.
*/
function withdraw(address _payee) public {
uint256 payment = deposits[_payee];
assert(address(this).balance >= payment);

deposits[_payee] = 0;

_payee.transfer(payment);

emit Withdrawn(_payee, payment);
}
}
37 changes: 18 additions & 19 deletions contracts/payment/PullPayment.sol
Original file line number Diff line number Diff line change
@@ -1,43 +1,42 @@
pragma solidity ^0.4.24;


import "../math/SafeMath.sol";
import "./Escrow.sol";


/**
* @title PullPayment
* @dev Base contract supporting async send for pull payments. Inherit from this
* contract and use asyncSend instead of send or transfer.
* contract and use asyncTransfer instead of send or transfer.
*/
contract PullPayment {
using SafeMath for uint256;
Escrow private escrow;

mapping(address => uint256) public payments;
uint256 public totalPayments;
constructor() public {
escrow = new Escrow();
}

/**
* @dev Withdraw accumulated balance, called by payee.
*/
function withdrawPayments() public {
address payee = msg.sender;
uint256 payment = payments[payee];

require(payment != 0);
require(address(this).balance >= payment);

totalPayments = totalPayments.sub(payment);
payments[payee] = 0;
escrow.withdraw(payee);
}

payee.transfer(payment);
/**
* @dev Returns the credit owed to an address.
* @param _dest The creditor's address.
*/
function payments(address _dest) public view returns (uint256) {
return escrow.depositsOf(_dest);
}

/**
* @dev Called by the payer to store the sent amount as credit to be pulled.
* @param dest The destination address of the funds.
* @param amount The amount to transfer.
* @param _dest The destination address of the funds.
* @param _amount The amount to transfer.
*/
function asyncSend(address dest, uint256 amount) internal {
payments[dest] = payments[dest].add(amount);
totalPayments = totalPayments.add(amount);
function asyncTransfer(address _dest, uint256 _amount) internal {
escrow.deposit.value(_amount)(_dest);
}
}
Loading