إرشادات تفصيلية لعقد ERC-721 الخاص بـ فايبر

1# @dev تنفيذ معيار الرمز غير القابل للاستبدال ERC-721.
2# @author Ryuya Nakamura (@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 (`from` == 0) وتدميرها (`to` == 0). استثناء: أثناء إنشاء العقد، يمكن إنشاء وتعيين أي عدد من رموز NFT دون إصدار حدث Transfer. في وقت أي تحويل، تتم إعادة تعيين العنوان المعتمد لهذا الرمز (إن وجد) إلى لا شيء.
2# @param _from مرسل الرمز غير القابل للاستبدال (NFT) (إذا كان العنوان هو العنوان الصفري فهذا يشير إلى إنشاء الرمز).
3# @param _to مستلم الرمز غير القابل للاستبدال (NFT) (إذا كان العنوان هو العنوان الصفري فهذا يشير إلى تدمير الرمز).
4# @param _tokenId الرمز غير القابل للاستبدال (NFT) الذي تم تحويله.
5event Transfer:
6    sender: indexed(address)
7    receiver: indexed(address)
8    tokenId: indexed(uint256)
نسخ

1# @dev يصدر هذا عند تغيير العنوان المعتمد لرمز غير قابل للاستبدال (NFT) أو إعادة تأكيده. يشير العنوان الصفري إلى عدم وجود عنوان معتمد. عندما يصدر حدث Transfer، يشير هذا أيضًا إلى أن العنوان المعتمد لهذا الرمز (إن وجد) تتم إعادة تعيينه إلى لا شيء.
2# @param _owner مالك الرمز غير القابل للاستبدال (NFT).
3# @param _approved العنوان الذي نوافق عليه.
4# @param _tokenId الرمز غير القابل للاستبدال (NFT) الذي نوافق عليه.
5event Approval:
6    owner: indexed(address)
7    approved: indexed(address)
8    tokenId: indexed(uint256)
نسخ

1# @dev يصدر هذا الحدث عند تمكين أو تعطيل مشغل لمالك. يمكن للمشغل إدارة جميع رموز NFT الخاصة بالمالك.
2# @param _owner مالك الرمز غير القابل للاستبدال (NFT).
3# @param _operator العنوان الذي نقوم بتعيين حقوق المشغل له.
4# @param _approved حالة حقوق المشغل (true إذا تم منح حقوق المشغل و false إذا تم إلغاؤها).
5event ApprovalForAll:
6    owner: indexed(address)
7    operator: indexed(address)
8    approved: bool
نسخ

