NUEVO: Solana Privacy Rings ya está disponible en la red principal
cómo usar webhooks de Solana para enviar notificaciones por correo electrónico
Blog/Desarrollo

Solana Dev 101 - Notificaciones por correo electrónico para dApps

Ingeniero de integracionesTidelaw en X
6 min de lectura

¿Por qué crearías esto?

Crearemos este backend de Vercel y Replit, diseñado para recibir datos de transacciones onchain de Solana mediante los webhooks de Helius y usar node-mailer para enviar correos electrónicos con información sobre estas transacciones. Esto permitirá que los usuarios reciban notificaciones de transacciones importantes en tiempo real, como cuando reciben un pago o se acuña un NFT nuevo.

Estos son algunos beneficios específicos de este sistema:

Notificaciones en tiempo real

Los usuarios recibirán notificaciones de transacciones importantes en cuanto ocurran. Esto les permitirá mantenerse al día con sus finanzas y participar más en el ecosistema de Solana.

Mayor seguridad

Los usuarios podrán recibir notificaciones sobre transacciones sospechosas, como intentos de retirar fondos de su cuenta. Esto les ayudará a monitorear sus activos.

Mejor experiencia de usuario

Los usuarios tendrán una experiencia más fluida al usar aplicaciones basadas en Solana. Podrán recibir notificaciones sobre eventos importantes sin tener que revisar manualmente sus cuentas.

Creemos que este sistema será una herramienta valiosa para los usuarios de Solana. Nos entusiasma ver cómo se usa para mejorar el ecosistema de Solana.

GitHub - Tidelaw/webhook-sms-email: Usa los webhooks de Helius para enviar notificaciones por SMS.

Si sigues la guía a continuación, puedes pedir ayuda en el Discord de Helius o consultar el repositorio de código abierto.

Versión para Replit

Replit es un entorno de desarrollo integrado (IDE) basado en la nube que te permite escribir y ejecutar código, además de compartirlo con otras personas en tiempo real. Es una excelente herramienta tanto para principiantes como para desarrolladores experimentados.

Para crear un Replit, solo tienes que ir al sitio web de Replit y hacer clic en el botón "Crear un Repl". Después, podrás elegir un lenguaje de programación (javascript) y una plantilla para tu Repl. Una vez creado, puedes comenzar a programar de inmediato.

Replit usa archivos .env para almacenar variables de entorno. Las variables de entorno se usan para guardar información confidencial, como claves de API y contraseñas. No se almacenan como texto sin formato en tu Replit, por lo que son más seguras.

Dependencias de Replit

Se requieren las siguientes dependencias para ejecutar nuestro script:

  • nodemailer: Esta dependencia se usa para enviar correos electrónicos.
  • express: Esta dependencia se usa para crear un servidor web.
  • body-parser: Esta dependencia se usa para analizar el cuerpo de las solicitudes HTTP.

Para instalar las dependencias, solo tienes que ingresar:

Código
npm install nodemailer express body-parser

‍Ahora podemos iniciar nuestro servidor express para comenzar a recibir datos de los webhooks:

Código
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 primera línea de código importa el paquete nodemailer, que nos permite enviar correos electrónicos.
  2. La segunda línea de código crea un servidor web de Express donde recibiremos datos del webhook de Helius.
  3. La tercera línea de código importa el módulo body-parser, que facilita mucho el análisis de los datos de nuestro webhook.
  4. La cuarta y quinta líneas de código configuran el servidor web para analizar solicitudes JSON mediante nuestra dependencia body-parser.

‍Ahora debemos configurar nuestra API de Gmail y guardar estas variables de entorno en Replit.

Claves de la API de Gmail

Primero, sigue esta guía y obtén una contraseña de aplicación para Gmail. También tendrás que configurar la verificación en dos pasos. Esto es todo lo que necesitamos para comenzar a enviar correos electrónicos con node-mailer.

Configuración de variables de entorno en Replit

Para acceder al menú de variables .env de Replit, búscalo en la esquina inferior izquierda del cliente de Replit.

‍Ahora lo verás en la parte inferior derecha, donde está tu terminal.

