Přejít na hlavní obsah

Průvodce kontraktem ERC-721 ve Vyperu

Vyper
erc-721
Python
Začátečník
Ori Pomerantz
1. dubna 2021
17 minut čtení

Úvod

Standard ERC-721 se používá k držení vlastnictví nezaměnitelných tokenů (NFT). Tokeny ERC-20 se chovají jako komodita, protože mezi jednotlivými tokeny není žádný rozdíl. Oproti tomu jsou tokeny ERC-721 navrženy pro aktiva, která jsou podobná, ale ne identická, jako jsou různé kreslené kočky (otevře se v nové kartě) nebo vlastnická práva k různým nemovitostem.

V tomto článku budeme analyzovat kontrakt ERC-721 od Ryuyi Nakamury (otevře se v nové kartě). Tento kontrakt je napsán v jazyce Vyper (otevře se v nové kartě), což je jazyk pro kontrakty podobný Pythonu, navržený tak, aby v něm bylo těžší napsat nezabezpečený kód než v Solidity.

Kontrakt

# @dev Implementace standardu ERC-721 pro nezaměnitelný token.
# @author Ryuya Nakamura (@nrryuya)
# Upraveno z: https://github.com/vyperlang/vyper/blob/de74722bf2d8718cca46902be165f9fe0e3641dd/examples/tokens/ERC721.vy

Komentáře ve Vyperu, stejně jako v Pythonu, začínají znakem hash (ethereum.ercs) a pokračují až do konce řádku. Komentáře, které obsahují @<keyword>, používá NatSpec (otevře se v nové kartě) k vytvoření lidsky čitelné dokumentace.

from vyper.interfaces import ERC721

implements: ERC721

Rozhraní ERC-721 je zabudováno do jazyka Vyper. Definici kódu si můžete prohlédnout zde (otevře se v nové kartě). Definice rozhraní je napsána v Pythonu, nikoli ve Vyperu, protože rozhraní se používají nejen v rámci blockchainu, ale také při odesílání transakce na blockchain z externího klienta, který může být napsán v Pythonu.

První řádek importuje rozhraní a druhý specifikuje, že ho zde implementujeme.

#pragma version >0.3.10
#pragma version >0.3.10

Rozhraní ERC721Receiver

# Rozhraní pro kontrakt volaný pomocí safeTransferFrom()
interface ERC721Receiver:
    def onERC721Received(

ERC-721 podporuje dva typy převodu:

  • transferFrom, který umožňuje odesílateli specifikovat jakoukoli cílovou adresu a přenáší odpovědnost za převod na odesílatele. To znamená, že můžete provést převod na neplatnou adresu, v takovém případě je NFT navždy ztraceno.
  • safeTransferFrom, který kontroluje, zda je cílová adresa kontrakt. Pokud ano, kontrakt ERC-721 se zeptá přijímajícího kontraktu, zda chce NFT přijmout.

Aby přijímající kontrakt mohl odpovídat na požadavky safeTransferFrom, musí implementovat ERC721Receiver.

            _operator: address,
            _from: address,

Adresa _from je aktuální vlastník tokenu. Adresa _operator je ta, která požádala o převod (tyto dvě nemusí být stejné kvůli povoleným limitům). Podle konvence většina parametrů funkcí v tomto kontraktu začíná podtržítkem (_).

            _tokenId: uint256,

ID tokenů ERC-721 mají 256 bitů. Obvykle se vytvářejí hashováním popisu toho, co token představuje.

            _data: Bytes[1024]

Požadavek může obsahovat až 1024 bajtů uživatelských dat.

        ) -> bytes4: nonpayable

Aby se předešlo případům, kdy kontrakt omylem přijme převod, návratovou hodnotou není boolean, ale specifická čtyřbajtová hodnota, selektor funkce onERC721Received. Funkce je nonpayable, protože přijímající kontrakt může při přijetí tokenu změnit svůj vlastní stav.

Události

