Add utxoCostPerByte parameter.

See #4052 See cardano-foundation/CIPs#265
IntersectMBO · Aug 2, 2022 · 46acf18 · 46acf18
1 parent 7c7eaca
commit 46acf18
Show file tree

Hide file tree

Showing 9 changed files with 108 additions and 67 deletions.
diff --git a/cardano-api/gen/Gen/Cardano/Api/Typed.hs b/cardano-api/gen/Gen/Cardano/Api/Typed.hs
@@ -765,6 +765,7 @@ genProtocolParameters =
     <*> Gen.maybe genNat
     <*> Gen.maybe genNat
     <*> Gen.maybe genNat
+    <*> Gen.maybe genLovelace
 
 genProtocolParametersUpdate :: Gen ProtocolParametersUpdate
 genProtocolParametersUpdate = do
@@ -795,6 +796,7 @@ genProtocolParametersUpdate = do
   protocolUpdateMaxValueSize        <- Gen.maybe genNat
   protocolUpdateCollateralPercent   <- Gen.maybe genNat
   protocolUpdateMaxCollateralInputs <- Gen.maybe genNat
+  protocolUpdateUTxOCostPerByte     <- Gen.maybe genLovelace
   pure ProtocolParametersUpdate{..}
 
 

diff --git a/cardano-api/src/Cardano/Api/Fees.hs b/cardano-api/src/Cardano/Api/Fees.hs
@@ -793,10 +793,6 @@ data TxBodyErrorAutoBalance =
        -- parameter, for eras that use this parameter.
      | TxBodyErrorMissingParamMinUTxO
 
-       -- | The 'ProtocolParameters' must provide the value for the cost per
-       -- word parameter, for eras that use this parameter.
-     | TxBodyErrorMissingParamCostPerWord
-
        -- | The transaction validity interval is too far into the future.
        -- See 'TransactionValidityIntervalError' for details.
      | TxBodyErrorValidityInterval TransactionValidityError
@@ -856,9 +852,6 @@ instance Error TxBodyErrorAutoBalance where
   displayError TxBodyErrorMissingParamMinUTxO =
       "The minUTxOValue protocol parameter is required but missing"
 
-  displayError TxBodyErrorMissingParamCostPerWord =
-      "The utxoCostPerWord protocol parameter is required but missing"
-
   displayError (TxBodyErrorValidityInterval err) =
       displayError err
 
@@ -1268,13 +1261,9 @@ calculateMinimumUTxO era txout@(TxOut _ v _ _) pparams' =
 
 data MinimumUTxOError =
     PParamsMinUTxOMissing
-  | PParamsUTxOCostPerWordMissing
   deriving Show
 
 instance Error MinimumUTxOError where
   displayError PParamsMinUTxOMissing =
     "\"minUtxoValue\" field not present in protocol parameters when \
     \trying to calculate minimum UTxO value."
-  displayError PParamsUTxOCostPerWordMissing =
-    "\"utxoCostPerWord\" field not present in protocol parameters when \
-    \trying to calculate minimum UTxO value."
diff --git a/cardano-api/src/Cardano/Api/ProtocolParameters.hs b/cardano-api/src/Cardano/Api/ProtocolParameters.hs
diff --git a/cardano-api/src/Cardano/Api/Value.hs b/cardano-api/src/Cardano/Api/Value.hs
@@ -88,14 +88,13 @@ import           Cardano.Api.SerialiseRaw
 import           Cardano.Api.SerialiseUsing
 import           Cardano.Api.Utils (failEitherWith)
 
-
 -- ----------------------------------------------------------------------------
 -- Lovelace
 --
 
 newtype Lovelace = Lovelace Integer
   deriving stock (Eq, Ord, Show)
-  deriving newtype (Enum, Num, ToJSON, FromJSON, ToCBOR, FromCBOR)
+  deriving newtype (Enum, Real, Integral, Num, ToJSON, FromJSON, ToCBOR, FromCBOR)
 
 instance Semigroup Lovelace where
   Lovelace a <> Lovelace b = Lovelace (a + b)

diff --git a/cardano-cli/src/Cardano/CLI/Run/Friendly.hs b/cardano-cli/src/Cardano/CLI/Run/Friendly.hs
@@ -231,6 +231,7 @@ friendlyProtocolParametersUpdate
     , protocolUpdateMaxTxExUnits
     , protocolUpdateMaxValueSize
     , protocolUpdatePrices
