見出し画像

SubgraphStudioの使用方法|APIキーの作成やクエリURLの見つけ方


Subgraph Studioは、サブグラフを作成および作成し、メタデータを追加して、新しい分散型エクスプローラーに公開するための場所です(詳細はこちら)。


Subgraph Studioでできること:


・StudioUIを使用してサブグラフを作成します
・CLIを使用してサブグラフをデプロイします
・StudioUIを使用してサブグラフを公開する
・サンドボックスでテストする
・クエリURLを使用してステージングに統合します
・特定のサブグラフのAPIキーを作成および管理します


ここSubgraphStudioでは、サブグラフを完全に制御できます。サブグラフを公開する前にテストできるだけでなく、APIキーを特定のドメインに制限し、特定のインデクサーにAPIキーからのクエリのみを許可することもできます。


サブグラフをクエリすると、グラフネットワーク上のインデクサーに報酬を与えるために使用されるクエリ料金が生成されます。dApp開発者またはサブグラフ開発者の場合、Studioを使用すると、より優れたサブグラフを作成して、自分またはコミュニティのクエリを強化できます。スタジオは5つの主要部分で構成されています。


・ユーザーアカウント制御
・作成したサブグラフのリスト
・特定のサブグラフのステータスを管理、詳細の表示、および視覚化するためのセクション
・サブグラフをクエリするために必要なAPIキーを管理するセクション
・請求を管理するセクション


アカウントを作成する方法



1 ウォレットでサインインします-MetaMaskまたはWalletConnectを介してこれを行うことができます



2 サインインすると、アカウントのホームページに一意のデプロイキーが表示されます。これにより、サブグラフを公開するか、APIキーと請求を管理することができます。侵害されたと思われる場合に再生成できる一意のデプロイキーがあります。


Subgraph Studioでサブグラフを作成する方法


最良の部分!最初にサブグラフを作成すると、次のように入力するように指示されます。


あなたのサブグラフ名
画像
説明
カテゴリ
Webサイト


グラフネットワークとのサブグラフの互換性

グラフネットワークは、ホステッドサービスで利用可能なすべてのデータソースと機能をまだサポートできていません。ネットワーク上のインデクサーによってサポートされるためには、サブグラフは次の条件を満たしている必要があります。


インデックスメインネットイーサリアム



次の機能を使用しないでください。


・ipfs.cat & ipfs.map 

・Non-fatal errors 

・Grafting



より多くの機能とネットワークがグラフネットワークに段階的に追加されます。


サブグラフのライフサイクルフロー

画像1

サブグラフを作成すると、CLIまたはコマンドラインインターフェイスを使用してサブグラフを展開できるようになります。CLIを使用してサブグラフを展開すると、サブグラフがスタジオにプッシュされ、プレイグラウンドを使用してサブグラフをテストできるようになります。これにより、最終的にはグラフネットワークに公開できるようになります。CLIセットアップの詳細については、これを確認してください(pst、デプロイキーが手元にあることを確認してください)。デプロイは公開と同じではないことを忘れないでください。サブグラフをデプロイするときは、テストできるStudioにサブグラフをプッシュするだけです。逆に、サブグラフを公開すると、チェーン上で公開されます。


Subgraph Studioでサブグラフをテストする



サブグラフをネットワークに公開する前にテストする場合は、サブグラフプレイグラウンドでテストするか、ログを確認できます。サブグラフログは、サブグラフが失敗した場合にどこで失敗したかを示します。


サブグラフスタジオでサブグラフを公開する


あなたはこれまでにそれを成し遂げました-おめでとうございます!サブグラフを公開するということは、CLI内にサブグラフをデプロイしたときにIPFSハッシュが生成され、ネットワークのイーサリアムスマートコントラクトに保存されることを意味します。サブグラフを正常に公開するには、このブログで概説されている次の手順を実行する必要があります。以下のビデオの概要も確認してください。


