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)