Add support to obtain start time from Byron genesis file

Author: palas

cardano-cli/src/Cardano/CLI/EraBased/Transaction/Command.hs

@@ -23,6 +23,7 @@ module Cardano.CLI.EraBased.Transaction.Command
   , NodeContextInfo (..)
   , TransactionContext (..)
   , MustExtendSafeZone (..)
+  , SystemStartOrGenesisFile (..)
   )
 where
 
@@ -263,13 +264,18 @@ data NodeContextInfo
 -- | Transaction context, requried to evaluate the execution
 -- costs of the plutus scripts in the transaction.
 data TransactionContext = TransactionContext
-  { systemStart :: SystemStart
+  { systemStartSource :: SystemStartOrGenesisFile
   , mustExtendSafeZone :: MustExtendSafeZone
   , eraHistoryFile :: File EraHistory In
   , utxoFile :: FilePath
   , protocolParamsFile :: ProtocolParamsFile
   }
 
+-- | The system start time or a means to get it (the genesis file)
+data SystemStartOrGenesisFile
+  = SystemStartLiteral !SystemStart
+  | SystemStartFromGenesisFile !GenesisFile
+
 -- | Whether the safe zone for the era history must be respected
 -- when evaluating the execution costs of the plutus scripts in the transaction.
 --

cardano-cli/src/Cardano/CLI/EraBased/Transaction/Option.hs

@@ -432,8 +432,14 @@ pMustExtendEraHistorySafeZone =
     )
     <|> pure DoNotExtendSafeZone
 
-pSystemStart :: Parser SystemStart
-pSystemStart = systemStartUTC <|> systemStartPOSIX
+pSystemStart :: Parser SystemStartOrGenesisFile
+pSystemStart =
+  (SystemStartLiteral <$> (systemStartUTC <|> systemStartPOSIX))
+    <|> ( SystemStartFromGenesisFile . GenesisFile
+            <$> parseFilePath
+              "start-time-from-byron-genesis-file"
+              "Path to the Byron genesis file from which to get the start time."
+        )
 
 systemStartPOSIX :: Parser SystemStart
 systemStartPOSIX =

cardano-cli/src/Cardano/CLI/EraBased/Transaction/Run.hs

