description
このマニュアルでは、海外ギルドオペレーター制作のツールを組み合わせてブロックログを表示させるプログラムとなっております。

ステークプールブロックログ導入手順

{% hint style="info" %} 最終更新日：2022/02/19 {% endhint %}

🎉 ∞ お知らせ

{% hint style="info" %} このツールは海外ギルドオペレーター制作のCNCLI By AndrewWestberg、logmonitor by Guild Operators、Guild LiveView、BLOCK LOG for CNToolsを組み合わせたツールとなっております。カスタマイズするにあたり、開発者のAHLNET(AHL)にご協力頂きました。ありがとうございます。 {% endhint %}

🏁 0. 前提条件

稼働ノード

BPノード限定

稼働要件

４つのサービス(プログラム)をsystemd × tmuxにて常駐させます。
ブロックチェーン同期用DBを新しく設置します(sqlite3)
日本語マニュアルのフォルダ構成に合わせて作成されています。
vrf.skey と vrf.vkeyが必要です。

ハードウェア最小構成

オペレーティング・システム: 64-bit Linux (Ubuntu 20.04 LTS)
プロセッサー: 1.6GHz以上(ステークプールまたはリレーの場合は2Ghz以上)の2つ以上のコアを備えたIntelまたはAMD x86プロセッサー
メモリ：16GB
SSD：50GB以上

インストール及びダウンロードツール内容

CNCLI (依存プログラム含む)　(コミュニティ製Cardano CLI)
sqlite3 (データベースソフト)
logmonitor.sh (ノードログ抽出プログラム)
block.sh　(ブロックログ表示ブログラム)
cncli.sh　(CNCLI操作用プログラム)
cntools.config (設定ファイル)
cntools.library　(ライブラリファイル)
env (設定ファイル)
gLiveView.sh (ノード監視ツール)

{% endhint %}

🏁 1. CNCLIをインストールする

{% hint style="info" %} AndrewWestbergさんによって開発されたCNCLIはプールのブロック生成スケジュールを算出ツールを開発し、Shelley期におけるSPOに革命をもたらしました。 {% endhint %}

RUST環境を準備します

mkdir $HOME/.cargo && mkdir $HOME/.cargo/bin
chown -R $USER $HOME/.cargo
touch $HOME/.profile
chown $USER $HOME/.profile

rustupをインストールします-デフォルトのインストールを続行します（オプション1）

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Proceed with installation (default) 1を入力してEnter

source $HOME/.cargo/env
rustup install stable
rustup default stable
rustup update
rustup component add clippy rustfmt

依存関係をインストールし、cncliをビルドします

source $HOME/.cargo/env
sudo apt-get update -y && sudo apt-get install -y automake build-essential pkg-config libffi-dev libgmp-dev libssl-dev libtinfo-dev libsystemd-dev zlib1g-dev make g++ tmux git jq wget libncursesw5 libtool autoconf
cd $HOME/git
git clone https://github.com/AndrewWestberg/cncli
cd cncli
git checkout v4.0.4
cargo install --path . --force

CNCLIのバージョンを確認します。

cncli --version

🏁 2. sqlite3をインストールする

sudo apt install sqlite3
sqlite3 --version

3.31.1以上のバージョンがインストールされたらOKです。

🏁 3. 各種ファイルをダウンロードする

依存関係のあるプログラムをダウンロードします。

{% hint style="info" %} 海外のギルドオペレーターによって開発された革新的な各種ツールです。 {% endhint %}

cd $NODE_HOME
mkdir scripts
cd $NODE_HOME/scripts
wget -N https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/cncli.sh
wget -N https://raw.githubusercontent.com/btbf/coincashew/master/guild-tools/cntools.config
wget -N https://raw.githubusercontent.com/btbf/coincashew/master/guild-tools/cntools.library
wget -N https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/env
wget -N https://raw.githubusercontent.com/btbf/coincashew/master/guild-tools/logMonitor.sh
wget -N https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/gLiveView.sh
wget -N https://raw.githubusercontent.com/btbf/coincashew/master/guild-tools/blocks.sh