1# @dev تعيين من معرف الرمز غير القابل للاستبدال (NFT) إلى العنوان الذي يمتلكه.
2idToOwner: HashMap[uint256, address]
3
4# @dev تعيين من معرف الرمز غير القابل للاستبدال (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 تعيين من معرّف الواجهة إلى قيمة منطقية حول ما إذا كانت مدعومة أم لا
2supportedInterfaces: HashMap[bytes32, bool]
3
4# @dev معرّف واجهة ERC165 الخاص بـ ERC165
5ERC165_INTERFACE_ID: constant(bytes32) = 0x0000000000000000000000000000000000000000000000000000000001ffc9a7
6
7# @dev معرّف واجهة 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 معرّف الواجهة
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 معرّف الرمز غير القابل للاستبدال (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 ترجع ما إذا كان المُنفِق المحدد يمكنه تحويل معرّف رمز معين
4    @param spender عنوان المُنفِق للاستعلام عنه
5    @param tokenId معرّف الرمز uint256 المراد تحويله
6    @return bool ما إذا كان msg.sender معتمدًا لمعرّف الرمز المحدد،
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@internal
15def _removeTokenFrom(_from: address, _tokenId: uint256):
16    """
17    @dev إزالة رمز NFT من عنوان معين
18         تطلق خطأ إذا لم يكن `_from` هو المالك الحالي.
19    """
20    # تطلق خطأ إذا لم يكن `_from` هو المالك الحالي
21    assert self.idToOwner[_tokenId] == _from
22    # تغيير المالك
23    self.idToOwner[_tokenId] = ZERO_ADDRESS
24    # تغيير تتبع العدد
25    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` هو المالك الحالي، أو مشغلًا معتمدًا، أو العنوان المعتمد لهذا الرمز NFT. (ملاحظة: `msg.sender` غير مسموح به في الدالة الخاصة لذا مرر `_sender`.)
6         تطلق خطأ إذا كان `_to` هو العنوان الصفري.
7         تطلق خطأ إذا لم يكن `_from` هو المالك الحالي.
8         تطلق خطأ إذا لم يكن `_tokenId` رمز NFT صالحًا.
9    """
إظهار الكل
نسخ

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` هو المالك الحالي، أو مشغلًا معتمدًا، أو العنوان المعتمد لهذا الرمز NFT.
8         تطلق خطأ إذا لم يكن `_from` هو المالك الحالي.
9         تطلق خطأ إذا كان `_to` هو العنوان الصفري.
10         تطلق خطأ إذا لم يكن `_tokenId` رمز NFT صالحًا.
11    @notice المتصل هو المسؤول عن التأكد من أن `_to` قادر على استلام رموز NFT وإلا فقد تُفقد بشكل دائم.
12    @param _from المالك الحالي لرمز NFT.
13    @param _to المالك الجديد.
14    @param _tokenId الرمز غير القابل للاستبدال (NFT) المراد تحويله.
15    """
16    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` هو المالك الحالي، أو مشغلًا معتمدًا، أو العنوان المعتمد لهذا الرمز NFT.
11         تطلق خطأ إذا لم يكن `_from` هو المالك الحالي.
12         تطلق خطأ إذا كان `_to` هو العنوان الصفري.
13         تطلق خطأ إذا لم يكن `_tokenId` رمز NFT صالحًا.
14         إذا كان `_to` عقدًا ذكيًا، فإنه يستدعي `onERC721Received` على `_to` ويطلق خطأ إذا لم تكن القيمة المرجعة هي `bytes4(keccak256("onERC721Received(address,address,uint256,bytes)"))`.
15         ملاحظة: يتم تمثيل bytes4 بـ bytes32 مع حشو
16    @param _from المالك الحالي لرمز NFT.
17    @param _to المالك الجديد.
18    @param _tokenId الرمز غير القابل للاستبدال (NFT) المراد تحويله.
19    @param _data بيانات إضافية بدون تنسيق محدد، يتم إرسالها في استدعاء إلى `_to`.
20    """
21    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 العنوان المراد اعتماده لمعرّف الرمز NFT المحدد.
9    @param _tokenId معرّف الرمز المراد اعتماده.
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@external
6def setApprovalForAll(_operator: address, _approved: bool):
7    """
8    @dev تمكين أو تعطيل الموافقة لطرف ثالث ("مشغل") لإدارة جميع أصول `msg.sender`.
9         كما أنه يصدر حدث ApprovalForAll.
10         يطلق خطأ إذا كان `_operator` هو `msg.sender`. (ملاحظة: هذا ليس مكتوبًا في EIP)
11    @notice يعمل هذا حتى لو لم يكن المرسل يمتلك أي رموز في ذلك الوقت.
12    @param _operator العنوان المراد إضافته إلى مجموعة المشغلين المعتمدين.
13    @param _approved True إذا تمت الموافقة على المشغلين، وfalse لإلغاء الموافقة.
14    """
15    # يطلق خطأ إذا كان `_operator` هو `msg.sender`
16    assert _operator != msg.sender
17    self.ownerToOperators[msg.sender][_operator] = _approved
18    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` هو المالك الحالي، أو مشغلًا معتمدًا، أو العنوان المعتمد لهذا الرمز NFT.
7         تطلق خطأ إذا لم يكن `_tokenId` رمز NFT صالحًا.
8    @param _tokenId معرّف uint256 لرمز ERC721 المراد حرقه.
9    """
10    # تحقق من المتطلبات
11    assert self._isApprovedOrOwner(msg.sender, _tokenId)
12    owner: address = self.idToOwner[_tokenId]
13    # تطلق خطأ إذا لم يكن `_tokenId` رمز NFT صالحًا
14    assert owner != ZERO_ADDRESS
15    self._clearApproval(owner, _tokenId)
16    self._removeTokenFrom(owner, _tokenId)
17    log Transfer(owner, ZERO_ADDRESS, _tokenId)
إظهار الكل
نسخ