Sismondi NFT demo

Ce répertoire contient la démo pour la semaine des étudiants du gymnase Sismondi. Pendant cette semaine, les étudiants vont passer une journée à l'EPFL pour apprendre plus sur les blockchains et les NFTs.

• Transparents de la journée: Blockchains et NFTs
• Exercices pour la journée: Exercices pour journée NFTs
• Comptes Ethereum et contrats NFTs: Comptes et Contrats

Installation

Le code original a été préparé pour être utilisé dans des machines virtuelles Linux. Pour une utilisation plus simple, le code a été re-écrit pour être utilisé avec Docker. Si vous voulez suivre les exercices proposés ici, il vous faudra donc installer Docker:

Installation Docker

Pour éditer le code vous pouvez utiliser n'importe quel editeur de code. Je vous suggère d'utiliser Visual Studio Code:

Installation Visual Studio Code

Il faut installer les extensions suivantes:

• Solidity pour le smart contract
• Python pour changer la création du smart contrat

II - Mise en place

Dans cette partie on va commencer par installer un portefeuille pour vos jetons.

II.3 - Créer un portefeuille (wallet)

On verra que les jetons sur la blockchain sont protégés par une "clé privée". Cette clé privée est stockée dans un portefeuille, ou "Wallet" en Anglais. Ces clés privées sont comme un mot de passe, mais beaucoup plus long, et avec des propriétés mathématiques intéressantes pour les blockchains. Si quelqu'un réussi à copier vos clés privées, cette personne a le même accès que vous à votre portefeuille. Donc ne donnez votre clé privée à personne! Le portefeuille Metamask demande un mot de passe qui protègera vos clés privées. Pour sécuriser d'avantage, il est conseillé d'utiliser la "recovery phrase" et de la stocker quelque part.

On utilisera ici le portefeuille le plus connu: Metamask.

ATTENTION! SCAMS! VOLS!

Il faut être très prudent dans le monde des blockchains sur les scams (tricheries) et vols. Vu que la clé privée est la seule chose qui protège vos jetons, du moment que quelqu'un la possède, cette personne peut faire ce qu'elle veut avec vos jetons. Donc, il est impératif de:

• ne jamais partager sa clé privée
• ne pas installer des logiciels d'une source douteuse

II.3.1 - Installer Metamask

Aller sur le site de Metamask et suivre les instructions d'installation:

Installer Metamask

1. On va faire confiance à Firefox pour stocker le mot de passe
2. Sécurisez l'installation
3. Copiez TOUS LES 12 mots de récupération dans un éditeur de texte
4. Pour confirmer, remplissez les espaces vides - ceci est pour vérifier que vous avez bien noté votre phrase de récupération
5. Suivez les instructions pour pin Metamask
6. Choisissez le réseau "Sepolia": cliquez en haut à gauche dans Ethereum Mainnet, puis cochez Show test networks, ensuite choisissez "Sepolia".

II.3.2 - Charger votre portefeuille avec quelques jetons depuis un "robinet"

CETTE éTAPE N'EST PAS NéCESSAIRE POUR LA JOURNéE NFTs DU 8 JANVIER 2025!

Pour la prochaine étape, vous avez besoin de quelques jetons. Les réseaux blockchains de test vous permettent de recevoir des jetons gratuits. Bien sûr que vous ne pouvez pas revendre ces jetons, ils ne valent rien.

Afin de recevoir quelques jetons, vous pouvez copier votre adresse depuis Metamask dans le robinet suivant:

Faucet

L'adresse PUBLIQUE commence avec un 0x et contient des chiffres et des lettres a-f.

Une fois le robinet ouvert, on va continuer la présentation. Assurez-vous que le "minage" continue en arrière-plan, parce qu'il vous faudra 1 SepoliaETH pour le reste de la journée.

Assurez-vous que vous avez au moins 1 SepoliaETH jusqu'à maintenant. Puis continuez sur l'étape suivante.

II.3.3 - Empocher la récompense

