Consistent output for the query ledger-state command

newhoggy · newhoggy · commit 681e191fc576 · 2025-05-06T19:57:31.000+10:00
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Query/Command.hs b/cardano-cli/src/Cardano/CLI/EraBased/Query/Command.hs
@@ -142,6 +142,7 @@ data QueryUTxOCmdArgs = QueryUTxOCmdArgs
 
 data QueryLedgerStateCmdArgs = QueryLedgerStateCmdArgs
   { commons :: !QueryCommons
+  , outputFormat :: !(Vary [FormatJson, FormatText])
   , mOutFile :: !(Maybe (File () Out))
   }
   deriving (Generic, Show)
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Query/Option.hs b/cardano-cli/src/Cardano/CLI/EraBased/Query/Option.hs
@@ -415,6 +415,11 @@ pQueryLedgerStateCmd era envCli =
   fmap QueryLedgerStateCmd $
     QueryLedgerStateCmdArgs
       <$> pQueryCommons era envCli
+      <*> pFormatFlags
+        "ledger-state query output"
+        [ flagFormatJson & setDefault
+        , flagFormatText
+        ]
       <*> pMaybeOutputFile
 
 pQueryLedgerPeerSnapshotCmd :: ShelleyBasedEra era -> EnvCli -> Parser (QueryCmds era)
diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Query/Run.hs b/cardano-cli/src/Cardano/CLI/EraBased/Query/Run.hs
@@ -791,24 +791,55 @@ runQueryLedgerStateCmd
           { Cmd.nodeConnInfo
           , Cmd.target
           }
+      , Cmd.outputFormat
       , Cmd.mOutFile
       }
     ) = do
-    join $
-      lift
-        ( executeLocalStateQueryExpr nodeConnInfo target $ runExceptT $ do
-            AnyCardanoEra era <- easyRunQueryCurrentEra
-
-            sbe <-
-              requireShelleyBasedEra era
-                & onNothing (left QueryCmdByronEra)
-
-            result <- easyRunQuery (queryDebugLedgerState sbe)
-
-            pure $ shelleyBasedEraConstraints sbe (writeLedgerState mOutFile) result
-        )
-        & onLeft (left . QueryCmdAcquireFailure)
-        & onLeft left
+    writeOutputContents <- case mOutFile of
+      Nothing -> pure LBS.putStr
+      Just (File fpath) -> pure $ LBS.writeFile fpath
+
+    contents <-
+      join $
+        lift
+          ( executeLocalStateQueryExpr nodeConnInfo target $ runExceptT $ do
+              AnyCardanoEra era <- easyRunQueryCurrentEra
+
+              sbe <-
+                requireShelleyBasedEra era
+                  & onNothing (left QueryCmdByronEra)
+
+              serialisedDebugLedgerState <- easyRunQuery (queryDebugLedgerState sbe)
+
+              pure $
+                shelleyBasedEraConstraints sbe $
+                  outputFormat
+                    & ( id
+                          . Vary.on (\FormatJson -> ledgerStateAsJsonByteString serialisedDebugLedgerState)
+                          . Vary.on (\FormatText -> ledgerStateAsTextByteString serialisedDebugLedgerState)
+                          $ Vary.exhaustiveCase
+                      )
+          )
+          & onLeft (left . QueryCmdAcquireFailure)
+          & onLeft left
+
+    liftIO $ writeOutputContents contents
+
+ledgerStateAsJsonByteString
+  :: IsShelleyBasedEra era
+  => SerialisedDebugLedgerState era
+  -> ExceptT QueryCmdError IO LBS.ByteString
+ledgerStateAsJsonByteString serialisedDebugLedgerState =
+  case decodeDebugLedgerState serialisedDebugLedgerState of
+    Left (bs, _decoderError) -> firstExceptT QueryCmdHelpersError $ cborToTextByteString bs
+    Right decodededgerState -> pure $ Aeson.encode decodededgerState <> "\n"
+
+ledgerStateAsTextByteString
+  :: Applicative f
+  => SerialisedDebugLedgerState era -> f LBS.ByteString
+ledgerStateAsTextByteString serialisedDebugLedgerState =
+  let SerialisedDebugLedgerState serLedgerState = serialisedDebugLedgerState
+   in pure $ unSerialised serLedgerState
 
 runQueryLedgerPeerSnapshot
   :: ()
@@ -1046,25 +1077,6 @@ writeStakeAddressInfo
             mDRep = Map.lookup addr voteDelegatees
       ]
 