+    , protocolUpdateUTxOCostPerByte
     } =
   object . catMaybes $
     [ protocolUpdateProtocolVersion <&> \(major, minor) ->
@@ -258,14 +259,16 @@ friendlyProtocolParametersUpdate
         ("monetary expansion" .=) . friendlyRational
     , protocolUpdateTreasuryCut <&> ("treasury expansion" .=) . friendlyRational
     , protocolUpdateUTxOCostPerWord <&>
-        ("UTxO storage cost per unit" .=) . friendlyLovelace
+        ("UTxO storage cost per word" .=) . friendlyLovelace
     , protocolUpdateCollateralPercent <&>
         ("collateral inputs share" .=) . (<> "%") . textShow
     , protocolUpdateMaxBlockExUnits <&> ("max block execution units" .=)
     , protocolUpdateMaxCollateralInputs <&> ("max collateral inputs" .=)
     , protocolUpdateMaxTxExUnits <&> ("max transaction execution units" .=)
     , protocolUpdateMaxValueSize <&> ("max value size" .=)
     , protocolUpdatePrices <&> ("execution prices" .=) . friendlyPrices
+    , protocolUpdateUTxOCostPerByte <&>
+        ("UTxO storage cost per byte" .=) . friendlyLovelace
     ]
 
 friendlyPrices :: ExecutionUnitPrices -> Aeson.Value

diff --git a/cardano-cli/src/Cardano/CLI/Shelley/Parsers.hs b/cardano-cli/src/Cardano/CLI/Shelley/Parsers.hs
@@ -2903,6 +2903,7 @@ pProtocolParametersUpdate =
     <*> optional pMaxValueSize
     <*> optional pCollateralPercent
     <*> optional pMaxCollateralInputs
+    <*> optional pUTxOCostPerByte
 
 pCostModels :: Parser FilePath
 pCostModels =
@@ -3062,6 +3063,14 @@ pUTxOCostPerWord =
       <> Opt.help "Cost in lovelace per unit of UTxO storage (from Alonzo era)."
       )
 
+pUTxOCostPerByte :: Parser Lovelace
+pUTxOCostPerByte =
+    Opt.option (readerFromParsecParser parseLovelace)
+      (  Opt.long "utxo-cost-per-byte"
+      <> Opt.metavar "LOVELACE"
+      <> Opt.help "Cost in lovelace per unit of UTxO storage (from Babbage era)."
+      )
+
 pExecutionUnitPrices :: Parser ExecutionUnitPrices
 pExecutionUnitPrices = ExecutionUnitPrices
   <$> Opt.option readRational

diff --git a/cardano-cli/test/data/golden/alonzo/transaction-view.out b/cardano-cli/test/data/golden/alonzo/transaction-view.out
@@ -17,7 +17,7 @@ update proposal:
   updates:
   - genesis key hash: 1bafa294233a5a7ffbf539ae798da0943aa83d2a19398c2d0e5af114
     update:
-      UTxO storage cost per unit: 194 Lovelace
+      UTxO storage cost per word: 194 Lovelace
       collateral inputs share: 200%
       execution prices:
         memory: 196/197

diff --git a/cardano-node/src/Cardano/Node/Tracing/Era/Shelley.hs b/cardano-node/src/Cardano/Node/Tracing/Era/Shelley.hs
@@ -434,9 +434,9 @@ instance ( ShelleyBasedEra era
     mconcat [ "kind" .= String "InvalidWitnessesUTXOW"
              , "invalidWitnesses" .= map textShow wits'
              ]
-  forMachine _dtal (MissingVKeyWitnessesUTXOW (WitHashes wits')) =
+  forMachine _dtal (MissingVKeyWitnessesUTXOW wits') =
     mconcat [ "kind" .= String "MissingVKeyWitnessesUTXOW"
-             , "missingWitnesses" .= wits'
+             , "missingWitnesses" .= String (Text.pack $ show wits')
              ]
   forMachine _dtal (MissingScriptWitnessesUTXOW missingScripts) =
     mconcat [ "kind" .= String "MissingScriptWitnessesUTXOW"

diff --git a/cardano-node/src/Cardano/Tracing/OrphanInstances/Shelley.hs b/cardano-node/src/Cardano/Tracing/OrphanInstances/Shelley.hs
@@ -372,10 +372,10 @@ instance ( ShelleyBasedEra era
     mconcat [ "kind" .= String "InvalidWitnessesUTXOW"
              , "invalidWitnesses" .= map textShow wits'
              ]
-  toObject _verb (MissingVKeyWitnessesUTXOW (WitHashes wits')) =
+  toObject _verb (MissingVKeyWitnessesUTXOW wits') =
     mconcat [ "kind" .= String "MissingVKeyWitnessesUTXOW"
-             , "missingWitnesses" .= wits'
-             ]
+            , "missingWitnesses" .= String (Text.pack $ show wits')
+            ]
   toObject _verb (MissingScriptWitnessesUTXOW missingScripts) =
     mconcat [ "kind" .= String "MissingScriptWitnessesUTXOW"
              , "missingScripts" .= missingScripts