NOUVEAU : Solana Privacy Rings est désormais disponible sur le réseau principal
comment utiliser les webhooks Solana pour envoyer des notifications par e-mail
Blog/Développement

Solana Dev 101 - Notifications par e-mail pour les dApps

Ingénieur intégrationTidelaw sur X
6 min de lecture

Pourquoi créer ce système ?

Nous allons créer ce backend Vercel et ce Replit, conçus pour recevoir les données des transactions on-chain de Solana depuis les webhooks de Helius et utiliser node-mailer afin d’envoyer des e-mails contenant des informations sur ces transactions. Les utilisateurs pourront ainsi être informés en temps réel des transactions importantes, par exemple lorsqu’ils reçoivent un paiement ou qu’un nouveau NFT est créé.

Voici quelques avantages concrets de ce système :

Notifications en temps réel

Les utilisateurs seront informés des transactions importantes dès qu’elles auront lieu. Cela les aidera à suivre leurs finances et à participer davantage à l’écosystème Solana.

Sécurité renforcée

Les utilisateurs pourront recevoir des notifications concernant les transactions suspectes, comme les tentatives de retrait de fonds depuis leur compte. Ils pourront ainsi mieux suivre leurs actifs.

Expérience utilisateur améliorée

Les utilisateurs profiteront d’une expérience plus fluide avec les applications basées sur Solana. Ils pourront recevoir des notifications concernant les événements importants sans devoir consulter manuellement leurs comptes.

Nous pensons que ce système sera un outil précieux pour les utilisateurs de Solana. Nous avons hâte de découvrir comment il contribuera à améliorer l’écosystème Solana.

GitHub - Tidelaw/webhook-sms-email : utilise les webhooks de Helius pour envoyer des notifications par SMS.

Si vous suivez le guide ci-dessous, n’hésitez pas à demander de l’aide sur le Discord de Helius ou à consulter le dépôt open source.

Version Replit

Replit est un environnement de développement intégré (IDE) dans le cloud qui vous permet d’écrire et d’exécuter du code, puis de le partager avec d’autres personnes en temps réel. C’est un excellent outil pour les développeurs débutants comme expérimentés.

Pour créer un Replit, rendez-vous simplement sur le site de Replit et cliquez sur le bouton « Create a Repl ». Vous pourrez ensuite choisir un langage de programmation (javascript) et un modèle pour votre Repl. Une fois votre Repl créé, vous pourrez immédiatement commencer à coder.

Replit utilise des fichiers .env pour stocker les variables d’environnement. Celles-ci servent à conserver des informations sensibles, comme les clés API et les mots de passe. Elles ne sont pas stockées en texte brut dans votre Replit, ce qui renforce leur sécurité.

Dépendances Replit

Les dépendances suivantes sont nécessaires pour exécuter notre script :

  • nodemailer : cette dépendance sert à envoyer des e-mails.
  • express : cette dépendance sert à créer un serveur web.
  • body-parser : cette dépendance sert à analyser le corps des requêtes HTTP.

Pour installer les dépendances, saisissez simplement :

Code
npm install nodemailer express body-parser

‍Nous pouvons maintenant démarrer notre serveur express afin de recevoir les données des webhooks :

Code
const nodemailer = require('nodemailer');
const express = require('express'),
  app = express(),
  bodyParser = require('body-parser');

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));
  1. La première ligne de code importe le package nodemailer, ce qui nous permet d’envoyer des e-mails.
  2. La deuxième ligne de code crée un serveur web Express sur lequel nous recevrons les données du webhook de Helius.
  3. La troisième ligne de code importe le module body-parser, qui facilite considérablement l’analyse des données de notre webhook.
  4. Les quatrième et cinquième lignes de code configurent le serveur web afin qu’il analyse les requêtes JSON à l’aide de notre dépendance body-parser.

‍Nous devons maintenant configurer notre API Gmail et enregistrer ces variables d’environnement dans Replit.

Clés API Gmail

Commencez par suivre ce guide afin d’obtenir un mot de passe d’application pour Gmail. Vous devrez également configurer la validation en deux étapes. C’est tout ce dont nous avons besoin pour commencer à envoyer des e-mails avec node-mailer.

Configuration des variables d’environnement Replit

Pour accéder au menu des variables .env de Replit, repérez-le en bas à gauche de votre client Replit.

‍Il s’affichera alors en bas à droite, à l’emplacement de votre terminal.

‍Saisissez simplement le nom de la variable, par exemple email_password, à la place de SECRET_KEY, puis entrez vos valeurs. receiver_email et sender_email correspondent aux deux adresses utilisées pour recevoir et envoyer l’e-mail. Dans notre cas, email_password sera le mot de passe de l’adresse utilisée pour l’envoi.

Nous pouvons maintenant commencer à recevoir les données de notre webhook :

