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 (opens in a new tab) nebo vlastnická práva k různým nemovitostem.

V tomto článku budeme analyzovat kontrakt ERC-721 od Ryuyi Nakamury (opens in a new tab). Tento kontrakt je napsán v jazyce Vyper (opens in a new tab), 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 (#) a pokračují až do konce řádku. Komentáře, které obsahují @<keyword>, používá NatSpec (opens in a new tab) 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 (opens in a new tab). 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.

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 zadat libovolnou 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 nadobro 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 mohl přijímající kontrakt 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).

            _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.

        ) -> bytes32: view

Aby se předešlo případům, kdy kontrakt omylem přijme převod, návratová hodnota není boolean, ale 256 bitů se specifickou hodnotou.

Tato funkce je view, což znamená, že může číst stav blockchainu, ale nemůže ho upravovat.

Události

Události jsou emitovány za účelem informování uživatelů a serverů mimo blockchain o událostech. Upozorňujeme, že obsah událostí není dostupný pro kontrakty na blockchainu.

To je podobné události Transfer u ERC-20, s tím rozdílem, že místo částky hlásíme tokenId. Nikdo nevlastní nulovou adresu, takže ji podle konvence používáme k hlášení vytvoření a zničení tokenů.

Schválení (approval) u ERC-721 je podobné povolenému limitu (allowance) u ERC-20. Konkrétní adresa má povoleno převést konkrétní token. 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 proveďte...“.

Jedná se o 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 obdržel konkrétní token, tím, že se podívá na vlastnictví tokenu.

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 pravomoc 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 dělat nic, 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 (opens in a new tab).

# @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í ID tokenů na jejich vlastníky a na ty, kteří mají schváleno je převádět (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 daný 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.

Upozorňujeme, ž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 se nejedná o operátora. Hodnoty můžete podle potřeby nastavit na True.

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

Nové tokeny musí být nějak vytvořeny. V tomto kontraktu je jediná entita, která to má povoleno, a to 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 Mapování ID rozhraní na bool o tom, zda je podporováno či nikoli
supportedInterfaces: HashMap[bytes32, bool]

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

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

ERC-165 (opens in a new tab) specifikuje mechanismus, jakým může kontrakt zveřejnit, jak s ním mohou aplikace komunikovat a kterým standardům ERC vyhovuje. V tomto případě kontrakt vyhovuje standardům ERC-165 a ERC-721.

Funkce

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

Konstruktor

@external
def __init__():

Ve Vyperu, stejně jako v Pythonu, se funkce konstruktoru nazývá __init__.

    """
    @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 (opens in a new tab).

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

Pro přístup ke stavovým proměnným použijete self.<variable name> (opět stejně jako v Pythonu).

Funkce View

Toto jsou funkce, které nemění stav blockchainu, a proto mohou být spuštěny zdarma, pokud jsou volány externě. Pokud jsou funkce view 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(_interfaceID: bytes32) -> bool:

Na rozdíl od Pythonu je Vyper staticky typovaný jazyk (opens in a new tab). Nemůžete deklarovat proměnnou nebo parametr funkce bez identifikace datového typu (opens in a new tab). V tomto případě je vstupním parametrem bytes32, 256bitová hodnota (256 bitů je nativní velikost slova Ethereum Virtual Machine). Výstupem je booleovská hodnota. Podle konvence začínají názvy parametrů funkcí podtržítkem (_).

    """
    @dev Identifikace rozhraní je specifikována v ERC-165.
    @param _interfaceID Id rozhraní
    """
    return self.supportedInterfaces[_interfaceID]

Vrátí hodnotu z HashMapy self.supportedInterfaces, která je nastavena v konstruktoru (__init__).

### VIEW FUNKCE ###

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

Tento řádek ověřuje (assert) (opens in a new tab), že _owner není nula. 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 uživatele _owner v tomto kontraktu. Protože může existovat více operátorů, jedná se o dvouúrovňovou HashMapu.

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 tyto názvy 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 má schváleno tento token utratit
  3. Adresa je operátorem pro vlastníka tokenu

Výše uvedená funkce může být view, protože nemění stav. Pro snížení provozních nákladů by každá funkce, která může být view, měla být view.

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

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 stávají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žijete příkaz log (více podrobností najdete zde (opens in a new tab)).

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, uvízne na této adrese a bude k ničemu.

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 s safeTransferFrom, pokud je převedete na adresu, ke které nikdo nezná soukromý klíč.

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

Zavolejte cílový kontrakt, abyste zjistili, zda může přijímat tokeny ERC-721.

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

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átit.

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 (opens in a new tab) 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 (opens in a new tab).