Покроковий опис контракту Vyper ERC-721

1# @dev Реалізація стандарту невзаємозамінних токенів ERC-721.
2# @author Рюя Накамура (@nrryuya)
3# Змінено з: https://github.com/vyperlang/vyper/blob/de74722bf2d8718cca46902be165f9fe0e3641dd/examples/tokens/ERC721.vy
Копіювати

1from vyper.interfaces import ERC721
2
3implements: ERC721
Копіювати

1# Інтерфейс для контракту, що викликається safeTransferFrom()
2interface ERC721Receiver:
3    def onERC721Received(
Копіювати

1            _operator: address,
2            _from: address,
Копіювати

1            _tokenId: uint256,
Копіювати

1            _data: Bytes[1024]
Копіювати

1        ) -> bytes32: view
Копіювати

1# @dev Генерується, коли право власності на будь-який NFT змінюється будь-яким механізмом. Ця подія генерується, коли NFT
2#      створюються (`from` == 0) і знищуються (`to` == 0). Виняток: під час створення контракту будь-яка
3#      кількість NFT може бути створена та призначена без генерації події Transfer. Під час будь-якого
4#      переказу затверджена адреса для цього NFT (якщо така є) скидається на «немає».
5# @param _from Відправник NFT (якщо адреса нульова, це вказує на створення токена).
6# @param _to Одержувач NFT (якщо адреса нульова, це вказує на знищення токена).
7# @param _tokenId NFT, який було передано.
8event Transfer:
9    sender: indexed(address)
10    receiver: indexed(address)
11    tokenId: indexed(uint256)
Показати всеКопіювати

1# @dev Генерується, коли затверджена адреса для NFT змінюється або підтверджується. Нульова
2#      адреса вказує на відсутність затвердженої адреси. Коли генерується подія Transfer, це також
3#      вказує, що затверджена адреса для цього NFT (якщо така є) скидається на «немає».
4# @param _owner Власник NFT.
5# @param _approved Адреса, яку ми затверджуємо.
6# @param _tokenId NFT, який ми затверджуємо.
7event Approval:
8    owner: indexed(address)
9    approved: indexed(address)
10    tokenId: indexed(uint256)
Показати всеКопіювати

1# @dev Генерується, коли оператора вмикають або вимикають для власника. Оператор може керувати
2#      всіма NFT власника.
3# @param _owner Власник NFT.
4# @param _operator Адреса, для якої ми встановлюємо права оператора.
5# @param _approved Статус прав оператора (true, якщо права оператора надано, і false, якщо
6# їх скасовано).
7event ApprovalForAll:
8    owner: indexed(address)
9    operator: indexed(address)
10    approved: bool
Показати всеКопіювати

1# @dev Зіставлення ID NFT з адресою його власника.
2idToOwner: HashMap[uint256, address]
3
4# @dev Зіставлення ID NFT із затвердженою адресою.
5idToApprovals: HashMap[uint256, address]
Копіювати

1# @dev Зіставлення адреси власника з кількістю його токенів.
2ownerToNFTokenCount: HashMap[address, uint256]
Копіювати

1# @dev Зіставлення адреси власника із зіставленням адрес операторів.
2ownerToOperators: HashMap[address, HashMap[address, bool]]
Копіювати

1# @dev Адреса карбувальника, який може карбувати токени
2minter: address
Копіювати

1# @dev Зіставлення ID інтерфейсу з булевим значенням, що вказує на його підтримку
2supportedInterfaces: HashMap[bytes32, bool]
3
4# @dev ID інтерфейсу ERC165 для ERC165
5ERC165_INTERFACE_ID: constant(bytes32) = 0x0000000000000000000000000000000000000000000000000000000001ffc9a7
6
7# @dev ID інтерфейсу ERC165 для ERC721
8ERC721_INTERFACE_ID: constant(bytes32) = 0x0000000000000000000000000000000000000000000000000000000080ac58cd
Копіювати

1@external
2def __init__():
Копіювати

1    """
2    @dev Конструктор контракту.
3    """
Копіювати

1    self.supportedInterfaces[ERC165_INTERFACE_ID] = True
2    self.supportedInterfaces[ERC721_INTERFACE_ID] = True
3    self.minter = msg.sender
Копіювати

1@view
2@external
Копіювати

1def supportsInterface(_interfaceID: bytes32) -> bool:
Копіювати