@@ -1697,7 +1697,7 @@ runTransactionCalculatePlutusScriptCostCmd
             & onLeft (left . TxCmdQueryConvenienceError)
         TransactionContextInfo
           ( TransactionContext
-              { systemStart
+              { systemStartSource
               , mustExtendSafeZone
               , eraHistoryFile
               , utxoFile
@@ -1706,7 +1706,7 @@ runTransactionCalculatePlutusScriptCostCmd
             ) -> do
             buildTransactionContext
               sbe
-              systemStart
+              systemStartSource
               mustExtendSafeZone
               eraHistoryFile
               utxoFile
@@ -1779,7 +1779,7 @@ runTransactionCalculatePlutusScriptCostCmd
 
 buildTransactionContext
   :: ShelleyBasedEra era
-  -> SystemStart
+  -> SystemStartOrGenesisFile
   -> MustExtendSafeZone
   -> File EraHistory In
   -> FilePath
@@ -1788,14 +1788,20 @@ buildTransactionContext
        TxCmdError
        IO
        (AnyCardanoEra, SystemStart, EraHistory, UTxO era, LedgerProtocolParameters era)
-buildTransactionContext sbe systemStart mustUnsafeExtendSafeZone eraHistoryFile utxoFile protocolParamsFile =
+buildTransactionContext sbe systemStartOrGenesisFile mustUnsafeExtendSafeZone eraHistoryFile utxoFile protocolParamsFile =
   shelleyBasedEraConstraints sbe $ do
     ledgerPParams <-
       firstExceptT TxCmdProtocolParamsError $ readProtocolParameters sbe protocolParamsFile
     EraHistory interpreter <-
       onLeft (left . TxCmdTextEnvError) $
         liftIO $
           readFileTextEnvelope (proxyToAsType (error "Proxy type for EraHistory evaluated")) eraHistoryFile
+    systemStart <- case systemStartOrGenesisFile of
+      SystemStartLiteral systemStart -> return systemStart
+      SystemStartFromGenesisFile (GenesisFile byronGenesisFile) -> do
+        (byronGenesisData, _) <- firstExceptT TxCmdGenesisDataError $ Byron.readGenesisData byronGenesisFile
+        let systemStartUTCTime = Byron.gdStartTime byronGenesisData
+        return $ SystemStart systemStartUTCTime
     utxosBytes <- handleIOExceptT (TxCmdUTxOFileError . FileIOError utxoFile) $ BS.readFile utxoFile
     utxos <- firstExceptT TxCmdUTxOJSONError $ ExceptT (return $ Aeson.eitherDecodeStrict' utxosBytes)
     let eraHistory = EraHistory $ case mustUnsafeExtendSafeZone of

cardano-cli/src/Cardano/CLI/Type/Error/TxCmdError.hs

@@ -15,6 +15,7 @@ module Cardano.CLI.Type.Error.TxCmdError
 where
 
 import Cardano.Api
+import Cardano.Api.Byron (GenesisDataError)
 import Cardano.Api.Consensus (EraMismatch (..))
 import Cardano.Api.Ledger qualified as L
 import Cardano.Api.Shelley
@@ -35,6 +36,8 @@ import Cardano.Prelude qualified as List
 
 import Data.Set (Set)
 import Data.Text (Text)
+import Data.Text.Lazy.Builder (toLazyText)
+import Formatting.Buildable (Buildable (build))
 
 {- HLINT ignore "Use let" -}
 
@@ -96,6 +99,7 @@ data TxCmdError
   | forall era. TxCmdAlonzoEraOnwardsRequired !(CardanoEra era)
   | TxCmdUTxOFileError !(FileError JsonDecodeError)
   | TxCmdUTxOJSONError String
+  | TxCmdGenesisDataError GenesisDataError
 
 instance Show TxCmdError where
   show = show . renderTxCmdError
@@ -251,6 +255,8 @@ renderTxCmdError = \case
     "Error while reading UTxO set from JSON file: " <> prettyError e
   TxCmdUTxOJSONError e ->
     "Error while reading UTxO set from JSON file: " <> pretty e
+  TxCmdGenesisDataError genesisDataError ->
+    "Error while reading Byron genesis data: " <> pshow (toLazyText $ build genesisDataError)
 
 prettyPolicyIdList :: [PolicyId] -> Doc ann
 prettyPolicyIdList =

cardano-cli/test/cardano-cli-golden/files/golden/help.cli

@@ -3126,6 +3126,7 @@ Usage: cardano-cli conway transaction calculate-min-required-utxo --protocol-par
 Usage: cardano-cli conway transaction calculate-plutus-script-cost 
                                                                      ( ( --start-time-utc UTC-TIME
                                                                        | --start-time-posix POSIX-TIME
+                                                                       | --start-time-from-byron-genesis-file FILEPATH
                                                                        )
                                                                        [--unsafe-extend-safe-zone]
                                                                        --era-history-file FILEPATH
@@ -5296,6 +5297,7 @@ Usage: cardano-cli latest transaction calculate-min-required-utxo --protocol-par
 Usage: cardano-cli latest transaction calculate-plutus-script-cost 
                                                                      ( ( --start-time-utc UTC-TIME
                                                                        | --start-time-posix POSIX-TIME
+                                                                       | --start-time-from-byron-genesis-file FILEPATH
                                                                        )
                                                                        [--unsafe-extend-safe-zone]
                                                                        --era-history-file FILEPATH

cardano-cli/test/cardano-cli-golden/files/golden/help/allegra_transaction_calculate-plutus-script-cost.cli

@@ -1,6 +1,7 @@
 Usage: cardano-cli allegra transaction calculate-plutus-script-cost 
                                                                       ( ( --start-time-utc UTC-TIME
                                                                         | --start-time-posix POSIX-TIME
+                                                                        | --start-time-from-byron-genesis-file FILEPATH
                                                                         )
                                                                         [--unsafe-extend-safe-zone]
                                                                         --era-history-file FILEPATH
@@ -24,6 +25,9 @@ Available options:
                            format.
   --start-time-posix POSIX-TIME
                            The genesis start time as POSIX seconds.
+  --start-time-from-byron-genesis-file FILEPATH
+                           Path to the Byron genesis file from which to get the
+                           start time.
   --unsafe-extend-safe-zone
                            Allow extending the validity of the era history past
                            the safe zone. The safe zone is a period of time

cardano-cli/test/cardano-cli-golden/files/golden/help/alonzo_transaction_calculate-plutus-script-cost.cli

@@ -1,6 +1,7 @@
 Usage: cardano-cli alonzo transaction calculate-plutus-script-cost 
                                                                      ( ( --start-time-utc UTC-TIME
                                                                        | --start-time-posix POSIX-TIME
+                                                                       | --start-time-from-byron-genesis-file FILEPATH
                                                                        )
                                                                        [--unsafe-extend-safe-zone]
                                                                        --era-history-file FILEPATH
@@ -24,6 +25,9 @@ Available options:
                            format.
   --start-time-posix POSIX-TIME
                            The genesis start time as POSIX seconds.
+  --start-time-from-byron-genesis-file FILEPATH
+                           Path to the Byron genesis file from which to get the
+                           start time.
   --unsafe-extend-safe-zone
                            Allow extending the validity of the era history past
                            the safe zone. The safe zone is a period of time

cardano-cli/test/cardano-cli-golden/files/golden/help/babbage_transaction_calculate-plutus-script-cost.cli

@@ -1,6 +1,7 @@
 Usage: cardano-cli babbage transaction calculate-plutus-script-cost 
                                                                       ( ( --start-time-utc UTC-TIME
                                                                         | --start-time-posix POSIX-TIME
+                                                                        | --start-time-from-byron-genesis-file FILEPATH
                                                                         )
                                                                         [--unsafe-extend-safe-zone]
                                                                         --era-history-file FILEPATH
@@ -24,6 +25,9 @@ Available options:
                            format.
   --start-time-posix POSIX-TIME
                            The genesis start time as POSIX seconds.
+  --start-time-from-byron-genesis-file FILEPATH
+                           Path to the Byron genesis file from which to get the
+                           start time.
   --unsafe-extend-safe-zone
                            Allow extending the validity of the era history past
                            the safe zone. The safe zone is a period of time

cardano-cli/test/cardano-cli-golden/files/golden/help/conway_transaction_calculate-plutus-script-cost.cli

@@ -1,6 +1,7 @@
 Usage: cardano-cli conway transaction calculate-plutus-script-cost 
                                                                      ( ( --start-time-utc UTC-TIME
                                                                        | --start-time-posix POSIX-TIME
+                                                                       | --start-time-from-byron-genesis-file FILEPATH
                                                                        )
                                                                        [--unsafe-extend-safe-zone]
                                                                        --era-history-file FILEPATH
@@ -24,6 +25,9 @@ Available options:
                            format.
   --start-time-posix POSIX-TIME
                            The genesis start time as POSIX seconds.
+  --start-time-from-byron-genesis-file FILEPATH
+                           Path to the Byron genesis file from which to get the
+                           start time.
   --unsafe-extend-safe-zone
                            Allow extending the validity of the era history past
                            the safe zone. The safe zone is a period of time

cardano-cli/test/cardano-cli-golden/files/golden/help/latest_transaction_calculate-plutus-script-cost.cli

@@ -1,6 +1,7 @@
 Usage: cardano-cli latest transaction calculate-plutus-script-cost 
                                                                      ( ( --start-time-utc UTC-TIME
                                                                        | --start-time-posix POSIX-TIME
+                                                                       | --start-time-from-byron-genesis-file FILEPATH
                                                                        )
                                                                        [--unsafe-extend-safe-zone]
                                                                        --era-history-file FILEPATH
@@ -24,6 +25,9 @@ Available options:
                            format.
   --start-time-posix POSIX-TIME
                            The genesis start time as POSIX seconds.
+  --start-time-from-byron-genesis-file FILEPATH
+                           Path to the Byron genesis file from which to get the
+                           start time.
   --unsafe-extend-safe-zone
                            Allow extending the validity of the era history past
                            the safe zone. The safe zone is a period of time