Vyper ERC-721 合约演练

Vyper

erc-721

Python

初级

奥里·波梅兰茨

2021年4月1日

28 分钟阅读

简介

ERC-721 标准用于持有非同质化代币 (NFT) 的所有权。 ERC-20 代币表现得像商品，因为各个代币之间没有区别。相比之下，ERC-721 代币专为相似但不完全相同的资产而设计，例如不同的卡通猫（在新标签页中打开）或不同房地产的产权。

在本文中，我们将分析 Ryuya Nakamura 的 ERC-721 合约（在新标签页中打开）。该合约使用 Vyper （在新标签页中打开）编写，这是一种类似 Python 的合约语言，旨在使其比 Solidity 更难编写出不安全的代码。

合约

# @dev ERC-721非同质化代币标准的实现。
# @author Ryuya Nakamura (@nrryuya)
# 修改自：https://github.com/vyperlang/vyper/blob/de74722bf2d8718cca46902be165f9fe0e3641dd/examples/tokens/ERC721.vy

与 Python 一样，Vyper 中的注释以哈希符号 (ethereum.ercs) 开头，并一直持续到行尾。包含 @<keyword> 的注释被 NatSpec （在新标签页中打开）用于生成人类可读的文档。

from vyper.interfaces import ERC721

implements: ERC721

ERC-721 接口内置于 Vyper 语言中。你可以在这里查看代码定义（在新标签页中打开）。接口定义是用 Python 而不是 Vyper 编写的，因为接口不仅在区块链内部使用，而且在从外部客户端（可能是用 Python 编写的）向区块链发送交易时也会使用。

第一行导入接口，第二行指定我们在此处实现它。

#pragma version >0.3.10

#pragma version >0.3.10

ERC721Receiver 接口

# 由 safeTransferFrom() 调用的合约接口
interface ERC721Receiver:
    def onERC721Received(

ERC-721 支持两种类型的转账：

transferFrom：允许发送者指定任何目标地址，并将转账的责任交给发送者。这意味着你可以转账到一个无效地址，在这种情况下，NFT 将永久丢失。
safeTransferFrom：检查目标地址是否为合约。如果是，ERC-721 合约会询问接收合约是否想要接收该 NFT。

为了响应 safeTransferFrom 请求，接收合约必须实现 ERC721Receiver。

            _operator: address,
            _from: address,

_from 地址是代币的当前所有者。_operator 地址是请求转账的地址（由于授权额度的存在，这两个地址可能不同）。按照惯例，此合约中的大多数函数参数都以下划线 (_) 开头。

            _tokenId: uint256,

ERC-721 代币 ID 为 256 位。通常，它们是通过对代币所代表的内容的描述进行哈希处理来创建的。

            _data: Bytes[1024]

该请求最多可以包含 1024 字节的用户数据。

        ) -> bytes4: nonpayable

为了防止合约意外接受转账的情况，返回值不是布尔值，而是一个特定的四字节值，即 onERC721Received 的函数选择器。该函数是 nonpayable 的，因为接收合约在接受代币时可能会改变其自身的状态。

事件

触发事件是为了向区块链外部的用户和服务器通知事件的发生。请注意，区块链上的合约无法访问事件的内容。这三个 ERC-721 事件由我们导入的 IERC721 接口定义，因此该合约本身并不声明它们；它使用 log IERC721.<Event>(...) 来触发它们，正如我们将在下面的转账函数中看到的那样。

Transfer（sender、receiver、token_id）报告 NFT 所有权的变更。这类似于 ERC-20 的 Transfer 事件，不同之处在于我们报告的是 token_id 而不是金额。没有人拥有零地址，因此按照惯例，我们使用它来报告代币的创建和销毁。唯一的例外是合约创建，在此期间可以创建和分配任意数量的 NFT，而无需触发 Transfer。

ERC-721 授权类似于 ERC-20 授权额度：允许特定地址转账特定代币，并且每当设置或重新确认该授权地址时，都会触发 Approval（owner、approved、token_id）。这为合约在接受代币时提供了一种响应机制。合约无法监听事件，因此如果你只是将代币转账给它们，它们并“不知道”这件事。通过这种方式，所有者首先提交授权，然后向合约发送请求：“我已经授权你转账代币 X，请执行……”。这是一种设计选择，旨在使 ERC-721 标准类似于 ERC-20 标准。由于 ERC-721 代币是非同质化的，合约还可以通过查看代币的所有权来识别它获得了特定的代币。