公開フローを実行している間、メインネットまたはサポートされているテストネットであるRinkebyのいずれかにプッシュできることを忘れないでください。初めてサブグラフを開発する場合は、無料でRinkebyに公開することから始めることを強くお勧めします。これにより、グラフエクスプローラーでサブグラフがどのように機能するかを確認し、キュレーション要素をテストできます。


メインネットデータにインデックスを付けるサブグラフのみがネットワークに公開できるため、メインネットからのデータにのみインデックスを付けることができます(サブグラフがテストネットに公開されている場合でも)。これは、インデクサーが特定のブロックハッシュの時点で必須のインデックス作成証明レコードを送信する必要があるためです。サブグラフの公開はチェーン上で実行されるアクションであるため、トランザクションが完了するまでに最大で数分かかる場合があることに注意してください。契約の公開に使用するアドレスは、将来のバージョンを公開できる唯一のアドレスになります。賢く選択してください!


サブグラフを公開したので、定期的にサブグラフを管理する方法を見ていきましょう。同期に失敗した場合、サブグラフをネットワークに公開できないことに注意してください。これは通常、サブグラフにバグがあるためです。ログには、それらの問題がどこにあるかが示されます。


CLIを使用したサブグラフのバージョン管理



開発者は、さまざまな理由から、サブグラフを更新することをお勧めします。この場合、CLIを使用して新しいバージョンのサブグラフをStudioにデプロイでき(現時点では非公開になります)、問題がなければ、この新しいデプロイメントをグラフエクスプローラーに公開できます。これにより、キュレーターがシグナリングを開始できるサブグラフの新しいバージョンが作成され、インデクサーはこの新しいバージョンにインデックスを付けることができます。


最近まで、開発者は、サブグラフのメタデータを更新するために、サブグラフの新しいバージョンをデプロイしてエクスプローラーに公開することを余儀なくされていました。これで、開発者は新しいバージョンを公開しなくても、サブグラフのメタデータを更新できます。開発者は、グラフエクスプローラーの[詳細の更新]オプションをオンにすることで、Studioのサブグラフの詳細(プロフィール写真、名前、説明など)を更新できます。これをオンにすると、新しい展開で新しいバージョンを公開しなくても、エクスプローラーでサブグラフの詳細を更新するオンチェーントランザクションが生成されます。


新しいバージョンのサブグラフをネットワークに公開することに関連するコストがあることに注意してください。開発者は、取引手数料に加えて、自動移行信号に対するキュレーション税の一部にも資金を提供する必要があります。キュレーターがサブグラフの合図を出していない場合、サブグラフの新しいバージョンを公開することはできません。キュレーションのリスクの詳細については、もっと読みくださいここに。


APIキーの管理



dApp開発者であるかサブグラフ開発者であるかに関係なく、APIキーを管理する必要があります。APIキーは、アプリケーションサービス間の接続が有効で承認されていることを確認するため、これはサブグラフをクエリできるようにするために重要です。これには、アプリケーションを使用したエンドユーザーとデバイスの認証が含まれます。


Studioは、既存のAPIキーを一覧表示します。これにより、それらを管理または削除することができます。


1 概要セクションはあなたをできるようになります:

キー名を編集する
APIキーを再生成します
統計を使用してAPIキーの現在の使用状況を表示します。
クエリの数
費やしたGRTの量

2 下にセキュリティ設定を管理し、あなたがあなたのAPIキーを経由したいのですが、コントロールのレベルに応じたセキュリティ設定に選ぶことができるようになります。このセクションでは、次のことができます。

APIキーの使用を許可されたドメイン名を表示および管理する
APIキーでクエリできるサブグラフを割り当てることができます


サブグラフを管理する方法


APIキーは別として、サブグラフを管理するための多くのツールを自由に使用できます。サブグラフは、ステータスとカテゴリ別に整理できます。


ステータスタグは、タグの様々なを含む間で選択することができます<created>、<deployed>、<published>、<archived>、など
一方、カテゴリでは、サブグラフがどのカテゴリに分類されるかを指定できます。オプションなどが<DeFi>、<NFTs>、<Governance>、など

マルチシグウォレットの使用