Události jsou emitovány, aby informovaly uživatele a servery mimo blockchain o událostech. Všimněte si, že obsah událostí není dostupný kontraktům na blockchainu. Tři události ERC-721 jsou definovány rozhraním IERC721, které jsme importovali, takže je tento kontrakt nedeklaruje sám; emituje je pomocí log IERC721.<Event>(...), jak uvidíme ve funkcích pro převod níže.

Transfer (sender, receiver, token_id) hlásí změnu vlastnictví NFT. To je podobné události Transfer u ERC-20, s tím rozdílem, že místo částky hlásíme token_id. Nikdo nevlastní nulovou adresu, takže podle konvence ji používáme k hlášení vytváření a ničení tokenů. Jedinou výjimkou je vytváření kontraktu, během kterého může být vytvořeno a přiřazeno libovolné množství NFT bez emitování události Transfer.

Schválení (approval) u ERC-721 je podobné povolenému limitu u ERC-20: konkrétní adrese je povoleno převést konkrétní token a událost Approval (owner, approved, token_id) je emitována, kdykoli je tato schválená adresa nastavena nebo potvrzena. To poskytuje mechanismus, jak mohou kontrakty reagovat, když přijmou token. Kontrakty nemohou naslouchat událostem, takže pokud jim token pouze převedete, "nevědí" o tom. Tímto způsobem vlastník nejprve odešle schválení a poté pošle požadavek kontraktu: "Schválil jsem vám převod tokenu X, prosím udělejte...". Toto je rozhodnutí při návrhu, aby byl standard ERC-721 podobný standardu ERC-20. Protože tokeny ERC-721 nejsou zaměnitelné, kontrakt může také identifikovat, že dostal konkrétní token, tím, že se podívá na vlastnictví tokenu.

Nakonec je emitována událost ApprovalForAll (owner, operator, approved), když je pro vlastníka povolen nebo zakázán operátor. Někdy je užitečné mít operátora, který může spravovat všechny tokeny účtu určitého typu (ty, které jsou spravovány konkrétním kontraktem), podobně jako plná moc. Například bych mohl chtít dát takovou moc kontraktu, který kontroluje, zda jsem ho nekontaktoval po dobu šesti měsíců, a pokud ano, rozdělí má aktiva mým dědicům (pokud o to některý z nich požádá, kontrakty nemohou nic dělat, aniž by byly zavolány transakcí). U ERC-20 můžeme dědickému kontraktu jednoduše dát vysoký povolený limit, ale to u ERC-721 nefunguje, protože tokeny nejsou zaměnitelné. Toto je ekvivalent. Hodnota approved nám říká, zda je událost pro schválení, nebo pro zrušení schválení.

Stavové proměnné

Tyto proměnné obsahují aktuální stav tokenů: které jsou k dispozici a kdo je vlastní. Většina z nich jsou objekty HashMap, jednosměrná mapování, která existují mezi dvěma typy (otevře se v nové kartě).

# @dev Mapování z ID NFT na adresu, která jej vlastní.
idToOwner: HashMap[uint256, address]

# @dev Mapování z ID NFT na schválenou adresu.
idToApprovals: HashMap[uint256, address]

Identity uživatelů a kontraktů v Ethereu jsou reprezentovány 160bitovými adresami. Tyto dvě proměnné mapují z ID tokenů na jejich vlastníky a ty, kteří jsou schváleni k jejich převodu (maximálně jeden pro každý). V Ethereu jsou neinicializovaná data vždy nulová, takže pokud neexistuje žádný vlastník nebo schválený převodce, hodnota pro tento token je nula.

# @dev Mapování z adresy vlastníka na počet jeho tokenů.
ownerToNFTokenCount: HashMap[address, uint256]

Tato proměnná uchovává počet tokenů pro každého vlastníka. Neexistuje žádné mapování z vlastníků na tokeny, takže jediný způsob, jak identifikovat tokeny, které konkrétní vlastník vlastní, je podívat se zpět do historie událostí blockchainu a najít příslušné události Transfer. Tuto proměnnou můžeme použít k tomu, abychom věděli, kdy máme všechna NFT a nemusíme se dívat ještě dále do minulosti.