最后，当为所有者启用或禁用_操作员_时，会触发 ApprovalForAll（owner、operator、approved）。有时，拥有一个可以管理账户中所有特定类型代币（由特定合约管理的代币）的操作员是很有用的，类似于委托书。例如，我可能想将这种权力赋予一个合约，该合约会检查我是否已有六个月没有联系它，如果是，则将我的资产分配给我的继承人（如果其中一人提出请求，因为如果没有被交易调用，合约什么也做不了）。在 ERC-20 中，我们只需给继承合约一个很高的授权额度即可，但这对于 ERC-721 不起作用，因为代币是非同质化的。这就是等效的机制。approved 值告诉我们该事件是用于授权还是撤销授权。

状态变量

这些变量包含代币的当前状态：哪些代币可用以及谁拥有它们。其中大多数是 HashMap 对象，即存在于两种类型之间的单向映射（在新标签页中打开）。

# @dev 从 NFT ID 到拥有它的地址的映射。
idToOwner: HashMap[uint256, address]

# @dev 从 NFT ID 到授权地址的映射。
idToApprovals: HashMap[uint256, address]

以太坊中的用户和合约身份由 160 位地址表示。这两个变量将代币 ID 映射到它们的所有者以及被授权转账它们的人（每个代币最多一个）。在以太坊中，未初始化的数据始终为零，因此如果没有所有者或授权转账者，该代币的值为零。

# @dev 从所有者地址到其代币数量的映射。
ownerToNFTokenCount: HashMap[address, uint256]

此变量保存每个所有者的代币数量。没有从所有者到代币的映射，因此识别特定所有者拥有的代币的唯一方法是回顾区块链的事件历史记录并查看相应的 Transfer 事件。我们可以使用此变量来知道何时我们已经找到了所有的 NFT，而不需要在时间上进一步追溯。

请注意，此算法仅适用于用户界面和外部服务器。在区块链本身上运行的代码无法读取过去的事件。

# @dev 从所有者地址到操作员地址映射的映射。
ownerToOperators: HashMap[address, HashMap[address, bool]]

一个账户可能有多个操作员。简单的 HashMap 不足以跟踪它们，因为每个键只对应一个值。相反，你可以使用 HashMap[address, bool] 作为值。默认情况下，每个地址的值为 False，这意味着它不是操作员。你可以根据需要将值设置为 True。

# @dev 铸造者的地址，可以铸造代币
minter: address

新代币必须以某种方式创建。在此合约中，只有一个实体被允许这样做，即 minter。例如，这对于游戏来说可能就足够了。对于其他目的，可能需要创建更复杂的业务逻辑。

# @dev 支持的 ERC165 接口 ID 的静态列表
SUPPORTED_INTERFACES: constant(bytes4[2]) = [
    # ERC165 的 ERC165 接口 ID
    0x01ffc9a7,
    # ERC721 的 ERC165 接口 ID
    0x80ac58cd,
]

ERC-165 （在新标签页中打开）规定了一种机制，让合约能够公开应用程序如何与其通信，以及它符合哪些 ERC 标准。SUPPORTED_INTERFACES 是一个常量列表，包含此合约符合的两个四字节接口 ID：ERC-165 本身和 ERC-721。

函数

这些是实际实现 ERC-721 的函数。

构造函数

@deploy
def __init__():

在 Vyper 中，与 Python 一样，构造函数被称为 __init__。它标有 @deploy 装饰器，这意味着它在合约部署时运行一次。

    """
    @dev 合约构造函数。
    """

