Add documentation regarding parameters update

IntersectMBO · May 7, 2024 · cadcaa3 · cadcaa3
1 parent 09aa0ba
commit cadcaa3
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/cardano-api/internal/Cardano/Api/ProtocolParameters.hs b/cardano-api/internal/Cardano/Api/ProtocolParameters.hs
@@ -459,7 +459,9 @@ createIntroducedInBabbagePParams w (IntroducedInBabbagePParams coinsPerUTxOByte)
 -- 'UpdateProposal', which contains a 'ProtocolParametersUpdate'.
 --
 -- The 'ProtocolParametersUpdate' is essentially a diff for the
--- 'ProtocolParameters'.
+-- 'ProtocolParameters', up to Alonzo included. Starting at Conway,
+-- updates to era-specific fields of 'ProtocolParameters' are handled
+-- with 'EraBasedProtocolParametersUpdate'.
 --
 -- There are also parameters fixed in the Genesis file. See 'GenesisParameters'.
 --
@@ -892,6 +894,9 @@ data ProtocolParametersUpdate =
        --
        -- /Introduced in Babbage/
        protocolUpdateUTxOCostPerByte :: Maybe L.Coin
+
+       -- Fields introduced in Conway and onwards are not added here. They
+       -- are handled via EraBasedProtocolParametersUpdate.
     }
   deriving (Eq, Show)