Apply suggestions from code review

Co-authored-by: Rodney Lorrimar <[email protected]>
cardano-foundation · Mar 25, 2022 · 992d3af · 992d3af
1 parent 483642c
commit 992d3af
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/lib/core/src/Cardano/Pool/Rank.hs b/lib/core/src/Cardano/Pool/Rank.hs
@@ -183,7 +183,9 @@ z0 RewardParams{nOpt} = 1 / fromIntegral nOpt
 epochsPerYear :: Int
 epochsPerYear = 73
 
--- | The current (yearly) return per unit of stake.
+-- | The yearly rate of return per unit of stake,
+-- assuming that the pool's stake remains at the same level.
+-- Rewards compound every epoch.
 currentROS :: RewardParams -> RewardInfoPool -> Coin -> Percentage
 currentROS rp RewardInfoPool{..} x
     | ownerStake < ownerPledge = clipToPercentage 0

diff --git a/lib/shelley/src/Cardano/Wallet/Shelley/Network/Blockfrost.hs b/lib/shelley/src/Cardano/Wallet/Shelley/Network/Blockfrost.hs
@@ -182,6 +182,9 @@ blockToBlockHeader [email protected]{..} = do
 -------------------------------------------------------------------------------}
 -- | Estimate the performance of a stake pool based on
 -- the past 50 epochs (or less if the pool is younger than that).
+--
+-- Uses 'estimatePoolPerformance' from "Cardano.Pool.Rank.Likelihood"
+-- for this purpose.
 getPoolPerformanceEstimate
     :: BF.MonadBlockfrost m
     => SlottingParameters