Lompat ke konten utama

Panduan Kontrak ERC-721 Vyper

Vyper
erc-721
Python
Pemula
Ori Pomerantz
1 April 2021
19 menit baca

Pengantar

Standar ERC-721 digunakan untuk memegang kepemilikan Non-Fungible Token (NFT). Token ERC-20 berperilaku sebagai komoditas, karena tidak ada perbedaan antara masing-masing token. Sebaliknya, token ERC-721 dirancang untuk aset yang serupa tetapi tidak identik, seperti kartun kucing (opens in a new tab) yang berbeda atau sertifikat untuk berbagai bidang real estat.

Dalam artikel ini kita akan menganalisis kontrak ERC-721 Ryuya Nakamura (opens in a new tab). Kontrak ini ditulis dalam Vyper (opens in a new tab), bahasa kontrak mirip Python yang dirancang untuk membuatnya lebih sulit menulis kode yang tidak aman dibandingkan di Solidity.

Kontrak

# @dev Implementasi standar token non-fungible ERC-721.
# @author Ryuya Nakamura (@nrryuya)
# Dimodifikasi dari: https://github.com/vyperlang/vyper/blob/de74722bf2d8718cca46902be165f9fe0e3641dd/examples/tokens/ERC721.vy

Komentar di Vyper, seperti di Python, dimulai dengan sebuah hash (#) dan berlanjut hingga akhir baris. Komentar yang menyertakan @<keyword> digunakan oleh NatSpec (opens in a new tab) untuk menghasilkan dokumentasi yang dapat dibaca manusia.

from vyper.interfaces import ERC721

implements: ERC721

Antarmuka ERC-721 dibangun ke dalam bahasa Vyper. Anda dapat melihat definisi kodenya di sini (opens in a new tab). Definisi antarmuka ditulis dalam Python, bukan Vyper, karena antarmuka digunakan tidak hanya di dalam rantai blok, tetapi juga saat mengirimkan transaksi ke rantai blok dari klien eksternal, yang mungkin ditulis dalam Python.

Baris pertama mengimpor antarmuka, dan yang kedua menentukan bahwa kita mengimplementasikannya di sini.

Antarmuka ERC721Receiver

# Antarmuka untuk kontrak yang dipanggil oleh safeTransferFrom()
interface ERC721Receiver:
    def onERC721Received(

ERC-721 mendukung dua jenis transfer:

  • transferFrom, yang memungkinkan pengirim menentukan alamat tujuan mana pun dan menempatkan tanggung jawab transfer pada pengirim. Ini berarti Anda dapat mentransfer ke alamat yang tidak valid, yang dalam hal ini NFT akan hilang selamanya.
  • safeTransferFrom, yang memeriksa apakah alamat tujuan adalah sebuah kontrak. Jika ya, kontrak ERC-721 bertanya kepada kontrak penerima apakah ia ingin menerima NFT tersebut.

Untuk menjawab permintaan safeTransferFrom, kontrak penerima harus mengimplementasikan ERC721Receiver.

            _operator: address,
            _from: address,

Alamat _from adalah pemilik token saat ini. Alamat _operator adalah pihak yang meminta transfer (keduanya mungkin tidak sama, karena adanya jatah).

            _tokenId: uint256,

ID token ERC-721 berukuran 256 bit. Biasanya ID ini dibuat dengan melakukan proses hash pada deskripsi dari apa pun yang diwakili oleh token tersebut.

            _data: Bytes[1024]

Permintaan tersebut dapat memiliki hingga 1024 bita data pengguna.

        ) -> bytes32: view

Untuk mencegah kasus di mana sebuah kontrak secara tidak sengaja menerima transfer, nilai kembaliannya bukanlah boolean, melainkan 256 bit dengan nilai tertentu.

Fungsi ini adalah view, yang berarti ia dapat membaca state dari rantai blok, tetapi tidak dapat memodifikasinya.

Peristiwa

Peristiwa dipancarkan untuk memberi tahu pengguna dan server di luar rantai blok tentang peristiwa tersebut. Perhatikan bahwa konten peristiwa tidak tersedia untuk kontrak di rantai blok.

Ini mirip dengan peristiwa Transfer ERC-20, kecuali bahwa kita melaporkan tokenId alih-alih jumlah. Tidak ada yang memiliki alamat nol, jadi berdasarkan konvensi kita menggunakannya untuk melaporkan penciptaan dan penghancuran token.

Persetujuan ERC-721 mirip dengan jatah ERC-20. Alamat tertentu diizinkan untuk mentransfer token tertentu. Ini memberikan mekanisme bagi kontrak untuk merespons saat mereka menerima token. Kontrak tidak dapat mendengarkan peristiwa, jadi jika Anda hanya mentransfer token kepada mereka, mereka tidak akan "tahu" tentang hal itu. Dengan cara ini pemilik pertama-tama mengirimkan persetujuan dan kemudian mengirimkan permintaan ke kontrak: "Saya menyetujui Anda untuk mentransfer token X, silakan lakukan ...".

Ini adalah pilihan desain untuk membuat standar ERC-721 mirip dengan standar ERC-20. Karena token ERC-721 tidak sepadan, sebuah kontrak juga dapat mengidentifikasi bahwa ia mendapatkan token tertentu dengan melihat kepemilikan token tersebut.

Terkadang berguna untuk memiliki operator yang dapat mengelola semua token akun dari jenis tertentu (yang dikelola oleh kontrak tertentu), mirip dengan surat kuasa. Misalnya, saya mungkin ingin memberikan kuasa tersebut kepada kontrak yang memeriksa apakah saya belum menghubunginya selama enam bulan, dan jika demikian mendistribusikan aset saya kepada ahli waris saya (jika salah satu dari mereka memintanya, kontrak tidak dapat melakukan apa pun tanpa dipanggil oleh sebuah transaksi). Di ERC-20 kita bisa saja memberikan jatah yang tinggi ke kontrak warisan, tetapi itu tidak berlaku untuk ERC-721 karena tokennya tidak sepadan. Ini adalah padanannya.

Nilai approved memberi tahu kita apakah peristiwa tersebut untuk persetujuan, atau penarikan persetujuan.

Variabel State

Variabel-variabel ini berisi state token saat ini: mana yang tersedia dan siapa pemiliknya. Sebagian besar dari ini adalah objek HashMap, pemetaan searah yang ada di antara dua tipe (opens in a new tab).

# @dev Pemetaan dari ID NFT ke alamat yang memilikinya.
idToOwner: HashMap[uint256, address]

# @dev Pemetaan dari ID NFT ke alamat yang disetujui.
idToApprovals: HashMap[uint256, address]

Identitas pengguna dan kontrak di Ethereum diwakili oleh alamat 160-bit. Kedua variabel ini memetakan dari ID token ke pemiliknya dan mereka yang disetujui untuk mentransfernya (maksimal satu untuk masing-masing). Di Ethereum, data yang tidak diinisialisasi selalu nol, jadi jika tidak ada pemilik atau pentransfer yang disetujui, nilai untuk token tersebut adalah nol.

# @dev Pemetaan dari alamat pemilik ke jumlah token miliknya.
ownerToNFTokenCount: HashMap[address, uint256]

Variabel ini menyimpan jumlah token untuk setiap pemilik. Tidak ada pemetaan dari pemilik ke token, jadi satu-satunya cara untuk mengidentifikasi token yang dimiliki oleh pemilik tertentu adalah dengan melihat kembali riwayat peristiwa rantai blok dan melihat peristiwa Transfer yang sesuai. Kita dapat menggunakan variabel ini untuk mengetahui kapan kita memiliki semua NFT dan tidak perlu melihat lebih jauh ke masa lalu.

Perhatikan bahwa algoritma ini hanya berfungsi untuk antarmuka pengguna dan server eksternal. Kode yang berjalan di rantai blok itu sendiri tidak dapat membaca peristiwa masa lalu.

# @dev Pemetaan dari alamat pemilik ke pemetaan alamat operator.
ownerToOperators: HashMap[address, HashMap[address, bool]]

Sebuah akun mungkin memiliki lebih dari satu operator. HashMap sederhana tidak cukup untuk melacaknya, karena setiap kunci mengarah ke satu nilai. Sebagai gantinya, Anda dapat menggunakan HashMap[address, bool] sebagai nilainya. Secara bawaan, nilai untuk setiap alamat adalah False, yang berarti ia bukan operator. Anda dapat mengatur nilai ke True sesuai kebutuhan.

# @dev Alamat pencetak, yang dapat mencetak token
minter: address

Token baru harus dibuat dengan suatu cara. Dalam kontrak ini ada satu entitas yang diizinkan untuk melakukannya, yaitu minter. Ini kemungkinan cukup untuk sebuah permainan, misalnya. Untuk tujuan lain, mungkin perlu membuat logika bisnis yang lebih rumit.

# @dev Pemetaan ID antarmuka ke bool tentang apakah itu didukung atau tidak
supportedInterfaces: HashMap[bytes32, bool]

# @dev ID antarmuka ERC-165 dari ERC-165
ERC165_INTERFACE_ID: constant(bytes32) = 0x0000000000000000000000000000000000000000000000000000000001ffc9a7

# @dev ID antarmuka ERC-165 dari ERC-721
ERC721_INTERFACE_ID: constant(bytes32) = 0x0000000000000000000000000000000000000000000000000000000080ac58cd

ERC-165 (opens in a new tab) menentukan mekanisme bagi kontrak untuk mengungkapkan bagaimana aplikasi dapat berkomunikasi dengannya, dan ERC mana yang dipatuhinya. Dalam hal ini, kontrak mematuhi ERC-165 dan ERC-721.

Fungsi

Ini adalah fungsi-fungsi yang benar-benar mengimplementasikan ERC-721.

Konstruktor

@external
def __init__():

Di Vyper, seperti di Python, fungsi konstruktor disebut __init__.

    """
    @dev Konstruktor kontrak.
    """

Di Python, dan di Vyper, Anda juga dapat membuat komentar dengan menentukan string multi-baris (yang dimulai dan diakhiri dengan """), dan tidak menggunakannya dengan cara apa pun. Komentar ini juga dapat menyertakan NatSpec (opens in a new tab).

    self.supportedInterfaces[ERC165_INTERFACE_ID] = True
    self.supportedInterfaces[ERC721_INTERFACE_ID] = True
    self.minter = msg.sender

Untuk mengakses variabel state Anda menggunakan self.<variable name> (sekali lagi, sama seperti di Python).

Fungsi View

Ini adalah fungsi-fungsi yang tidak memodifikasi state dari rantai blok, dan oleh karena itu dapat dieksekusi secara gratis jika dipanggil secara eksternal. Jika fungsi view dipanggil oleh sebuah kontrak, fungsi tersebut tetap harus dieksekusi di setiap node dan oleh karena itu membutuhkan biaya gas.

@view
@external

Kata kunci sebelum definisi fungsi yang dimulai dengan tanda at (@) disebut dekorasi. Mereka menentukan keadaan di mana suatu fungsi dapat dipanggil.

  • @view menentukan bahwa fungsi ini adalah sebuah view.
  • @external menentukan bahwa fungsi khusus ini dapat dipanggil oleh transaksi dan oleh kontrak lain.
def supportsInterface(_interfaceID: bytes32) -> bool:

Berbeda dengan Python, Vyper adalah bahasa bertipe statis (opens in a new tab). Anda tidak dapat mendeklarasikan variabel, atau parameter fungsi, tanpa mengidentifikasi tipe data (opens in a new tab). Dalam hal ini parameter masukannya adalah bytes32, nilai 256-bit (256 bit adalah ukuran kata asli dari Ethereum Virtual Machine). Keluarannya adalah nilai boolean. Berdasarkan konvensi, nama parameter fungsi dimulai dengan garis bawah (_).

    """
    @dev Identifikasi antarmuka ditentukan dalam ERC-165.
    @param _interfaceID Id dari antarmuka
    """
    return self.supportedInterfaces[_interfaceID]

Mengembalikan nilai dari HashMap self.supportedInterfaces, yang diatur dalam konstruktor (__init__).

### FUNGSI VIEW ###

Ini adalah fungsi-fungsi view yang membuat informasi tentang token tersedia bagi pengguna dan kontrak lain.

Baris ini menegaskan (opens in a new tab) bahwa _owner bukan nol. Jika ya, terjadi kesalahan dan operasi dikembalikan.

Di Ethereum Virtual Machine (EVM), penyimpanan apa pun yang tidak memiliki nilai yang tersimpan di dalamnya adalah nol. Jika tidak ada token di _tokenId maka nilai self.idToOwner[_tokenId] adalah nol. Dalam hal itu fungsi mengembalikan.

Perhatikan bahwa getApproved dapat mengembalikan nol. Jika token valid, ia mengembalikan self.idToApprovals[_tokenId]. Jika tidak ada pemberi persetujuan, nilai tersebut adalah nol.

Fungsi ini memeriksa apakah _operator diizinkan untuk mengelola semua token _owner dalam kontrak ini. Karena bisa ada beberapa operator, ini adalah HashMap dua tingkat.

Fungsi Pembantu Transfer

Fungsi-fungsi ini mengimplementasikan operasi yang merupakan bagian dari mentransfer atau mengelola token.


### PEMBANTU FUNGSI TRANSFER ###

@view
@internal

Dekorasi ini, @internal, berarti bahwa fungsi tersebut hanya dapat diakses dari fungsi lain dalam kontrak yang sama. Berdasarkan konvensi, nama fungsi ini juga dimulai dengan garis bawah (_).

Ada tiga cara di mana sebuah alamat dapat diizinkan untuk mentransfer token:

  1. Alamat tersebut adalah pemilik token
  2. Alamat tersebut disetujui untuk membelanjakan token itu
  3. Alamat tersebut adalah operator untuk pemilik token

Fungsi di atas dapat berupa view karena tidak mengubah state. Untuk mengurangi biaya operasi, fungsi apa pun yang dapat berupa view seharusnya menjadi view.

Ketika ada masalah dengan transfer, kita mengembalikan panggilan tersebut.

Hanya ubah nilai jika perlu. Variabel state hidup di penyimpanan. Menulis ke penyimpanan adalah salah satu operasi paling mahal yang dilakukan EVM (Ethereum Virtual Machine) (dalam hal gas). Oleh karena itu, ada baiknya untuk meminimalkannya, bahkan menulis nilai yang ada pun memiliki biaya yang tinggi.

Kita memiliki fungsi internal ini karena ada dua cara untuk mentransfer token (biasa dan aman), tetapi kita hanya menginginkan satu lokasi dalam kode tempat kita melakukannya untuk mempermudah audit.

Untuk memancarkan peristiwa di Vyper, Anda menggunakan pernyataan log (lihat di sini untuk detail lebih lanjut (opens in a new tab)).

Fungsi Transfer

Fungsi ini memungkinkan Anda mentransfer ke alamat mana pun. Kecuali alamat tersebut adalah pengguna, atau kontrak yang tahu cara mentransfer token, token apa pun yang Anda transfer akan tersangkut di alamat tersebut dan tidak berguna.

Tidak apa-apa untuk melakukan transfer terlebih dahulu karena jika ada masalah kita akan mengembalikannya, jadi semua yang dilakukan dalam panggilan akan dibatalkan.

    if _to.is_contract: # memeriksa apakah `_to` adalah alamat kontrak

Pertama periksa untuk melihat apakah alamat tersebut adalah sebuah kontrak (jika memiliki kode). Jika tidak, asumsikan itu adalah alamat pengguna dan pengguna akan dapat menggunakan token atau mentransfernya. Namun jangan biarkan hal itu membuat Anda terlena dalam rasa aman yang palsu. Anda bisa kehilangan token, bahkan dengan safeTransferFrom, jika Anda mentransfernya ke alamat yang tidak ada seorang pun yang mengetahui kunci privatnya.

        returnValue: bytes32 = ERC721Receiver(_to).onERC721Received(msg.sender, _from, _tokenId, _data)

Panggil kontrak target untuk melihat apakah ia dapat menerima token ERC-721.

        # Menghasilkan galat jika tujuan transfer adalah kontrak yang tidak mengimplementasikan 'onERC721Received'
        assert returnValue == method_id("onERC721Received(address,address,uint256,bytes)", output_type=bytes32)

Jika tujuannya adalah sebuah kontrak, tetapi kontrak yang tidak menerima token ERC-721 (atau yang memutuskan untuk tidak menerima transfer khusus ini), kembalikan.

Berdasarkan konvensi, jika Anda tidak ingin memiliki pemberi persetujuan, Anda menunjuk alamat nol, bukan diri Anda sendiri.

    # Memeriksa persyaratan
    senderIsOwner: bool = self.idToOwner[_tokenId] == msg.sender
    senderIsApprovedForAll: bool = (self.ownerToOperators[owner])[msg.sender]
    assert (senderIsOwner or senderIsApprovedForAll)

Untuk mengatur persetujuan, Anda bisa menjadi pemilik, atau operator yang diberi wewenang oleh pemilik.

Mencetak Token Baru dan Menghancurkan yang Sudah Ada

Akun yang membuat kontrak adalah minter, pengguna super yang berwenang untuk mencetak NFT baru. Namun, bahkan ia tidak diizinkan untuk membakar token yang ada. Hanya pemilik, atau entitas yang diberi wewenang oleh pemilik, yang dapat melakukannya.

### FUNGSI CETAK & BAKAR ###

@external
def mint(_to: address, _tokenId: uint256) -> bool:

Fungsi ini selalu mengembalikan True, karena jika operasi gagal, ia akan dikembalikan.

Hanya pencetak (akun yang membuat kontrak ERC-721) yang dapat mencetak token baru. Ini bisa menjadi masalah di masa depan jika kita ingin mengubah identitas pencetak. Dalam kontrak produksi, Anda mungkin menginginkan fungsi yang memungkinkan pencetak untuk mentransfer hak istimewa pencetak kepada orang lain.

    # Menghasilkan galat jika `_to` adalah alamat nol
    assert _to != ZERO_ADDRESS
    # Menambahkan NFT. Menghasilkan galat jika `_tokenId` dimiliki oleh seseorang
    self._addTokenTo(_to, _tokenId)
    log Transfer(ZERO_ADDRESS, _to, _tokenId)
    return True

Berdasarkan konvensi, pencetakan token baru dihitung sebagai transfer dari alamat nol.

Siapa pun yang diizinkan untuk mentransfer token diizinkan untuk membakarnya. Meskipun pembakaran tampak setara dengan transfer ke alamat nol, alamat nol sebenarnya tidak menerima token tersebut. Ini memungkinkan kita untuk membebaskan semua penyimpanan yang digunakan untuk token, yang dapat mengurangi biaya gas dari transaksi.

Menggunakan Kontrak Ini

Berbeda dengan Solidity, Vyper tidak memiliki pewarisan. Ini adalah pilihan desain yang disengaja untuk membuat kode lebih jelas dan karenanya lebih mudah diamankan. Jadi untuk membuat kontrak ERC-721 Vyper Anda sendiri, Anda mengambil kontrak ini (opens in a new tab) dan memodifikasinya untuk mengimplementasikan logika bisnis yang Anda inginkan.

Kesimpulan

Sebagai ulasan, berikut adalah beberapa ide terpenting dalam kontrak ini:

  • Untuk menerima token ERC-721 dengan transfer yang aman, kontrak harus mengimplementasikan antarmuka ERC721Receiver.
  • Bahkan jika Anda menggunakan transfer yang aman, token masih bisa tersangkut jika Anda mengirimkannya ke alamat yang kunci privatnya tidak diketahui.
  • Ketika ada masalah dengan suatu operasi, ada baiknya untuk revert panggilan tersebut, daripada hanya mengembalikan nilai kegagalan.
  • Token ERC-721 ada ketika mereka memiliki pemilik.
  • Ada tiga cara untuk diberi wewenang mentransfer NFT. Anda bisa menjadi pemilik, disetujui untuk token tertentu, atau menjadi operator untuk semua token pemilik.
  • Peristiwa masa lalu hanya terlihat di luar rantai blok. Kode yang berjalan di dalam rantai blok tidak dapat melihatnya.

Sekarang pergilah dan implementasikan kontrak Vyper yang aman.

Lihat di sini untuk karya saya yang lain (opens in a new tab).