‍Solo ingresa el nombre de la variable, por ejemplo, email_password, donde aparece SECRET_KEY e introduce tus valores. receiver_email y sender_email son los dos correos electrónicos que se usarán para enviar y recibir el mensaje. En nuestro caso, email_password será la contraseña del correo electrónico que usarás para enviarlo.

Ahora podemos comenzar a recibir datos de nuestro webhook:

Código
app.post("/webhooks", async (req, res) => {

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

app.listen(3000);

‍El servidor web está configurado para gestionar solicitudes HTTP POST en la ruta /webhooks. Cuando el servidor web reciba una solicitud POST en la ruta /webhooks, extraerá el cuerpo de la solicitud y lo mostrará en la consola para que puedas probarlo. Después, el servidor web responderá a la solicitud con un código de estado 200 OK para informar a Helius que la recibimos y evitar que envíe mensajes duplicados.

Configuración y pruebas del webhook

Para comenzar las pruebas, solo tienes que hacer clic en el botón Ejecutar. Debería aparecer un sitio web a la derecha.

‍No te preocupes por el error. Nuestro servidor solo acepta solicitudes POST, así que tendremos que usar Helius para hacer la prueba. Ahora podemos ir a Helius y configurar un webhook.‍

‍Escucharemos transacciones de Mainnet del tipo ‘Enhanced’. Estas contienen la propiedad description que enviaremos por correo electrónico. Pega el enlace del servidor de Replit que generamos antes, en este caso https://helius-webhook-sms-email.tidelaw.repl.co/webhooks, y la billetera que deseas escuchar. Asegúrate de incluir /webhooks junto con el sitio generado por Replit.

Ahora puedes probarlo con esta función en el Portal para desarrolladores de Helius

‍Esto debería devolver lo siguiente:

‍Este es un archivo JSON con los datos que recibimos del webhook de Helius:

Código
[
  {
    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'
  }
]

‍Observa que es un arreglo. Para hacer referencia al objeto que enviaremos como mensaje, debemos acceder a la propiedad description mediante body[0].description.

Integración del correo electrónico

‍Ahora podemos integrar Gmail para enviar un correo electrónico con la descripción de la transacción. Primero, tendrás que configurar nodemailer con el servicio o tipo de correo electrónico que usarás. Luego, consulta las variables .env que acabamos de configurar con los datos del correo electrónico desde el que enviarás el mensaje.

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

Ahora podemos programar el envío del correo electrónico con el endpoint de express que configuramos antes para recibir las solicitudes. Primero, creamos un objeto con toda la información relevante que nodemailer necesita para enviar el correo electrónico, como un remitente, un destinatario, un asunto (opcional) y el cuerpo. Aquí insertaremos los datos reales de la transacción haciendo referencia al objeto body que recibimos de los webhooks de Helius. Con los datos de prueba anteriores, podemos determinar cómo acceder a la propiedad description.

Código
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!");
    }
  })
});

‍El código completo debería verse así:

Código
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);

‍¡Felicitaciones! Ahora deberías poder recibir un correo electrónico si configuraste correctamente las variables .env e instalaste las dependencias adecuadas. Si tienes algún problema, puedes enviar un mensaje en el Discord de Helius para pedir ayuda.

Próximos pasos: versión para Vercel

El problema con Replit es que mantener este script activo las 24 horas del día, los 7 días de la semana, tiene un costo. Una solución es alojar en Vercel un sitio web que solo tenga un backend. Se ejecutará de forma continua sin costo. La configuración es casi igual. Las únicas diferencias son dónde se almacenan las variables .env y el uso de un repositorio de GitHub.

Primero, tendrás que crear un fork de este repositorio:

‍Ahora podemos ir a Vercel, donde tendrás que crear una cuenta.

Luego, ve al panel de control y agrega un proyecto nuevo.

‍Solo agrega al proyecto de Vercel las variables de entorno que configuraste antes:

‍Después de desplegar el proyecto, puedes ejecutar las mismas pruebas que hicimos en Replit. Ahora podrás recibir gratis, las 24 horas del día, los 7 días de la semana, correos electrónicos con datos de transacciones onchain.

Suscríbete a Helius

Mantente al día con las novedades del desarrollo en Solana y recibe actualizaciones cuando publiquemos

Imagen ampliada