Skip to content

Commit

Permalink
Add comment to getDesiredPoolNumberValue explaining what the `desir…
Browse files Browse the repository at this point in the history
…edPoolNumber` is
  • Loading branch information
palas committed May 3, 2024
1 parent 7a04e61 commit 71c4ca2
Showing 1 changed file with 6 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,12 @@ voteChangeProposal execConfig epochStateView sbe work prefix governanceActionTxI
(paymentKeyInfoPair wallet:[defaultDRepKeyPair n | (_, n) <- votes])
submitTx execConfig cEra voteTxFp

-- | Obtains the @desiredPoolNumberValue@ from the protocol parameters.
-- The @desiredPoolNumberValue@ or (@k@ in the spec) is the protocol parameter
-- that defines what is the optimal number of SPOs. It is a tradeoff between
-- decentralization and efficiency and the spec suggest it should be between 100 an 1000.
-- Changing this parameter will inderectly affect how easy it is to saturate a pool in order to
-- incentivize that the number of SPOs states close to the parameter value.
getDesiredPoolNumberValue :: (MonadTest m, MonadCatch m, MonadIO m) => H.ExecConfig -> m Integer
getDesiredPoolNumberValue execConfig = do
govStateString <- H.execCli' execConfig
Expand Down

0 comments on commit 71c4ca2

Please sign in to comment.