コンテンツにスキップ

クイックスタートガイド

Tx Submit APIは、Go言語で書かれたCardanoトランザクション送信APIサービスです。HTTPを介してCBORエンコードされたトランザクションペイロードを受け取り、gOuroborosを使用してOuroboros NetworkのLocalTxSubmissionミニプロトコルに変換します。このプロジェクトはProject Catalyst Fund 9で資金提供されました。

Tx Submit APIはHTTPを介してトランザクションを送信するため、Cardanoブロックチェーンへのトランザクション送信をより高速に行うことができます。

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

開始するには、以下の手順に従ってください。

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


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

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

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

txsubmit-blinklabs-site

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

txsubmit-blinklabs-site-operating-system

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

txsubmit-blinklabs-site-download


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

txsubmit-blinklabs-site-copy-link


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

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

wget -O - https://github.com/blinklabs-io/tx-submit-api/releases/download/v0.20.8/tx-submit-api-v0.20.8-linux-amd64 > tx-submit-api

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

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

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

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

chmod +x $NODE_HOME/tx-submit-api

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

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

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

sudo ufw allow 8090/tcp


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

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

サンプルconfig.yaml:

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

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

echo $CARDANO_NODE_SOCKET_PATH

設定ファイルの詳細な説明はこちらで確認できます: https://github.com/blinklabs-io/tx-submit-api/blob/main/config.yaml.example


ステップ5 - 設定ファイルでTx Submit APIを実行

Section titled “ステップ5 - 設定ファイルでTx Submit APIを実行”

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

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

cd $NODE_HOME
./tx-submit-api -config /path/to/config.yaml

txsubmit-screen

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


💡 ヒント: 以下のコマンドを使用してTx Submit APIが実行されていることを確認できます。必要に応じてポートを調整してください。

curl http://localhost:8090/healthcheck

おめでとうございます!Tx Submit APIでトランザクションを送信する準備が整いました!

Section titled “おめでとうございます!Tx Submit APIでトランザクションを送信する準備が整いました!”

ウォレットを使用してTx Submit APIでトランザクションを送信するには、ウォレットの設定でカスタム送信エンドポイントを設定する必要があります。Tx Submit APIを使用するためのウォレット設定ガイドをご覧ください。