1    """
2    @dev Ідентифікація інтерфейсу вказана в ERC-165.
3    @param _interfaceID ID інтерфейсу
4    """
5    return self.supportedInterfaces[_interfaceID]
Копіювати

1### ФУНКЦІЇ ПЕРЕГЛЯДУ ###
2
Копіювати

1@view
2@external
3def balanceOf(_owner: address) -> uint256:
4    """
5    @dev Повертає кількість NFT, що належать `_owner`.
6         Видає помилку, якщо `_owner` є нульовою адресою. NFT, призначені нульовій адресі, вважаються недійсними.
7    @param _owner Адреса, для якої потрібно запитати баланс.
8    """
9    assert _owner != ZERO_ADDRESS
Показати всеКопіювати

1    return self.ownerToNFTokenCount[_owner]
2
3@view
4@external
5def ownerOf(_tokenId: uint256) -> address:
6    """
7    @dev Повертає адресу власника NFT.
8         Видає помилку, якщо `_tokenId` не є дійсним NFT.
9    @param _tokenId Ідентифікатор NFT.
10    """
11    owner: address = self.idToOwner[_tokenId]
12    # Видає помилку, якщо `_tokenId` не є дійсним NFT
13    assert owner != ZERO_ADDRESS
14    return owner
Показати всеКопіювати

1@view
2@external
3def getApproved(_tokenId: uint256) -> address:
4    """
5    @dev Отримати затверджену адресу для одного NFT.
6         Видає помилку, якщо `_tokenId` не є дійсним NFT.
7    @param _tokenId ID NFT, для якого потрібно запитати затвердження.
8    """
9    # Видає помилку, якщо `_tokenId` не є дійсним NFT
10    assert self.idToOwner[_tokenId] != ZERO_ADDRESS
11    return self.idToApprovals[_tokenId]
Показати всеКопіювати

1@view
2@external
3def isApprovedForAll(_owner: address, _operator: address) -> bool:
4    """
5    @dev Перевіряє, чи є `_operator` затвердженим оператором для `_owner`.
6    @param _owner Адреса, яка володіє NFT.
7    @param _operator Адреса, яка діє від імені власника.
8    """
9    return (self.ownerToOperators[_owner])[_operator]
Показати всеКопіювати

1
2### ДОПОМІЖНІ ФУНКЦІЇ ПЕРЕКАЗУ ###
3
4@view
5@internal
Копіювати

1def _isApprovedOrOwner(_spender: address, _tokenId: uint256) -> bool:
2    """
3    @dev Повертає, чи може даний витрачальник передати даний ID токена
4    @param spender адреса витрачальника для запиту
5    @param tokenId uint256 ID токена, який потрібно передати
6    @return bool чи затверджено msg.sender для даного ID токена,
7        чи є він оператором власника, чи є власником токена
8    """
9    owner: address = self.idToOwner[_tokenId]
10    spenderIsOwner: bool = owner == _spender
11    spenderIsApproved: bool = _spender == self.idToApprovals[_tokenId]
12    spenderIsApprovedForAll: bool = (self.ownerToOperators[owner])[_spender]
13    return (spenderIsOwner or spenderIsApproved) or spenderIsApprovedForAll
Показати всеКопіювати

1@internal
2def _addTokenTo(_to: address, _tokenId: uint256):
3    """
4    @dev Додати NFT до даної адреси
5         Видає помилку, якщо `_tokenId` належить комусь.
6    """
7    # Видає помилку, якщо `_tokenId` належить комусь
8    assert self.idToOwner[_tokenId] == ZERO_ADDRESS
9    # Змінити власника
10    self.idToOwner[_tokenId] = _to
11    # Змінити відстеження кількості
12    self.ownerToNFTokenCount[_to] += 1
13
14
15@internal
16def _removeTokenFrom(_from: address, _tokenId: uint256):
17    """
18    @dev Видалити NFT з даної адреси
19         Видає помилку, якщо `_from` не є поточним власником.
20    """
21    # Видає помилку, якщо `_from` не є поточним власником
22    assert self.idToOwner[_tokenId] == _from
23    # Змінити власника
24    self.idToOwner[_tokenId] = ZERO_ADDRESS
25    # Змінити відстеження кількості
26    self.ownerToNFTokenCount[_from] -= 1
Показати всеКопіювати

