Plonger plus profondément dans Cellframe : Python SDK & Plugins pt. 1 | de Mika Hyttinen | Coinmons | mars 2022

Comme Cellframe gagne en popularité auprès des investisseurs et des développeurs (cela le mérite vraiment !), Je voulais écrire quelque chose sur son puissant SDK Python.

Si certains de mes lecteurs ne le savent pas encore, Cellframe est une plateforme blockchain de troisième génération qui vous permet de créer des services/solutions blockchain avec son SDK. Cellframe contient également des fonctionnalités de base intéressantes :

Et bien plus encore.

Cellframe et son SDK Python vous permettent d’écrire des dApps, ou en fait des t-dApps (applications véritablement décentralisées) pour l’écosystème Cellframe. Il vous permet également d’écrire simplement des plugins simples pour le nœud Cellframe.

Pourquoi Python ?

Il y a probablement de nombreuses raisons pour lesquelles Cellframe a choisi Python comme langage par défaut pour son SDK, mais je vais donner ici quelques raisons pour lesquelles je pense personnellement qu’ils ont fait ce choix :

1. Pour faire simple, Python est le langage de programmation le plus populaire au monde.
2. Python est facile à apprendre, facile à utiliser et il a des tonnes de bibliothèques prêtes à l’emploi disponibles à installer avec le programme d’installation du package Python.
3. Et comme Cellframe est écrit en C, l’intégration de Python à un logiciel basé sur C est un choix solide.

Construire un plugin simple avec Cellframe Python SDK

Même si mon expérience n’est pas exactement dans le domaine de la programmation, j’ai quand même décidé de faire un exemple d’utilisation de Cellframe Python SDK car j’ai encore de l’expérience sur des langages comme Bash, PHP, C++, Javascript (et HTML 😆).

Tout d’abord, vous devez avoir installé Cellframe Python SDK. Le moyen le plus simple de faire avancer les choses est probablement d’installer simplement le nœud Cellframe. Si vous avez Raspberry Pi 3/4, vous pouvez utiliser mon tutoriel Raspberry Pi pour l’installation de votre nœud. Dans ce didacticiel particulier, j’ai également expliqué comment créer correctement un nœud Cellframe pour charger des plugins, car vous devez modifier le fichier de configuration avant de charger les plugins.

Si vous utilisez Windows, vous pouvez installer Cellframe Dashboard car il intègre le nœud Cellframe. Le chemin du fichier de configuration dans Windows est %SystemDrive%\Users\Public\Documents\cellframe-node\etc

Comprendre la structure des fichiers et dossiers du plugin

Si vous avez lu mon tutoriel précédent, le chemin par défaut pour les plugins est /opt/cellframe-node/var/lib/plugins. Par défaut, ce répertoire particulier est absent de ce chemin, alors n’hésitez pas à créer le répertoire plugins par toi-même.

Lorsque vous avez créé le répertoire des plugins, il est temps de créer un autre répertoire à l’intérieur des plugins. Dans cet exemple, nous utilisons tutorial .

Maintenant à l’intérieur tutorial, vous devez avoir deux fichiers. Un fichier est le plugin lui-même (dans cet exemple, nous utiliserons tutorial.py ) et le deuxième fichier est manifest.json . Voici le répertoire et la structure de fichiers actuels après avoir créé tous les fichiers nécessaires :

├── plugins
│   └── tutorial
│       ├── manifest.json
│       └── tutorial.py

Maintenant, en utilisant manifest.json, vous spécifiez des métadonnées de base sur votre plugin telles que le nom, la version et la description. Vous pouvez également déclarer si ce plugin actuel a des dépendances d’autres plugins. Typique manifest.json ressemble à ceci :

le name, version, author et description les clés doivent avoir une valeur de chaîne. le name La valeur doit correspondre au nom du plugin et au nom du répertoire. le version et author valeurs spécifie la version du plugin et l’auteur du plugin. le dependencys La clé ² doit avoir une valeur de tableau contenant des chaînes avec des noms de plug-ins. Si les plugins spécifiés ne sont pas installés, alors ce plugin ne sera pas lancé. le description valeur spécifie une courte description du plugin.¹
¹ Source : https://wiki.cellframe.net/en/python/plugins
² Remarque : les dépendances sont mal orthographiées. Il devrait être corrigé dans les versions ultérieures.

le tutorial.py (ou quel que soit le nom que vous lui donnerez) est le plug-in qui s’exécute lorsque vous démarrez le nœud Cellframe. Un squelette pour le plugin de nœud Cellframe pourrait ressembler à ceci :

Lors du démarrage du service de nœud, le init les fonctions du script python de chaque plugin seront appelées. Lors de l’arrêt du service de nœud, le deinit les fonctions seront appelées.

Créons un plugin simple !

Commençons cette série d’articles par un simple « Hello World! » tutoriel de plug-in.

Cellframe Python SDK vous permet d’ajouter vos propres commandes, que vous pouvez exécuter avec le cellframe-node-cli outil.

Nous devons d’abord étudier comment tout cela fonctionne et regarder leur Wiki pour AppCliServer.cmdItemCreate() et AppCliServer.setReplyText() méthodes

La méthode cmdItemCreate() prend 4 arguments :

name: Name of the command
callbackFunction: Runs a function when command is called
doc: Short description of the command
docEx: Long description of the command

La méthode setReplyText() prend 2 arguments :

replyText: String that is returned when command is called
idStrReply: must be a parameter idStrReply passed to the callback function.

Ainsi, après avoir ajouté ceci à notre plugin, cela devrait ressembler à ceci :

Comme le deuxième argument est la fonction de gestionnaire, nous devons ajouter une fonction à notre plugin qui est appelée lorsque vous exécutez helloworld -command :

Donc après avoir ajouté cela, le plugin ressemble à ceci :

Après cela, le plugin est terminé !

Si vous n’avez pas encore placé le plugin dans votre dossier de plugins, vous pouvez le faire maintenant. Après cela, redémarrez simplement votre nœud et lancez votre terminal/Powershell etc. et tapez cellframe-node-cli help vous devriez alors pouvoir voir notre commande helloworld dans la liste des commandes :

Donc, pour utiliser cette commande, tapez simplement cellframe-node-cli helloworld et:

Alors voilà. Premier plugin simple pour votre noeud Cellframe !

Et après?

Dans le prochain article, nous reviendrons sur notre série d’installation de nœuds, cette fois nous couvrirons Windows (différents types d’installations, recommandations, etc.).

Quand je reviendrai sur le SDK, nous construirons quelque chose de plus avancé et sérieux 😉.

Des questions? Des recommandations ?

Si vous voulez construire quelque chose sur Cellframe, rejoignez leur chaîne Telegram de développement !

Vous pouvez aussi me contacter sur Twitter ou avec Telegram.
Les sources de ce tutoriel sont également disponibles sur mon github.

Merci pour la lecture!

Rejoignez Coinmonks Telegram Channel et Youtube Channel pour en savoir plus sur le trading et l’investissement cryptographiques