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 銷毀特定的 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)