原文地址
https://solidity-cn.readthedocs.io/zh/develop/solidity-by-example.html
源代码
pragma solidity ^0.4.22;
contract SimpleAuction {
// 拍卖的参数。
address public beneficiary;
// 时间是unix的绝对时间戳(自1970-01-01以来的秒数)
// 或以秒为单位的时间段。
uint public auctionEnd;
// 拍卖的当前状态
address public highestBidder;
uint public highestBid;
//可以取回的之前的出价
mapping(address => uint) pendingReturns;
// 拍卖结束后设为 true,将禁止所有的变更
bool ended;
// 变更触发的事件
event HighestBidIncreased(address bidder, uint amount);
event AuctionEnded(address winner, uint amount);
// 以下是所谓的 natspec 注释,可以通过三个斜杠来识别。
// 当用户被要求确认交易时将显示。
/// 以受益者地址 `_beneficiary` 的名义,
/// 创建一个简单的拍卖,拍卖时间为 `_biddingTime` 秒。
constructor(
uint _biddingTime,
address _beneficiary
) public {
beneficiary = _beneficiary;
auctionEnd = now + _biddingTime;
}
/// 对拍卖进行出价,具体的出价随交易一起发送。
/// 如果没有在拍卖中胜出,则返还出价。
function bid() public payable {
// 参数不是必要的。因为所有的信息已经包含在了交易中。
// 对于能接收以太币的函数,关键字 payable 是必须的。
// 如果拍卖已结束,撤销函数的调用。
require(
now <= auctionEnd,
"Auction already ended."
);
// 如果出价不够高,返还你的钱
require(
msg.value > highestBid,
"There already is a higher bid."
);
if (highestBid != 0) {
// 返还出价时,简单地直接调用 highestBidder.send(highestBid) 函数,
// 是有安全风险的,因为它有可能执行一个非信任合约。
// 更为安全的做法是让接收方自己提取金钱。
pendingReturns[highestBidder] += highestBid;
}
highestBidder = msg.sender;
highestBid = msg.value;
emit HighestBidIncreased(msg.sender, msg.value);
}
/// 取回出价(当该出价已被超越)
function withdraw() public returns (bool) {
uint amount = pendingReturns[msg.sender];
if (amount > 0) {
// 这里很重要,首先要设零值。
// 因为,作为接收调用的一部分,
// 接收者可以在 `send` 返回之前,重新调用该函数。
pendingReturns[msg.sender] = 0;
if (!msg.sender.send(amount)) {
// 这里不需抛出异常,只需重置未付款
pendingReturns[msg.sender] = amount;
return false;
}
}
return true;
}
/// 结束拍卖,并把最高的出价发送给受益人
function auctionEnd() public {
// 对于可与其他合约交互的函数(意味着它会调用其他函数或发送以太币),
// 一个好的指导方针是将其结构分为三个阶段:
// 1. 检查条件
// 2. 执行动作 (可能会改变条件)
// 3. 与其他合约交互
// 如果这些阶段相混合,其他的合约可能会回调当前合约并修改状态,
// 或者导致某些效果(比如支付以太币)多次生效。
// 如果合约内调用的函数包含了与外部合约的交互,
// 则它也会被认为是与外部合约有交互的。
// 1. 条件
require(now >= auctionEnd, "Auction not yet ended.");
require(!ended, "auctionEnd has already been called.");
// 2. 生效
ended = true;
emit AuctionEnded(highestBidder, highestBid);
// 3. 交互
beneficiary.transfer(highestBid);
}
}
引例
A,B,C进行拍卖竞价,拍卖必须在规定时间内结束。A竞价100,就会把A的余额中100元取走,并记录下来A的上次出价,即100。若B又竞价200,就会把B的余额中200元取走,并记录下来B的上次出价,即200。并让A提取走它的上次出价回余额,再设置其上次出价为0。(文中注释说:这样让拍卖者自己主动调用函数回滚更安全)。如此下去,直到拍卖时间结束,并将受益者转换成最终的赢家。
总结
合约拍卖{
设置受益者变量(用来最终将受益者转换给赢家),设置拍卖时间、最高竞价者、最高竞价、拍卖结束标志。
每一个玩家都可以映射出其上一次出价。
定义最高竞价改变事件和拍卖结束事件。
拍卖函数:要求拍卖时间未结束,调用者余额高于当前最高竞价。余额回滚。设置新的的最高竞价者,扣费。广播最高竞价改变事件。
回滚函数:由已被超过的最高竞价者自己调用。余额回滚,并设置其上次竞价为0。
拍卖结束函数:只能被调用一次,要求拍卖时间结束。广播拍卖结束事件,转移受益者。
}
一个小细节
由合约(其中的函数)向用户地址转账以太币是不需要payable修饰的,但由用户地址向合约函数转出以太币是必须用payable修饰的。