Všimněte si, že tento algoritmus funguje pouze pro uživatelská rozhraní a externí servery. Kód běžící na samotném blockchainu nemůže číst minulé události.

# @dev Mapování z adresy vlastníka na mapování adres operátorů.
ownerToOperators: HashMap[address, HashMap[address, bool]]

Účet může mít více než jednoho operátora. Jednoduchá HashMap k jejich sledování nestačí, protože každý klíč vede k jediné hodnotě. Místo toho můžete jako hodnotu použít HashMap[address, bool]. Ve výchozím nastavení je hodnota pro každou adresu False, což znamená, že není operátorem. Hodnoty můžete podle potřeby nastavit na True.

# @dev Adresa raziče (minter), který může razit token
minter: address

Nové tokeny musí být nějak vytvořeny. V tomto kontraktu existuje jediná entita, která to má povoleno, minter. To pravděpodobně postačí například pro hru. Pro jiné účely může být nutné vytvořit složitější obchodní logiku.

# @dev Statický seznam podporovaných ID rozhraní ERC165
SUPPORTED_INTERFACES: constant(bytes4[2]) = [
    # ID rozhraní ERC165 pro ERC165
    0x01ffc9a7,
    # ID rozhraní ERC165 pro ERC721
    0x80ac58cd,
]

ERC-165 (otevře se v nové kartě) specifikuje mechanismus, jak může kontrakt zveřejnit, jak s ním mohou aplikace komunikovat, a kterým standardům ERC vyhovuje. SUPPORTED_INTERFACES je konstantní seznam dvou čtyřbajtových ID rozhraní, kterým tento kontrakt vyhovuje: samotnému ERC-165 a ERC-721.

Funkce

Toto jsou funkce, které skutečně implementují ERC-721.

Konstruktor

@deploy
def __init__():

Ve Vyperu, stejně jako v Pythonu, se funkce konstruktoru nazývá __init__. Je označena dekorátorem @deploy, což znamená, že se spustí jednou, když je kontrakt nasazen.

    """
    @dev Konstruktor kontraktu.
    """