1@internal
2def _clearApproval(_owner: address, _tokenId: uint256):
3    """
4    @dev Очистити затвердження для даної адреси
5         Видає помилку, якщо `_owner` не є поточним власником.
6    """
7    # Видає помилку, якщо `_owner` не є поточним власником
8    assert self.idToOwner[_tokenId] == _owner
9    if self.idToApprovals[_tokenId] != ZERO_ADDRESS:
10        # Скинути затвердження
11        self.idToApprovals[_tokenId] = ZERO_ADDRESS
Показати всеКопіювати

1@internal
2def _transferFrom(_from: address, _to: address, _tokenId: uint256, _sender: address):
3    """
4    @dev Виконати переказ NFT.
5         Видає помилку, якщо `msg.sender` не є поточним власником, авторизованим оператором або затвердженою
6         адресою для цього NFT. (ПРИМІТКА: `msg.sender` не дозволено у приватній функції, тому передайте `_sender`.)
7         Видає помилку, якщо `_to` є нульовою адресою.
8         Видає помилку, якщо `_from` не є поточним власником.
9         Видає помилку, якщо `_tokenId` не є дійсним NFT.
10    """
Показати всеКопіювати

1    # Перевірка вимог
2    assert self._isApprovedOrOwner(_sender, _tokenId)
3    # Видає помилку, якщо `_to` є нульовою адресою
4    assert _to != ZERO_ADDRESS
5    # Очистити затвердження. Видає помилку, якщо `_from` не є поточним власником
6    self._clearApproval(_from, _tokenId)
7    # Видалити NFT. Видає помилку, якщо `_tokenId` не є дійсним NFT
8    self._removeTokenFrom(_from, _tokenId)
9    # Додати NFT
10    self._addTokenTo(_to, _tokenId)
11    # Зареєструвати переказ
12    log Transfer(_from, _to, _tokenId)
Показати всеКопіювати

1
2### ФУНКЦІЇ ПЕРЕКАЗУ ###
3
4@external
5def transferFrom(_from: address, _to: address, _tokenId: uint256):
6    """
7    @dev Видає помилку, якщо `msg.sender` не є поточним власником, авторизованим оператором або затвердженою
8         адресою для цього NFT.
9         Видає помилку, якщо `_from` не є поточним власником.
10         Видає помилку, якщо `_to` є нульовою адресою.
11         Видає помилку, якщо `_tokenId` не є дійсним NFT.
12    @notice Той, хто викликає, несе відповідальність за підтвердження того, що `_to` здатний отримувати NFT, інакше
13            вони можуть бути назавжди втрачені.
14    @param _from Поточний власник NFT.
15    @param _to Новий власник.
16    @param _tokenId NFT, який потрібно переказати.
17    """
18    self._transferFrom(_from, _to, _tokenId, msg.sender)
Показати всеКопіювати

1@external
2def safeTransferFrom(
3        _from: address,
4        _to: address,
5        _tokenId: uint256,
6        _data: Bytes[1024]=b""
7    ):
8    """
9    @dev Передає право власності на NFT з однієї адреси на іншу.
10         Видає помилку, якщо `msg.sender` не є поточним власником, авторизованим оператором або
11         затвердженою адресою для цього NFT.
12         Видає помилку, якщо `_from` не є поточним власником.
13         Видає помилку, якщо `_to` є нульовою адресою.
14         Видає помилку, якщо `_tokenId` не є дійсним NFT.
15         Якщо `_to` — це смарт-контракт, він викликає `onERC721Received` для `_to` і видає помилку, якщо
16         повернуте значення не дорівнює `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`.
17         ПРИМІТКА: bytes4 представлено як bytes32 із доповненням
18    @param _from Поточний власник NFT.
19    @param _to Новий власник.
20    @param _tokenId NFT, який потрібно переказати.
21    @param _data Додаткові дані без зазначеного формату, що надсилаються у виклику до `_to`.
22    """
23    self._transferFrom(_from, _to, _tokenId, msg.sender)
Показати всеКопіювати

1    if _to.is_contract: # перевірка, чи є `_to` адресою контракту
Копіювати

1        returnValue: bytes32 = ERC721Receiver(_to).onERC721Received(msg.sender, _from, _tokenId, _data)
Копіювати

1        # Видає помилку, якщо адресат переказу є контрактом, який не реалізує 'onERC721Received'
2        assert returnValue == method_id("onERC721Received(address,address,uint256,bytes)", output_type=bytes32)
Копіювати

