全新:Solana Privacy Rings 现已上线主网
如何使用 Solana webhook 发送电子邮件通知
博客/开发

Solana 开发 101——为 dApps 添加电子邮件通知

集成工程师X 上的 Tidelaw
阅读需 6 分钟

为什么要构建这个系统?

我们将构建一个 Vercel 后端和 Replit,用于接收 Helius webhook 提供的 Solana 链上交易数据,并使用 node-mailer 发送包含这些交易信息的电子邮件。这样,用户就能实时收到重要交易的通知,例如收到付款或铸造新 NFT 时。

该系统有以下具体优势:

实时通知

重要交易一旦发生,用户就会收到通知。这有助于用户及时掌握自己的财务状况,并更深入地参与 Solana 生态系统。

提高安全性

用户可以收到可疑交易的通知,例如有人尝试从其账户中提取资金。这有助于用户追踪自己的资产。

改善用户体验

用户在使用基于 Solana 的应用时将获得更流畅的体验。他们无需手动检查账户,就能收到重要事件的通知。

我们相信,这个系统将成为 Solana 用户的实用工具。我们也期待看到它如何推动 Solana 生态系统进一步发展。

GitHub - Tidelaw/webhook-sms-email:使用 Helius 的 webhook 发送短信通知。

如果你按照以下指南操作时遇到问题,可以在 Helius Discord 中寻求帮助,也可以查看开源代码仓库。

Replit 版本

Replit 是一个基于云的集成开发环境(IDE),你可以用它编写和运行代码,并与他人实时共享。无论是初学者还是经验丰富的开发者,它都非常实用。

要创建 Replit,只需访问 Replit 网站并点击“Create a Repl”按钮。然后,你可以为 Repl 选择编程语言(javascript)和模板。创建 Repl 后,就可以立即开始编写代码。

Replit 使用 .env 文件存储环境变量。环境变量用于保存 API 密钥和密码等敏感信息。它们不会以纯文本形式存储在 Replit 中,因此更加安全。

Replit 依赖项

运行脚本需要以下依赖项:

  • nodemailer:用于发送电子邮件。
  • express:用于创建 Web 服务器。
  • 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 Web 服务器,用于接收 Helius webhook 发送的数据。
  3. 第三行代码导入 body-parser 模块,让解析 webhook 数据变得更加容易。
  4. 第四行和第五行代码使用 body-parser 依赖项配置 Web 服务器,使其能够解析 JSON 请求。

‍接下来,我们需要设置 Gmail API,并将这些环境变量保存到 Replit。

Gmail API 密钥

首先,按照这篇指南获取 Gmail 应用专用密码。你还需要设置两步验证。这就是使用 node-mailer 发送电子邮件所需的全部准备工作。

设置 Replit 环境变量

要访问 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);

‍该 Web 服务器已配置为处理发送到 /webhooks 路由的 HTTP POST 请求。当 Web 服务器收到发送到 /webhooks 路由的 POST 请求时,会提取请求正文并将其显示在控制台中,供你测试。随后,Web 服务器会返回 200 OK 状态码,告知 Helius 已成功收到请求,从而避免 Helius 重复发送消息。

Webhook 设置与测试

要开始测试,只需点击 Run 按钮,右侧就会出现一个网站。

‍看到错误不必担心,我们的服务器只接受 POST 请求,因此需要使用 Helius 进行测试。现在可以前往 Helius 设置 webhook。‍

‍我们将监听 Mainnet 上“Enhanced”类型的交易。这些交易包含 description 属性,我们会将其作为电子邮件发送。粘贴之前生成的 Replit 服务器链接(本例为 https://helius-webhook-sms-email.tidelaw.repl.co/webhooks),并添加要监听的钱包。请务必在 Replit 生成的网站地址后加上 /webhooks!

现在,你可以使用 Helius Developer Portal 中的这项功能进行测试。

‍它应该返回以下结果:

‍以下是我们从 Helius webhook 收到的数据对应的 JSON 文件:

代码
[
  {
    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'
  }
]

‍请注意,这是一个数组。要引用需要作为消息发送的对象,我们需要通过 body[0].description 访问 description 属性。

电子邮件集成

‍现在可以集成 Gmail,以便发送包含交易 description 的电子邮件。首先,你需要根据所使用的服务或电子邮件类型配置 nodemailer。然后,引用我们刚刚设置的 .env 变量,填入发件邮箱的详细信息。

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

现在,我们可以使用之前为接收请求而设置的 express 端点,编写实际发送电子邮件的代码。首先创建一个对象,其中包含 nodemailer 发送邮件所需的所有相关信息,例如发件人、收件人、主题(非必需)和正文。我们将在这里引用从 Helius webhook 收到的 body 对象,插入实际的交易数据。利用之前的测试数据,我们可以确定如何访问 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 代码仓库。

首先,你需要 fork 这个代码仓库:

‍现在可以前往 Vercel 创建账户。

然后进入控制面板并添加新项目。

‍只需将之前的环境变量添加到 Vercel 项目中:

‍部署项目后,你就可以运行与 Replit 版本相同的测试。现在,你可以全天候免费接收包含链上交易数据的电子邮件了!

订阅 Helius

及时了解 Solana 开发的最新动态,并在我们发布新内容时收到更新

放大图片