Quand le montant est atteint, cliquez sur Stop Mining, puis Claim Rewards et attendez que vos jetons se trouvent sur votre compte.

Si vous avez réussi à recevoir une récompense, vous pouvez sauter l'étape II.5.

II.5 - Recevoir 2 SepoliaETH

Vu qu'un transfert sur la blockchain ne peut pas être annulé, on va faire le transfert dans deux étapes:

1. Commencer par un petit montant
2. Si on est sûr de l'adresse, transférer le reste

Commencez par remplir le "Google Spreadsheet" que vous trouvez dans le canal Discord #ii-setup. Ajoutez votre adresse publique que vous trouvez dans Metamask. Puis Linus va vous envoyer 0.1 SepoliaETH. Pour prouver que l'adresse a été juste, renvoyez 0.05 SepoliaETH à l'adresse suivante: 0x30880e9B16e55922EA76e77e45D93BDb9CE48F01. Dans "Metamask", chosissez votre compte, cliquez Send, entrez l'adresse qui commence par 0x3088, indiquez le montant (0.05), puis confirmez la transaction. Une fois que Linus a reçu votre retour, il va vous envoyer le reste des jetons nécessaire pour le reste de la journée.

III - Utilisation de ce répertoire

III.1 - Visualiser le transfert

Maintenant, on va utiliser Etherscan pour voir ce qui s'est passé. Entrez votre adresse publique sur le site suivant, afin de suivre les transactions sur votre compte et depuis votre compte:

Etherscan

Si vous ne voyez pas votre transaction, assurez-vous que vous êtes connecté au réseau "Sepolia".

III.1.1 - Transférer des jetons

Si vous avez le temps, vous pouvez transférer quelques jetons à vos voisins. Ne mettez pas trop de jetons, quelque chose comme 0.01 est très bien.

1. Demandez à vos voisins leur adresse privée de leur portefeuille

• Assurez-vous qu'ils ne vous la donnent pas! Sinon, vous pouvez créer un nouveau portefeuille et transférer tous leurs jetons chez vous!

2. Demandez à vos voisins leur adresse publique de leur portefeuille. Vous pouvez utiliser "Discord"
3. Ouvrez "Metamask" dans Firefox
4. Cliquez sur "Send"
5. Entrez l'adresse que vous avez reçu de vos voisins
6. Entrez 0.001 SepETH et confirmez

III.1.2 - Visualiser le transfert

Utilisez de nouveau Etherscan pour visualiser votre compte. Cherchez quel lien il faut cliquer pour voir le compte de vos voisins.

III.2 - Préparer la configuration de Brownie

Brownie est un outil de développement et de teste pour écrire des smart contracts pour Ethereum. Brownie réunit tous les outils nécessaires pour intéragir avec Ethereum:

• un compilateur pour traduire un smart contract dans un format convenable pour Ethereum
• une blockchain de test locale pour faire les premiers pas
• les outils nécessaires pour envoyer et intéragir avec un smart contract

Ici, on va configurer cet outil avec la clé privée et un accès supplémentaire nécessaire pour le bon fonctionnement.

III.2.1 - Télécharger le répertoire

Pour commencer, il faut télécharger le répertoire github sur votre ordinateur. Suivez ces étapes:

1. Ouvrez un terminal de commande sur votre ordinateur a. Pour Linux et MacOS, c'est simple. Pour Windows, il faut s'assurer que c'est un terminal du WSL: https://learn.microsoft.com/en-us/windows/wsl/install
2. Copiez la commande suivante dans votre terminal - attention, tous les caractères doivent être copiés/collés tel quel! Vous pouvez faire un copier/coller depuis Firefox:

git clone https://github.com/c4dt/sismondi_nft_2025

Une fois que c'est téléchargé, vous pouvez changer dans ce répertoire avec la commande suivante:

cd sismondi_nft_2025
ls

Ceci devrait vous montrer les fichiers dans le répertoire. Garder le terminal ouvert, on en aura encore besoin!

III.2.2 - Regénérer les images

