Implement leadership-schedule command for stake pool operators #3464

Jimbo4350 · 2021-12-24T19:14:02Z

Resolves #1027

The leadership-schedule command can calculate a given stake pool's leadership schedule in the current epoch

Output:

> cardano-cli query leadership-schedule \
     --testnet-magic 42 \
     --genesis example/shelley/genesis.json \
     --stake-pool-id  pool12t0y7agkqct89pf00eeytkvfjlquv76tjy27duannan9w63ckxv \
     --vrf-signing-key-file example/node-pool1/shelley/vrf.skey
     --current
> 
     SlotNo                          UTC Time              
-------------------------------------------------------------
     4073                   2021-12-29 17:26:54.998001755 UTC
     4126                   2021-12-29 17:27:00.298001755 UTC
     4206                   2021-12-29 17:27:08.298001755 UTC
     4256                   2021-12-29 17:27:13.298001755 UTC
     4309                   2021-12-29 17:27:18.598001755 UTC
     4376                   2021-12-29 17:27:25.298001755 UTC
     4423                   2021-12-29 17:27:29.998001755 UTC
     4433                   2021-12-29 17:27:30.998001755 UTC

scripts/plutus/staking-example/register-stake-pool.sh

newhoggy · 2022-01-04T11:05:50Z

cardano-api/src/Cardano/Api/LedgerState.hs

+    "Failed to successfully decode protocol state"
+
+-- | Return the slots at which a particular stake pool operator is
+-- expected to mint a block.


Please document for which epoch(s) the function will report over.

Also similar functionality in cncli allows the operator to query for either the current epoch or the next epoch which helps them schedule downtime, so it would be nice if we can achieve something similar here.

cardano-cli/src/Cardano/CLI/Shelley/Run/Query.hs

newhoggy · 2022-01-04T11:16:40Z

cardano-cli/src/Cardano/CLI/Shelley/Run/Query.hs

+          & hoistMaybe (ShelleyQueryCmdEraConsensusModeMismatch (AnyConsensusMode cMode) anyE)
+
+      let pparamsQuery = QueryInEra eInMode $ QueryInShelleyBasedEra sbe QueryProtocolParameters
+          serDebugLedgerStateQuery = QueryInEra eInMode . QueryInShelleyBasedEra sbe $ QueryDebugLedgerState


What's the ser prefix? Does it mean Shelly ERa?

cardano-cli/src/Cardano/CLI/Shelley/Run/Query.hs

newhoggy · 2022-01-08T04:01:30Z

This is the result of my testing:

$ rm -rf example; scripts/byron-to-alonzo/mkfiles.sh alonzo; bash -x example/run/all.sh

Wait a few minutes, then in another shell:

$ CARDANO_NODE_SOCKET_PATH=example/node-bft1/node.sock cardano-cli query tip --testnet-magic 42
{
    "era": "Alonzo",
    "syncProgress": "100.00",
    "hash": "888adbca6d32b566e30decf5ef85fa0cdd967c616771dfe44f37251506df88c0",
    "epoch": 1,
    "slot": 714,
    "block": 50
}
$ pool_id=$(cardano-cli stake-pool id --cold-verification-key-file ./example/node-pool1/shelley/operator.vkey --output-format hex)
$ CARDANO_NODE_SOCKET_PATH=example/node-bft1/node.sock cardano-cli query leadership-schedule --testnet-magic 42 --genesis example/shelley/genesis.json --signing-key-file example/node-pool1/shelley/vrf.skey --stake-pool-id "$pool_id" --current
     SlotNo                          UTC Time
-------------------------------------------------------------

Can you tell me where I'm going wrong?

newhoggy · 2022-01-08T04:18:37Z

This is what I get when trying the same on mainnet:

