【以太坊篇】-简单的拍卖合约解析

2022-04-26 19:56:14 浏览数 (1)

最近学习了一个通用型的拍卖合约,具体解析也可参照solidity学习官网中的例子。

总体思路是合约创建后每个人都可以在投标期内发送他们的出价参与竞拍。在一段时间后出价最高者将会获胜。智能合约的不同在于需要竞拍者在出价时直接把“币”发送给智能合约进行托管。否则只出价不付款,在拍卖结束后无法保证能及时按照拍卖价格进行付款。

在这个合约里只负责交割,实际拍卖物品不在合约里。合约执行结果作为所有权转移依据并不是保障。

(在执行合约时,由于remix的合约版本过高,例子里的要求在0.7.0版本内,所以视情况而定改变合约版本,建议可用0.5.0以上版本就行)

先上代码:

代码语言:javascript复制
pragma solidity >=0.5.0 <0.7.0;

contract SimpleAuction {
    // 拍卖的参数。
    address payable 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 payable _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);
    }
}

主要分为四大块:simpleAuction合约创建、出价函数、退款函数和竞拍结束函数。

(1) simpleAction合约创建:在deploy中要输入的参数有两类:受益者(beneficiary)和竞拍时长(biddingTime)如下图,拍卖结束的时间auctionTime即为合约部署的时间(now函数的返回值 竞拍时长)。

第二个受益者也即拍卖者,可在虚拟机随意选择一个哈希地址作为受益者,也可连接到本地地址metamask内部作为受益者,我选择的是前者。之后选择竞标时间看到给的uint256格式,uint是无符号整数,后缀必须是8~256范围内8的整数倍。int默认表示256,这里我用的是0x0000000000000000000000000000000000000000000000000000000000000003

(2)出价函数:合约创建以后所有人都可以调用合约函数的bid()来进行出价。

代码语言:javascript复制
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);
    }

(3)退款函数

当一个用户的出价被其余出价超过,其可通过调用withdraw()函数让合约进行退款。

代码语言:javascript复制
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;
    }

    /// 结束拍卖,并把最高的出价发送给受益人

(4)竞拍结束函数:在竞拍结束后向受益者移交最高的出价。

Checks对应两个require条件: require(now >= auctionEnd, require(!ended,

先判断竞拍是否结束再判断竞拍本身已经结束。第二个条件主要用来防止函数被重复执行。

ended = true:表示整个竞拍过程即将结束。

beneficiary.transfer(highestBid)在effects后执行转账,防止攻击者通过智能合约迭代调用,重复执行转账操作。

代码语言:javascript复制
 function auctionEnd1() 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);
    }
}

这是一个简易拍卖合约,在此基础上后期会出盲拍以及作者改进的合约示例,在学习同时一起交流。(附两张结果图)

之后更新速度会变慢,挤时间学区块链太难了。或许会出几期时间不需那么久,科普知识型的新文。或者自己的想法什么的。

参考文献:solidity 官网和《以太坊技术详解与实战》

0 人点赞