Lancer brownie prend un peu de temps la première fois. Commencez à recréer les images - cette commande va prendre quelques minutes la première fois que vous la lancez. Par la suite ça devrait se faire en quelques secondes.

./mk_contract.sh

Vous pouvez vérifiez les images générées dans le répertoire images/results.

III.2.3 - Ouvrir avec Visual Studio Code

CETTE éTAPE EST SEULEMENT SI VOUS REFAITES LES EXERCICES EN DEHORS DE LA JOURNéE DU 8 JANVIER 2025!

Ouvrez maintenant le fichier NOTES.md dans Visual Studio Code (VSCode) et commencez à le remplir:

1. Copiez la phrase de récupération depuis votre éditeur de texte dans ce fichier
2. Recopiez votre adresse PUBLIQUE depuis Metamask dans le fichier NOTES.md
3. Faites de même pour la clé privée. Elle est protégée par Metamask:

• Cliquez sur les trois petits points à droite du nom de votre compte
• Choisissez "Account details", puis "Show private key"
• Confirmez avec votre mot de passe
• Appuyez longuement sur le bouton
• Copiez/collez la clé privée depuis la fenêtre dans le fichier NOTES.md

III.3 - Installer vos propres images

Vous pouvez installer vos propres images en les copiant dans les répertoires suivants:

• images/background pour les arrière-plans
• images/shoe pour les chaussures
• images/sole pour les semelles

Assurez-vous que les images des chaussures et des semelles sont transparentes, afin de pouvoir les superposer les unes sur les autres. Les images doivent aussi être de la même taille!

Quand tout est fait, vous pouvez éditer le fichier scripts/images.py et changer les noms des fichiers tout en bas. Pour ouvrir le fichier, je vous propose d'utiliser Visual Studio Code. Mais vous pouvez aussi utiliser Thonny.

Une fois que le fichier est adapté, lancez la commande suivante:

./mk_contract.sh

Cette commande devrait s'exécuter sans erreur et produire 6 images dans le répertoire images/results. Assurez-vous que ces six images sont bonnes et représentent les différentes combinaisons de vos images.

IV - Utilisation du réseau de test Sepolia

Dans cette étape nous allons configurer ce répertoire afin d'utiliser le réseau de test Sepolia.

IV.1 - Configurer le réseau de test

Dans une première étape nous allons faire la configuration du réseau de test en ajoutant votre clé privée dans un fichier de configuration.

IV.1.1 - Créer le fichier .env

Afin de pouvoir envoyer des commandes à la chaîne de teste "Sepolia", il faut configurer le fichier .env. Le plus simple est de copier le fichier env.example dans le fichier .env.

1. Ouvrez Visual Studio Code ou Thonny

• avec Visual Studio Code vous pouvez directement ouvrir le répertoire
• avec Thonny vous devez choisir all files en bas à droite

2. Ouvrez le fichier env.example
3. Fichier -> Enregistrer sous
4. Changer le nom en .env
5. Enregistrez avec OK
6. Confirmer que vous voulez faire un fichier caché
7. Vérifiez dans le terminal que le fichier s'affiche en lançant la commande suivante:

cat .env

IV.1.2 - Copier la clé privée

Maintenant, vous pouvez copier la clé privée dans votre fichier .env. Vous la trouvez dans votre fichier NOTES.md. Copiez/collez la clé privée dans le fichier .env

IV.1.3 - Vérifier le .env

Faites le test suivant pour voir si tout a bien fonctionné. Lancez la commande suivante:

./brownie.sh run test_env.py

Ceci coûte à peu près 0.007 SepoliaETH. Le test devrait prendre autour de 30 seconds et il va vous côuter quelques jetons. Vous pouvez vérifier que la transaction a été bien reçue par la blockchain en copiant le numéro de transaction ou le numéro du contrat dans l'explorateur Ethereum:

https://sepolia.etherscan.io

IV.2 - Installer le contrat NFT sur le réseau Sepolia