-writeLedgerState
-  :: forall era ledgerera
-   . ShelleyLedgerEra era ~ ledgerera
-  => ToJSON (DebugLedgerState era)
-  => FromCBOR (DebugLedgerState era)
-  => Maybe (File () Out)
-  -> SerialisedDebugLedgerState era
-  -> ExceptT QueryCmdError IO ()
-writeLedgerState mOutFile qState@(SerialisedDebugLedgerState serLedgerState) =
-  case mOutFile of
-    Nothing ->
-      case decodeDebugLedgerState qState of
-        Left (bs, _decoderError) -> firstExceptT QueryCmdHelpersError $ pPrintCBOR bs
-        Right ledgerState -> liftIO . LBS.putStrLn $ Aeson.encode ledgerState
-    Just (File fpath) ->
-      handleIOExceptT (QueryCmdWriteFileError . FileIOError fpath) $
-        LBS.writeFile fpath $
-          unSerialised serLedgerState
-
 -- | Writes JSON-encoded big ledger peer snapshot
 writeLedgerPeerSnapshot
   :: Maybe (File () Out)
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help.cli
@@ -371,6 +371,7 @@ Usage: cardano-cli query ledger-state [--cardano-mode [--epoch-slots SLOTS]]
                                         (--mainnet | --testnet-magic NATURAL)
                                         --socket-path SOCKET_PATH
                                         [--volatile-tip | --immutable-tip]
+                                        [--output-json | --output-text]
                                         [--out-file FILEPATH]
 
   Dump the current ledger state of the node (Ledger.NewEpochState -- advanced
@@ -2062,6 +2063,7 @@ Usage: cardano-cli conway query ledger-state
                                                [ --volatile-tip
                                                | --immutable-tip
                                                ]
+                                               [--output-json | --output-text]
                                                [--out-file FILEPATH]
 
   Dump the current ledger state of the node (Ledger.NewEpochState -- advanced
@@ -4298,6 +4300,7 @@ Usage: cardano-cli latest query ledger-state
                                                [ --volatile-tip
                                                | --immutable-tip
                                                ]
+                                               [--output-json | --output-text]
                                                [--out-file FILEPATH]
 
   Dump the current ledger state of the node (Ledger.NewEpochState -- advanced
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_ledger-state.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_ledger-state.cli
@@ -8,6 +8,7 @@ Usage: cardano-cli conway query ledger-state
                                                [ --volatile-tip
                                                | --immutable-tip
                                                ]
+                                               [--output-json | --output-text]
                                                [--out-file FILEPATH]
 
   Dump the current ledger state of the node (Ledger.NewEpochState -- advanced
@@ -30,5 +31,7 @@ Available options:
   --volatile-tip           Use the volatile tip as a target. (This is the
                            default)
   --immutable-tip          Use the immutable tip as a target.
+  --output-json            Format ledger-state query output to JSON (default).
+  --output-text            Format ledger-state query output to TEXT.
   --out-file FILEPATH      Optional output file. Default is to write to stdout.
   -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_ledger-state.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_ledger-state.cli
@@ -8,6 +8,7 @@ Usage: cardano-cli latest query ledger-state
                                                [ --volatile-tip
                                                | --immutable-tip
                                                ]
+                                               [--output-json | --output-text]
                                                [--out-file FILEPATH]
 
   Dump the current ledger state of the node (Ledger.NewEpochState -- advanced
@@ -30,5 +31,7 @@ Available options:
   --volatile-tip           Use the volatile tip as a target. (This is the
                            default)
   --immutable-tip          Use the immutable tip as a target.
+  --output-json            Format ledger-state query output to JSON (default).
+  --output-text            Format ledger-state query output to TEXT.
   --out-file FILEPATH      Optional output file. Default is to write to stdout.
   -h,--help                Show this help text
diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/query_ledger-state.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/query_ledger-state.cli
@@ -2,6 +2,7 @@ Usage: cardano-cli query ledger-state [--cardano-mode [--epoch-slots SLOTS]]
                                         (--mainnet | --testnet-magic NATURAL)
                                         --socket-path SOCKET_PATH
                                         [--volatile-tip | --immutable-tip]
+                                        [--output-json | --output-text]
                                         [--out-file FILEPATH]
 
   Dump the current ledger state of the node (Ledger.NewEpochState -- advanced
@@ -24,5 +25,7 @@ Available options:
   --volatile-tip           Use the volatile tip as a target. (This is the
                            default)
   --immutable-tip          Use the immutable tip as a target.
+  --output-json            Format ledger-state query output to JSON (default).
+  --output-text            Format ledger-state query output to TEXT.
   --out-file FILEPATH      Optional output file. Default is to write to stdout.
   -h,--help                Show this help text

Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,7 @@ data QueryUTxOCmdArgs = QueryUTxOCmdArgs`
`142`	`142`
`143`	`143`	`data QueryLedgerStateCmdArgs = QueryLedgerStateCmdArgs`
`144`	`144`	`{ commons :: !QueryCommons`
	`145`	`+ , outputFormat :: !(Vary [FormatJson, FormatText])`
`145`	`146`	`, mOutFile :: !(Maybe (File () Out))`
`146`	`147`	`}`
`147`	`148`	`deriving (Generic, Show)`