🌐

Avalanche: avalanche-network-runner コマンドまとめ

2022/09/24に公開

avalanche-network-runner (ANR)

ANRを使用すると、ユーザーは Avalanche ノードのネットワークを定義、作成、および操作できます。

※このツールは本番ノードを実行するためのものではなく、現在大規模に開発されているため、ドキュメントは実際のコードとわずかに異なる場合があることに注意してください。

リポジトリ: https://github.com/ava-labs/avalanche-network-runner

簡易アーキテクチャ

バイナリを実行すると、ユーザーは RPC サーバーにリクエストを送信して、ネットワークの開始、サブネットの作成、ネットワークへのノードの追加、ネットワークからのノードの削除、ノードの再起動などを行うことができます。

avalanche-network-runner コマンドまたは API 呼び出しを使用してリクエストを行うことができます。 リクエストは gRPC に「変換」され、サーバーに送信されます。

インストール

ANRを使用するには、主に 2 つの方法があります。

  • ANR をバイナリとして実行する
    • ほとんどのユースケースで推奨されるアプローチ
  • Go言語を使用して実行する
    • カスタム ネットワーク シナリオと高い柔軟性が可能になりますが、より多くのコードを記述する必要があります。
# バイナリとして実行する方法
# 最新リリースのバイナリをダウンロードする。
curl -sSfL https://raw.githubusercontent.com/ava-labs/avalanche-network-runner/main/scripts/install.sh | sh -s

# インストールしたバイナリをパスに追加する。
# パスに永続的に追加するには、エクスポート コマンドをシェル初期化スクリプト (例: .bashrc) に追加します。
cd bin
export PATH=$PWD:$PATH

1. avalanche-network-runner [commands]

avalanche-network-runnerのコマンド一覧。

1.1. 使用方法

avalanche-network-runner [command]
avalanche-network-runner [flag]

1.2. 利用可能コマンド

コマンド 内容
completion 指定されたシェルのオートコンプリート スクリプトを生成します。
control ネットワーク ランナー コントローラーを起動します。
help コマンドに関するヘルプ
ping サーバーに ping を実行します。
server ネットワーク ランナー サーバーを起動します。

1.3. フラグ

コマンド 内容
-h, --help Avalanche-network-runner のヘルプ。
-v, --version Avalanche-network-runner のバージョン。

2. avalanche-network-runner completion

指定されたシェルの avalanche-network-runner のオートコンプリート スクリプトを生成します。

2.1. 使用方法

avalanche-network-runner completion [command]
avalanche-network-runner completion [flag]

2.2. 利用可能コマンド

コマンド 内容
bash bash のオートコンプリート スクリプトを生成します。
fish fish のオートコンプリート スクリプトを生成します。
powershell powershell のオートコンプリート スクリプトを生成します。
zsh zsh のオートコンプリート スクリプトを生成します。

2.3. フラグ

コマンド 内容
-h, --help completion のヘルプ。

3. avalanche-network-runner control

ネットワーク ランナー コントローラーを起動します。

3.1. 使用方法

avalanche-network-runner control [command]
avalanche-network-runner control [flag]

3.2. 利用可能コマンド

サブコマンド 内容
add-node ネットワークに新しいノードを追加します。
attach-peer ピアをノードに接続します。
create-blockchains ブロックチェーンを作成します。
create-subnets サブネットを作成します。
get-snapshot-names サーバーにスナップショットのリストを取得するように要求します。
health サーバーの正常性を要求します。
load-snapshot サーバーにネットワーク スナップショットをロードするように要求します。
remove-node ノードを削除します。
remove-snapshot サーバーにネットワーク スナップショットを削除するように要求します。
restart-node ノードを再起動します。
save-snapshot サーバーにネットワーク スナップショットを保存するように要求します。
send-outbound-message 接続されたピアにアウトバウンド メッセージを送信します。
start 接続されたピアにアウトバウンド メッセージを送信します。
status サーバーの状態を要求します。
stop サーバーの停止を要求します。
stream-status サーバーのブートストラップ ステータスを要求します。
uris サーバー URI を要求します。

3.3. フラグ

オプション 内容
--dial-timeout duration サーバーのダイヤル タイムアウト (デフォルトは 10 秒)
--endpoint string サーバー エンドポイント (デフォルト "0.0.0.0:8080")
-h, --help コントロールのヘルプ
--log-level string ログレベル (デフォルトは「INFO」)
--request-timeout duration client request timeout (default 3m0s)

4. avalanche-network-runner ping

サーバーに ping を実行します。

4.1. 使用方法

avalanche-network-runner ping [options] [flags]

4.3. フラグ

オプション 内容
--dial-timeout duration サーバーのダイヤル タイムアウト (デフォルトは 10 秒)
--endpoint string サーバー エンドポイント (デフォルト "0.0.0.0:8080")
-h, --help コントロールのヘルプ
--log-level string ログレベル (デフォルトは「INFO」)
--request-timeout duration client request timeout (default 3m0s)

5. avalanche-network-runner server

ネットワーク ランナー サーバーを起動します。

5.1. 使用方法

avalanche-network-runner server [options] [flags]

5.2. フラグ

オプション 内容
--dial-timeout duration サーバーのダイヤル タイムアウト (デフォルトは 10 秒)
--disable-grpc-gateway grpc-gateway サーバーを無効にする場合は true (--grpc-gateway-port を上書き)
--grpc-gateway-port string grpc-gateway サーバー ポート (デフォルト ":8081")
-h, --help コントロールのヘルプ
--log-dir string ログディレクトリ
--log-level string ログレベル (デフォルトは「INFO」)
--port string サーバーポート (デフォルト ":8080")
--snapshots-dir string スナップショットのディレクトリ

Discussion