Le cadre de développement Truffle comprend plusieurs packages Node.js. Avant d’installer truffle, vous devez avoir une installation à jour et fonctionnelle de Node.js et du Node Package Manager (npm).

La méthode recommandée pour installer Node.js et npm consiste à utiliser le gestionnaire de version de nœud (nvm). Une fois que vous avez installé nvm, il gérera toutes les dépendances et mises à jour pour vous. Suivez les instructions trouvées sur http://nvm.sh.

Une fois que nvm est installé sur votre système d’exploitation, l’installation de Node.js est simple. Utilisez le drapeau --lts pour dire à nvm que vous voulez la version la plus récente de "support à long terme" (LTS) de Node.js :

Vérifiez que node et npm sont installés :

Ensuite, créez un fichier caché, .nvmrc, qui contient la version Node.js prise en charge par votre DApp afin que les développeurs n’aient qu’à exécuter "nvm install" à la racine du répertoire du projet et il s’installera automatiquement et passera à l’utilisation de cette version. :

Ça parait bien. Maintenant, installons truffle :

Si vous souhaitez utiliser ou créer une DApp qui s’appuie sur un passe-partout prédéfini, accédez au site Web de Truffle Boxes, choisissez un projet Truffle existant, puis exécutez la commande suivante pour le télécharger et l’extraire :

Pour chaque projet où vous utiliserez truffle, créez un répertoire de projet et initialisez truffle dans ce répertoire. truffle créera la structure de répertoire nécessaire dans le répertoire de votre projet. Il est d’usage de donner au répertoire du projet un nom qui décrit le projet. Pour cet exemple, nous utiliserons truffle pour déployer notre contrat Faucet depuis [simple_contract_example], et donc nous nommerons le dossier du projet Faucet :

Une fois dans le répertoire Faucet, nous initialisons truffle :

truffle crée une structure de répertoires et des fichiers par défaut :

Nous utiliserons également un certain nombre de packages de support JavaScript (Node.js), en plus de truffle lui-même. Nous pouvons les installer avec npm. Nous initialisons la structure de répertoires npm et acceptons les valeurs par défaut suggérées par npm :

Maintenant, nous pouvons installer les dépendances que nous utiliserons pour faciliter le travail avec truffle :

Nous avons maintenant un répertoire node_modules avec plusieurs milliers de fichiers dans notre répertoire Faucet.

Avant de déployer un DApp dans un environnement de production cloud ou d’intégration continue, il est important de spécifier le champ engines afin que votre DApp soit construit avec la bonne version de Node.js et que ses dépendances associées soient installées. Pour plus de détails sur la configuration de ce champ, consultez la documentation.

truffle crée des fichiers de configuration vides, truffle.js et truffle-config.js. Sur les systèmes Windows, le nom truffle.js peut provoquer un conflit lorsque vous essayez d’exécuter la commande truffle et que Windows tente d’exécuter truffle.js à la place. Pour éviter cela, nous allons supprimer truffle.js et utiliser truffle-config.js (en soutien aux utilisateurs de Windows, qui, honnêtement, souffrent déjà assez) :

Maintenant, nous éditons truffle-config.js et remplaçons le contenu par l’exemple de configuration montré ici :

Cette configuration est un bon point de départ. Il configure un réseau Ethereum par défaut (nommé localnode), qui suppose que nous exécutons un client Ethereum tel que Parity, soit en tant que nœud complet, soit en tant que client léger. Cette configuration demandera à truffle de communiquer avec le nœud local via RPC, sur le port 8545. truffle utilisera le réseau Ethereum auquel le nœud local est connecté, comme le réseau principal Ethereum ou un réseau de test comme Ropsten. Le nœud local fournira également la fonctionnalité de portefeuille.

Dans les sections suivantes, nous configurerons des réseaux supplémentaires pour truffle à utiliser, tels que la chaîne de blocs de test locale ganache et Infura, un fournisseur de réseau hébergé. Au fur et à mesure que nous ajouterons des réseaux, le fichier de configuration deviendra plus complexe, mais il nous donnera également plus d’options pour notre flux de travail de test et de développement.

Nous avons maintenant un répertoire de travail de base pour notre projet Faucet, et nous avons truffle et ses dépendances configurées. Les contrats vont dans le sous-répertoire contracts de notre projet. Le répertoire contient déjà un contrat "d’aide", Migrations.sol, qui gère pour nous les mises à jour des contrats. Nous examinerons l’utilisation de Migrations.sol dans la section suivante.

Copions le contrat Faucet.sol (depuis [solidity_faucet_example]) dans le sous-répertoire contracts, de sorte que le répertoire du projet ressemble à ceci :

Nous pouvons maintenant demander à truffle de compiler le contrat pour nous :

Truffle propose un système de déploiement appelé migration. Si vous avez travaillé dans d’autres cadres de développement, vous avez peut-être vu quelque chose de similaire : Ruby on Rails, Python Django et de nombreux autres langages et cadres de développement ont une commande migrate.

Dans tous ces cadres de développement, le but d’une migration est de gérer les modifications du schéma de données entre différentes versions du logiciel. Le but des migrations dans Ethereum est légèrement différent. Parce que les contrats Ethereum sont immuables et coûtent du gaz à déployer, Truffle propose un mécanisme de migration pour garder une trace des contrats (et des versions) qui ont déjà été déployés. Dans un projet complexe avec des dizaines de contrats et des dépendances complexes, vous ne voudriez pas avoir à payer pour redéployer des contrats qui n’ont pas changé. Vous ne voudriez pas non plus suivre manuellement quelles versions de quels contrats ont déjà été déployées. Le mécanisme de migration Truffle fait tout cela en déployant le contrat intelligent Migrations.sol, qui suit ensuite tous les autres déploiements de contrat.