Subgraph Studioは現在、マルチシグウォレットを使用した署名をサポートしていません。それまでは、GNSコントラクト関数を呼び出してサブグラフを公開する方法について、このガイドに従うことができます。


サブグラフを作成する



通常のウォレットを使用するのと同様に、SubgraphStudioで非マルチシグウォレットを接続することでサブグラフを作成できます。ウォレットを接続したら、新しいサブグラフを作成するだけです。該当する場合は、サブグラフ名、説明、画像、ウェブサイト、ソースコードのURLなどのすべての詳細を必ず入力してください。


スターターサブグラフを初期化するには、UIに表示されるコマンドに従うか、単に実行します。


graph init --studio <SUBGRAPH_SLUG>



SUBGRAPH_SLUGUIまたはブラウザのURLからコピーできるサブグラフの名前です。このコマンドは、サブグラフの開発を開始するために必要なすべてのファイルを含むフォルダーをファイルシステムに作成する必要があります。


サブグラフをデプロイする



サブグラフをグラフノードにデプロイする準備ができたら、UIに表示されるコマンドに従うか、次のコマンドを実行します。


graph deploy --studio <SUBGRAPH_SLUG>


注:コマンドを実行する前に、サブグラフフォルダー内にいることを確認してください。


サブグラフまたはバージョン番号を公開する

新しいサブグラフを分散型ネットワークに公開するか、以前に公開したサブグラフの新しいバージョンを公開することができます。


新しいサブグラフを公開する


マルチシグウォレットを使用してサブグラフを公開するには、いくつかの方法があります。ここでは、Etherscanを使用publishNewSubgraphしてGNSコントラクトで関数を呼び出す方法について説明します。


その関数を使用する前に、その関数の入力引数を生成する必要があります。Subgraph Studioでこのページにアクセスし、以下を提供します。


マルチシグウォレットのイーサリアムアドレス
公開したいサブグラフ
公開したいバージョン



「引数の取得」をクリックすると、すべての契約引数が生成されます。


4つの引数が必要です。


・graphAccount:マルチシグアカウントのアドレスはどれですか
・subgraphDeploymentID:そのサブグラフのデプロイメントIDの16進ハッシュ
・versionMetadata:IPFSにアップロードされるバージョンメタデータ(ラベルと説明)。そのJSONファイルの16進ハッシュ値が提供されます。
・subgraphMetadata:バージョンメタデータと同様に、サブグラフメタデータ(名前、画像、説明、Webサイト、ソースコードのURL)がIPFSにアップロードされ、そのJSONファイルの16進ハッシュ値が提供されます


これらの4つの引数を使用すると、次のことができるようになります。


・私たちのGraphProxyのEtherscanの契約を訪問
・マルチシグのWalletConnectSafeアプリを介してWalletConnectを使用してEtherscanに接続します
・publishNewSubgraphツールによって生成されたパラメーターを使用してメソッドを呼び出します



新しいバージョンを公開する



既存のサブグラフの新しいバージョンを公開するには、最初にその入力引数を生成する必要があります。Subgraph Studioでこのページにアクセスし、以下を提供します。


・マルチシグウォレットのイーサリアムアドレス
・公開したいサブグラフ
・公開したいバージョン
・グラフエクスプローラーで更新するサブグラフのID

「引数の取得」をクリックすると、すべてのコントラクト引数が生成されます。

Publish New Versionタイトルの下のUIの右側には、次の4つの引数があります。
・graphAccount:Multisigアカウントのアドレスはどれですか
・subgraphNumber:は、すでに公開されているサブグラフの番号です。これは、グラフネットワークサブグラフを介してクエリされた公開サブグラフのサブグラフIDの一部です。
・subgraphDeploymentID:これは、そのサブグラフのデプロイメントIDの16進ハッシュです。
・versionMetadata:バージョンメタデータ(ラベルと説明)がIPFSにアップロードされ、そのJSONファイルの16進ハッシュ値が提供されます

これですべての引数が生成されたので、続行してpublishNewVersionメソッドを呼び出す準備ができました。そのためには、次のことを行う必要があります。

