Thread by @0xNekr

[#CALENDRIER DE L'AVENT 12/25]

25 jours pour apprendre à développer des Smart Contracts en #Solidity 🔥

Jour 12 / 25 :

Création #ERC721 : Mise en place de la whitelist ! C'est l'une des plus grosses journées de notre calendrier 💪

🧵

Tweet précédent

🔽

https://twitter.com/0xNekr/status/1602000331897860096

Aujourd'hui nous attaquons une des parties les plus complexes de notre contrat... la gestion de la whitelist !

Nous allons utiliser un des composants de base de la blockchain (et indispensable) de la blockchain, les arbres de Merkle !

Nous allons voir pourquoi !

Petit rappel de ce qu'est une whitelist pour notre projet :

C'est une liste qui permet de définir si une personne a le droit de mint pendant une certaine phase.

Dans notre cas, la whitelist permet de mint avant la phase ouverte au public et à un prix avantageux !

Mais alors, ne suffirait-il pas d'utiliser un "mapping" qui lie une adresse à un booléen afin de déclarer qu'une adresse est sur la whitelist ?

Avec une fonction accessible au propriétaire pour gérer qui est whitelist ou non, comme ceci ?

🔽

Et si vous avez répondu oui, vous avez raison !

C'est en effet une très bonne solution pour identifier des adresses ayant le droit de mint en avance !

Sauf si vous avez 500/1000 adresses à renseigner, ça serait très long et surtout très très cher...

Même si notre projet ne comporte que 20 NFTs, nous allons quand même utiliser une solution plus robuste et moins cher :

Celle de l'arbre de Merkle.

Mais qu'est-ce que c'est ?

🔽

C'est un sujet très technique.

Vous pouvez mettre en place cette solution sans connaitre tous ses recoins, mais il faut comprendre le principe de base.

Heureusement, @0xKaelSensei a fait un super thread sur ce sujet, vous devez le lire avant la suite !

Et vous abonnez à lui !

https://twitter.com/0xKaelSensei/status/1595587550646702080

Comme d'habitude, si vous avez manqué le jour d'hier ou que vous souhaitez repartir au propre, vous pouvez repartir du code présent dans le répertoire "Jour12/NekrIsERC721_Jour12.sol"

Vous pouvez stocker vos adresses comme vous le souhaitez pour la whitelist, le but est juste de pouvoir itérer dessus grâce à un script Java.

Personnellement, j'utilise du ".json" et j'ai mis un template à disposition dans le dossier "assets/whitelist.json".

À partir de cette liste, nous allons devoir générer :

- La racine de Merkle qui sera stocké sur le contrat.
- La preuve de Merkle que nous devrons passer en argument de la fonction de mint.

Dans un premier temps, nous allons apprendre à générer la racine de Merkle

🔽

Le script pour générer la racine de Merkle est disponible dans le répertoire "scripts/GenerateMerkle.ts".

Le script parcourt les adresses pour les ajouter dans un tableau, puis grâce à "MerkleTreeJs" & "keccak256" il va générer les feuilles de l'arbre de Merkle et sa racine.

C'est cette racine que nous passerons dans l'argument "_merkleRoot" dans le constructeur créé hier !

Très important à savoir, il faut régénérer une racine de Merkle à chaque ajout/retrait d'adresse dans la liste, car la racine changera du tout au tout !

Il faut rajouter deux lignes à notre script pour récupérer la preuve de Merkle pour une adresse.

Pour se faire, il faut repartir de l'arbre et passer une adresse pour générer la preuve 🔽

C'est l'exercice que devra faire la dApp pour permettre aux utilisateurs de mint !

Voici le résultat lorsque je lance le script via la commande :

"node .scripts/GenerateMerkle.ts"

Nous récupérons la racine de Merkle qui sera stocké sur le contrat dans la variable "merkleRoot".

Nous récupérons aussi la preuve qui devra être passé à la fonction de mint !

Important :

Votre application qui permet à vos utilisateurs de mint doit avoir la même liste que celle qui a permis de générer la racine de Merkle sur le contrat !

Si ce n'est pas le cas, les preuves qu'elle va générer ne seront pas bonnes !

Pour information, voici ce qu'est la "preuve" si l'adresse n'est pas sur la liste : un tableau vide !

Nous avons vu ce qui était à faire off-chain pour la whitelist, c'est dense, si vous n'avez pas tout compris, pas de panique !

Lisez les scripts, ça va venir vite en utilisant!

Revenons sur Solidity, nous allons pouvoir implémenter tout ce qui est en rapport avec la whitelist sur notre contrat.

On commence avec une fonction simple, comme celles pour modifier les prix que nous avons fait hier.

Celle-ci permet de mettre à jour notre racine de Merkle !

Nous allons devoir implémenter trois fonctions afin de vérifier si une adresse est whitelist grâce à une preuve de Merkle.

Nous pourrions tout faire dans une seule fonction, mais il est plus simple de comprendre le fonctionnement en découpant la logique en trois parties.

La première fonction à implémenter est la fonction "_leaf()".

C'est une fonction "internal" donc interne au contrat.

Elle est de type "pure" car elle ne manipule pas de donnée inscrite sur la blockchain.

Elle renvoie le hash de l'adresse passé en paramètre au format "bytes32".

La fonction "_verify" est aussi une vue "internal".

Elle prend en paramètre la feuille précédemment créée et une preuve.

Elle se sert de la librairie "MerkleProof" d'OpenZeppelin afin de vérifier la preuve et renvoie "true" ou "false" si l'utilisateur est whitelist ou non.

On fini par mettre en place une vue "public" qui :

- Appelle la fonction "_leaf()" avec une adresse spécifique
- Appelle la fonction "_verify()" avec le retour de "_leaf()"
- Retourne le résultat de "_verify()" : "true" ou "false"

Et nous saurons si l'utilisateur est whitelist!

Et c'est fini pour les fonctions en rapport avec la whitelist dans notre contrat.

Lorsque nous souhaitons savoir si un utilisateur est whitelist, il nous suffira d'appeler la fonction "isWhitelisted()" avec l'adresse de la personne et la preuve envoyé à la fonction.

Pour rappel, cette preuve sera généré par l'application qui possède la liste exacte !

Côté frais de gas, il nous suffit de stocker une variable "merkleRoot" pour gérer toute la whitelist, nous n'avons pas à stocker x adresses, ce qui serait bien trop couteux !

C'était une des journées les plus denses du calendrier !

Si vous avez des questions, les commentaires sont là pour échanger.

Il existe aussi beaucoup de vidéos sur internet pour expliquer plus en profondeur le principe d'arbre de Merkle si vous avez soif de savoir !

On se retrouve dès demain pour parler métadonnées !

Si l'initiative vous plait, vous pouvez me soutenir avec un j'aime et un retweet sur le tweet principal.

N'hésitez pas à vous abonner pour ne pas rater les prochains jours ! 🔥