在 Python 和 Vyper 中，你还可以通过指定多行字符串（以 """ 开头和结尾）来创建注释，并且不以任何方式使用它。这些注释也可以包含 NatSpec （在新标签页中打开）。

    self.minter = msg.sender

要访问状态变量，你可以使用 self.<variable name>（同样，与 Python 相同）。构造函数将部署合约的账户记录为 minter。

视图函数

这些函数不会修改区块链的状态，因此如果从外部调用它们，可以免费执行。如果视图函数由合约调用，它们仍然必须在每个节点上执行，因此会消耗 Gas。

@view
@external

在函数定义之前这些以 at 符号 (@) 开头的关键字被称为_装饰器_。它们指定了可以调用函数的情况。

@view 指定此函数是一个视图。
@external 指定此特定函数可以被交易和其他合约调用。

def supportsInterface(interface_id: bytes4) -> bool:

与 Python 相比，Vyper 是一种静态类型语言（在新标签页中打开）。如果不标识数据类型（在新标签页中打开），你就无法声明变量或函数参数。在这种情况下，输入参数是 bytes4（一个四字节值），输出是一个布尔值。

    """
    @dev 接口标识在 ERC-165 中指定。
    @param interface_id 接口的 ID
    """
    return interface_id in SUPPORTED_INTERFACES

如果 interface_id 是 SUPPORTED_INTERFACES 列表中的接口 ID 之一，则返回 True。

### 视图函数 ###

这些视图函数使用户和其他合约能够获取有关代币的信息。

@view
@external
def balanceOf(_owner: address) -> uint256:
    """
    @dev 返回 `_owner` 拥有的 NFT 数量。
         如果 `_owner` 是零地址则抛出异常。分配给零地址的 NFT 被视为无效。
    @param _owner 要查询余额的地址。
    """
    assert _owner != empty(address)

这一行断言（在新标签页中打开） _owner 不是零地址，写为 empty(address)。如果是，则会出现错误并且操作将被回退。

    return self.ownerToNFTokenCount[_owner]

@view
@external
def ownerOf(_tokenId: uint256) -> address:
    """
    @dev 返回 NFT 所有者的地址。
         如果 `_tokenId` 不是有效的 NFT 则抛出异常。
    @param _tokenId NFT 的标识符。
    """
    owner: address = self.idToOwner[_tokenId]
    # 如果 `_tokenId` 不是有效的 NFT 则抛出异常
    assert owner != empty(address)
    return owner

在以太坊虚拟机 (EVM) 中，任何未存储值的存储空间都为零。如果 _tokenId 处没有代币，则 self.idToOwner[_tokenId] 的值为零。在这种情况下，函数将回退。

@view
@external
def getApproved(_tokenId: uint256) -> address:
    """
    @dev 获取单个 NFT 的授权地址。
         如果 `_tokenId` 不是有效的 NFT 则抛出异常。
    @param _tokenId 要查询授权的 NFT 的 ID。
    """
    # 如果 `_tokenId` 不是有效的 NFT 则抛出异常
    assert self.idToOwner[_tokenId] != empty(address)
    return self.idToApprovals[_tokenId]

请注意，getApproved _可以_返回零。如果代币有效，它将返回 self.idToApprovals[_tokenId]。如果没有授权人，该值则为零。

@view
@external
def isApprovedForAll(_owner: address, _operator: address) -> bool:
    """
    @dev 检查 `_operator` 是否是 `_owner` 的授权操作员。
    @param _owner 拥有 NFT 的地址。
    @param _operator 代表所有者行事的地址。
    """
    return (self.ownerToOperators[_owner])[_operator]

此函数检查是否允许 _operator 管理此合约中 _owner 的所有代币。因为可以有多个操作员，所以这是一个两级 HashMap。

转账辅助函数

这些函数实现了作为转账或管理代币一部分的操作。


### 转账函数辅助工具 ###

@view
@internal

这个装饰器 @internal 意味着该函数只能从同一合约内的其他函数访问。按照惯例，这些函数名也以下划线 (_) 开头。

def _isApprovedOrOwner(_spender: address, _tokenId: uint256) -> bool:
    """
    @dev 返回给定的花费者是否可以转账给定的代币 ID
    @param spender 要查询的花费者地址
    @param tokenId 要转账的代币的 uint256 ID
    @return bool msg.sender 是否被授权用于给定的代币 ID，
        是否是所有者的操作员，或者是否是代币的所有者
    """
    owner: address = self.idToOwner[_tokenId]
    spenderIsOwner: bool = owner == _spender
    spenderIsApproved: bool = _spender == self.idToApprovals[_tokenId]
    spenderIsApprovedForAll: bool = (self.ownerToOperators[owner])[_spender]
    return (spenderIsOwner or spenderIsApproved) or spenderIsApprovedForAll

允许一个地址转账代币有三种方式：

该地址是代币的所有者
该地址被授权花费该代币
该地址是代币所有者的操作员

上面的函数可以是一个视图，因为它不改变状态。为了降低运营成本，任何_可以_是视图的函数都_应该_是视图。

@internal
def _addTokenTo(_to: address, _tokenId: uint256):
    """
    @dev 将 NFT 添加到给定地址
         如果 `_tokenId` 已被某人拥有则抛出异常。
    """
    # 如果 `_tokenId` 已被某人拥有则抛出异常
    assert self.idToOwner[_tokenId] == empty(address)
    # 更改所有者
    self.idToOwner[_tokenId] = _to
    # 更改数量跟踪
    self.ownerToNFTokenCount[_to] += 1


@internal
def _removeTokenFrom(_from: address, _tokenId: uint256):
    """
    @dev 从给定地址移除 NFT
         如果 `_from` 不是当前所有者则抛出异常。
    """
    # 如果 `_from` 不是当前所有者则抛出异常
    assert self.idToOwner[_tokenId] == _from
    # 更改所有者
    self.idToOwner[_tokenId] = empty(address)
    # 更改数量跟踪
    self.ownerToNFTokenCount[_from] -= 1

当转账出现问题时，我们会回退调用。

@internal
def _clearApproval(_owner: address, _tokenId: uint256):
    """
    @dev 清除给定地址的授权
         如果 `_owner` 不是当前所有者则抛出异常。
    """
    # 如果 `_owner` 不是当前所有者则抛出异常
    assert self.idToOwner[_tokenId] == _owner
    if self.idToApprovals[_tokenId] != empty(address):
        # 重置授权
        self.idToApprovals[_tokenId] = empty(address)

仅在必要时更改值。状态变量存在于存储中。写入存储是 EVM（以太坊虚拟机）执行的最昂贵的操作之一（就 Gas 而言）。因此，最好尽量减少这种操作，即使写入现有的值也会产生很高的成本。

@internal
def _transferFrom(_from: address, _to: address, _tokenId: uint256, _sender: address):
    """
    @dev 执行 NFT 的转账。
         除非 `msg.sender` 是当前所有者、授权操作员或该 NFT 的授权
         地址，否则抛出异常。（注意：私有函数中不允许使用 `msg.sender`，因此传递 `_sender`。）
         如果 `_to` 是零地址则抛出异常。
         如果 `_from` 不是当前所有者则抛出异常。
         如果 `_tokenId` 不是有效的 NFT 则抛出异常。
    """

我们有这个内部函数是因为有两种转账代币的方式（常规和安全），但我们希望代码中只有一个执行转账的位置，以使审计更容易。

    # 检查要求
    assert self._isApprovedOrOwner(_sender, _tokenId)
    # 如果 `_to` 是零地址则抛出异常
    assert _to != empty(address)
    # 清除授权。如果 `_from` 不是当前所有者则抛出异常
    self._clearApproval(_from, _tokenId)
    # 移除 NFT。如果 `_tokenId` 不是有效的 NFT 则抛出异常
    self._removeTokenFrom(_from, _tokenId)
    # 添加 NFT
    self._addTokenTo(_to, _tokenId)
    # 记录转账
    log IERC721.Transfer(sender=_from, receiver=_to, token_id=_tokenId)

要在 Vyper 中触发事件，你可以使用 log 语句（有关更多详细信息，请参见此处（在新标签页中打开））。因为事件属于导入的接口，所以我们将它们称为 IERC721.Transfer 并通过关键字传递它们的字段。

转账函数


### 转账函数 ###

@external
@payable
def transferFrom(_from: address, _to: address, _tokenId: uint256):
    """
    @dev 除非 `msg.sender` 是当前所有者、授权操作员或该 NFT 的授权
         地址，否则抛出异常。
         如果 `_from` 不是当前所有者则抛出异常。
         如果 `_to` 是零地址则抛出异常。
         如果 `_tokenId` 不是有效的 NFT 则抛出异常。
    @notice 调用者有责任确认 `_to` 能够接收 NFT，否则
            它们可能会永久丢失。
    @param _from NFT 的当前所有者。
    @param _to 新所有者。
    @param _tokenId 要转账的 NFT。
    """
    self._transferFrom(_from, _to, _tokenId, msg.sender)

此函数允许你转账到任意地址。除非该地址是用户，或者是知道如何转账代币的合约，否则你转账的任何代币都将卡在该地址中且毫无用处。

这里使用 @payable 装饰器是因为 IERC721 接口将 transferFrom、safeTransferFrom 和 approve 声明为 payable，因此实现该接口的合约必须匹配这些签名。

@external
@payable
def safeTransferFrom(
        _from: address,
        _to: address,
        _tokenId: uint256,
        _data: Bytes[1024]=b""
    ):
    """
    @dev 将 NFT 的所有权从一个地址转账到另一个地址。
         除非 `msg.sender` 是当前所有者、授权操作员或该 NFT 的
         授权地址，否则抛出异常。
         如果 `_from` 不是当前所有者则抛出异常。
         如果 `_to` 是零地址则抛出异常。
         如果 `_tokenId` 不是有效的 NFT 则抛出异常。
         如果 `_to` 是智能合约，它会在 `_to` 上调用 `onERC721Received`，如果
         返回值不是 `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))` 则抛出异常。
    @param _from NFT 的当前所有者。
    @param _to 新所有者。
    @param _tokenId 要转账的 NFT。
    @param _data 没有指定格式的附加数据，在调用 `_to` 时发送。
    """
    self._transferFrom(_from, _to, _tokenId, msg.sender)

先进行转账是可以的，因为如果出现问题，我们无论如何都会回退，因此调用中所做的一切都将被取消。

    if _to.is_contract: # 检查 `_to` 是否为合约地址

首先检查该地址是否为合约（如果它有代码）。如果没有，则假定它是一个用户地址，并且用户将能够使用该代币或转账它。但不要让这使你产生虚假的安全感。即使使用 safeTransferFrom，如果你将代币转账到一个没有人知道私钥的地址，你仍然可能会丢失代币。

        returnValue: bytes4 = extcall ERC721Receiver(_to).onERC721Received(msg.sender, _from, _tokenId, _data)

调用目标合约以查看它是否可以接收 ERC-721 代币。Vyper 0.4 要求标记对其他合约的调用，因此调用以 extcall 为前缀。

        # 如果转账目标是未实现 'onERC721Received' 的合约则抛出异常
        assert returnValue == method_id("onERC721Received(address,address,uint256,bytes)", output_type=bytes4)

如果目标是一个合约，但它不接受 ERC-721 代币（或者决定不接受这次特定的转账），则回退。

@external
@payable
def approve(_approved: address, _tokenId: uint256):
    """
    @dev 设置或重新确认 NFT 的授权地址。零地址表示没有授权地址。
         除非 `msg.sender` 是当前 NFT 所有者，或者是当前所有者的授权操作员，否则抛出异常。
         如果 `_tokenId` 不是有效的 NFT 则抛出异常。（注意：这没有写在 EIP 中）
         如果 `_approved` 是当前所有者则抛出异常。（注意：这没有写在 EIP 中）
    @param _approved 要为给定 NFT ID 授权的地址。
    @param _tokenId 要授权的代币的 ID。
    """
    owner: address = self.idToOwner[_tokenId]
    # 如果 `_tokenId` 不是有效的 NFT 则抛出异常
    assert owner != empty(address)
    # 如果 `_approved` 是当前所有者则抛出异常
    assert _approved != owner

按照惯例，如果你不想有授权人，你应该指定零地址，而不是你自己。

    # 检查要求
    senderIsOwner: bool = self.idToOwner[_tokenId] == msg.sender
    senderIsApprovedForAll: bool = (self.ownerToOperators[owner])[msg.sender]
    assert (senderIsOwner or senderIsApprovedForAll)

要设置授权，你可以是所有者，或者是所有者授权的操作员。

    # 设置授权
    self.idToApprovals[_tokenId] = _approved
    log IERC721.Approval(owner=owner, approved=_approved, token_id=_tokenId)


@external
def setApprovalForAll(_operator: address, _approved: bool):
    """
    @dev 启用或禁用第三方（“操作员”）管理 `msg.sender` 所有资产的
         授权。它还会触发 ApprovalForAll 事件。
         如果 `_operator` 是 `msg.sender` 则抛出异常。（注意：这没有写在 EIP 中）
    @notice 即使发送者当时不拥有任何代币，这也有效。
    @param _operator 要添加到授权操作员集合中的地址。
    @param _approved 如果操作员被授权则为 True，撤销授权则为 false。
    """
    # 如果 `_operator` 是 `msg.sender` 则抛出异常
    assert _operator != msg.sender
    self.ownerToOperators[msg.sender][_operator] = _approved
    log IERC721.ApprovalForAll(owner=msg.sender, operator=_operator, approved=_approved)

铸造新代币和销毁现有代币

创建合约的账户是 minter，即被授权铸造新 NFT 的超级用户。然而，即使是它也不允许销毁现有的代币。只有所有者或所有者授权的实体才能这样做。

### 铸造与销毁函数 ###

@external
def mint(_to: address, _tokenId: uint256) -> bool:

此函数始终返回 True，因为如果操作失败，它将被回退。

    """
    @dev 铸造代币的函数
         如果`msg.sender`不是铸造者则抛出异常。
         如果`_to`是零地址则抛出异常。
         如果`_tokenId`已被某人拥有则抛出异常。
    @param _to 将接收铸造代币的地址。
    @param _tokenId 要铸造的代币ID。
    @return 指示操作是否成功的布尔值。
    """
    # 如果`msg.sender`不是铸造者则抛出异常
    assert msg.sender == self.minter

只有铸造者（创建 ERC-721 合约的账户）才能铸造新代币。如果我们将来想要更改铸造者的身份，这可能会成为一个问题。在生产合约中，你可能需要一个允许铸造者将铸造权限转让给其他人的函数。

    # 如果`_to`是零地址则抛出异常
    assert _to != ZERO_ADDRESS
    # 添加NFT。如果`_tokenId`已被某人拥有则抛出异常
    self._addTokenTo(_to, _tokenId)
    log Transfer(ZERO_ADDRESS, _to, _tokenId)
    return True

按照惯例，铸造新代币算作从零地址转账。


@external
def burn(_tokenId: uint256):
    """
    @dev 销毁特定的ERC-721代币。
         除非`msg.sender`是当前所有者、授权操作员或该NFT的授权
         地址，否则抛出异常。
         如果`_tokenId`不是有效的NFT则抛出异常。
    @param _tokenId 要销毁的ERC-721代币的uint256 ID。
    """
    # 检查要求
    assert self._isApprovedOrOwner(msg.sender, _tokenId)
    owner: address = self.idToOwner[_tokenId]
    # 如果`_tokenId`不是有效的NFT则抛出异常
    assert owner != ZERO_ADDRESS
    self._clearApproval(owner, _tokenId)
    self._removeTokenFrom(owner, _tokenId)
    log Transfer(owner, ZERO_ADDRESS, _tokenId)

任何被允许转账代币的人都被允许销毁它。虽然销毁看起来等同于转账到零地址，但零地址实际上并没有接收到代币。这使我们能够释放用于该代币的所有存储空间，从而可以降低交易的 Gas 成本。

使用此合约

与 Solidity 相比，Vyper 没有继承。这是一种深思熟虑的设计选择，旨在使代码更清晰，从而更容易保证安全。因此，要创建你自己的 Vyper ERC-721 合约，你可以采用此合约（在新标签页中打开）并对其进行修改以实现你想要的业务逻辑。

结论

作为回顾，以下是此合约中一些最重要的概念：

要通过安全转账接收 ERC-721 代币，合约必须实现 ERC721Receiver 接口。
即使你使用安全转账，如果你将代币发送到一个私钥未知的地址，代币仍然可能会被卡住。
当操作出现问题时，最好revert调用，而不是仅仅返回一个失败值。
ERC-721 代币在拥有所有者时存在。
有三种方式可以获得转账 NFT 的授权。你可以是所有者，被授权使用特定代币，或者是所有者所有代币的操作员。
过去的事件仅在区块链外部可见。在区块链内部运行的代码无法查看它们。

现在去实现安全的 Vyper 合约吧。

在这里查看我的更多作品（在新标签页中打开）。