-
Notifications
You must be signed in to change notification settings - Fork 11.7k
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
Feature/crowdsale refactor #744
Changes from 54 commits
49b16cf
fc7af3c
d54f799
f48c150
3f5680b
a8a14df
469a999
90f0973
3ffe518
a5aaf94
8a3cfb9
6343246
2c22337
8c8fed1
962b5bc
bbb2dfa
3fdb6da
53ec3cc
2be5806
b814a05
dd05925
120d277
e677e33
5873f8e
2fe239c
bf5e9dd
cd0ba80
0487d25
c4a2f9c
3ef55bc
c1a41ae
b455000
a841691
3d4d41a
8b6b342
1a2a5ec
1680a18
344bec6
7d4035a
bcd0464
51c0954
cd15b41
e716a22
7134f0d
f56116e
2a6dd9f
8e8e8cc
fa055a6
56e83b9
1bf30f9
a70e3ed
5f4fc83
47ce79f
5dab495
dd338f1
8376baa
8ad6a10
107fdc4
530d85d
9fe61b8
de8e88f
6c38f46
33839c1
df03099
c6def0e
c177f01
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,107 +1,158 @@ | ||
pragma solidity ^0.4.18; | ||
|
||
import "../token/ERC20/MintableToken.sol"; | ||
import "../token/ERC20/ERC20.sol"; | ||
import "../math/SafeMath.sol"; | ||
|
||
|
||
/** | ||
* @title Crowdsale | ||
* @dev Crowdsale is a base contract for managing a token crowdsale. | ||
* Crowdsales have a start and end timestamps, where investors can make | ||
* token purchases and the crowdsale will assign them tokens based | ||
* on a token per ETH rate. Funds collected are forwarded to a wallet | ||
* as they arrive. The contract requires a MintableToken that will be | ||
* minted as contributions arrive, note that the crowdsale contract | ||
* must be owner of the token in order to be able to mint it. | ||
* @dev Crowdsale is a base contract for managing a token crowdsale, | ||
* allowing investors to purchase tokens with ether. This contract implements | ||
* such functionality in its most fundamental form and can be extended to provide additional | ||
* functionality and/or custom behavior. | ||
* The external interface represents the basic interface for purchasing tokens, and conform | ||
* the base architecture for crowdsales. They are *not* intended to be modified / overriden. | ||
* The internal interface conforms the extensible and modifiable surface of crowdsales. Override | ||
* the methods to add functionality. Consider using 'super' where appropiate to concatenate | ||
* behavior. | ||
*/ | ||
|
||
contract Crowdsale { | ||
using SafeMath for uint256; | ||
|
||
// The token being sold | ||
MintableToken public token; | ||
|
||
// start and end timestamps where investments are allowed (both inclusive) | ||
uint256 public startTime; | ||
uint256 public endTime; | ||
ERC20 public token; | ||
|
||
// address where funds are collected | ||
// Address where funds are collected | ||
address public wallet; | ||
|
||
// how many token units a buyer gets per wei | ||
// How many token units a buyer gets per wei | ||
uint256 public rate; | ||
|
||
// amount of raised money in wei | ||
// Amount of wei raised | ||
uint256 public weiRaised; | ||
|
||
/** | ||
* event for token purchase logging | ||
* Event for token purchase logging | ||
* @param purchaser who paid for the tokens | ||
* @param beneficiary who got the tokens | ||
* @param value weis paid for purchase | ||
* @param amount amount of tokens purchased | ||
*/ | ||
event TokenPurchase(address indexed purchaser, address indexed beneficiary, uint256 value, uint256 amount); | ||
|
||
|
||
function Crowdsale(uint256 _startTime, uint256 _endTime, uint256 _rate, address _wallet, MintableToken _token) public { | ||
require(_startTime >= now); | ||
require(_endTime >= _startTime); | ||
/** | ||
* @param _rate Number of token units a buyer gets per wei | ||
* @param _wallet Address where collected funds will be forwarded to | ||
* @param _token Address of the token being sold | ||
*/ | ||
function Crowdsale(uint256 _rate, address _wallet, ERC20 _token) public { | ||
require(_rate > 0); | ||
require(_wallet != address(0)); | ||
require(_token != address(0)); | ||
|
||
startTime = _startTime; | ||
endTime = _endTime; | ||
rate = _rate; | ||
wallet = _wallet; | ||
token = _token; | ||
} | ||
|
||
// fallback function can be used to buy tokens | ||
// ----------------------------------------- | ||
// Crowdsale external interface | ||
// ----------------------------------------- | ||
|
||
/** | ||
* @dev fallback function ***DO NOT OVERRIDE*** | ||
*/ | ||
function () external payable { | ||
buyTokens(msg.sender); | ||
} | ||
|
||
// low level token purchase function | ||
function buyTokens(address beneficiary) public payable { | ||
require(beneficiary != address(0)); | ||
require(validPurchase()); | ||
/** | ||
* @dev low level token purchase ***DO NOT OVERRIDE*** | ||
* @param _beneficiary Address performing the token purchase | ||
*/ | ||
function buyTokens(address _beneficiary) public payable { | ||
|
||
uint256 weiAmount = msg.value; | ||
_preValidatePurchase(_beneficiary, weiAmount); | ||
|
||
// calculate token amount to be created | ||
uint256 tokens = getTokenAmount(weiAmount); | ||
uint256 tokens = _getTokenAmount(weiAmount); | ||
|
||
// update state | ||
weiRaised = weiRaised.add(weiAmount); | ||
|
||
token.mint(beneficiary, tokens); | ||
TokenPurchase(msg.sender, beneficiary, weiAmount, tokens); | ||
_processPurchase(_beneficiary, tokens); | ||
TokenPurchase(msg.sender, _beneficiary, weiAmount, tokens); | ||
|
||
_updatePurchasingState(_beneficiary, weiAmount); | ||
|
||
_forwardFunds(); | ||
_postValidatePurchase(_beneficiary, weiAmount); | ||
} | ||
|
||
// ----------------------------------------- | ||
// Internal interface (extensible) | ||
// ----------------------------------------- | ||
|
||
/** | ||
* @dev Validation of an incoming purchase. Use require statemens to revert state when conditions are not met. Use super to concatenate validations. | ||
* @param _beneficiary Address performing the token purchase | ||
* @param _weiAmount Value in wei involved in the purchase | ||
*/ | ||
function _preValidatePurchase(address _beneficiary, uint256 _weiAmount) internal { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what about using just There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm down to do that, now that we're making sweeping changes. Obviously updated across the file(s) where appropriate There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. NACK |
||
require(_beneficiary != address(0)); | ||
require(_weiAmount != 0); | ||
} | ||
|
||
forwardFunds(); | ||
/** | ||
* @dev Validation of an executed purchase. Observe state and use revert statements to undo rollback when valid conditions are not met. | ||
* @param _beneficiary Address performing the token purchase | ||
* @param _weiAmount Value in wei involved in the purchase | ||
*/ | ||
function _postValidatePurchase(address _beneficiary, uint256 _weiAmount) internal { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. what are some example use-cases for this, especially since we don't use it in these contracts? If the answer is just "why not allow it" that's fine too There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For example, if you are performing a purchase that involves a call to another contract, you can check that the call worked the way you were expecting here There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, gotcha, for invariants and such. Nice. |
||
// optional override | ||
} | ||
|
||
// @return true if crowdsale event has ended | ||
function hasEnded() public view returns (bool) { | ||
return now > endTime; | ||
/** | ||
* @dev Source of tokens. Override this method to modify the way in which the crowdsale ultimately gets and sends its tokens. | ||
* @param _beneficiary Address performing the token purchase | ||
* @param _tokenAmount Number of tokens to be emitted | ||
*/ | ||
function _emitTokens(address _beneficiary, uint256 _tokenAmount) internal { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Given that the function is called There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ..but it might be confusing in |
||
token.transfer(_beneficiary, _tokenAmount); | ||
} | ||
|
||
// Override this method to have a way to add business logic to your crowdsale when buying | ||
function getTokenAmount(uint256 weiAmount) internal view returns(uint256) { | ||
return weiAmount.mul(rate); | ||
/** | ||
* @dev Executed when a purchase has been validated and is ready to be executed. Not necessarily emits/sends tokens. | ||
* @param _beneficiary Address receiving the tokens | ||
* @param _tokenAmount Number of tokens to be purchased | ||
*/ | ||
function _processPurchase(address _beneficiary, uint256 _tokenAmount) internal { | ||
_emitTokens(_beneficiary, _tokenAmount); | ||
} | ||
|
||
// send ether to the fund collection wallet | ||
// override to create custom fund forwarding mechanisms | ||
function forwardFunds() internal { | ||
wallet.transfer(msg.value); | ||
/** | ||
* @dev Override for extensions that require an internal state to check for validity (current user contributions, etc.) | ||
* @param _beneficiary Address receiving the tokens | ||
* @param _weiAmount Value in wei involved in the purchase | ||
*/ | ||
function _updatePurchasingState(address _beneficiary, uint256 _weiAmount) internal { | ||
// optional override | ||
} | ||
|
||
// @return true if the transaction can buy tokens | ||
function validPurchase() internal view returns (bool) { | ||
bool withinPeriod = now >= startTime && now <= endTime; | ||
bool nonZeroPurchase = msg.value != 0; | ||
return withinPeriod && nonZeroPurchase; | ||
/** | ||
* @dev Override to extend the way in which ether is converted to tokens. | ||
* @param _weiAmount Value in wei to be converted into tokens | ||
* @return Number of tokens that can be purchased with the specified _weiAmount | ||
*/ | ||
function _getTokenAmount(uint256 _weiAmount) internal view returns (uint256) { | ||
return _weiAmount.mul(rate); | ||
} | ||
|
||
/** | ||
* @dev Determines how ETH is stored/forwarded on purchases. | ||
*/ | ||
function _forwardFunds() internal { | ||
wallet.transfer(msg.value); | ||
} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I really loved how this look like, great job guys π |
||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
pragma solidity ^0.4.18; | ||
|
||
import "../validation/TimedCrowdsale.sol"; | ||
import "../../token/ERC20/ERC20.sol"; | ||
import "../../math/SafeMath.sol"; | ||
|
||
/** | ||
* @title PostDeliveryCrowdsale | ||
* @dev Crowdsale that locks tokens from withdrawal until it ends. | ||
*/ | ||
contract PostDeliveryCrowdsale is TimedCrowdsale { | ||
using SafeMath for uint256; | ||
|
||
mapping(address => uint256) public balances; | ||
|
||
/** | ||
* @dev Overrides parent by storing balances instead of issuing tokens right away. | ||
* @param _beneficiary Token purchaser | ||
* @param _tokenAmount Amount of tokens purchased | ||
*/ | ||
function _processPurchase(address _beneficiary, uint256 _tokenAmount) internal { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. missing doc |
||
balances[_beneficiary] = balances[_beneficiary].add(_tokenAmount); | ||
} | ||
|
||
/** | ||
* @dev Withdraw tokens only after crowdsale ends. | ||
*/ | ||
function withdrawTokens() public { | ||
require(hasExpired()); | ||
uint256 amount = balances[msg.sender]; | ||
require(amount > 0); | ||
balances[msg.sender] = 0; | ||
_emitTokens(msg.sender, amount); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. From the description:
but I guess it is locking tokens not funds right? |
||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've traditionally seen multiline
@dev
comments either prefixed with@dev
all the way downThe docs don't specify what happens for multiline, though, so I'm not sure what the standard is. Off the top of my head, though, I think OZ primarily uses the
@dev
prefix per-line, but I could be wrong and I'm not particularly partialThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @shrugs. Throughout the OZ codebase, a single
@dev
at the beginning of a multi-sentence description seems to be the norm (examples: Bounty.sol, DayLimit.sol). Also, the automatically-generated docs parse NatSpec following this convention.The NatSpec specification is not at all clear about how to handle this case, but there are two examples within the document which use a muti-line
@notice
tag (link).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the heads up!