Code
app.post("/webhooks", async (req, res) => {

  const { body } = req;
	console.log(body)
  res.status(200).json("Success!");
  
};

app.listen(3000);

‍Le serveur web est configuré pour traiter les requêtes HTTP POST envoyées à la route /webhooks. Lorsqu’il reçoit une requête POST sur la route /webhooks, il extrait le corps de la requête et l’affiche dans la console afin que vous puissiez effectuer vos tests. Le serveur web répond ensuite à la requête avec un code d’état 200 OK pour indiquer à Helius qu’elle a bien été reçue et éviter l’envoi répété des mêmes messages.

Configuration et test du webhook

Pour commencer les tests, cliquez simplement sur le bouton Run. Un site web devrait s’afficher à droite.

‍Ne vous inquiétez pas de l’erreur : notre serveur accepte uniquement les requêtes POST. Nous devons donc utiliser Helius pour effectuer le test. Nous pouvons maintenant accéder à Helius et configurer un webhook.‍

‍Nous écouterons les transactions du Mainnet de type « Enhanced ». Elles contiennent la propriété description que nous enverrons par e-mail. Collez le lien du serveur Replit généré précédemment, dans ce cas https://helius-webhook-sms-email.tidelaw.repl.co/webhooks, ainsi que le portefeuille que vous souhaitez écouter. Veillez à inclure /webhooks dans l’adresse du site généré par Replit !

Vous pouvez maintenant le tester grâce à cette fonctionnalité du portail développeur Helius

‍Vous devriez obtenir le résultat suivant :

‍Voici un fichier JSON contenant les données reçues depuis le webhook de Helius :

Code
[
  {
    accountData: [
      [Object], [Object], [Object],
      [Object], [Object], [Object],
      [Object], [Object], [Object],
      [Object], [Object], [Object],
      [Object], [Object], [Object],
      [Object], [Object], [Object],
      [Object]
    ],
    description: '5DxD5ViWjvRZEkxQEaJHZw2sBsso6xoXx3wGFNKgXUzE sold Fox #7637 to CKs1E69a2e9TmH4mKKLrXFF8kD3ZnwKjoEuXa6sz9WqX for 72 SOL on MAGIC_EDEN.',
    events: { nft: [Object] },
    fee: 10000,
    feePayer: 'CKs1E69a2e9TmH4mKKLrXFF8kD3ZnwKjoEuXa6sz9WqX',
    nativeTransfers: [ [Object], [Object], [Object], [Object], [Object] ],
    signature: '5nNtjezQMYBHvgSQmoRmJPiXGsPAWmJPoGSa64xanqrauogiVzFyGQhKeFataHGXq51jR2hjbzNTkPUpP787HAmL',
    slot: 171942732,
    source: 'MAGIC_EDEN',
    timestamp: 1673445241,
    tokenTransfers: [ [Object] ],
    type: 'NFT_SALE'
  }
]

‍Notez qu’il s’agit d’un tableau. Pour référencer l’objet à envoyer comme message, nous devons accéder à la propriété description via body[0].description.

Intégration des e-mails

‍Nous pouvons maintenant intégrer Gmail afin d’envoyer un e-mail contenant la description de la transaction. Vous devez d’abord configurer nodemailer pour le service ou le type d’adresse e-mail que vous utiliserez. Référencez ensuite les variables .env que nous venons de configurer avec les informations de l’adresse depuis laquelle vous enverrez les messages.

Code
const transporter = nodemailer.createTransport({
  service: 'gmail',
  auth: {
    user: `${process.env['sender_email']}`,
    pass: `${process.env['email_password']}`
  }
});

Nous pouvons maintenant coder l’envoi de l’e-mail en utilisant l’endpoint express configuré précédemment pour recevoir les requêtes. Nous commençons par créer un objet contenant toutes les informations dont nodemailer a besoin pour envoyer l’e-mail, par exemple un expéditeur, un destinataire, un objet (facultatif) et le corps du message. C’est ici que nous insérerons les données réelles de la transaction en référençant l’objet body reçu depuis les webhooks de Helius. Les données de test précédentes nous permettent de déterminer comment accéder à la propriété description.

Code
app.post("/webhooks", async (req, res) => {
  const { body } = req;
  console.log(body)
  let mailOptions = {
    from: `${process.env['sender_email']}`,
    to: `${process.env['receiver_email']}`,
    subject: 'Sending Email using Node.js',
    text: body[0].description
  };
  transporter.sendMail(mailOptions, (error, info) => {
    if (error) {
      console.log(error);
    } else {
      res.status(200).json("Success!");
    }
  })
});

‍Le code final devrait maintenant ressembler à ceci :

Code
const nodemailer = require('nodemailer');
const express = require('express'),
  app = express(),
  bodyParser = require('body-parser');

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({ extended: true }));

const transporter = nodemailer.createTransport({
  service: 'gmail',
  auth: {
    user: `${process.env['sender_email']}`,
    pass: `${process.env['email_password']}`
  }
});

app.post("/webhooks", async (req, res) => {
  const { body } = req;
  console.log(body)
  let mailOptions = {
    from: `${process.env['sender_email']}`,
    to: `${process.env['receiver_email']}`,
    subject: 'Sending Email using Node.js',
    text: body[0].description
  };
  transporter.sendMail(mailOptions, (error, info) => {
    if (error) {
      console.log(error);
    } else {
      res.status(200).json("Success!");
    }
  })
});

app.listen(3000);

‍Félicitations ! Si vous avez correctement configuré les variables .env et installé les bonnes dépendances, vous devriez maintenant pouvoir recevoir un e-mail. Si vous rencontrez un problème, n’hésitez pas à demander de l’aide sur le Discord de Helius.

Étapes suivantes : version Vercel

Le problème avec Replit est que le maintien de ce script en fonctionnement 24 h/24 et 7 j/7 a un coût. Une solution consiste à héberger sur Vercel un site doté uniquement d’un backend. Celui-ci fonctionnera en continu, sans frais. La configuration est globalement identique ; seuls l’emplacement des variables .env et le dépôt GitHub diffèrent.

Vous devez d’abord forker ce dépôt :

‍Nous pouvons maintenant accéder à Vercel, où vous devrez créer un compte.

Accédez ensuite au tableau de bord et ajoutez un nouveau projet.

‍Ajoutez simplement au projet Vercel les variables d’environnement définies précédemment :

‍Après avoir déployé le projet, vous pouvez effectuer les mêmes tests que pour Replit. Vous pourrez alors recevoir gratuitement et 24 h/24, 7 j/7, des e-mails contenant les données de transactions on-chain !

Abonnez-vous à Helius

Suivez les dernières actualités du développement sur Solana et recevez une notification à chaque publication

Image agrandie