Vyper ERC-721 合約逐步解說

# @dev 當任何 NFT 的所有權因任何機制發生變更時發出。當 NFT 被
#      建立 (`from` == 0) 和銷毀 (`to` == 0) 時會發出此事件。例外：在合約建立期間，可以
#      建立並指派任意數量的 NFT 而不發出 Transfer 事件。在任何
#      轉移時，該 NFT 的核准地址 (若有) 會被重設為無。
# @param _from NFT 的傳送方 (若地址為零地址，則表示代幣建立)。
# @param _to NFT 的接收方 (若地址為零地址，則表示代幣銷毀)。
# @param _tokenId 已轉移的 NFT。
event Transfer:
    sender: indexed(address)
    receiver: indexed(address)
    tokenId: indexed(uint256)

# @dev 當一個 NFT 的核准地址被變更或再次確認時發出。零
#      地址表示沒有核准地址。當 Transfer 事件發出時，這也
#      表示該 NFT 的核准地址 (若有) 被重設為無。
# @param _owner NFT 的擁有者。
# @param _approved 我們正在核准的地址。
# @param _tokenId 我們正在核准的 NFT。
event Approval:
    owner: indexed(address)
    approved: indexed(address)
    tokenId: indexed(uint256)

# @dev 當擁有者的操作員被啟用或停用時發出。操作員可以管理
#      該擁有者的所有 NFT。
# @param _owner NFT 的擁有者。
# @param _operator 我們要為其設定操作員權限的地址。
# @param _approved 操作員權限的狀態 (true 表示授予操作員權限，false 表示
# 撤銷)。
event ApprovalForAll:
    owner: indexed(address)
    operator: indexed(address)
    approved: bool

@view
@external
def balanceOf(_owner: address) -> uint256:
    """
    @dev 傳回 `_owner` 擁有的 NFT 數量。
         如果 `_owner` 是零地址，則會擲出錯誤。指派給零地址的 NFT 被視為無效。
    @param _owner 要查詢餘額的地址。
    """
    assert _owner != ZERO_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 != ZERO_ADDRESS
    return owner

@view
@external
def getApproved(_tokenId: uint256) -> address:
    """
    @dev 取得單一 NFT 的核准地址。
         如果 `_tokenId` 不是有效的 NFT，則會擲出錯誤。
    @param _tokenId 要查詢核准的 NFT ID。
    """
    # 如果 `_tokenId` 不是有效的 NFT，則會擲出錯誤
    assert self.idToOwner[_tokenId] != ZERO_ADDRESS
    return 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]

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] == ZERO_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] = ZERO_ADDRESS
    # 變更計數追蹤
    self.ownerToNFTokenCount[_from] -= 1

@internal
def _clearApproval(_owner: address, _tokenId: uint256):
    """
    @dev 清除給定地址的核准
         如果 `_owner` 不是目前的擁有者，則會擲出錯誤。
    """
    # 如果 `_owner` 不是目前的擁有者，則會擲出錯誤
    assert self.idToOwner[_tokenId] == _owner
    if self.idToApprovals[_tokenId] != ZERO_ADDRESS:
        # 重設核准
        self.idToApprovals[_tokenId] = ZERO_ADDRESS

@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 != ZERO_ADDRESS
    # 清除核准。如果 `_from` 不是目前的擁有者，則會擲出錯誤
    self._clearApproval(_from, _tokenId)
    # 移除 NFT。如果 `_tokenId` 不是有效的 NFT，則會擲出錯誤
    self._removeTokenFrom(_from, _tokenId)
    # 新增 NFT
    self._addTokenTo(_to, _tokenId)
    # 記錄轉移
    log Transfer(_from, _to, _tokenId)

### 轉移函式 ###

@external
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)

@external
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)"))`，則會擲出錯誤。
         注意：bytes4 由帶有填充的 bytes32 表示
    @param _from NFT 的目前擁有者。
    @param _to 新的擁有者。
    @param _tokenId 要轉移的 NFT。
    @param _data 額外資料，無指定格式，在對 `_to` 的呼叫中傳送。
    """
    self._transferFrom(_from, _to, _tokenId, msg.sender)

@external
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 != ZERO_ADDRESS
    # 如果 `_approved` 是目前的擁有者，則會擲出錯誤
    assert _approved != owner

    # 設定核准
    self.idToApprovals[_tokenId] = _approved
    log Approval(owner, _approved, _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 ApprovalForAll(msg.sender, _operator, _approved)

    """
    @dev 鑄造代幣的函式
         如果 `msg.sender` 不是鑄幣者，則會擲出錯誤。
         如果 `_to` 是零地址，則會擲出錯誤。
         如果 `_tokenId` 已被他人擁有，則會擲出錯誤。
    @param _to 將接收鑄造代幣的地址。
    @param _tokenId 要鑄造的代幣 id。
    @return 一個布林值，表示操作是否成功。
    """
    # 如果 `msg.sender` 不是鑄幣者，則會擲出錯誤
    assert msg.sender == self.minter

@external
def burn(_tokenId: uint256):
    """
    @dev 銷毀特定的 ERC721 代幣。
         除非 `msg.sender` 是目前的擁有者、授權的操作員或此 NFT 的核准
         地址，否則會擲出錯誤。
         如果 `_tokenId` 不是有效的 NFT，則會擲出錯誤。
    @param _tokenId 要銷毀的 ERC721 代幣的 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)