20230315BlindAuction合约及代码解释
//SPDX-License-Identifier: GPL-3.0
pragma Solidity ^0.8.17;
contract BlindAuction{
/*
定义了一个出价的结构,有两个属性,一个是出价人,一个是存入金额*/
struct Bid{
bytes32 blindedBid;
uint deposit;
}
//受益人地址
address payable public beneficiary;
//拍卖结束时间
uint public biddingEnd;
//揭露时间
uint public revealEnd;
//是否结束标志
bool ended;
//定义了一个mapping,key为出价的地址, value为对应的出价人出价数据的数组
mapping(address => Bid[])public bids;
//最高出价人地址
address public highestBidder;
//最高出价金额
uint public highestBId;
//竞标失败人允许的提款金额mapping, key为允许提款的地址,value为对应的可提款金额
mapping(address =>uint)pendingReturns;
/*
定义了一个事件,拍卖结束,并且告知所有人拍卖的赢家以及拍卖的成交金额*/
event AuctionEnded(addres winner,uint highestBid);
//定义了一个错误,too Early, 并且提示调用方可以调用当前方法的时间.
error TooEarly(uint time);
//定义了一个错误,too late,返回的时间是调用的最后截止时间,在这个时间之后调用就会触发这个错误.
error TooLate(uint time);
//定义了AuctionEnd方法已经调用的错误.
error AuctionEndAlreadyCalled();
modifier onlyBefore(uint time){
if(block.timestamp >= time)
revert TooLate(time);//如果当前区块时间超过了允许的时间,那么触发too late error
_;
}
modifier onlyAfter(uint time){
if(block.timestamp<=time)
revert TooEarly(time);
_;
}
/*
定义了一个构造函数,有三个参数,一个就是拍卖时间,第二个就是揭露时间,第三个就是受益人收款地址*/
constructor(uint biddingTime,uint revealTime,address payable beneficiaryAddress){
beneficiary = beneficiaryAddress;
biddingEnd = block.timestamp + biddingTime;// 当前时间戳以秒为单位的数字,加上拍卖时长,就是拍卖结束时间.
revealEnd = biddingEnd + revealTime;//拍卖结束时间加上揭露结果时长就是揭露结果结束时间
}
/*
定义了一个外部调用的方法拍卖出价,在方法中,将每个地址的出价以及发送的金额放入到一个 mapping状态变量中*/
function bid(bytes32 blindedBid)external payable onlyBefore(biddingEnd){
bids[msg.sender].push(Bid({
blindedBid: blindedBid,
deposit: msg.value
}));
}
function reveal(uint[] calldata values,bool[] calldata fakes,bytes32 calldata secrets)external onlyAfter(biddingEnd) onlyBefore(revealEnd){
uint length = bids[msg.sender].length;
require(values.length == length);
require(fakes.length == length);
require(secrets.length == length);
uint refund;
for(uint i=0;i
Bidstorage bidToCheck = bids[msg.sender][i];
(uint value,bool fake,bytes32 secret) = (values[i],fakes[i],secrets[i]);
if(bidToCheck.blindedBid != keccak256(abi.encodePacked(value,fake,secret))){
//todo 这里没看懂
continue;
}
refund += bidToCheck.deposit;
if(!fake&& bidToCheck.deposit>=value){
if(placeBid(msg.sender,value)){
refund -= value;
}
}
bidToCheck.blindedBid =bytes32(0);
}
//向没有中招的那些人退款
payable(msg.sender).transfer(refund);
}
/*
定义了一个供外部调用的提款功能,将拍卖未中标的人退还其本金*/
function withdraw()external {
uint amount = pendingReturns[msg.sender];
if(amount>0){
pendingReturns[msg.sender] =0;
payable(msg.sender).transfer(amount);
}
}
function auctionEnd()external onlyAfter(revealEnd) {
//判断是否已经执行过这个方法,如果已经执行过,那么抛出AuctionEndAlreadyCalled error
if(ended)
revert AuctionEndAlreadyCalled();
emit AuctionEnded(highestBidder,highestBId);
ended =true;//将结束标志设置为true
beneficiary.transfer(highestBId);//将合约中的金额转给受益人
}
/*
定义了一个内部方法,该方法只供内部使用,或者来源的合约进行调用.
*/
function placeBid(address bidder,uint value)internal returns (bool success){
if(value<= highest){
return false;//出价失败说明并没有高于当前最高价.
}
if(highestBidder !=address(0)){
//如果出价人不是零地址,那么就给之前出价高的地址进行退还
pendingReturns[highestBidder] += highestBId;
}
//到了这边就说明当前人是出价最高的,则修改出价最高人和对应的出价金额.
highestBId = value;
highestBidder = bidder;
return false;
}
}
