新登場:Solana Privacy Ringsがmainnetで利用可能になりました
メール通知にSolanaのwebhookを使用する方法
ブログ/開発

Solana Dev 101 - dApps向けメール通知

インテグレーションエンジニアXのTidelaw
読了時間:6分

なぜこれを構築するのでしょうか?

HeliusのオンチェーンSolanaトランザクション用webhookからデータを受信し、node-mailerを使用してトランザクション情報を含むメールを送信するVercelバックエンドとReplitを構築します。これにより、支払いを受け取ったときや新しいNFTがミントされたときなど、重要なトランザクションをリアルタイムでユーザーに通知できます。

このシステムには、次のような具体的なメリットがあります。

リアルタイム通知

重要なトランザクションが発生すると、すぐにユーザーへ通知されます。これにより、資産状況を常に把握し、Solanaエコシステムへより積極的に参加できます。

セキュリティの向上

アカウントから資金を引き出そうとする試みなど、不審なトランザクションについて通知を受け取れます。これにより、資産を追跡しやすくなります。

ユーザー体験の向上

Solanaベースのアプリケーションをよりシームレスに利用できます。アカウントを手動で確認しなくても、重要なイベントに関する通知を受け取れます。

このシステムは、Solanaユーザーにとって有用なツールになると考えています。Solanaエコシステムの改善にどのように活用されるか楽しみです。

GitHub - Tidelaw/webhook-sms-email:Heliusのwebhookを使用してSMS通知を送信します。

以下のガイドに従う際にサポートが必要な場合は、Helius Discordでお気軽に質問するか、オープンソースのリポジトリをご確認ください。

Replitバージョン

Replitは、コードの作成、実行、他のユーザーとのリアルタイム共有ができるクラウドベースの統合開発環境(IDE)です。初心者にも経験豊富な開発者にも適したツールです。

Replitを作成するには、ReplitのWebサイトにアクセスして「Create a Repl」ボタンをクリックします。その後、Replで使用するプログラミング言語(javascript)とテンプレートを選択できます。Replを作成したら、すぐにコーディングを始められます。

Replitでは、環境変数の保存に.envファイルを使用します。環境変数は、APIキーやパスワードなどの機密情報を保存するために使用されます。Replit内にプレーンテキストで保存されないため、より安全です。

Replitの依存関係

このスクリプトを実行するには、次の依存関係が必要です。

  • nodemailer:メールの送信に使用する依存関係です。
  • express:Webサーバーの作成に使用する依存関係です。
  • body-parser:HTTPリクエストのbodyを解析するために使用する依存関係です。

依存関係をインストールするには、次のコマンドを入力します。

コード
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. 1行目のコードではnodemailerパッケージをインポートし、メールを送信できるようにします。
  2. 2行目のコードでは、Heliusのwebhookからデータを受信するExpress Webサーバーを作成します。
  3. 3行目のコードではbody-parserモジュールをインポートし、webhookからのデータを簡単に解析できるようにします。
  4. 4行目と5行目のコードでは、body-parser依存関係を使用してJSONリクエストを解析するようにWebサーバーを設定します。

次にGmail APIを設定し、これらの環境変数をReplitに保存する必要があります。

Gmail APIキー

まず、こちらのガイドに従ってGmailのアプリパスワードを取得します。2段階認証も設定する必要があります。node-mailerを使用してメール送信を始めるために必要なのはこれだけです。

Replitの環境変数の設定

Replitの.env変数メニューは、Replitクライアントの左下にあります。

これで、ターミナルがある右下にメニューが表示されます。

SECRET_KEYの欄にemail_passwordなどの変数名を入力し、その値を設定します。receiver_emailとsender_emailはメールの受信と送信に使用する2つのメールアドレスです。この例の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リクエストを受信すると、リクエストのbodyを抽出し、テスト用にコンソールへ表示します。その後、リクエストに200 OKステータスコードで応答し、データを受信済みであることをHeliusへ通知して、同じメッセージが繰り返し送信されないようにします。

Webhookの設定とテスト

テストを開始するには、Runボタンをクリックします。右側にWebサイトが表示されます。

エラーが表示されても問題ありません。このサーバーはPOSTリクエストのみを受け付けるため、テストにはHeliusを使用する必要があります。Heliusに移動してwebhookを設定しましょう。

「Enhanced」タイプのメインネットトランザクションを監視します。これには、メールで送信するdescriptionプロパティが含まれています。先ほど生成したReplitサーバーのリンク(この例ではhttps://helius-webhook-sms-email.tidelaw.repl.co/webhooks)と、監視するウォレットを貼り付けます。Replitが生成したサイトのURLには、必ず**/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では、このスクリプトを24時間365日稼働させるためにコストがかかります。解決策の1つは、バックエンドのみのWebサイトをVercelでホストすることです。これにより、コストをかけずに常時稼働させられます。設定方法はほぼ同じで、異なるのは.env変数の保存場所とGitHubリポジトリです。

まず、このリポジトリをフォークします。

次にVercelへ移動し、アカウントを作成します。

その後、ダッシュボードへ移動して新しいプロジェクトを追加します。

先ほどの環境変数をVercelプロジェクトに追加します。

プロジェクトをデプロイしたら、Replitで行ったものと同じテストを実行できます。これで、オンチェーントランザクションデータを含むメールを無料で24時間365日受信できるようになります。

Heliusを購読

Solana開発の最新情報や新しい記事の公開通知を受け取れます

拡大画像