Envioでブロックチェインデータをインデックス化してみた
Envioのチュートリアルを実践してみた経験を共有します。
Envioとは
Envioは、ブロックチェイン上のデータをインデックス化して効率的に検索・アクセス可能にするサービスです。ブロックチェインのデータは公開されていますが、時系列に記録されず、検索しにくい状態で存在します。インデックス化サービスを利用することで、特定のキーワードやパラメータに基づいたデータアクセスが容易になります。インデックスサービスの概念については、この記事で説明されていますが、要するにブロックチェインの目次を作成してくれるサービスです。ブロックチェインのデータは公開されていますが、時系列で記録されておらず、インデックス化されていません。そのため、特定のキーワードやパラメータに基づいてデータを取得するのが困難です。インデックス化サービスを利用することで、データアクセスが格段に容易になります。
なお、Envioは、PonderやtheGraphと比べて高速であるとされています。
チュートリアルを実践してみた
Envioの公式ドキュメントGetting Startedに沿って、Envioの基本的な使い方を試してみました。以下はそのステップごとの紹介です。
インストール
npm i -g envio
インストール確認
envio --help
初期化
envio init
ここでは、既存のスマートコントラクトを取り込むか、ERC20またはGreeterのテンプレートから選択します。
ERC20とは
ERC20は、イーサリアムブロックチェイン上でトークンを作成・発行するための標準規約です。トークンの転送、残高の取得、供給量の確認などの機能を標準化し、トークン間の相互運用性を保証します。ERC20トークンは、仮想通貨や資産の代表、投票権など、多岐にわたる用途で利用されています。
Greeterとは
Greeterは、ブロックチェイン上で動作する単純なスマートコントラクトの例です。「Hello, World」というメッセージを出力することで、スマートコントラクトの基本やブロックチェインプログラミングの入門として機能します。
今回はGreeterを選択してみます。名前の設定、プロジェクトのディレクトリ選択、イベントハンドラーの言語を選択します。
インデクサーの起動
envio dev
Dockerが起動し、インデックス化されたデータ用のデータベースを作成します。config.yamlファイルで指定された契約からインデックスを開始します。
インデックス化された結果の表示
ローカルのHasuraサーバー(GraphQL APIを提供するオープンソースのエンジンです)で結果を表示します。
open http://localhost:8080
次のような画面が出てきます。
The hasura admin-secret / password is testing and the tables can be viewed in the data tab or queried from the playground
とドキュメントに記載があるのでadmin-secretにtestingと入力すると管理画面が開きます。
GraphQLに次のようなクエリを入力して実行ボタンをクリックすると結果を取得できます。
query MyQuery {
User {
greetings
}
}
{
"data": {
"User": [
{
"greetings": [
"gm EthGlobal Paris",
"gm EthGlobal Paris"
]
},
{
"greetings": [
"hello sers",
"gm!",
"hello fam!"
]
},
{
"greetings": [
"gm",
"gm",
"gm (https://polygonscan.com/address/0x9D02A17dE4E68545d3a58D3a20BbBE0399E05c9c#writeContract#F2)",
"hello world"
]
},
{
"greetings": [
"Hello"
]
},
{
"greetings": [
"Greetings from ct1aic.eth",
"Thanks for the NFT #0"
]
},
{
"greetings": [
"GG"
]
},
{
"greetings": [
" "
]
},
{
"greetings": [
"Welcome to envio"
]
},
{
"greetings": [
"\"hello\""
]
},
{
"greetings": [
"Testing Envio!Envio is a real-time indexer built specifically for EVM-compatible blockchains, providing developers with a seamless and efficient indexing solution. Designed to optimize the user experience, Envio offers automatic code generation and flexible language support. Indexers on Envio can be written in JavaScript, TypeScript or ReScript.",
"Testing Envio!Envio is a real-time indexer built specifically for EVM-compatible blockchains providing developers with a seamless and efficient indexing solution. Designed to optimize the user experience Envio offers automatic code generation and flexible language support. Indexers on Envio can be written in JavaScript TypeScript or ReScript."
]
},
{
"greetings": [
"Roadiooooh",
"Rick Stack",
"Tee House",
"Ada Lovelace",
"Readings Baye"
]
},
{
"greetings": [
"This is a greeting from Noah."
]
},
{
"greetings": [
"gm brymes"
]
},
{
"greetings": [
"Hello Envio",
"Gm, 1234"
]
},
{
"greetings": [
"gm",
"gn",
"gm paris",
"gm Linea",
"assah dude",
"envio actions 👀",
"envio actions 👀, whats that 🤔",
"Hello notifications",
"envio actions are going to be a game changer",
"its all hosted for testing"
]
},
{
"greetings": [
"gm!",
"gm ser",
"envio is super faaaast"
]
},
{
"greetings": [
"ottie"
]
}
]
}
}
ホスティングしてみる
EnvioのDeploy the indexer onto the hosted serviceに従い、デプロイプロセスを経てインデクサーをホスティングサービスにデプロイしました。GitHubアカウントでログイン後、インデクサーを追加するためのUIが提供されており、簡単にデプロイが完了します。デプロイ後は、エンドポイントにクエリを送信して、実際の動作を確認できます。
まずDeploy the indexer onto the hosted serviceの説明にしたがいhosted serviceの画面を開きます。
GitHubアカウントを使ってログインすると次の画面が出てきます。Add new indexer +をクリックします。
どのリポジトリを使用するのか選択できるのでenvioのチュートリアルで使っているリポジトリを選択します。
その後パラメータを指定する画面が出てくるので、適宜入力します。今回はGit release branchだけmainにしました。
指示にしたがいmainブランチへコードをプッシュするとデプロイが始まります。
Openをクリックするとステータスが出てきます。インデクサーのデプロイが完了するまで待ちます。
Deployが終わるとクエリを送信するエンドポイントの情報がでてきます。
実際にクエリを送信してみると結果が返ってきます。
クエリをコードから送信
コードからもクエリを送信してみると結果が返ってきます。
import requests
import json
# GraphQLエンドポイントURL適切に置き換える
url = "https://indexer.bigdevenergy.link/XXXXX/v1/graphql"
# 送信するGraphQLクエリ
query = """
query MyQuery {
User {
greetings
}
}
"""
# GraphQLエンドポイントに対するリクエストヘッダー
headers = {
"Content-Type": "application/json",
}
# リクエストデータ
data = {"query": query}
# POSTリクエストを送信してレスポンスを取得
response = requests.post(url, json=data, headers=headers)
# レスポンスデータを整形して表示
# json.dumps()の第二引数にindentを指定することで整形できる
# sort_keys=Trueはキーをアルファベット順にソートするオプション
formatted_response = json.dumps(response.json(), indent=4, sort_keys=True)
print(formatted_response)
実行結果
❯ python3 sample.py
{
"data": {
"User": [
{
"greetings": [
"gm EthGlobal Paris",
"gm EthGlobal Paris"
]
},
{
"greetings": [
"hello sers",
"gm!",
"hello fam!"
]
},
{
"greetings": [
"gm",
"gm",
"gm (https://polygonscan.com/address/0x9D02A17dE4E68545d3a58D3a20BbBE0399E05c9c#writeContract#F2)",
"hello world"
]
},
{
"greetings": [
"Hello"
]
},
{
"greetings": [
"Greetings from ct1aic.eth",
"Thanks for the NFT #0"
]
},
{
"greetings": [
"GG"
]
},
{
"greetings": [
" "
]
},
{
"greetings": [
"Welcome to envio"
]
},
{
"greetings": [
"\"hello\""
]
},
{
"greetings": [
"Testing Envio!Envio is a real-time indexer built specifically for EVM-compatible blockchains, providing developers with a seamless and efficient indexing solution. Designed to optimize the user experience, Envio offers automatic code generation and flexible language support. Indexers on Envio can be written in JavaScript, TypeScript or ReScript.",
"Testing Envio!Envio is a real-time indexer built specifically for EVM-compatible blockchains providing developers with a seamless and efficient indexing solution. Designed to optimize the user experience Envio offers automatic code generation and flexible language support. Indexers on Envio can be written in JavaScript TypeScript or ReScript."
]
},
{
"greetings": [
"Roadiooooh",
"Rick Stack",
"Tee House",
"Ada Lovelace",
"Readings Baye"
]
},
{
"greetings": [
"This is a greeting from Noah."
]
},
{
"greetings": [
"gm brymes"
]
},
{
"greetings": [
"Hello Envio",
"Gm, 1234"
]
},
{
"greetings": [
"gm",
"gn",
"gm paris",
"gm Linea",
"assah dude",
"envio actions \ud83d\udc40",
"envio actions \ud83d\udc40, whats that \ud83e\udd14",
"Hello notifications",
"envio actions are going to be a game changer",
"its all hosted for testing"
]
},
{
"greetings": [
"gm!",
"gm ser",
"envio is super faaaast"
]
},
{
"greetings": [
"ottie"
]
}
]
}
}
最後に
Envioを使用してみた経験を通じて、ブロックチェインデータのインデックス化が簡単に行えることを理解しました。これは開発者にとって大きなメリットをもたらします。今後もEnvioを使い続け、さらに深い機能を探求していきたいです。Envioに興味のある方は、是非このチュートリアルを試してみてください。
Discussion