cardano-leader-logs

In a community effort, led by Andrew Westberg [BCSH], we implemented a way to retrieve stake pool's slot leader logs (block schedules).

This is a nodejs + python implementation which was tested on Ubuntu 20.04.

Installation

Ubuntu 20.04

Node.js

curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get update
sudo apt-get install -y nodejs

Python

sudo apt-get update
sudo apt-get install -y software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get update
sudo apt-get install -y python3.9
sudo apt-get install -y python3-pip

python3 --version
pip3 --version

pip3 install pytz

Libsodium

git clone https://github.com/input-output-hk/libsodium
cd libsodium
git checkout 66f017f1
./autogen.sh
./configure
make
sudo make install

Clone the repo and install dependencies

https://github.com/DamjanOstrelic/cardano-leader-logs.git
cd cardano-leader-logs
npm install

Create configuration file - slotLeaderLogsConfig.json

Add your poolId, poolIdBech32, the path to your pool's vrf.skey, and paths for node genesis files (Shelley and Byron). Make sure to have the node stats available as seen below (or change the nodeStatsURL port if not using the default one). The path to the cardano-cli can be cardano-cli (if in $PATH) or absolute/path/to/cardano-cli.

Example file available in example.slotLeaderLogsConfig.json.

{
  "poolIdBech32":     "<YOUR_POOL_BECH32_ID (pool1...)", // bech32 encoded pool ID
  "vrfSkey":          "vrf.skey", // path to pool's VRF signing key
  "genesisShelley":   "../files/genesis.json", // path to Shelley genesis file
  "libsodiumBinary":  "/usr/local/lib/libsodium.so", // path to Libsodium executable
  "timeZone":         "Europe/London" // timezone to be used to display the block schedule in
}

Running

1. Through the provided runLeaderLogsCurrent.sh or runLeaderLogsNext.sh: By default, this script will look for the slotLeaderLogsConfig.json in the same directory -> this can be edited inside the script to specify another location for the config file:

# runLeaderLogsCurrent.sh
SLOTLEADER_CONFIG="slotLeaderLogsConfig.json" # path to configuration file

./runLeaderLogsCurrent.sh

...

      Calculating leader slots...

expected blocks with d == 0.00: xy
assigned blocks with d == 0.00: xyz

[
  { index: 1, slot: 6354, date: '2021-06-25 00:30:45' }
  ...
]

2. Manually, by running:

node cardanoLeaderLogs.js path/to/slotLeaderLogsConfig.json <previous | current | next>

Thanks

Thanks to Andrew Westberg [BCSH], Papacarp [LOVE], Marcel Baumberg [TITAN] and others who contributed.