コンテンツにスキップ

クイックスタートガイド

ローカルのCardanoノードとインターフェースし、ノード内部データをHTTPクライアントに提供するHTTP APIです。このサービスは、UNIXソケットを介してOuroborosネットワークプロトコルを使用してCardanoフルノードと通信し、基盤となるNode-to-Client(NtC)Ouroborosミニプロトコルをクライアントに対してREST APIまたはUTxO RPC gRPC APIとして公開します。


Cardano Node APIは、Goで記述されたサービスで、プライベートインターフェースを介してCardanoノードと通信し、協調標準に基づいた機能豊富なHTTP APIセットを提供します。


blinklabs.ioからCardano Node APIのバイナリファイルをノードサーバーにダウンロードするだけです。その後、サーバーのコマンドラインでCardano Node APIを実行します。設定は、設定ファイルまたは環境変数を使用して行うことができます。この例では、設定ファイルを使用して実行します。


以下の手順に従って開始してください


⚠️ このガイドは、一般的なLinux Cardanoノードのセットアップを想定しています。必要に応じてコマンドとパスを調整してください。



ステップ 1 - Blinklabsからバイナリをダウンロード

Section titled “ステップ 1 - Blinklabsからバイナリをダウンロード”

ステップ 1-A - まず、https://blinklabs.io/projects-open-sourceにアクセスし、Cardano Node APIまでスクロールダウンします。

cardano-node-api-blinklabs-site

ステップ 1-B - ノードサーバーのオペレーティングシステムを選択します。

cardano-node-api-blinklabs-site-operating-system

ステップ 1-C - バイナリファイルをダウンロードしてノードサーバーに移動するか、または…

cardano-node-api-blinklabs-site-download


Blinklabsからパスをコピーして、以下のコマンドを実行し、ノードサーバーにバイナリファイルをダウンロードします

cardano-node-api-blinklabs-site-copy-link


⚠️ ダウンロードするバージョンに合わせてリンクパスを調整してください。

💡 ヒント: 最新のCardano Node APIリリースは、https://github.com/blinklabs-io/cardano-node-api/releasesページからダウンロードできます。

wget -O - https://github.com/blinklabs-io/cardano-node-api/releases/download/v0.9.0/cardano-node-api-v0.9.0-linux-amd64 > cardano-node-api


ステップ 2 - パーミッションの変更

Section titled “ステップ 2 - パーミッションの変更”

この例では、バイナリファイルをcardano-node-apiという名前にして、$NODE_HOMEフォルダに保存しました。ファイルを実行可能にするには、以下のコマンドを実行します:


⚠️ 必要に応じてファイルパスとファイル名を調整してください。

chmod +x $NODE_HOME/cardano-node-api


ステップ 3 - 選択したポートでファイアウォールを開放

Section titled “ステップ 3 - 選択したポートでファイアウォールを開放”

選択したポートでファイアウォールが開いていることを確認してください。この例では、ポート8080を使用しました。ポート8080を開放するには、以下のコマンドを実行します:

sudo ufw allow 8080/tcp


ステップ 4 - 設定ファイルのセットアップ

Section titled “ステップ 4 - 設定ファイルのセットアップ”

サンプルconfig.yaml:

node:
network: mainnet
port: 8080
socketPath: /home/user/cardano-my-node/db/socket


💡 ヒント: ノードソケットへのパスを見つけるには、以下のコマンドを実行します:

echo $CARDANO_NODE_SOCKET_PATH

設定ファイルの詳細な説明はこちらにあります: https://github.com/blinklabs-io/cardano-node-api/blob/main/config.yaml.example



ステップ 5 - 設定ファイルを使用してCardano Node APIを実行

Section titled “ステップ 5 - 設定ファイルを使用してCardano Node APIを実行”

コマンドラインフラグ-configを使用して、設定として読み込むファイルを指定し、実行ファイルを実行します。

⚠️ 以下のファイルパスを、config.yamlファイルへのパスに合わせて調整してください。

cd $NODE_HOME
./cardano-node-api -config /path/to/config.yaml

💡 ヒント: control+zを押してからbgと入力すると、バックグラウンドで実行できます。fgを押すとフォアグラウンドに戻ります。



💡 ヒント: IP:port/swagger/index.htmlにアクセスして、Cardano Node APIを確認できます。必要に応じてIPとポートを調整してください。

http://192.0.2.0:8080/swagger/index.html

cardano-node-api-swagger


おめでとうございます、Cardano Node APIを使用する準備ができました!

Section titled “おめでとうございます、Cardano Node APIを使用する準備ができました!”

UTxO RPCについて詳しくはこちら https://utxorpc.org