$ CARDANO_NODE_SOCKET_PATH=... cardano-cli query leadership-schedule --mainnet --genesis genesis-shelley.json --signing-key-file vrf.skey --stake-pool-id $(cardano-cli stake-pool id --cold-verification-key-file node.vkey --current
Command failed: query leadership-schedule  Error: Failed to successfully decode ledger state

For this, I queried against the node that comes with Daedalus. The node was fully synced when I did this.

This was the cardano-node version I used:

$ cardano-node-mainnet --version
cardano-node 1.30.1 - darwin-x86_64 - ghc-8.10
git rev 0fb43f4e3da8b225f4f86557aed90a183981a64f

Jimbo4350 · 2022-01-10T13:24:59Z

This is the result of my testing:

$ rm -rf example; scripts/byron-to-alonzo/mkfiles.sh alonzo; bash -x example/run/all.sh

Wait a few minutes, then in another shell:

$ CARDANO_NODE_SOCKET_PATH=example/node-bft1/node.sock cardano-cli query tip --testnet-magic 42
{
    "era": "Alonzo",
    "syncProgress": "100.00",
    "hash": "888adbca6d32b566e30decf5ef85fa0cdd967c616771dfe44f37251506df88c0",
    "epoch": 1,
    "slot": 714,
    "block": 50
}
$ pool_id=$(cardano-cli stake-pool id --cold-verification-key-file ./example/node-pool1/shelley/operator.vkey --output-format hex)
$ CARDANO_NODE_SOCKET_PATH=example/node-bft1/node.sock cardano-cli query leadership-schedule --testnet-magic 42 --genesis example/shelley/genesis.json --signing-key-file example/node-pool1/shelley/vrf.skey --stake-pool-id "$pool_id" --current
     SlotNo                          UTC Time
-------------------------------------------------------------

Can you tell me where I'm going wrong?

So you need have a stake pool running. I would use scripts/plutus/staking-example/register-stake-pool.sh and then try again. Also trying to predict the leadership schedule in the first epoch would involve getting the stake distribution from genesis. I didn't bother to do this as it would be additional work without much benefit to the user.

Jimbo4350 · 2022-01-10T13:29:57Z

This is what I get when trying the same on mainnet:

$ CARDANO_NODE_SOCKET_PATH=... cardano-cli query leadership-schedule --mainnet --genesis genesis-shelley.json --signing-key-file vrf.skey --stake-pool-id $(cardano-cli stake-pool id --cold-verification-key-file node.vkey --current
Command failed: query leadership-schedule  Error: Failed to successfully decode ledger state

For this, I queried against the node that comes with Daedalus. The node was fully synced when I did this.

This was the cardano-node version I used:

$ cardano-node-mainnet --version
cardano-node 1.30.1 - darwin-x86_64 - ghc-8.10
git rev 0fb43f4e3da8b225f4f86557aed90a183981a64f

I need to update the version mismatch error as it currently gives no information.

…dership schedule for a given stake pool in the current epoch.

disassembler · 2022-01-11T15:38:43Z

@newhoggy you should test CLI with node built from same branch. Ledger state format has changed from 1.30 to here.

disassembler

From a functionality perspective, this works great! Tested against a couple pools. Got leadership schedule for last epoch (using --current before the boundary) and then compared to db-sync slot leader from block table. 💯 from my perspective. So happy to have this done!

Jimbo4350 · 2022-01-11T15:56:32Z

bors r+

3464: Implement leadership-schedule command for stake pool operators r=Jimbo4350 a=Jimbo4350 Resolves #1027 The `leadership-schedule` command can calculate a given stake pool's leadership schedule in the current epoch Output: ``` > cardano-cli query leadership-schedule \ --testnet-magic 42 \ --genesis example/shelley/genesis.json \ --stake-pool-id pool12t0y7agkqct89pf00eeytkvfjlquv76tjy27duannan9w63ckxv \ --vrf-signing-key-file example/node-pool1/shelley/vrf.skey --current > SlotNo UTC Time ------------------------------------------------------------- 4073 2021-12-29 17:26:54.998001755 UTC 4126 2021-12-29 17:27:00.298001755 UTC 4206 2021-12-29 17:27:08.298001755 UTC 4256 2021-12-29 17:27:13.298001755 UTC 4309 2021-12-29 17:27:18.598001755 UTC 4376 2021-12-29 17:27:25.298001755 UTC 4423 2021-12-29 17:27:29.998001755 UTC 4433 2021-12-29 17:27:30.998001755 UTC ``` Co-authored-by: Jordan Millar <jordan.millar@iohk.io>

command

iohk-bors · 2022-01-11T15:59:05Z

Canceled.

Jimbo4350 · 2022-01-11T15:59:26Z

bors r+

JaredCorduan

LGTM!

iohk-bors · 2022-01-11T16:30:56Z

Build succeeded:

Jimbo4350 force-pushed the jordan/cli-command-get-eligible-leadership-slots branch from 332b459 to 8ec6f66 Compare December 24, 2021 19:41

Jimbo4350 changed the title ~~cli command that returns eligible leadership slots~~ Implement leadership-schedule command for stake pool operators Dec 24, 2021

Jimbo4350 force-pushed the jordan/cli-command-get-eligible-leadership-slots branch 8 times, most recently from f9d7783 to 6a890e7 Compare December 30, 2021 15:35

Jimbo4350 marked this pull request as ready for review December 30, 2021 15:37

Jimbo4350 requested review from DavidEichmann, dcoutts, erikd, JaredCorduan, nc6 and newhoggy as code owners December 30, 2021 15:37

Jimbo4350 force-pushed the jordan/cli-command-get-eligible-leadership-slots branch 2 times, most recently from 9ebe265 to 4fcf994 Compare December 30, 2021 18:35

newhoggy reviewed Jan 4, 2022

View reviewed changes

scripts/plutus/staking-example/register-stake-pool.sh Show resolved Hide resolved

newhoggy reviewed Jan 4, 2022

View reviewed changes

cardano-cli/src/Cardano/CLI/Shelley/Run/Query.hs Outdated Show resolved Hide resolved

newhoggy reviewed Jan 4, 2022

View reviewed changes

cardano-cli/src/Cardano/CLI/Shelley/Run/Query.hs Outdated Show resolved Hide resolved

Jimbo4350 force-pushed the jordan/cli-command-get-eligible-leadership-slots branch 5 times, most recently from 20d10ff to c07e124 Compare January 6, 2022 20:51

dorin100 mentioned this pull request Jan 9, 2022

add tests for cardano-cli query leadership-schedule IntersectMBO/cardano-node-tests#865

Closed

Jimbo4350 added 3 commits January 10, 2022 16:12

Move decodeDebugLedgerState and decodeProtocolState to cardano-api

86a55ee

Implement currentEpochEligibleLeadershipSlot which calculates the lea…

ba3f5f1

…dership schedule for a given stake pool in the current epoch.

Factor out readAndDecodeShelleyGenesis

2a153cf

Jimbo4350 force-pushed the jordan/cli-command-get-eligible-leadership-slots branch 4 times, most recently from b43fbce to c799dc3 Compare January 11, 2022 15:27

disassembler approved these changes Jan 11, 2022

View reviewed changes

Jimbo4350 added 4 commits January 11, 2022 11:58

Implement leadership-schedule cli command

43dbd95

Update register-stake-pool.sh with minimum required UTxO values

30915d1

Add EpochState query

d5ad647

Add leadership_schedule.md to describe the new leadership-schedule cli

f4be627

command

Jimbo4350 force-pushed the jordan/cli-command-get-eligible-leadership-slots branch from c799dc3 to f4be627 Compare January 11, 2022 15:59

JaredCorduan approved these changes Jan 11, 2022

View reviewed changes

iohk-bors bot merged commit 54c3adf into master Jan 11, 2022

iohk-bors bot deleted the jordan/cli-command-get-eligible-leadership-slots branch January 11, 2022 16:31

Jimbo4350 restored the jordan/cli-command-get-eligible-leadership-slots branch January 11, 2022 16:52

Jimbo4350 deleted the jordan/cli-command-get-eligible-leadership-slots branch January 13, 2022 12:54

ZiruiXue mentioned this pull request Mar 23, 2022

Missing Slot Leader Schedule Info cardano-foundation/cardano-graphql#699

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement leadership-schedule command for stake pool operators #3464

Implement leadership-schedule command for stake pool operators #3464

Jimbo4350 commented Dec 24, 2021 •

edited

newhoggy Jan 4, 2022 •

edited

newhoggy Jan 4, 2022

Jimbo4350 Jan 4, 2022

newhoggy commented Jan 8, 2022

newhoggy commented Jan 8, 2022 •

edited

Jimbo4350 commented Jan 10, 2022 •

edited

Jimbo4350 commented Jan 10, 2022

disassembler commented Jan 11, 2022

disassembler left a comment

Jimbo4350 commented Jan 11, 2022

iohk-bors bot commented Jan 11, 2022

Jimbo4350 commented Jan 11, 2022

JaredCorduan left a comment

iohk-bors bot commented Jan 11, 2022

Implement leadership-schedule command for stake pool operators #3464

Implement leadership-schedule command for stake pool operators #3464

Conversation

Jimbo4350 commented Dec 24, 2021 • edited

newhoggy Jan 4, 2022 • edited

Choose a reason for hiding this comment

newhoggy Jan 4, 2022

Choose a reason for hiding this comment

Jimbo4350 Jan 4, 2022

Choose a reason for hiding this comment

newhoggy commented Jan 8, 2022

newhoggy commented Jan 8, 2022 • edited

Jimbo4350 commented Jan 10, 2022 • edited

Jimbo4350 commented Jan 10, 2022

disassembler commented Jan 11, 2022

disassembler left a comment

Choose a reason for hiding this comment

Jimbo4350 commented Jan 11, 2022

iohk-bors bot commented Jan 11, 2022

Jimbo4350 commented Jan 11, 2022

JaredCorduan left a comment

Choose a reason for hiding this comment

iohk-bors bot commented Jan 11, 2022

Jimbo4350 commented Dec 24, 2021 •

edited

newhoggy Jan 4, 2022 •

edited

newhoggy commented Jan 8, 2022 •

edited

Jimbo4350 commented Jan 10, 2022 •

edited