Address another set of review comments

IntersectMBO · May 9, 2024 · 7a877b2 · 7a877b2
1 parent a3fe7b6
commit 7a877b2
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 23 deletions.
diff --git a/eras/conway/impl/src/Cardano/Ledger/Conway/Governance/DRepPulser.hs b/eras/conway/impl/src/Cardano/Ledger/Conway/Governance/DRepPulser.hs
@@ -217,11 +217,6 @@ computeDRepDistr stakeDistr regDReps proposalDeposits poolDistr dRepDistr uMapCh
               , addToPoolDistr spo proposalDeposit poolAccum
               )
     addToPoolDistr spo proposalDeposit distr = fromMaybe distr $ do
-      -- Avoid adding the proposal deposits to anything other than the numerator
-      -- and denominator in order not to interfere with rewards calculation,
-      -- although this is an isolated copy inside the DRepPulser, we want to
-      -- just be sure we do not confuse ourselves over which representations are
-      -- used where.
       guard (proposalDeposit /= mempty)
       ips <- Map.lookup spo $ distr ^. poolDistrDistrL
       pure $
@@ -365,7 +360,7 @@ finishDRepPulser (DRPulsing (DRepPulser {..})) =
   (PulsingSnapshot dpProposals finalDRepDistr dpDRepState, ratifyState')
   where
     !leftOver = Map.drop dpIndex $ umElems dpUMap
-    (!finalDRepDistr, !finalStakePoolDistr) =
+    (finalDRepDistr, finalStakePoolDistr) =
       computeDRepDistr dpStakeDistr dpDRepState dpProposalDeposits dpStakePoolDistr dpDRepDistr leftOver
     !ratifyEnv =
       RatifyEnv

diff --git a/libs/cardano-ledger-core/CHANGELOG.md b/libs/cardano-ledger-core/CHANGELOG.md
@@ -2,14 +2,14 @@
 
 ## 1.12.0.0
 
-* Add `UMap.umElemDelegations` to extract SPO, DRep and rewards for a given stake credential. #4324
-  * Add `sumAllStakeCompact` and redefine `sumAllStake` as a composition of it.
-  * Change `computeDRepPulser` to also process proposal-deposits for SPOs.
-    * Add `pdTotalActiveStake` field to `PoolDistr`, to hold the total active stake delegated to pools, including proposal deposits.
-    * Add `individualTotalPoolStake` to `IndividualPoolStake` to hold the delegated stake as an absolute number, including proposal deposits.
-    * Add lenses:
-      * `individualTotalPoolStakeL`
-      * `poolDistrTotalL`
+* Change `computeDRepPulser` to also process proposal-deposits for SPOs. #4324
+  * Add `sumAllStakeCompact`.
+  * Add `UMap.umElemDelegations` to extract SPO, DRep and rewards for a given stake credential.
+  * Add `pdTotalActiveStake` field to `PoolDistr`, to hold the total active stake delegated to pools, including proposal deposits.
+  * Add `individualTotalPoolStake` to `IndividualPoolStake` to hold the delegated stake as an absolute number, including proposal deposits.
+  * Add lenses:
+    * `individualTotalPoolStakeL`
+    * `poolDistrTotalL`
 * Add lenses to `RewardAccount`. #4309
   * `rewardAccountCredentialL`
   * `rewardAccountNetworkL`

diff --git a/libs/cardano-ledger-core/src/Cardano/Ledger/PoolDistr.hs b/libs/cardano-ledger-core/src/Cardano/Ledger/PoolDistr.hs
@@ -52,9 +52,7 @@ import NoThunks.Class (NoThunks (..))
 -- delegated to a registered stake pool.
 data IndividualPoolStake c = IndividualPoolStake
   { individualPoolStake :: !Rational
-  -- ^ Pool stake distribution. This is a ratio of
-  -- (individualTotalPoolStake - proposal deposits) to
-  -- (pdTotalActiveStake - proposal deposits)
+  -- ^ Pool stake distribution. This is a ratio of `individualTotalPoolStake`/`pdTotalActiveStake`
   , individualTotalPoolStake :: !(CompactForm Coin)
   -- ^ Total stake delegated to this pool. In addition to all the stake  that
   -- is part of `individualPoolStake` we also add proposal-deposits to this

diff --git a/libs/cardano-ledger-test/src/Test/Cardano/Ledger/Constrained/Vars.hs b/libs/cardano-ledger-test/src/Test/Cardano/Ledger/Constrained/Vars.hs
@@ -71,7 +71,7 @@ import Cardano.Ledger.Keys.WitVKey (WitVKey (..))
 import Cardano.Ledger.Mary.Value (AssetName (..), MaryValue (..), MultiAsset (..), PolicyID (..))
 import Cardano.Ledger.Plutus (ExUnits (..))
 import Cardano.Ledger.Plutus.Data (Data (..), Datum (..))
-import Cardano.Ledger.PoolDistr (IndividualPoolStake (..), PoolDistr (..))
+import Cardano.Ledger.PoolDistr (IndividualPoolStake (..), PoolDistr (..), poolDistrDistrL)
 import Cardano.Ledger.PoolParams (PoolParams)
 import Cardano.Ledger.SafeHash (SafeHash)
 import Cardano.Ledger.Shelley.Governance (FuturePParams (..), futureProposalsL, proposalsL)
@@ -677,10 +677,7 @@ markPoolDistr = Var (V "markPoolDistr" (MapR PoolHashR IPoolStakeR) No)
 
 markPoolDistrL ::
   NELens era (Map (KeyHash 'StakePool (EraCrypto era)) (IndividualPoolStake (EraCrypto era)))
-markPoolDistrL = nesEsL . esSnapshotsL . ssStakeMarkPoolDistrL . pooldistrHelpL
-
-pooldistrHelpL :: Lens' (PoolDistr c) (Map (KeyHash 'StakePool c) (IndividualPoolStake c))
-pooldistrHelpL = lens unPoolDistr (\x y -> x {unPoolDistr = y})
+markPoolDistrL = nesEsL . esSnapshotsL . ssStakeMarkPoolDistrL . poolDistrDistrL
 
 snapShotFee :: Era era => Term era Coin
 snapShotFee = Var (V "snapShotFee" CoinR No)
@@ -690,7 +687,7 @@ snapShotsT ::
 snapShotsT =
   Invert "SnapShots" (typeRep @(SnapShots (EraCrypto era))) shotsfun
     :$ Shift markSnapShotT ssStakeMarkL
-    :$ Lensed markPoolDistr (ssStakeMarkPoolDistrL . pooldistrHelpL)
+    :$ Lensed markPoolDistr (ssStakeMarkPoolDistrL . poolDistrDistrL)
     :$ Shift setSnapShotT ssStakeSetL
     :$ Shift goSnapShotT ssStakeGoL
     :$ Lensed snapShotFee ssFeeL