Add a function registerInState to EraTransition (#4023)

* Add a new function `injectIntoTestState` to `EraTransition`, which
 allows to inject transition configuration data in the given
`NewEpochState`.

This change allows the Ledger to define this logic in this component
without needing to do it in the Consensus layer. In this way, we
improve the separation of concerns.

* Do no register the initial funds in `createInitialState`.

This allows the `ThreadNet` tests in Consensus to use
`injectIntoTestState` after creating the initial state.
 Add a comment on `createInitialState` stating that no funds 
 or delegates are registered by this function.

* Remove registration functions used by Consensus.

Functions `registerInitialFunds`, `registerInitialStaking`,
`registerInitialDReps`, and `registerDelegs` were used by the
Consensus code, which now relies on `injectIntoTestState`.

* Update the changelogs.

Author: dnadales

eras/allegra/impl/src/Cardano/Ledger/Allegra/Transition.hs

@@ -22,6 +22,8 @@ instance Crypto c => EraTransition (AllegraEra c) where
 
   mkTransitionConfig () = AllegraTransitionConfig
 
+  injectIntoTestState = registerInitialFundsThenStaking
+
   tcPreviousEraConfigL =
     lens atcShelleyTransitionConfig (\atc pc -> atc {atcShelleyTransitionConfig = pc})
 

eras/alonzo/impl/src/Cardano/Ledger/Alonzo/Transition.hs

@@ -41,6 +41,8 @@ instance Crypto c => EraTransition (AlonzoEra c) where
 
   mkTransitionConfig = AlonzoTransitionConfig
 
+  injectIntoTestState = registerInitialFundsThenStaking
+
   tcPreviousEraConfigL =
     lens atcMaryTransitionConfig (\atc pc -> atc {atcMaryTransitionConfig = pc})
 

eras/babbage/impl/src/Cardano/Ledger/Babbage/Transition.hs

@@ -23,6 +23,8 @@ instance Crypto c => EraTransition (BabbageEra c) where
 
   mkTransitionConfig () = BabbageTransitionConfig
 
+  injectIntoTestState = registerInitialFundsThenStaking
+
   tcPreviousEraConfigL =
     lens btcAlonzoTransitionConfig (\btc pc -> btc {btcAlonzoTransitionConfig = pc})
 

eras/conway/impl/CHANGELOG.md

@@ -22,6 +22,7 @@
 * Add `hoistGovRelation` and `withGovActionParent`
 * Add `TreeMaybe`, `toGovRelationTree` and `toGovRelationTreeEither`
 * Remove `proposalsAreConsistent`
+* Remove `registerDelegs` and `registerInitialDReps`
 
 ### `testlib`
 

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

@@ -12,8 +12,6 @@ module Cardano.Ledger.Conway.Transition (
   ConwayEraTransition (..),
   TransitionConfig (..),
   toConwayTransitionConfigPairs,
-  registerDelegs,
-  registerInitialDReps,
 ) where
 
 import Cardano.Ledger.Alonzo.Transition (toAlonzoTransitionConfigPairs)
@@ -72,6 +70,15 @@ class EraTransition era => ConwayEraTransition era where
 
   tcConwayGenesisL :: Lens' (TransitionConfig era) (ConwayGenesis (EraCrypto era))
 
+registerDRepsThenDelegs ::
+  ConwayEraTransition era =>
+  TransitionConfig era ->
+  NewEpochState era ->
+  NewEpochState era
+registerDRepsThenDelegs cfg =
+  -- NOTE: The order of registration does not matter.
+  registerDelegs cfg . registerInitialDReps cfg
+
 instance Crypto c => EraTransition (ConwayEra c) where
   data TransitionConfig (ConwayEra c) = ConwayTransitionConfig
     { ctcConwayGenesis :: !(ConwayGenesis c)
@@ -81,6 +88,10 @@ instance Crypto c => EraTransition (ConwayEra c) where
 
   mkTransitionConfig = ConwayTransitionConfig
 
+  injectIntoTestState cfg =
+    registerDRepsThenDelegs cfg
+      . registerInitialFundsThenStaking cfg
+
   tcPreviousEraConfigL =
     lens ctcBabbageTransitionConfig (\ctc pc -> ctc {ctcBabbageTransitionConfig = pc})
 

eras/mary/impl/src/Cardano/Ledger/Mary/Transition.hs

@@ -23,6 +23,8 @@ instance Crypto c => EraTransition (MaryEra c) where
 
   mkTransitionConfig () = MaryTransitionConfig
 
+  injectIntoTestState = registerInitialFundsThenStaking
+
   tcPreviousEraConfigL =
     lens mtcAllegraTransitionConfig (\mtc pc -> mtc {mtcAllegraTransitionConfig = pc})
 

eras/shelley/impl/CHANGELOG.md

@@ -8,6 +8,8 @@
 * Rename `RewardAccount` fields `getRwdNetwork` and `getRwdCred` to `raNetwork` and `raCredential` respectively
 * Deprecate `prAcnt` in favor of `prAccountState`
 * Deprecate `RewardAcnt` in favor of `RewardAccount`
+* Remove `registerInitialFunds` and `registerInitialStaking`
+* Add `registerInitialFundsThenStaking`
 
 ### `testlib`
 

eras/shelley/impl/src/Cardano/Ledger/Shelley/Transition.hs

@@ -24,8 +24,7 @@ module Cardano.Ledger.Shelley.Transition (
   tcInitialStakingL,
   mkShelleyTransitionConfig,
   createInitialState,
-  registerInitialFunds,
-  registerInitialStaking,
+  registerInitialFundsThenStaking,
   toShelleyTransitionConfigPairs,
   protectMainnet,
   protectMainnetLens,
@@ -85,6 +84,15 @@ class
     TransitionConfig (PreviousEra era) ->
     TransitionConfig era
 
+  injectIntoTestState ::
+    -- | Extract data from the given transition configuration and store it in the given state.
+    --
+    -- /Warning/ - Should only be used in testing and benchmarking. Will result in an error
+    -- when 'NetworkId' is set to 'Mainnet'.
+    TransitionConfig era ->
+    NewEpochState era ->
+    NewEpochState era
+
   -- | In case when a previous era is available, we should always be able to access
   -- `TransitionConfig` for the previous era, from within the current era's
   -- `TransitionConfig`
@@ -130,6 +138,16 @@ class
 tcNetworkIDG :: EraTransition era => SimpleGetter (TransitionConfig era) Network
 tcNetworkIDG = tcShelleyGenesisL . to sgNetworkId
 
+registerInitialFundsThenStaking ::
+  EraTransition era =>
+  TransitionConfig era ->
+  NewEpochState era ->
+  NewEpochState era
+registerInitialFundsThenStaking cfg =
+  -- We must first register the initial funds, because the stake
+  -- information depends on it.
+  registerInitialStaking cfg . registerInitialFunds cfg
+
 instance Crypto c => EraTransition (ShelleyEra c) where
   newtype TransitionConfig (ShelleyEra c) = ShelleyTransitionConfig
     { stcShelleyGenesis :: ShelleyGenesis c
@@ -139,6 +157,8 @@ instance Crypto c => EraTransition (ShelleyEra c) where
   mkTransitionConfig =
     error "Impossible: There is no EraTransition instance for ByronEra"
 
+  injectIntoTestState = registerInitialFundsThenStaking
+
   tcPreviousEraConfigL = notSupportedInThisEraL
 
   tcTranslationContextL =
@@ -228,6 +248,8 @@ toShelleyTransitionConfigPairs stc@(ShelleyTransitionConfig _) =
 --
 -- /Warning/ - Should only be used in testing and benchmarking. Will result in an error
 -- when NetworkId is set to Mainnet
+--
+-- This function does not register any initial funds or delegates.
 createInitialState ::
   forall era.
   (EraTransition era, HasCallStack) =>
@@ -278,7 +300,7 @@ createInitialState tc =
     initialEpochNo :: EpochNo
     initialEpochNo = 0
     initialUtxo :: UTxO era
-    initialUtxo = genesisUTxO sg
+    initialUtxo = mempty
     reserves :: Coin
     reserves = word64ToCoin (sgMaxLovelaceSupply sg) <-> coinBalance initialUtxo
 

libs/cardano-ledger-api/CHANGELOG.md

@@ -11,6 +11,8 @@
 * Deprecate `deserialiseRewardAcnt` in favor of `deserialiseRewardAccount`
 * Deprecate `serialiseRewardAcnt` in favor of `serialiseRewardAccount`
 * Deprecate `RewardAcnt` in favor of `RewardAccount`
+* Remove `registerInitialFunds`, `registerInitialStaking`, `registerInitialDReps`, and `registerDelegs` in favor of `injectIntoTestState`.
+* Change the semantics of `createInitialState` to not register any initial funds or delegates.
 
 ## 1.8.0.0
 

libs/cardano-ledger-api/src/Cardano/Ledger/Api/Transition.hs

@@ -21,28 +21,19 @@ module Cardano.Ledger.Api.Transition (
   tcInitialFundsL,
   tcInitialStakingL,
   createInitialState,
-  registerInitialFunds,
-  registerInitialStaking,
-  registerInitialDReps,
-  registerDelegs,
+  injectIntoTestState,
 ) where
 
 import Cardano.Ledger.Alonzo.Genesis (AlonzoGenesis (..))
 import Cardano.Ledger.Api.Era (LatestKnownEra)
 import Cardano.Ledger.Conway.Genesis (ConwayGenesis (..))
-import Cardano.Ledger.Conway.Transition (
-  registerDelegs,
-  registerInitialDReps,
- )
 import Cardano.Ledger.Crypto
 import Cardano.Ledger.Shelley.Genesis (ShelleyGenesis (..))
 import Cardano.Ledger.Shelley.Transition (
   EraTransition (..),
   TransitionConfig,
   createInitialState,
   mkShelleyTransitionConfig,
-  registerInitialFunds,
-  registerInitialStaking,
   tcInitialFundsL,
   tcInitialStakingL,
  )