НОВОЕ: кольца конфиденциальности Solana уже доступны в основной сети
как использовать webhook Solana для уведомлений по электронной почте
Блог/Разработка

Solana Dev 101 — уведомления по электронной почте для dApps

Инженер по интеграциямTidelaw в X
Чтение: 6 мин

Зачем создавать такую систему?

Мы создадим бэкенд на Vercel и Replit, предназначенный для получения данных об ончейн-транзакциях Solana из webhook Helius и отправки писем с информацией об этих транзакциях через node-mailer. Пользователи смогут получать уведомления о важных транзакциях в реальном времени, например о получении платежа или выпуске нового NFT.

Вот несколько конкретных преимуществ этой системы:

Уведомления в реальном времени

Пользователи будут получать уведомления о важных транзакциях сразу после их выполнения. Это поможет им следить за своими финансами и активнее участвовать в экосистеме Solana.

Повышенная безопасность

Пользователи смогут получать уведомления о подозрительных транзакциях, например о попытках вывода средств с их счета. Это поможет им отслеживать свои активы.

Улучшенный пользовательский опыт

Работа с приложениями на базе Solana станет удобнее. Пользователи смогут получать уведомления о важных событиях без необходимости вручную проверять свои счета.

Мы считаем, что эта система станет ценным инструментом для пользователей Solana. Нам интересно увидеть, как она поможет улучшить экосистему Solana.

GitHub — Tidelaw/webhook-sms-email: использует webhook Helius для отправки SMS-уведомлений.

Если вы следуете приведенному ниже руководству, можете обратиться за помощью в Helius Discord или свериться с открытым репозиторием.

Версия для Replit

Replit — это облачная интегрированная среда разработки (IDE), в которой можно писать и запускать код, а также делиться им с другими в реальном времени. Она отлично подходит как начинающим, так и опытным разработчикам.

Чтобы создать Replit, просто перейдите на сайт Replit и нажмите кнопку «Create a Repl». Затем выберите язык программирования (javascript) и шаблон для Repl. После создания Repl можно сразу приступать к написанию кода.

Replit использует файлы .env для хранения переменных окружения. В переменных окружения хранится конфиденциальная информация, например ключи API и пароли. В Replit они не хранятся в виде обычного текста, что повышает безопасность.

Зависимости Replit

Для запуска нашего скрипта необходимы следующие зависимости:

  • nodemailer: эта зависимость используется для отправки писем.
  • express: эта зависимость используется для создания веб-сервера.
  • body-parser: эта зависимость используется для разбора тела HTTP-запросов.

Чтобы установить зависимости, просто введите:

Код
npm install nodemailer express body-parser

‍Теперь можно запустить сервер express, чтобы начать получать данные из webhook:

Код
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. Первая строка кода импортирует пакет nodemailer, который позволяет отправлять письма.
  2. Вторая строка кода создает веб-сервер Express, на котором мы будем получать данные из webhook Helius.
  3. Третья строка кода импортирует модуль body-parser, который значительно упрощает разбор данных из webhook.
  4. Четвертая и пятая строки кода настраивают веб-сервер для разбора JSON-запросов с помощью зависимости body-parser.

‍Теперь нужно настроить Gmail API и сохранить эти переменные окружения в Replit.

Ключи Gmail API

Сначала следуйте этому руководству и получите пароль приложения для Gmail. Вам также потребуется настроить двухэтапную аутентификацию. Этого достаточно, чтобы начать отправлять письма с помощью node-mailer.

Настройка переменных окружения Replit

Меню переменных .env находится в левом нижнем углу клиента Replit.

‍Теперь оно отобразится в правом нижнем углу, где находится терминал.

‍Просто укажите вместо SECRET_KEY имя переменной, например email_password, и введите нужное значение. receiver_email и sender_email — это два адреса электронной почты, которые будут использоваться для получения и отправки письма. В нашем случае email_password — пароль от почтового аккаунта, с которого будет отправлено письмо.

Теперь можно начать получать данные из webhook:

Код
app.post("/webhooks", async (req, res) => {

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

app.listen(3000);

‍Веб-сервер настроен на обработку HTTP POST-запросов к маршруту /webhooks. Когда веб-сервер получает POST-запрос к маршруту /webhooks, он извлекает тело запроса и выводит его в консоль для тестирования. Затем веб-сервер отвечает кодом состояния 200 OK, чтобы сообщить Helius об успешном получении запроса и предотвратить повторную отправку сообщений.

Настройка и тестирование webhook

Чтобы начать тестирование, просто нажмите кнопку Run. Справа должен появиться веб-сайт.

‍Не пугайтесь ошибки: наш сервер принимает только POST-запросы, поэтому для тестирования потребуется Helius. Теперь можно перейти в Helius и настроить webhook.‍

‍Мы будем отслеживать транзакции Mainnet типа ‘Enhanced’. Они содержат свойство description, которое мы будем отправлять по электронной почте. Вставьте созданную ранее ссылку на сервер Replit, в данном случае https://helius-webhook-sms-email.tidelaw.repl.co/webhooks, и укажите кошелек, который хотите отслеживать. Обязательно добавьте /webhooks к адресу сайта, созданного Replit!

Теперь это можно протестировать с помощью соответствующей функции в Helius Developer Portal

‍В ответ должно вернуться следующее:

‍Вот JSON-файл с данными, полученными из webhook Helius:

Код
[
  {
    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'
  }
]

‍Обратите внимание, что это массив. Чтобы обратиться к объекту, который нужно отправить в сообщении, необходимо получить доступ к свойству description через body[0].description.

Интеграция электронной почты

‍Теперь можно интегрировать Gmail, чтобы отправлять письма с описанием транзакции.  Сначала настройте nodemailer для используемого сервиса или типа электронной почты. Затем укажите созданные ранее переменные .env с данными почтового аккаунта, с которого будут отправляться письма.

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

Теперь можно написать код для отправки письма через настроенную ранее конечную точку express, которая принимает запросы. Сначала создайте объект со всей информацией, необходимой nodemailer для отправки письма: отправителем, получателем, темой (необязательно) и телом. Здесь мы добавим фактические данные транзакции, обратившись к объекту body, полученному из webhook Helius. Используя предыдущие тестовые данные, можно определить, как получить доступ к свойству description.

Код
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!");
    }
  })
});

‍Готовый код должен выглядеть так:

Код
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);

‍Поздравляем! Если переменные .env настроены правильно и установлены нужные зависимости, теперь вы сможете получать письма. Если у вас возникли трудности, обратитесь за помощью в Helius Discord.

Следующие шаги: версия для Vercel

Недостаток Replit в том, что за круглосуточную работу этого скрипта нужно платить. Один из вариантов — бесплатно разместить на Vercel сайт только с бэкендом, который будет работать постоянно. Настройка почти не отличается: меняется только место хранения переменных .env, а также используется репозиторий GitHub.

Сначала сделайте форк этого репозитория:

‍Теперь перейдите на Vercel и создайте аккаунт.

Затем откройте панель управления и добавьте новый проект.

‍Просто добавьте в проект Vercel переменные окружения, указанные ранее:

‍После развертывания проекта можно запустить те же тесты, что и для Replit. Теперь вы сможете бесплатно и круглосуточно получать письма с данными об ончейн-транзакциях!

Подпишитесь на Helius

Следите за новостями разработки на Solana и получайте уведомления о наших публикациях

Увеличенное изображение