V Pythonu a ve Vyperu můžete také vytvořit komentář zadáním víceřádkového řetězce (který začíná a končí """) a nijak ho nepoužít. Tyto komentáře mohou také obsahovat NatSpec (otevře se v nové kartě).

    self.minter = msg.sender

Pro přístup ke stavovým proměnným používáte self.<název proměnné> (opět stejně jako v Pythonu). Konstruktor zaznamená účet, který nasadil kontrakt, jako minter.

View funkce

Toto jsou funkce, které nemění stav blockchainu, a proto mohou být spuštěny zdarma, pokud jsou volány externě. Pokud jsou view funkce volány kontraktem, musí být stále spuštěny na každém uzlu, a proto stojí gas.

@view
@external

Tato klíčová slova před definicí funkce, která začínají zavináčem (@), se nazývají dekorátory. Specifikují okolnosti, za kterých může být funkce volána.

  • @view specifikuje, že tato funkce je view (pouze pro čtení).
  • @external specifikuje, že tato konkrétní funkce může být volána transakcemi a jinými kontrakty.
def supportsInterface(interface_id: bytes4) -> bool:

Na rozdíl od Pythonu je Vyper staticky typovaný jazyk (otevře se v nové kartě). Nemůžete deklarovat proměnnou nebo parametr funkce bez identifikace datového typu (otevře se v nové kartě). V tomto případě je vstupním parametrem bytes4, čtyřbajtová hodnota, a výstupem je booleovská hodnota.

    """
    @dev Identifikace rozhraní je specifikována v ERC-165.
    @param interface_id Id rozhraní
    """
    return interface_id in SUPPORTED_INTERFACES

Vrátí True, pokud je interface_id jedním z ID rozhraní v seznamu SUPPORTED_INTERFACES.

### VIEW FUNKCE ###

Toto jsou view funkce, které zpřístupňují informace o tokenech uživatelům a dalším kontraktům.

Tento řádek ověřuje (assert) (otevře se v nové kartě), že _owner není nulová adresa, zapsaná jako empty(address). Pokud ano, dojde k chybě a operace je zvrácena.

V Ethereum Virtual Machine (EVM) je jakékoli úložiště, ve kterém není uložena žádná hodnota, nulové. Pokud na _tokenId není žádný token, pak je hodnota self.idToOwner[_tokenId] nula. V takovém případě je funkce zvrácena.

Všimněte si, že getApproved může vrátit nulu. Pokud je token platný, vrátí self.idToApprovals[_tokenId]. Pokud neexistuje žádný schvalovatel, je tato hodnota nula.

Tato funkce kontroluje, zda má _operator povoleno spravovat všechny tokeny _owner v tomto kontraktu. Protože může existovat více operátorů, jedná se o dvouúrovňovou HashMap.

Pomocné funkce pro převod

Tyto funkce implementují operace, které jsou součástí převodu nebo správy tokenů.


### POMOCNÉ FUNKCE PRO PŘEVOD ###

@view
@internal

Tento dekorátor, @internal, znamená, že funkce je přístupná pouze z jiných funkcí v rámci stejného kontraktu. Podle konvence názvy těchto funkcí také začínají podtržítkem (_).

Existují tři způsoby, jak může mít adresa povoleno převést token:

  1. Adresa je vlastníkem tokenu
  2. Adresa je schválena k utracení tohoto tokenu
  3. Adresa je operátorem pro vlastníka tokenu

Výše uvedená funkce může být view, protože nemění stav. Aby se snížily provozní náklady, jakákoli funkce, která může být view, by měla být view.

Když nastane problém s převodem, zvrátíme volání.

Hodnotu měňte pouze v případě potřeby. Stavové proměnné žijí v úložišti. Zápis do úložiště je jednou z nejdražších operací, které EVM (Ethereum Virtual Machine) provádí (z hlediska gasu). Proto je dobré to minimalizovat, dokonce i zápis existující hodnoty má vysoké náklady.

Tuto interní funkci máme proto, že existují dva způsoby převodu tokenů (běžný a bezpečný), ale chceme mít v kódu pouze jedno místo, kde to děláme, aby byl audit snazší.

K emitování události ve Vyperu používáte příkaz log (více podrobností najdete zde (otevře se v nové kartě)). Protože události patří do importovaného rozhraní, odkazujeme na ně jako na IERC721.Transfer a jejich pole předáváme pomocí klíčových slov.

Funkce pro převod

Tato funkce vám umožňuje provést převod na libovolnou adresu. Pokud adresa není uživatel nebo kontrakt, který ví, jak převádět tokeny, jakýkoli token, který převedete, na této adrese uvízne a bude k ničemu.

Dekorátor @payable je zde proto, že rozhraní IERC721 deklaruje transferFrom, safeTransferFrom a approve jako payable, takže kontrakt, který implementuje rozhraní, musí těmto signaturám odpovídat.

Je v pořádku provést převod jako první, protože pokud nastane problém, stejně ho zvrátíme, takže vše, co bylo ve volání provedeno, bude zrušeno.

    if _to.is_contract: # zkontroluje, zda je `_to` adresa kontraktu

Nejprve zkontrolujte, zda je adresa kontrakt (zda má kód). Pokud ne, předpokládejte, že se jedná o adresu uživatele a uživatel bude moci token použít nebo převést. Nenechte se tím ale ukolébat k falešnému pocitu bezpečí. Tokeny můžete ztratit, a to i pomocí safeTransferFrom, pokud je převedete na adresu, ke které nikdo nezná soukromý klíč.

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

Zavolejte cílový kontrakt, abyste zjistili, zda může přijímat tokeny ERC-721. Vyper 0.4 vyžaduje, aby volání jiných kontraktů byla označena, takže volání je uvozeno extcall.

        # Zvrátí, pokud je cíl převodu kontrakt, který neimplementuje 'onERC721Received'
        assert returnValue == method_id("onERC721Received(address,address,uint256,bytes)", output_type=bytes4)

Pokud je cílem kontrakt, ale takový, který nepřijímá tokeny ERC-721 (nebo který se rozhodl nepřijmout tento konkrétní převod), zvrátí.

Podle konvence, pokud nechcete mít schvalovatele, určíte nulovou adresu, nikoli sebe.

    # Zkontroluje požadavky
    senderIsOwner: bool = self.idToOwner[_tokenId] == msg.sender
    senderIsApprovedForAll: bool = (self.ownerToOperators[owner])[msg.sender]
    assert (senderIsOwner or senderIsApprovedForAll)

Chcete-li nastavit schválení, můžete být buď vlastníkem, nebo operátorem autorizovaným vlastníkem.

Ražení nových tokenů a zničení stávajících

Účet, který vytvořil kontrakt, je minter, superuživatel, který je oprávněn razit nová NFT. Nicméně ani on nemá povoleno spálit stávající tokeny. To může udělat pouze vlastník nebo entita autorizovaná vlastníkem.

### FUNKCE PRO RAŽENÍ A SPÁLENÍ ###

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

Tato funkce vždy vrací True, protože pokud operace selže, je zvrácena.

Pouze minter (účet, který vytvořil kontrakt ERC-721) může razit nové tokeny. To může být v budoucnu problém, pokud budeme chtít změnit identitu mintera. V produkčním kontraktu byste pravděpodobně chtěli funkci, která minterovi umožní převést oprávnění k ražení na někoho jiného.

    # Zvrátí, pokud je `_to` nulová adresa
    assert _to != ZERO_ADDRESS
    # Přidá NFT. Zvrátí, pokud `_tokenId` někdo vlastní
    self._addTokenTo(_to, _tokenId)
    log Transfer(ZERO_ADDRESS, _to, _tokenId)
    return True

Podle konvence se ražení nových tokenů počítá jako převod z nulové adresy.

Kdokoli, kdo má povoleno převést token, má povoleno ho spálit. Ačkoli se spálení jeví jako ekvivalent převodu na nulovou adresu, nulová adresa ve skutečnosti token nepřijme. To nám umožňuje uvolnit veškeré úložiště, které bylo pro token použito, což může snížit náklady na gas u transakce.

Použití tohoto kontraktu

Na rozdíl od Solidity nemá Vyper dědičnost. Jedná se o záměrné rozhodnutí při návrhu, aby byl kód jasnější a tím pádem snáze zabezpečitelný. Takže k vytvoření vlastního kontraktu ERC-721 ve Vyperu vezmete tento kontrakt (otevře se v nové kartě) a upravíte ho tak, aby implementoval požadovanou obchodní logiku.

Závěr

Pro zopakování uvádíme některé z nejdůležitějších myšlenek v tomto kontraktu:

  • Pro příjem tokenů ERC-721 pomocí bezpečného převodu musí kontrakty implementovat rozhraní ERC721Receiver.
  • I když použijete bezpečný převod, tokeny mohou stále uvíznout, pokud je pošlete na adresu, jejíž soukromý klíč není znám.
  • Když nastane problém s operací, je dobré volání revert (zvrátit), spíše než jen vrátit hodnotu selhání.
  • Tokeny ERC-721 existují, když mají vlastníka.
  • Existují tři způsoby, jak být oprávněn k převodu NFT. Můžete být vlastníkem, mít schválení pro konkrétní token, nebo být operátorem pro všechny tokeny vlastníka.
  • Minulé události jsou viditelné pouze mimo blockchain. Kód běžící uvnitř blockchainu je nemůže zobrazit.

Nyní běžte a implementujte bezpečné kontrakty ve Vyperu.

Zde najdete další mou práci (otevře se v nové kartě).