Dans cette étape on va installer le contrat qui gère les NFTs sur le réseau Sepolia. Vu que cette étape va utiliser les jetons que vous avez reçu, vous devez être prudent·e·s, afin de ne pas gâcher ces jetons.

IV.2.1 - Configurer le contrat Sismondi_NFT avec vos images

Dans l'étape III.3 on a configuré votre contrat pour les NFTs. Vous trouvez le contrat dans le répertoire ici:

contracts/SismondiNFT.sol

Si vous modifiez ce contrat, faites attention au fait que chaque lancement de ./mk_images.sh va écraser le contrat!

En plus des images, vous pouvez changer les mots qui seront associés aux différents NFTs qui sont créés par ce contrat. Vous trouvez la liste dans wordList. Soyez prudent·e·s en changeant la liste que vous respectez la syntaxe du script!

IV.2.2 - Tester le contrat localement

Avant d'installer le contrat sur la blockchain Sepolia, on va d'abord le tester localement. Ceci peut assurer que vous n'avez pas fait d'erreur dans le copier/coller des images dans le contrat. Lancez la commande suivante:

./brownie.sh run sismondi.py deploy_mint --network development

Si tout va bien, vous devriez voir un total de 3 blocs:

• block 0: installation du contrat
• block 1: mint d'un premier NFT
• block 2: mint d'un deuxième NFT

Il se peut qu'il y a une erreur qui se termine avec

Terminating local RPC client

Ce n'est pas grave, si ou moins, il y a trois blocs qui s'affichent.

IV.2.3 - Installer le contrat sur le réseau de test Sepolia

Maintenant que vous avez mis à jour le contrat SismondiNFT.sol, et que vous avez créé le fichier .env, vous êtes prêt·e·s! Pour installer votre contrat SismondiNFT.sol sur la chaîne, vous pouvez lancer la commande suivante:

# ATTENTION: SEULEMENT DEPLOY, PAS DEPLOY_MINT!
./brownie.sh run sismondi.py deploy

Si tout se passe bien, vous devrez voir un commentaire qui se termine avec quelque chose comme ceci:

Running 'scripts/sismondi.py::deploy'...
Transaction sent: 0x84096187a70ccfbdbb16546bbc250e72db949af3e726a5d0156222b7f7dc6f6d
  Gas price: 0.0 gwei   Gas limit: 12000000   Nonce: 0
  SismondiNFT.constructor confirmed   Block: 1   Gas used: 2816575 (23.47%)
  SismondiNFT deployed at: 0x3194cBDC3dbcd3E11a07892e7bA5c3394048Cc87

contract has been deployed successfully to : 0x3194cBDC3dbcd3E11a07892e7bA5c3394048Cc87
Terminating local RPC client...

Ce qui est le plus important, c'est le dernier long numéro, dans notre cas le 0x3194cBDC3dbcd3E11a07892e7bA5c3394048Cc87. C'est l'adresse de votre contrat sur la blockchain. Copiez cette adresse dans le fichier NOTES_NFTs.

Vous trouvez tous les messages d'exécution dans le fichier operations.log. Donc si vous avez oublié l'adresse de votre contrat, vous pouvez y jeter un coup d'œil.

IV.2.4 - Vérifier l'installation du contrat

Avec l'aide de l'outil Etherscan, vous pouvez maintenant vérifier que votre contrat est bel et bien installé sur la chaîne. Entrez l'adresse du contrat que vous avez reçu en IV.2.3, et regardez ce que Etherscan sait de votre contrat. On verra qu'une fois que vous faites un "mint" sur ce contrat, Etherscan va ajouter plus d'information.

IV.4 - Utilisation du contrat

Maintenant que votre contrat est installé, on va l'utiliser pour créer votre premier NFT! On appelle cette procédure en Anglais to mint, et ici vous trouvez la version francisé minter.

IV.4.1 - Minter un NFT

Maintenant, vous êtes prêt·e·s pour faire un mint de votre premier NFT! Parce que le contrat lui-même n'a encore rien minté, il n'y a pas encore de NFT stocké dans le contrat!