1@external
2def approve(_approved: address, _tokenId: uint256):
3    """
4    @dev Встановити або підтвердити затверджену адресу для NFT. Нульова адреса вказує на відсутність затвердженої адреси.
5         Видає помилку, якщо `msg.sender` не є поточним власником NFT або авторизованим оператором поточного власника.
6         Видає помилку, якщо `_tokenId` не є дійсним NFT. (ПРИМІТКА: це не описано в EIP)
7         Видає помилку, якщо `_approved` є поточним власником. (ПРИМІТКА: це не описано в EIP)
8    @param _approved Адреса, яка буде затверджена для даного ID NFT.
9    @param _tokenId ID токена, який потрібно затвердити.
10    """
11    owner: address = self.idToOwner[_tokenId]
12    # Видає помилку, якщо `_tokenId` не є дійсним NFT
13    assert owner != ZERO_ADDRESS
14    # Видає помилку, якщо `_approved` є поточним власником
15    assert _approved != owner
Показати всеКопіювати

1    # Перевірка вимог
2    senderIsOwner: bool = self.idToOwner[_tokenId] == msg.sender
3    senderIsApprovedForAll: bool = (self.ownerToOperators[owner])[msg.sender]
4    assert (senderIsOwner or senderIsApprovedForAll)
Копіювати

1    # Встановити затвердження
2    self.idToApprovals[_tokenId] = _approved
3    log Approval(owner, _approved, _tokenId)
4
5
6@external
7def setApprovalForAll(_operator: address, _approved: bool):
8    """
9    @dev Вмикає або вимикає затвердження для третьої сторони («оператора») для управління всіма
10         активами `msg.sender`. Також генерує подію ApprovalForAll.
11         Видає помилку, якщо `_operator` є `msg.sender`. (ПРИМІТКА: це не описано в EIP)
12    @notice Це працює, навіть якщо відправник не володіє жодними токенами на даний момент.
13    @param _operator Адреса для додавання до набору авторизованих операторів.
14    @param _approved True, якщо оператор затверджений, false, щоб скасувати затвердження.
15    """
16    # Видає помилку, якщо `_operator` є `msg.sender`
17    assert _operator != msg.sender
18    self.ownerToOperators[msg.sender][_operator] = _approved
19    log ApprovalForAll(msg.sender, _operator, _approved)
Показати всеКопіювати

1### ФУНКЦІЇ КАРБУВАННЯ ТА СПАЛЮВАННЯ ###
2
3@external
4def mint(_to: address, _tokenId: uint256) -> bool:
Копіювати

1    """
2    @dev Функція для карбування токенів
3         Видає помилку, якщо `msg.sender` не є карбувальником.
4         Видає помилку, якщо `_to` є нульовою адресою.
5         Видає помилку, якщо `_tokenId` належить комусь.
6    @param _to Адреса, яка отримає викарбувані токени.
7    @param _tokenId Ідентифікатор токена для карбування.
8    @return Булеве значення, яке вказує, чи була операція успішною.
9    """
10    # Видає помилку, якщо `msg.sender` не є карбувальником
11    assert msg.sender == self.minter
Показати всеКопіювати

1    # Видає помилку, якщо `_to` є нульовою адресою
2    assert _to != ZERO_ADDRESS
3    # Додати NFT. Видає помилку, якщо `_tokenId` належить комусь
4    self._addTokenTo(_to, _tokenId)
5    log Transfer(ZERO_ADDRESS, _to, _tokenId)
6    return True
Копіювати

1
2@external
3def burn(_tokenId: uint256):
4    """
5    @dev Спалює певний токен ERC721.
6         Видає помилку, якщо `msg.sender` не є поточним власником, авторизованим оператором або затвердженою
7         адресою для цього NFT.
8         Видає помилку, якщо `_tokenId` не є дійсним NFT.
9    @param _tokenId uint256 id токена ERC721, який потрібно спалити.
10    """
11    # Перевірка вимог
12    assert self._isApprovedOrOwner(msg.sender, _tokenId)
13    owner: address = self.idToOwner[_tokenId]
14    # Видає помилку, якщо `_tokenId` не є дійсним NFT
15    assert owner != ZERO_ADDRESS
16    self._clearApproval(owner, _tokenId)
17    self._removeTokenFrom(owner, _tokenId)
18    log Transfer(owner, ZERO_ADDRESS, _tokenId)
Показати всеКопіювати