From 2f37bf06d2006d8f27ac0af148ae50d3139e291e Mon Sep 17 00:00:00 2001
From: Heinrich Apfelmus <heinrich.apfelmus@iohk.io>
Date: Mon, 11 Oct 2021 14:26:20 +0200
Subject: [PATCH] Rename `getRewardInfo` to `getRewardProvenance`

---
 .../src/Cardano/Ledger/Shelley/API/Wallet.hs  | 24 +++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/eras/shelley/impl/src/Cardano/Ledger/Shelley/API/Wallet.hs b/eras/shelley/impl/src/Cardano/Ledger/Shelley/API/Wallet.hs
index cb539e38cb2..3965568157b 100644
--- a/eras/shelley/impl/src/Cardano/Ledger/Shelley/API/Wallet.hs
+++ b/eras/shelley/impl/src/Cardano/Ledger/Shelley/API/Wallet.hs
@@ -27,6 +27,7 @@ module Cardano.Ledger.Shelley.API.Wallet
     RewardInfoPool (..),
     RewardParams (..),
     getRewardInfoPools,
+    getRewardProvenance,
     getRewardInfo,
     getNonMyopicMemberRewards,
 
@@ -440,13 +441,32 @@ getRewardInfoPools globals ss =
             mempty
             (_poolOwners poolp)
 
+{-# DEPRECATED getRewardInfo "Use 'getRewardProvenance' instead." #-}
+getRewardInfo ::
+  forall era.
+  ( HasField "_a0" (Core.PParams era) NonNegativeInterval,
+    HasField "_d" (Core.PParams era) UnitInterval,
+    HasField "_nOpt" (Core.PParams era) Natural,
+    HasField "_protocolVersion" (Core.PParams era) ProtVer,
+    HasField "_rho" (Core.PParams era) UnitInterval,
+    HasField "_tau" (Core.PParams era) UnitInterval
+  ) =>
+  Globals ->
+  NewEpochState era ->
+  (RewardUpdate (Crypto era), RewardProvenance (Crypto era))
+getRewardInfo = getRewardProvenance
+
 -- | Calculate stake pool rewards from the snapshot labeled `go`.
 -- Also includes information on how the rewards were calculated
 -- ('RewardProvenance').
 --
 -- For a calculation of rewards based on the current stake distribution,
 -- see 'getRewardInfoPools'.
-getRewardInfo ::
+--
+-- TODO: Deprecate 'getRewardProvenance', because wallets are more
+-- likely to use 'getRewardInfoPools' for up-to-date information
+-- on stake pool rewards.
+getRewardProvenance ::
   forall era.
   ( HasField "_a0" (Core.PParams era) NonNegativeInterval,
     HasField "_d" (Core.PParams era) UnitInterval,
@@ -458,7 +478,7 @@ getRewardInfo ::
   Globals ->
   NewEpochState era ->
   (RewardUpdate (Crypto era), RewardProvenance (Crypto era))
-getRewardInfo globals newepochstate =
+getRewardProvenance globals newepochstate =
   runReader
     ( runWithProvM def $
         createRUpd slotsPerEpoch blocksmade epochstate maxsupply asc secparam