AptosフルノードREST APIを使う
Aptos APIを使用したい場合はこのガイドが最適です。このガイドではAptos APIを使用してAptosブロックチェーンをプラットフォームに統合するための手順を全て解説します。
Aptos統合の詳細なチュートリアルについてはシステム統合ガイドも参照して下さい。
レート制限を理解する
Aptosインデクサーと同様に、Aptos REST APIはトランザクションを送信するかAptosが提供するノード上でAPIをクエリするかに関わらず、IPアドレスごとに5分あたり5000リクエストのレート制限が有ります。(ノードオペレーターは自分のノードの制限を引き上げる事が出来ます。)予告の有無に関わらずこの制限は変更される可能性があります。
現在と過去の状態の閲覧
Aptosブロックチェーンへの統合の殆どは、ブロックチェーンの現在および過去の状態の全体的で包括的な概要から恩恵を受けます。Aptosはトランザクション履歴、状態、イベント、全てのトランザクション実行の結果を提供します。
- トランザクション履歴は実行状態、出力を指定し、関連イベントと連動します。各トランザクションはトランザクションと関連する固有のバージョン番号を持ち、ブロックチェーン台帳の履歴におけるトランザクションのグローバルな連続順序を決定します。
- 状態は特定のバージョンまでの全てのトランザクション出力を代表します。言い換えると状態バージョンは、そのトランザクションバージョンを含む全てのトランザクションの累積です。
- トランザクションの実行時、イベントが発行される場合があります。イベントは、オンチェーンデータの変更に関するヒントです。
必ず最新のフルノードで通信して下さい。フルノードは、トランザクシ ョンから適切なデータを取得するため、あなたのトランザクションを含んだバージョンに達している必要があります。フルノードがバリデーターフルノードから状態を取得する際遅延が発生する可能性があり、真の情報源としてバリデーターノードに依存しているためです。
ノード上のストレージサービスは、ノードからデータを消去する以下の2つの形式のプルーニングを採用しています。
- 状態
- イベント、トランザクション、その他全て
これらのいずれかを無効にする事は出来ますが、状態バージョンの保存は特に持続可能ではありません。
イベントとトランザクションのプルーニングは、storage_config.rs内でenable_ledger_prunerをfalseに設定することで無効に出来ます。これはメインネットのデフォルトの動作です。近い将来Aptosはノードから直接クエリする必要性の低いインデクサーを提供する予定です。
REST APIでは以下の方法でトランザクションのクエリとイベントを実行できます。
View関数で状態を読みとる
View関数はAPIから呼び出された時、ブロックチェーンの状態を変更しません。View関数とその入力を使用すると、潜在的に複雑なオンチェーン状態をMoveを使用して読み取る事が出来ます。例えば、オークションコントラクトで誰が最も高い入札をしたのか評価できます。関連ファイルは以下の通りです。
view_function.rsの例- Moveと関連するコード
- 仕様.
view関数はAptos Simulation APIと同様に動作しますが副作用はなく、出力パスにアクセス出来ます。view関数は/viewエンドポイント経由で呼び出す事が出来ます。view関数の呼び出しにはモジュール名と関数名、およびインプットタイプのパラメーターと値が必要です。
関数は#[view]としてタグ付けされるために不変(immutable)である必要はありませんが、関数が可変(mutable)である場合、APIから呼び出された時状態の変更は発生しません。可変関数に#[view]のタグを付けたい場合は、実行時に悪意を持って呼び出されない様に関数をプライベートにする事を検討して下さい。
View関数を使用するには、Aptos CLIを介して モジュールを公開する必要があります。
Aptos CLIでは、view関数リクエストは以下の様になります。
aptos move view --function-id devnet::message::get_message --profile devnet --args address:devnet
{
"Result": [
"View functions rock!"
]
}
TypeScript SDKでは、view関数リクエストは以下の様になります。
const payload: Gen.ViewRequest = {
function: "0x1::coin::balance",
type_arguments: ["0x1::aptos_coin::AptosCoin"],
arguments: [alice.address().hex()],
};
const balance = await client.view(payload);
expect(balance[0]).toBe("100000000");
view関数は、値のリストをベクトルとして返します。デフォルトでは結果はJSON形式で返されます。ただし、オプションでBinary Canonical Serialization(BCS)エンコード形式で返す事もできます。
最終更新日2024年3月23日