Lancez la commande:

./brownie.sh run sismondi.py mint 0xADRESSE_CONTRAT

Vous devez remplacer 0xADRESSE_CONTRAT par l'adresse que vous avez trouvé dans l'étape Création d'un contrat NFT. Si tout va bien, vous devez voir quelque chose comme ça:

Transaction sent: 0xb267bdc54994fe92746c21ca45853ae0d0f6d5d36461f92040462fae3558c407
  Gas price: 0.0 gwei   Gas limit: 12000000   Nonce: 1
  SismondiNFT.makeSismondiNFT confirmed   Block: 2   Gas used: 1493155 (12.44%)

A new NFT with id 0 has been successfully created in block 2 with transaction 0xb267bdc54994fe92746c21ca45853ae0d0f6d5d36461f92040462fae3558c407

Les numéros sont sûrement différents des vôtres. Ce qu'il faut noter ici, c'est le id 0, qui signifie que c'est le premier NFT créé par ce contrat.

IV.4.2 - Vérifier sur Etherscan

Allez regarder de nouveau sur Etherscan l'adresse de votre smart contract et vérifiez qu'il y a bien une deuxième transaction. Vous pouvez aussi cliquer sur le Token Tracker pour voir combien de NFTs ont été émis.

IV.4.3 - Visualiser dans OpenSea

La visualisation avec le site OpenSea est possible même sans inscription. Allez sur le site ici:

OpenSea

Et entrez l'adresse publique de votre compte Metamask. Si vous avez déjà minté un NFT, il devrait s'afficher ici.

V - Utilisation des NFTs

V.1 - Suivre les comptes d'autres groupes

Visualisez un des comptes publiques d'un autre groupe dans OpenSea et regardez leurs NFTs. Vous pouvez aussi aller sur Etherscan et voir combien la création du contrat et le mintage a coûté. Pourquoi ce n'est pas le même montant que chez vous?

V.2 - Minter un NFT d'un autre groupe

Prenez l'adresse d'un contrat d'un autre groupe, afin de faire du mint sur leur contrat à eux. Vous pouvez utiliser "Discord" pour échanger les adresses. Quand ils vous donnent leur adresse, il faut d'abord vérifier que c'est bien un contrat de mintage, à l'aide de Etherscan. Dans la partie More Info, il faudrait une mention de Token Tracker. Si ce n'est pas le cas, ça peut être à cause de:

• une erreur dans la transmission de l'adresse
• que l'autre groupe n'a pas encore fait un premier mint

V.3 - Ajouter au portefeuille Metamask

Afin de transmettre le NFT, on peut utiliser Metamask:

1. Dans votre page de Metamask, cliquez sur NFTs, puis sur Import NFT
2. Ajoutez l'adresse de votre contrat, ainsi que le id de votre NFT

Vous ne pouvez pas ajouter un NFT que vous n'avez pas minté!

V.3.1 - Envoyer vers d'autres utilisateurs

Pour envoyer votre NFT vers un autre utilisateur, vous devez d'abord ajouter le NFT comme dans la section précédente. Maintenant, vous pouvez cliquer sur le NFT, et choisir Send. On vous demande l'adresse du destinataire.

ATTENTION: une fois envoyé, il n'est pas possible de récupérer le NFT! Donc si vous envoyez à une mauvaise adresse, le NFT est perdu!

Questions et retour

Si vous avez des questions ou des retours, n'hésitez pas d'entrer en contact avec nous:

[email protected]

Documentation

• Transparents de la journée: Blockchains et NFTs
• Exercices pour la journée: Exercices pour journée NFTs
• Comptes Ethereum et contrats NFTs: Comptes et Contrats
• Howto qui a été utilisé pour préparer la journée: Deploy Your First NFT With Python - Github with contract
• Contract utilisé pour le NFT: openzeppelin-contracts Definition of ERC 721
• Réseaux de test Ethereum: https://ethereum.org/en/developers/docs/networks/