Nous n’avons qu’un seul contrat, Faucet.sol, ce qui signifie que le système de migration est pour le moins exagéré. Malheureusement, nous devons l’utiliser. Mais, en apprenant à l’utiliser pour un contrat, nous pouvons commencer à mettre en pratique de bonnes habitudes pour notre flux de travail de développement. L’effort sera payant au fur et à mesure que les choses se compliqueront.

Le répertoire migrations de Truffle est l’endroit où se trouvent les scripts de migration. À l’heure actuelle, il n’y a qu’un seul script, 1_initial_migration.js, qui déploie le contrat Migrations.sol lui-même :

Nous avons besoin d’un deuxième script de migration, pour déployer Faucet.sol. Appelons-le 2_deploy_contracts.js. C’est très simple, tout comme 1_initial_migration.js, avec seulement quelques petites modifications. En fait, vous pouvez copier le contenu de 1_initial_migration.j et simplement remplacer toutes les instances de Migrations par Faucet :

Le script initialise une variable Faucet, identifiant le code source Solidity Faucet.sol comme l’artefact qui définit Faucet. Ensuite, il appelle la fonction "deploy" pour déployer ce contrat.

Nous sommes prêts. Utilisons truffle migrate pour le déployer. Nous devons spécifier sur quel réseau déployer le contrat, en utilisant l’argument --network . Nous n’avons qu’un seul réseau spécifié dans le fichier de configuration, que nous avons nommé localnode. Assurez-vous que votre client Ethereum local est en cours d’exécution, puis tapez :

Comme nous utilisons un nœud local pour nous connecter au réseau Ethereum et gérer notre portefeuille, nous devons autoriser la transaction créée par truffle. Nous exécutons parity connecté à la chaîne de blocs de test de Ropsten, donc pendant la migration, nous verrons une fenêtre contextuelle comme celle de Parity demandant confirmation pour déployer Faucet sur la console web de Parity.

Il y a quatre transactions au total : une pour déployer Migrations, une pour mettre à jour le compteur de déploiements à 1, une pour déployer Faucet et une pour mettre à jour le compteur de déploiements à 2.

Truffle affichera les migrations terminées, affichera chacune des transactions et affichera les adresses de contrat :

Truffle propose une console JavaScript que nous pouvons utiliser pour interagir avec le réseau Ethereum (via le noeud local), interagir avec les contrats déployés et interagir avec le fournisseur de portefeuille. Dans notre configuration actuelle (localnode), le fournisseur de nœud et de portefeuille est notre client Parity local.

Démarrons la console Truffle et essayons quelques commandes :

Truffle présente une invite indiquant la configuration réseau sélectionnée (localnode).

La console Truffle offre une fonction de saisie semi-automatique qui nous permet d’explorer facilement l’environnement. Si nous appuyons sur Tab après une commande partiellement terminée, Truffle terminera la commande pour nous. Appuyer deux fois sur Tab affichera toutes les complétions possibles si plus d’une commande correspond à notre entrée. En fait, si nous appuyons deux fois sur Tab sur une invite vide, Truffle liste toutes les commandes disponibles :

La grande majorité des fonctions liées au portefeuille et aux nœuds sont fournies par l’objet web3, qui est une instance de la bibliothèque web3.js. L’objet web3 résume l’interface RPC à notre nœud Parity. Vous remarquerez également deux objets aux noms familiers : Migrations et Faucet. Ceux-ci représentent les contrats que nous venons de déployer. Nous utiliserons la console Truffle pour interagir avec un contrat. Tout d’abord, vérifions notre wallet via l’objet web3 :

Notre client Parity a deux portefeuilles, avec un peu d’ether de test sur Ropsten. L’attribut web3.eth.accounts contient une liste de tous les comptes. Nous pouvons vérifier le solde du premier compte en utilisant la fonction getBalance :

web3.js est une grande bibliothèque JavaScript qui offre une interface complète au système Ethereum, via un fournisseur tel qu’un client local. Nous examinerons web3.js plus en détail dans [web3js_tutorial]. Essayons maintenant d’interagir avec nos contrats :

Ensuite, nous utiliserons sendTransaction pour envoyer de l’ether de test afin de financer le contrat Faucet. Notez l’utilisation de web3.utils.toWei pour convertir les unités ether pour nous. Taper 18 zéros sans se tromper est à la fois difficile et dangereux, il est donc toujours préférable d’utiliser un convertisseur d’unités pour les valeurs. Voici comment nous envoyons la transaction :

Si nous passons à l’interface Web de Parity, nous verrons une fenêtre contextuelle nous demandant de confirmer cette transaction. Une fois la transaction extraite, nous pourrons voir le solde de notre contrat Faucet :

Appelons maintenant la fonction withdraw, pour retirer de l’ether de test du contrat :

Encore une fois, nous devrons approuver la transaction dans l’interface Web de Parity. Si nous vérifions à nouveau, nous verrons que le solde du contrat Faucet a diminué et que notre portefeuille de test a reçu 0,1 ether: