Add deprecations and replacement lenses

* Add `casTreasuryL` and `casReservesL`
* Deprecate `asTreasuryL` and `asReservesL`
* Add pattern synonym for `AccountState` with deprecation pragma

Author: lehins

eras/conway/impl/src/Cardano/Ledger/Conway/Rules/Epoch.hs

@@ -67,7 +67,6 @@ import Cardano.Ledger.Shelley.LedgerState (
   EpochState (..),
   LedgerState (..),
   UTxOState (..),
-  asTreasuryL,
   curPParamsEpochStateL,
   esChainAccountState,
   esChainAccountStateL,
@@ -244,7 +243,7 @@ applyEnactedWithdrawals chainAccountState dState enactedState =
           --   + unclaimed - totWithdrawals
           -- we just subtract the `refunds`
           --   - refunds
-          & asTreasuryL %~ (<-> fold successfulWithdrawls)
+          & casTreasuryL %~ (<-> fold successfulWithdrawls)
       -- The use of the partial function `compactCoinOrError` is justified here because
       -- 1. the decoder for coin at the proposal-submission boundary has already
       --    confirmed we have a compactible value
@@ -378,7 +377,7 @@ epochTransition = do
     chainAccountState3 =
       chainAccountState2
         -- Move donations and unclaimed rewards from proposals to treasury:
-        & asTreasuryL <>~ (utxoState0 ^. utxosDonationL <> fold unclaimed)
+        & casTreasuryL <>~ (utxoState0 ^. utxosDonationL <> fold unclaimed)
     utxoState2 =
       utxoState1
         & utxosDepositedL .~ totalObligation certState2 govState1

eras/conway/impl/src/Cardano/Ledger/Conway/Rules/Ledger.hs

@@ -83,16 +83,13 @@ import Cardano.Ledger.Conway.Rules.GovCert (ConwayGovCertPredFailure)
 import Cardano.Ledger.Conway.Rules.Utxo (ConwayUtxoPredFailure)
 import Cardano.Ledger.Conway.Rules.Utxos (ConwayUtxosPredFailure)
 import Cardano.Ledger.Conway.Rules.Utxow (ConwayUtxowPredFailure)
-import Cardano.Ledger.Conway.State (ConwayEraCertState)
+import Cardano.Ledger.Conway.State
 import Cardano.Ledger.Conway.UTxO (txNonDistinctRefScriptsSize)
 import Cardano.Ledger.Credential (Credential (..), credKeyHash)
 import qualified Cardano.Ledger.Shelley.HardForks as HF (bootstrapPhase)
 import Cardano.Ledger.Shelley.LedgerState (
   LedgerState (..),
   UTxOState (..),
-  asTreasuryL,
-  dsUnifiedL,
-  utxoL,
   utxosGovStateL,
  )
 import Cardano.Ledger.Shelley.Rules (
@@ -108,7 +105,6 @@ import Cardano.Ledger.Shelley.Rules (
   shelleyLedgerAssertions,
  )
 import Cardano.Ledger.Slot (epochFromSlot)
-import Cardano.Ledger.State (EraCertState (..), EraUTxO (..))
 import Cardano.Ledger.UMap (UView (..))
 import qualified Cardano.Ledger.UMap as UMap
 import Control.DeepSeq (NFData)
@@ -363,7 +359,7 @@ ledgerTransition ::
   TransitionRule (someLEDGER era)
 ledgerTransition = do
   TRC
-    ( LedgerEnv slot mbCurEpochNo _txIx pp account
+    ( LedgerEnv slot mbCurEpochNo _txIx pp chainAccountState
       , LedgerState utxoState certState
       , tx
       ) <-
@@ -375,7 +371,7 @@ ledgerTransition = do
     if tx ^. isValidTxL == IsValid True
       then do
         let txBody = tx ^. bodyTxL
-            actualTreasuryValue = account ^. asTreasuryL
+            actualTreasuryValue = chainAccountState ^. casTreasuryL
         case txBody ^. currentTreasuryValueTxBodyL of
           SNothing -> pure ()
           SJust submittedTreasuryValue ->

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/Imp/EnactSpec.hs

@@ -17,6 +17,7 @@ import Cardano.Ledger.Conway.Core
 import Cardano.Ledger.Conway.Governance
 import Cardano.Ledger.Conway.PParams
 import Cardano.Ledger.Conway.Rules
+import Cardano.Ledger.Conway.State
 import Cardano.Ledger.Credential
 import Cardano.Ledger.Shelley.LedgerState
 import Cardano.Ledger.Shelley.Rules (ShelleyTickEvent (..))
@@ -184,7 +185,7 @@ treasuryWithdrawalsSpec =
           -- check that the sum of the rewards matches what was spent from the treasury
           sumRewardAccounts withdrawals `shouldReturn` (initialTreasury <-> expectedTreasury)
   where
-    getTreasury = getsNES (nesEsL . esChainAccountStateL . asTreasuryL)
+    getTreasury = getsNES (nesEsL . esChainAccountStateL . casTreasuryL)
     sumRewardAccounts withdrawals = mconcat <$> traverse (getRewardAccountAmount . fst) withdrawals
     genWithdrawalsExceeding (Coin val) n = do
       vals <- genValuesExceeding val n

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/Imp/EpochSpec.hs

@@ -21,6 +21,7 @@ import Cardano.Ledger.Conway.Rules (
   ConwayEpochEvent (GovInfoEvent),
   ConwayNewEpochEvent (..),
  )
+import Cardano.Ledger.Conway.State
 import Cardano.Ledger.Shelley.LedgerState
 import Cardano.Ledger.Shelley.Rules (Event, ShelleyTickEvent (..))
 import Cardano.Ledger.Val
@@ -421,7 +422,7 @@ treasuryWithdrawalExpectation extraWithdrawals = do
   donateToTreasury withdrawalAmount
   committeeHotCreds <- registerInitialCommittee
   (dRepCred, _, _) <- setupSingleDRep 1_000_000
-  treasuryStart <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+  treasuryStart <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
   treasuryStart `shouldBe` withdrawalAmount
   rewardAccount <- registerRewardAccount
   govPolicy <- getGovPolicy
@@ -436,7 +437,7 @@ treasuryWithdrawalExpectation extraWithdrawals = do
     getReward (raCredential rewardAccount) `shouldReturn` mempty
   passEpoch -- 2nd epoch crossing enacts all the ratified actions
   expectMissingGovActionId govActionId
-  treasuryEnd <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+  treasuryEnd <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
   impAnn "Withdrawal deducted from treasury" $
     treasuryStart <-> treasuryEnd `shouldBe` withdrawalAmount
   impAnn "Withdrawal received by reward account" $
@@ -445,7 +446,7 @@ treasuryWithdrawalExpectation extraWithdrawals = do
 depositMovesToTreasuryWhenStakingAddressUnregisters :: ConwayEraImp era => ImpTestM era ()
 depositMovesToTreasuryWhenStakingAddressUnregisters = do
   disableTreasuryExpansion
-  initialTreasury <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+  initialTreasury <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
   modifyPParams $ \pp ->
     pp
       & ppGovActionLifetimeL .~ EpochInterval 8

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/Imp/RatifySpec.hs

@@ -12,9 +12,9 @@ import Cardano.Ledger.Coin
 import Cardano.Ledger.Conway.Core
 import Cardano.Ledger.Conway.Governance
 import Cardano.Ledger.Conway.PParams
+import Cardano.Ledger.Conway.State
 import Cardano.Ledger.Conway.TxCert
 import Cardano.Ledger.Credential
-import Cardano.Ledger.DRep
 import Cardano.Ledger.Shelley.HardForks (bootstrapPhase)
 import Cardano.Ledger.Shelley.LedgerState
 import qualified Cardano.Ledger.UMap as UM
@@ -476,14 +476,14 @@ committeeMinSizeAffectsInFlightProposalsSpec =
             & ppuCommitteeMinSizeL .~ SJust 3
       submitYesVoteCCs_ hotCommitteeCs gaiPC
       submitYesVote_ (DRepVoter drepC) gaiPC
-      treasury <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+      treasury <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
       passNEpochs 2
       -- The ParameterChange prevents the TreasuryWithdrawal from being enacted,
       -- because it has higher priority.
       getLastEnactedParameterChange `shouldReturn` SJust (GovPurposeId gaiPC)
       isCommitteeAccepted gaiTW `shouldReturn` False
       currentProposalsShouldContain gaiTW
-      getsNES (nesEsL . esChainAccountStateL . asTreasuryL) `shouldReturn` treasury
+      getsNES (nesEsL . esChainAccountStateL . casTreasuryL) `shouldReturn` treasury
     it "TreasuryWithdrawal ratifies due to a decrease in CommitteeMinSize" $ whenPostBootstrap $ do
       disableTreasuryExpansion
       (drepC, hotCommitteeC, _) <- electBasicCommittee
@@ -492,14 +492,14 @@ committeeMinSizeAffectsInFlightProposalsSpec =
       -- Ensure sufficient amount in the treasury
       submitTx_ $ mkBasicTx (mkBasicTxBody & treasuryDonationTxBodyL .~ amount)
       passEpoch
-      treasury <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+      treasury <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
       gaiTW <- submitTreasuryWithdrawal amount
       submitYesVote_ (CommitteeVoter hotCommitteeC) gaiTW
       submitYesVote_ (DRepVoter drepC) gaiTW
       setCommitteeMinSize 2
       isCommitteeAccepted gaiTW `shouldReturn` False
       passNEpochs 2
-      getsNES (nesEsL . esChainAccountStateL . asTreasuryL) `shouldReturn` treasury
+      getsNES (nesEsL . esChainAccountStateL . casTreasuryL) `shouldReturn` treasury
       -- We do not enact the ParameterChange here because that does not pass
       -- ratification as the CC size is smaller than MinSize.
       -- We instead just add another Committee member to reach the CommitteeMinSize.
@@ -511,7 +511,7 @@ committeeMinSizeAffectsInFlightProposalsSpec =
       _hotCommitteeC' <- registerCommitteeHotKey coldCommitteeCred
       isCommitteeAccepted gaiTW `shouldReturn` True
       passNEpochs 2
-      getsNES (nesEsL . esChainAccountStateL . asTreasuryL) `shouldReturn` (treasury <-> amount)
+      getsNES (nesEsL . esChainAccountStateL . casTreasuryL) `shouldReturn` (treasury <-> amount)
 
 spoVotesForHardForkInitiation ::
   forall era.
@@ -854,7 +854,7 @@ votingSpec =
           passEpoch
           getCommitteeMembers `shouldReturn` mempty
         it "AlwaysAbstain" $ whenPostBootstrap $ do
-          let getTreasury = getsNES (nesEsL . esChainAccountStateL . asTreasuryL)
+          let getTreasury = getsNES (nesEsL . esChainAccountStateL . casTreasuryL)
 
           disableTreasuryExpansion
           donateToTreasury $ Coin 5_000_000

eras/conway/impl/testlib/Test/Cardano/Ledger/Conway/ImpTest.hs

@@ -184,7 +184,6 @@ import Cardano.Ledger.Plutus.Language (Language (..), SLanguage (..), hashPlutus
 import Cardano.Ledger.PoolParams (PoolParams (..), ppRewardAccount)
 import qualified Cardano.Ledger.Shelley.HardForks as HardForks (bootstrapPhase)
 import Cardano.Ledger.Shelley.LedgerState (
-  asTreasuryL,
   curPParamsEpochStateL,
   epochStateGovStateL,
   epochStatePoolParamsL,
@@ -1171,7 +1170,7 @@ logRatificationChecks gaId = do
   committee <- getsNES $ nesEsL . epochStateGovStateL . committeeGovStateL
   ratEnv@RatifyEnv {reCurrentEpoch} <- getRatifyEnv
   let ratSt = RatifyState ens mempty mempty False
-  curTreasury <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+  curTreasury <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
   currentEpoch <- getsNES nesELL
   pv <- getProtVer
   let
@@ -1671,13 +1670,13 @@ expectCommitteeMemberAbsence cc = do
 donateToTreasury :: ConwayEraImp era => Coin -> ImpTestM era ()
 donateToTreasury amount =
   impAnn ("Donation to treasury in the amount of: " ++ show amount) $ do
-    treasuryStart <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+    treasuryStart <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
     submitTx_ $ mkBasicTx (mkBasicTxBody & treasuryDonationTxBodyL .~ amount)
-    treasuryEndEpoch0 <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+    treasuryEndEpoch0 <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
     -- Actual donation happens on the epoch boundary
     treasuryStart `shouldBe` treasuryEndEpoch0
     passEpoch
-    treasuryEndEpoch1 <- getsNES $ nesEsL . esChainAccountStateL . asTreasuryL
+    treasuryEndEpoch1 <- getsNES $ nesEsL . esChainAccountStateL . casTreasuryL
     treasuryEndEpoch1 <-> treasuryStart `shouldBe` amount
 
 expectMembers ::

eras/shelley-ma/test-suite/test/Test/Cardano/Ledger/Allegra/ScriptTranslation.hs

@@ -7,6 +7,7 @@ module Test.Cardano.Ledger.Allegra.ScriptTranslation (
 where
 
 import Cardano.Ledger.Allegra (AllegraEra)
+import Cardano.Ledger.Allegra.State
 import Cardano.Ledger.Genesis (NoGenesis (..))
 import Cardano.Ledger.Shelley (ShelleyEra)
 import qualified Cardano.Ledger.Shelley.API as S
@@ -63,7 +64,7 @@ testScriptPostTranslation =
               Nothing
               minBound
               emptyPParams
-              (S.ChainAccountState (S.Coin 0) (S.Coin 0))
+              (ChainAccountState (S.Coin 0) (S.Coin 0))
           utxoStShelley = def {S.utxosUtxo = utxo}
           utxoStAllegra = fromRight . runExcept $ translateEra @AllegraEra NoGenesis utxoStShelley
           txb =

eras/shelley-ma/test-suite/test/Test/Cardano/Ledger/Mary/Examples/MultiAssets.hs

@@ -24,14 +24,14 @@ import Cardano.Ledger.Coin (Coin (..))
 import Cardano.Ledger.Keys (asWitness)
 import Cardano.Ledger.Mary (MaryEra)
 import Cardano.Ledger.Mary.Core
+import Cardano.Ledger.Mary.State
 import Cardano.Ledger.Mary.Value (
   AssetName (..),
   MaryValue (..),
   MultiAsset (..),
   PolicyID (..),
  )
 import Cardano.Ledger.Shelley.API (LedgerEnv (..), ShelleyLEDGER)
-import Cardano.Ledger.Shelley.LedgerState (ChainAccountState (..))
 import Cardano.Ledger.Shelley.Rules (ShelleyLedgerPredFailure (..), ShelleyUtxowPredFailure (..))
 import Cardano.Ledger.Shelley.Scripts (
   pattern RequireAllOf,
@@ -41,7 +41,6 @@ import Cardano.Ledger.Shelley.Tx (ShelleyTx (..))
 import Cardano.Ledger.Shelley.TxOut (ShelleyTxOut (..))
 import Cardano.Ledger.Shelley.TxWits (addrWits)
 import Cardano.Ledger.Slot (SlotNo (..))
-import Cardano.Ledger.State (UTxO (..))
 import Cardano.Ledger.TxIn (TxId, TxIn (..), mkTxInPartial)
 import Cardano.Ledger.Val ((<+>), (<->))
 import qualified Cardano.Ledger.Val as Val

eras/shelley/impl/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 1.17.0.0
 
-* Rename `esAccountState` and `esAccountStateL` to `esChainAccountState` and `esChainAccountStateL`
+* Rename `esAccountState` to `esChainAccountState`
 * Replaced `prDState` and `prPState` with `prCertState` in `ShelleyPoolreapState`
 * Removed `ShelleyPoolreapEnv` (became obsolete)
 * Removed `shelleyCertVState` from `ShelleyCertState`

eras/shelley/impl/src/Cardano/Ledger/Shelley/API/ByronTranslation.hs

@@ -28,9 +28,8 @@ import Cardano.Ledger.Shelley.API.Types
 import Cardano.Ledger.Shelley.Core
 import Cardano.Ledger.Shelley.LedgerState.Types (curPParamsEpochStateL, prevPParamsEpochStateL)
 import Cardano.Ledger.Shelley.Rules ()
-import Cardano.Ledger.Shelley.State ()
+import Cardano.Ledger.Shelley.State
 import Cardano.Ledger.Shelley.Translation (FromByronTranslationContext (..))
-import Cardano.Ledger.State (coinBalance, emptySnapShots)
 import qualified Cardano.Ledger.UMap as UM
 import Cardano.Ledger.Val (zero, (<->))
 import qualified Data.ByteString.Short as SBS