3-1.パーミッションを設定する

chmod 755 cncli.sh
chmod 755 logMonitor.sh
chmod 755 gLiveView.sh
chmod 755 blocks.sh
cd ../
chmod 400 vrf.vkey

3-2.設定ファイルを修正する

envファイルを修正します

PORT=`grep "PORT=" $NODE_HOME/startBlockProducingNode.sh`
b_PORT=${PORT#"PORT="}
echo "BPポートは${b_PORT}です"

sed -i $NODE_HOME/scripts/env \
  -e '1,73s!#CCLI="${HOME}/.cabal/bin/cardano-cli"!CCLI="/usr/local/bin/cardano-cli"!' \
  -e '1,73s!#CNODE_HOME="/opt/cardano/cnode"!CNODE_HOME='${NODE_HOME}'!' \
  -e '1,73s!#CNODE_PORT=6000!CNODE_PORT='${b_PORT}'!' \
  -e '1,73s!#CONFIG="${CNODE_HOME}/files/config.json"!CONFIG="${CNODE_HOME}/mainnet-config.json"!' \
  -e '1,73s!#SOCKET="${CNODE_HOME}/sockets/node0.socket"!SOCKET="${CNODE_HOME}/db/socket"!' \
  -e '1,73s!#BLOCKLOG_TZ="UTC"!BLOCKLOG_TZ="Asia/Tokyo"!'

cncli.shファイルを修正します。

プールID取得

pool_ID=`cat $NODE_HOME/stakepoolid.txt`
echo "プールIDは${pool_ID}です"

sed -i $NODE_HOME/scripts/cncli.sh \
  -e '1,73s!#POOL_ID=""!POOL_ID='${pool_ID}'!' \
  -e '1,73s!#POOL_VRF_SKEY=""!POOL_VRF_SKEY="${CNODE_HOME}/vrf.skey"!' \
  -e '1,73s!#POOL_VRF_VKEY=""!POOL_VRF_VKEY="${CNODE_HOME}/vrf.vkey"!'

🏁 4.サービスファイル5種類を作成・登録します。

cd $NODE_HOME
mkdir service
cd service

{% tabs %} {% tab title="cncli" %}

cat > $NODE_HOME/service/cnode-cncli-sync.service << EOF 
# file: /etc/systemd/system/cnode-cncli-sync.service

[Unit]
Description=Cardano Node - CNCLI sync
BindsTo=cardano-node.service
After=cardano-node.service

[Service]
Type=oneshot
RemainAfterExit=yes
Restart=on-failure
RestartSec=20
User=$(whoami)
WorkingDirectory=$NODE_HOME/scripts
ExecStart=/bin/bash -c "sleep 5;/usr/bin/tmux new -d -s cncli"
ExecStartPost=/usr/bin/tmux send-keys -t cncli ./cncli.sh Space sync Enter
ExecStop=/usr/bin/tmux kill-session -t cncli
KillSignal=SIGINT
RestartKillSignal=SIGINT
SuccessExitStatus=143
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cnode-cncli-sync
TimeoutStopSec=5

[Install]
WantedBy=cardano-node.service
EOF

{% endtab %}

{% tab title="validate" %}

cat > $NODE_HOME/service/cnode-cncli-validate.service << EOF 
# file: /etc/systemd/system/cnode-cncli-validate.service

[Unit]
Description=Cardano Node - CNCLI validate
BindsTo=cnode-cncli-sync.service
After=cnode-cncli-sync.service

[Service]
Type=oneshot
RemainAfterExit=yes
Restart=on-failure
RestartSec=20
User=$(whoami)
WorkingDirectory=$NODE_HOME/scripts
ExecStart=/bin/bash -c "sleep 10;/usr/bin/tmux new -d -s validate"
ExecStartPost=/usr/bin/tmux send-keys -t validate ./cncli.sh Space validate Enter
ExecStop=/usr/bin/tmux kill-session -t validate
KillSignal=SIGINT
RestartKillSignal=SIGINT
SuccessExitStatus=143
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cnode-cncli-validate
TimeoutStopSec=5

[Install]
WantedBy=cnode-cncli-sync.service
EOF

{% endtab %}

{% tab title="leaderlog" %}

cat > $NODE_HOME/service/cnode-cncli-leaderlog.service << EOF 
# file: /etc/systemd/system/cnode-cncli-leaderlog.service

[Unit]
Description=Cardano Node - CNCLI Leaderlog
BindsTo=cnode-cncli-sync.service
After=cnode-cncli-sync.service

[Service]
Type=oneshot
RemainAfterExit=yes
Restart=on-failure
RestartSec=20
User=$(whoami)
WorkingDirectory=$NODE_HOME/scripts
ExecStart=/bin/bash -c "sleep 15;/usr/bin/tmux new -d -s leaderlog"
ExecStartPost=/usr/bin/tmux send-keys -t leaderlog ./cncli.sh Space leaderlog Enter
ExecStop=/usr/bin/tmux kill-session -t leaderlog
KillSignal=SIGINT
RestartKillSignal=SIGINT
SuccessExitStatus=143
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cnode-cncli-leaderlog
TimeoutStopSec=5

[Install]
WantedBy=cnode-cncli-sync.service
EOF

{% endtab %}

{% tab title="logmonitor" %}

cat > $NODE_HOME/service/cnode-logmonitor.service << EOF 
# file: /etc/systemd/system/cnode-logmonitor.service

[Unit]
Description=Cardano Node - CNCLI logmonitor
BindsTo=cnode-cncli-sync.service
After=cnode-cncli-sync.service

[Service]
Type=oneshot
RemainAfterExit=yes
Restart=on-failure
RestartSec=20
User=$(whoami)
WorkingDirectory=$NODE_HOME
ExecStart=/bin/bash -c "sleep 20;/usr/bin/tmux new -d -s logmonitor"
ExecStartPost=/usr/bin/tmux send-keys -t logmonitor $NODE_HOME/scripts/logMonitor.sh Enter
ExecStop=/usr/bin/tmux kill-session -t logmonitor
KillSignal=SIGINT
RestartKillSignal=SIGINT
SuccessExitStatus=143
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=cnode-logmonitor
TimeoutStopSec=5

[Install]
WantedBy=cnode-cncli-sync.service
EOF

{% endtab %}

{% endtabs %}

4-1サービスファイルをシステムフォルダにコピーして権限を付与します。

1行づつコマンドに貼り付けてください

sudo cp $NODE_HOME/service/cnode-cncli-sync.service /etc/systemd/system/cnode-cncli-sync.service
sudo cp $NODE_HOME/service/cnode-cncli-validate.service /etc/systemd/system/cnode-cncli-validate.service
sudo cp $NODE_HOME/service/cnode-cncli-leaderlog.service /etc/systemd/system/cnode-cncli-leaderlog.service
sudo cp $NODE_HOME/service/cnode-logmonitor.service /etc/systemd/system/cnode-logmonitor.service

sudo chmod 644 /etc/systemd/system/cnode-cncli-sync.service
sudo chmod 644 /etc/systemd/system/cnode-cncli-validate.service
sudo chmod 644 /etc/systemd/system/cnode-cncli-leaderlog.service
sudo chmod 644 /etc/systemd/system/cnode-logmonitor.service

4-2サービスファイルを有効化します

sudo systemctl daemon-reload
sudo systemctl enable cnode-cncli-sync.service
sudo systemctl enable cnode-cncli-validate.service
sudo systemctl enable cnode-cncli-leaderlog.service
sudo systemctl enable cnode-logmonitor.service

🏁 5.ブロックチェーンとDBを同期する

cncli-syncサービスを開始しログ画面を表示します

sudo systemctl start cnode-cncli-sync.service

5秒後に実行

tmux a -t cncli

{% hint style="info" %} 「100.00% synced」になるまで待ちます。
100%になったら、Ctrl+bを押した後に d を押し元の画面に戻ります(バックグラウンド実行に切り替え) {% endhint %}

🏁 6.過去のブロック生成実績をDBに登録します。

cd $NODE_HOME/scripts
./cncli.sh init

🏁 7.ログファイルを作成するように設定する

cd $NODE_HOME
nano mainnet-config.json

defaultScribesを下記のように書き換える

 "defaultScribes": [
   [
     "FileSK",
     "logs/node.json"
   ],
   [
     "StdoutSK",
     "stdout"
   ]
 ],

setupScribesを下記のように書き換える

  "setupScribes": [
   {
     "scFormat": "ScJson",
     "scKind": "FileSK",
     "scName": "logs/node.json"
   },
   {
     "scFormat": "ScText",
     "scKind": "StdoutSK",
     "scName": "stdout",
     "scRotation": null
   }
 ]

Ctrl+Oでファイルを保存し、Ctrl+Xで閉じる

ノードを再起動する

sudo systemctl reload-or-restart cardano-node

cardano-nodeを再起動すると、以下サービスも連動して再起動します。
5秒間隔で起動されます
cnode-cncli-sync.service
cnode-cncli-validate.service
cnode-cncli-leaderlog.service
cnode-logmonitor.service

tmux起動確認

tmux ls

{% hint style="info" %} ノードを再起動してから、約20秒後に4プログラムがバックグラウンドで起動中であればOKです

cncli
validate
leaderlog
logmonitor {% endhint %}

{% hint style="info" %}

●各種サービスをストップする方法

sudo systemctl stop cnode-cncli-sync.service

上記コマンドを実行すると以下サービスも連動して止まります
cnode-cncli-validate.service
cnode-cncli-leaderlog.service
cnode-logmonitor.service

sudo systemctl stop cnode-logmonitor.service

●各種サービスを再起動する方法

sudo systemctl reload-or-restart cnode-cncli-sync.service

上記コマンドを実行すると以下サービスも連動して止まります
cnode-cncli-validate.service
cnode-cncli-leaderlog.service
cnode-logmonitor.service {% endhint %}

7-1.　3プログラムのログ画面を確認します。

{% tabs %}

{% tab title="validate" %} {% hint style="info" %} こちらのプログラムは生成したブロックが、ブロックチェーン上に記録されているか照合するためのプログラムです {% endhint %}

tmux a -t validate

以下表示なら正常です。

~ CNCLI Block Validation started ~

Ctrl+bを押した後すぐにd でバックグラウンド実行に切り替えます(デタッチ) {% endtab %}

{% tab title="leaderlog" %}

{% hint style="info" %} こちらのプログラムはスロットリーダーを自動的に算出するプログラムです。
次エポックの1.5日前から次エポックのスケジュールを算出することができます。 {% endhint %}

tmux a -t leaderlog

以下の表示なら正常です。
スケジュール予定がある場合、表示されるまでに5分ほどかかります。

~ CNCLI Leaderlog started ~

Ctrl+bを押した後すぐにd でバックグラウンド実行に切り替えます(デタッチ) {% endtab %}

{% tab title="logmonitor" %}

{% hint style="info" %} こちらのプログラムはプールのノードログからブロック生成結果を抽出します。 {% endhint %}

tmux a -t logmonitor

以下の表示なら正常です。

~~ LOG MONITOR STARTED ~~
monitoring logs/node.json for traces

Ctrl+bを押した後すぐにd でバックグラウンド実行に切り替えます(デタッチ) {% endtab %}

{% endtabs %}

🏁 8.ブロックログを表示する

このツールでは上記で設定してきたプログラムを組み合わせ、割り当てられたスロットリーダーに対してのブロック生成結果をデータベースに格納し、確認することができます。

cd $NODE_HOME/scripts
./blocks.sh

{% hint style="info" %} スクリプトへのパスを通し、任意の単語で起動出来るようにする。

echo alias blocks="'cd $NODE_HOME/scripts; ./blocks.sh'" >> $HOME/.bashrc
source $HOME/.bashrc

単語を入力するだけで、どこからでも起動できます。
blocks・・・blocks.sh
glive・・・gLiveView.sh

{% endhint %}

（ｓ）実績概要---エポック毎のブロック生成実績参照
（ｅ）エポック詳細---個別エポックのブロック生成スケジュールおよび生成実績参照

ブロックステータス:

Leader - ブロック生成予定スロット
Ideal - アクティブステーク（シグマ）に基づいて割り当てられたブロック数の期待値/理想値
Luck - 期待値における実際に割り当てられたスロットリーダー数のパーセンテージ
Adopted - ブロック生成成功
Confirmed - 生成したブロックのうち確実にオンチェーンであることが検証されたブロック set in 'cncli.sh' for 'CONFIRM_BLOCK_CNT'
Missed - スロットでスケジュールされているが、 cncli DB には記録されておらず他のプールがこのスロットのためにブロックを作った可能性
Ghosted - ブロックは作成されましたが「Orpah(孤立ブロック)」となっております。スロットバトル・ハイトバトルで敗北したか、ブロック伝播の問題で有効なブロックになっていません
Stolen - 別のプールに有効なブロックが登録されているため、スロットバトルで敗北した可能性。
Invalid - プールはブロックの作成に失敗しました。base64でエンコードされたエラーメッセージ。次のコードでデコードできます 'echo | base64 -d | jq -r' {% endhint %}

メニュー項目が文字化けする場合は、システム文字コードが「UTF-8」であることを確認してください。

echo $LANG

🏁 9.gLiveViewでブロック生成サマリを確認する

cd $NODE_HOME/scripts
./gLiveView.sh

9-1. 次エポックのスケジュールを算出する

次エポックの1.5日前から次エポックのブロック生成スケジュールを算出することができます。

blocks.shを起動し、直近にブロック生成スケジュールが無いことを確認する

blocks

ノードを再起動する

sudo systemctl reload-or-restart cardano-node

cardano-nodeを再起動すると、5秒間隔で以下サービスも連動して再起動します。
cnode-cncli-sync.service
cnode-cncli-validate.service
cnode-cncli-leaderlog.service
cnode-logmonitor.service

5分～10分後にblocks.shを起動する

blocks

[e] エポック詳細 を選択し
「次エポック[＊＊＊]のスロットリーダースケジュールが表示可能になっています」が表示されていればOKです

スケジュールが無い場合、上記の文言は表示されません。以下のコマンドを使って算出内容を確認してください

tmux a -t leaderlog

9-2. ブロック生成スケジュール算出のタイミングについて

算出タイミングは、エポックスロットが約302400を過ぎてから次エポックのスケジュールを取得できるようになります。(次エポックの1.5日前)
取得するには、手動でノードを再起動します。(いろんな要素があって手動運用にしています)

1エポックで1ブロック割り当てられるために必要な委任量の目安は以下の通りです。%は確率
1M 60%
2M 85%
3M 95%

プール開設時は、2エポック後から割り当てがスタートします。
303 プール登録
304 待機期間次エポックスケジュール算出
305 委任有効ブロック生成
306 報酬計算
307 報酬振り込み

🏁 10. ブロック生成ステータスを通知する

{% hint style="info" %} ブロックログDBに保存されるブロック生成ステータスをLINEまたはDiscordに通知することができます。
設定手順はブロック生成ステータス通知設定手順を参照してください。 {% endhint %}

🏁 100. CNCLI更新手順

以下は最新版がリリースされた場合に実行してください

cncli旧バージョンからの更新手順

{% hint style="info" %} １時間以内にブロック生成スケジュールがないことを確認してから、以下を実施してください {% endhint %}

rustup update
cd $HOME/git/cncli
git fetch --all --prune
git checkout v4.0.4
cargo install --path . --force

バージョンを確認する

cncli --version

ノードを再起動する

sudo systemctl reload-or-restart cardano-node

ノードが同期したことを確認する

tmux a -t cncli

100% syncedになったことを確認する

各サービスを表示し、envまたはcncli.shのアップデートメッセージがある場合は"n"で拒否

tmux a -t leaderlog
tmux a -t validate

envまたはcncli.shのアップデートが必要になった場合は改めてアナウンスします。

101.スケジュールにないブロックが生成される場合

CNCLIのブロック生成スケジュールは正しい値が取得できていれば、100%正確です。
cncli.dbを再作成することで正しいスケジュールを取得することができます。

修正手順

・サービスを止める

sudo systemctl stop cnode-cncli-sync.service

cncli.dbを削除する

cd $NODE_HOME/guild-db/cncli
rm cncli.db

サービスを起動し、同期が100％になるまで待つ

sudo systemctl start cnode-cncli-sync.service
tmux a -t cncli

リーダースケジュールを再取得する

tmux a -t leaderlog
(Ctrl+C)で処理を中断する
$NODE_HOME/scripts/cncli.sh leaderlog force

過去のブロック生成実績をDBに登録する

cd $NODE_HOME/scripts
./cncli.sh init

102.blocks.shアップデート(2021/10/7以前から設定している場合)

cd $NODE_HOME/scripts
rm blocks.sh
wget https://raw.githubusercontent.com/btbf/coincashew/master/guild-tools/blocks.sh
chmod 755 blocks.sh

・アップデート内容 blocks起動時にenvファイルやcncli.shの更新(ｙ)を行うとファイル破損が発生する症状を修正

■envファイルバグ修正提出(alpha修正済み) ●症状　cncli.sh更新時にパーミッションが正しく設定されない問題

コード上の記述修正issuesを提出→受理済み cardano-community/guild-operators#1135

次回envファイル更新時に修正されるため、(y)で更新をお願いします。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

ステークプールブロックログ導入手順

🎉 ∞ お知らせ

🏁 0. 前提条件

稼働ノード

稼働要件

ハードウェア最小構成

インストール及びダウンロードツール内容

🏁 1. CNCLIをインストールする

🏁 2. sqlite3をインストールする

🏁 3. 各種ファイルをダウンロードする

3-1.パーミッションを設定する

3-2.設定ファイルを修正する

🏁 4.サービスファイル5種類を作成・登録します。

4-1サービスファイルをシステムフォルダにコピーして権限を付与します。

4-2サービスファイルを有効化します

🏁 5.ブロックチェーンとDBを同期する

🏁 6.過去のブロック生成実績をDBに登録します。

🏁 7.ログファイルを作成するように設定する

●各種サービスをストップする方法

●各種サービスを再起動する方法

7-1.　3プログラムのログ画面を確認します。

🏁 8.ブロックログを表示する

🏁 9.gLiveViewでブロック生成サマリを確認する

9-1. 次エポックのスケジュールを算出する

9-2. ブロック生成スケジュール算出のタイミングについて

🏁 10. ブロック生成ステータスを通知する

🏁 100. CNCLI更新手順

101.スケジュールにないブロックが生成される場合

102.blocks.shアップデート(2021/10/7以前から設定している場合)

Files

README.md

Latest commit

History

README.md

File metadata and controls

ステークプールブロックログ導入手順

🎉 ∞ お知らせ

🏁 0. 前提条件

稼働ノード

稼働要件

ハードウェア最小構成

インストール及びダウンロードツール内容

🏁 1. CNCLIをインストールする

🏁 2. sqlite3をインストールする

🏁 3. 各種ファイルをダウンロードする

3-1.パーミッションを設定する

3-2.設定ファイルを修正する

🏁 4.サービスファイル5種類を作成・登録します。

4-1サービスファイルをシステムフォルダにコピーして権限を付与します。

4-2サービスファイルを有効化します

🏁 5.ブロックチェーンとDBを同期する

🏁 6.過去のブロック生成実績をDBに登録します。

🏁 7.ログファイルを作成するように設定する

●各種サービスをストップする方法

●各種サービスを再起動する方法

7-1. 3プログラムのログ画面を確認します。

🏁 8.ブロックログを表示する

🏁 9.gLiveViewでブロック生成サマリを確認する

9-1. 次エポックのスケジュールを算出する

9-2. ブロック生成スケジュール算出のタイミングについて

🏁 10. ブロック生成ステータスを通知する

🏁 100. CNCLI更新手順

101.スケジュールにないブロックが生成される場合

102.blocks.shアップデート(2021/10/7以前から設定している場合)

7-1.　3プログラムのログ画面を確認します。