[Solidityのはじめ方] Part11: イベントとログの利用

スマートコントラクトはブロックチェーン上で動作しますが、その内部状態の変化や特定の出来事を外部アプリケーション（DAppsのフロントエンドなど）やユーザーに効率的に知らせる仕組みが必要です。それが「イベント」と「ログ」です。イベントを使うことで、コントラクトは実行中に特定の情報をブロックチェーンのログ領域に記録できます。このログは、外部から比較的低コストでアクセス・監視することが可能です。

イベントは、オンチェーンのトランザクション実行結果をオフチェーンの世界に伝えるための重要な橋渡し役となります。

Solidityでは、event キーワードを使ってイベントを定義します。関数定義に似ていますが、引数にはイベントで記録したいデータの型と名前を指定します。

pragma solidity ^0.8.0;
contract EventExample { // 送金イベントを定義 event Transfer(address from, address to, uint256 amount); // 新しいアイテムが作成されたイベントを定義 event ItemCreated(uint256 indexed itemId, string name, address owner); // 何らかの重要なアクションが完了したことを示すイベント event ActionCompleted(address indexed user, string message); // ... コントラクトの他の部分 ...
}

上記の例では、Transfer、ItemCreated、ActionCompleted という3つのイベントを定義しています。各イベントには、記録したい情報の種類に応じたパラメータが設定されています。

パラメータ名の前に indexed キーワードを付けることができます（詳細は後述）。

定義したイベントは、コントラクト内の関数実行中に emit キーワードを使って発行（記録）します。イベントを発行する際には、定義したパラメータに対応する値を渡します。

pragma solidity ^0.8.0;
contract EventExample { event Transfer(address indexed from, address indexed to, uint256 amount); event ItemCreated(uint256 indexed itemId, string name, address owner); mapping(address => uint256) public balances; uint256 nextItemId = 0; struct Item { string name; address owner; } mapping(uint256 => Item) public items; constructor() { balances[msg.sender] = 1000; } function transfer(address _to, uint256 _amount) public { require(balances[msg.sender] >= _amount, "Insufficient balance"); balances[msg.sender] -= _amount; balances[_to] += _amount; // Transferイベントを発行 emit Transfer(msg.sender, _to, _amount); } function createItem(string memory _name) public { uint256 newItemId = nextItemId++; items[newItemId] = Item(_name, msg.sender); // ItemCreatedイベントを発行 emit ItemCreated(newItemId, _name, msg.sender); }
}

transfer 関数では、送金処理が成功した後に Transfer イベントを発行し、送金元、送金先、送金額を記録しています。 createItem 関数では、新しいアイテムが作成された際に ItemCreated イベントを発行し、アイテムID、名前、所有者を記録しています。

イベントの発行自体は、コントラクトの状態変数を変更するよりもガス代が安価な操作です。そのため、状態変化そのものではなく、変化があったことを通知する目的でよく利用されます。

イベントのパラメータに indexed キーワードを付けると、そのパラメータの値を使ってログを効率的に検索・フィルタリングできるようになります。これは、DAppsのフロントエンドなどが特定の条件に合致するイベントログだけを素早く見つけるのに役立ちます。

// 例: 送金元(from)と送金先(to)をインデックス化
event Transfer(address indexed from, address indexed to, uint256 amount);
// 例: アイテムIDと所有者(owner)をインデックス化
event ItemCreated(uint256 indexed itemId, string name, address indexed owner);

特徴:

• indexed を付けたパラメータは「トピック (Topic)」として扱われ、ログの特別な領域に保存されます。
• トピックを使うと、特定のアドレスやIDに関連するイベントログを高速に検索できます。例えば、「特定のアドレスが関与した全てのTransferイベント」や「特定の所有者が作成した全てのItemCreatedイベント」を探すことが容易になります。
• indexed を付けられるパラメータの数には制限があります。通常、1つのイベントにつき最大3つまでです。（匿名イベントの場合は4つまで）。
• indexed を付けなかったパラメータの値は、ログのデータ部分にABIエンコードされて保存されます。これらはトピックによる直接的なフィルタリングはできませんが、ログを取得した後に内容を確認することは可能です。
• 参照型（string, bytes, 配列, 構造体）を indexed にすると、そのデータのハッシュ値がトピックとして保存されます。元の値そのものではない点に注意が必要です。

スマートコントラクトが発行したイベントログは、ブロックチェーン上に記録されます。これらのログは、Ethereumクライアントが提供するAPI（JSON-RPC API）を通じて取得できます。

代表的なAPIエンドポイント:

• eth_getLogs: 過去のブロックに含まれるログを、コントラクトアドレスやトピック（indexedパラメータの値）などの条件を指定して一括で取得します。
• eth_subscribe: 新しいブロックが生成された際に、指定した条件に合致する新しいログが発生したらリアルタイムで通知を受け取ります（WebSocket接続などが必要）。

通常、DAppsの開発では、これらの低レベルAPIを直接扱うのではなく、web3.js や ethers.js といったJavaScriptライブラリを使用します。これらのライブラリは、イベントログの取得や購読をより簡単に行うための便利な機能を提供しています。

// ethers.jsを使ったイベント購読の簡単なイメージ（実際のコードはStep 7で詳しく学びます）
import { ethers } from "ethers";
// プロバイダーとコントラクトインスタンスの設定 (仮)
const provider = new ethers.providers.WebSocketProvider("wss://your-node-provider-url");
const contractAddress = "0x..."; // あなたのコントラクトアドレス
const contractABI = [ /* あなたのコントラクトABI */ ];
const contract = new ethers.Contract(contractAddress, contractABI, provider);
console.log("イベントの購読を開始します...");
// Transferイベントを購読
contract.on("Transfer", (from, to, amount, event) => { console.log(" Transfer イベント受信!"); console.log(` From: ${from}`); console.log(` To: ${to}`); console.log(` Amount: ${ethers.utils.formatUnits(amount, 'ether')} ETH`); // 例: トークン量がether単位の場合 // console.log(" Event data:", event); // イベントの詳細情報
});
// ItemCreatedイベントを購読（itemIdでフィルタリングする例）
// 注意: 文字列やbytesをindexedした場合、トピックはそのハッシュ値になるため、
// ライブラリによってはフィルタリング方法が異なります。
// const filter = contract.filters.ItemCreated(null, null, "0xYourTargetOwnerAddress");
// contract.on(filter, (itemId, name, owner, event) => { ... });
// エラーハンドリングなども必要です

このように、フロントエンドやバックエンドのアプリケーションは、イベントログを監視することで、コントラクトの状態変化を検知し、UIの更新、データベースへの記録、他のシステムへの通知など、様々なアクションを実行できます。

具体的なライブラリの使い方やフロントエンドとの連携については、「Step 7: 実践的なDApp開発」で詳しく解説しますので、ここでは概念を理解しておきましょう。

イベントは様々な目的で利用されます。主なユースケースをいくつか見てみましょう。

• Solidity 公式ドキュメント (日本語): イベント
• Solidity Official Documentation (English): Events
• Ethereum開発者ドキュメント: JSON-RPC API