・GraphProxyのEtherscanの契約を訪問
・MultisigのWalletConnectSafeアプリを介してWalletConnectを使用してEtherscanに接続します
・publishNewVersionツールによって生成されたパラメーターを使用してメソッドを呼び出します


トランザクションが成功すると、サブグラフのグラフエクスプローラーに新しいバージョンのサブグラフが表示されます。これは、キュレーターがサブグラフのシグナリングを開始し、インデクサーがインデックス作成を開始できることを意味します。


サブグラフスタジオでの請求



請求書は、顧客が支払うべき支払い金額の明細書であり、通常、システムで毎週生成されます。APIキーを使用して生成したクエリ料金に基づいて料金を支払う必要があります。請求契約はPolygonネットワーク上にあります。これにより、次のことが可能になります。


・GRTの追加と削除
・アカウントに追加したGRTの量、削除した量、および請求書に基づいて残高を追跡します
・生成されたクエリ料金に基づいて自動的に支払いを清算します



アカウントにGRTを追加するには、次の手順を実行する必要があります。


1 お好みの取引所でGRTとETHを購入する

2 GRTとETHをウォレットに送信します

3 UIを使用してGRTをポリゴンにブリッジする


a)ポリゴンブリッジに任意の量のGRTを送信した後、数分で0.001マティックを受け取ります。検索バーに住所を入力することで、Polygonscanで取引を追跡できます。


4 ブリッジGRTをPolygonの請求契約に追加します。請求契約アドレスは0xa382f75b375d6a07bfd1af99d4383c6e1d1c4004です。


a)ステップ4を完了するには、ウォレット内のネットワークをポリゴンに切り替える必要があります。ウォレットを接続し、ここで「マティック(ポリゴン)メインネットを選択」をクリックすると、ポリゴンのネットワークを追加できます。ネットワークを追加したら、右上隅にあるネットワークピルに移動して、ウォレットでネットワークを切り替えます。Metamaskでは、ネットワークはMaticMainnnetと呼ばれます。


毎週の終わりに、APIキーを使用した場合、この期間中に生成したクエリ料金に基づいて請求書を受け取ります。この請求書は、残高で利用可能なGRTを使用して支払われます。クエリボリュームは、所有しているAPIキーによって評価されます。手数料が引き落とされた後、残高が更新されます。


請求プロセスの手順は次のとおりです。



請求書の状態は次の4つです。


作成済み-請求書が作成されたばかりで、まだ支払われていません
支払い済み-請求書は正常に支払われました
未払い-請求契約の残高に十分なGRTがありません
エラー-支払いの処理中にエラーが発生しました
詳細については、以下の図を参照してください。

画像2

請求フロー


Subgraph Studioでの請求の仕組みの簡単なデモについては、以下のビデオをご覧ください。

サブグラフスタジオのFAQ



1. APIキーを作成するにはどうすればよいですか?



Subgraph Studioでは、必要に応じてAPIキーを作成し、それぞれにセキュリティ設定を追加できます。


2.複数のAPIキーを作成できますか?



A:はい!さまざまなプロジェクトで使用する複数のAPIキーを作成できます。こちらのリンクをご覧ください。


3. APIキーのドメインを制限するにはどうすればよいですか?



APIキーを作成した後、[セキュリティ]セクションで、特定のAPIキーをクエリできるドメインを定義できます。


4.使用したいサブグラフの開発者でない場合、サブグラフのクエリURLを見つけるにはどうすればよいですか?


各サブグラフのクエリURLは、グラフエクスプローラーの[サブグラフの詳細]セクションにあります。[クエリ]ボタンをクリックすると、関心のあるサブグラフのクエリURLを表示できるペインが表示されます。次に、<api_key>プレースホルダーを利用するAPIキーに置き換えることができます。サブグラフスタジオで。


自分でサブグラフを作成する場合でも、APIキーを作成し、ネットワークに公開されているサブグラフをクエリできることを忘れないでください。新しいAPIキーを介したこれらのクエリは、ネットワーク上の他のクエリと同様に有料クエリです。






この記事が気に入ったらサポートをしてみませんか?