Skip to content

Commit 4cbe194

Browse files
committed
New pFormatQueryOutput function
1 parent 5f38070 commit 4cbe194

File tree

4 files changed

+60
-52
lines changed

4 files changed

+60
-52
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ runGenesisTxInCmd
205205
readFileTextEnvelope verificationKeyPath
206206
let txin = genesisUTxOPseudoTxIn network (verificationKeyHash vkey)
207207

208-
cioWriteTextOutput mOutFile (renderTxIn txin)
208+
maybeWriteTextOutput mOutFile (renderTxIn txin)
209209

210210
runGenesisAddrCmd
211211
:: GenesisAddrCmdArgs
@@ -226,7 +226,7 @@ runGenesisAddrCmd
226226
(PaymentCredentialByKey vkh)
227227
NoStakeAddress
228228

229-
cioWriteTextOutput mOutFile (serialiseAddress addr)
229+
maybeWriteTextOutput mOutFile (serialiseAddress addr)
230230

231231
--
232232
-- Create Genesis command implementation
@@ -1359,11 +1359,11 @@ runGenesisHashFileCmd (GenesisFile fpath) = do
13591359
gh = Crypto.hashWith id content
13601360
liftIO $ Text.putStrLn (Crypto.hashToTextAsHex gh)
13611361

1362-
cioWriteTextOutput
1362+
maybeWriteTextOutput
13631363
:: Maybe (File content Out)
13641364
-> Text
13651365
-> CIO e ()
1366-
cioWriteTextOutput mOutput t =
1366+
maybeWriteTextOutput mOutput t =
13671367
case mOutput of
13681368
Just fp -> liftIO $ Text.writeFile (unFile fp) t
13691369
Nothing -> liftIO $ Text.putStr t

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

Lines changed: 52 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import Data.Function
3030
import GHC.Exts (IsList (..))
3131
import Options.Applicative hiding (help, str)
3232
import Options.Applicative qualified as Opt
33+
import Vary (Vary)
3334

3435
pQueryCmdsTopLevel :: EnvCli -> Parser (QueryCmds ConwayEra)
3536
pQueryCmdsTopLevel envCli =
@@ -355,8 +356,8 @@ pQueryProtocolParametersCmd envCli =
355356
<*> pNetworkId envCli
356357
<*> pSocketPath envCli
357358
)
358-
<*> pFormatFlags
359-
"protocol-parameters query output"
359+
<*> pFormatQueryOutputFlags
360+
"protocol-parameters"
360361
[ flagFormatJson & setDefault
361362
, flagFormatYaml
362363
]
@@ -367,8 +368,8 @@ pQueryTipCmd era envCli =
367368
fmap QueryTipCmd $
368369
QueryTipCmdArgs
369370
<$> pQueryCommons era envCli
370-
<*> pFormatFlags
371-
"tip query output"
371+
<*> pFormatQueryOutputFlags
372+
"tip"
372373
[ flagFormatJson & setDefault
373374
, flagFormatYaml
374375
]
@@ -380,8 +381,8 @@ pQueryUTxOCmd era envCli =
380381
QueryUTxOCmdArgs
381382
<$> pQueryCommons era envCli
382383
<*> pQueryUTxOFilter
383-
<*> pFormatFlags
384-
"utxo query output"
384+
<*> pFormatQueryOutputFlags
385+
"utxo"
385386
[ flagFormatCborBin
386387
, flagFormatCborHex
387388
, flagFormatJson & setDefault
@@ -394,8 +395,8 @@ pQueryStakePoolsCmd era envCli =
394395
fmap QueryStakePoolsCmd $
395396
QueryStakePoolsCmdArgs
396397
<$> pQueryCommons era envCli
397-
<*> pFormatFlags
398-
"stake-pools query output"
398+
<*> pFormatQueryOutputFlags
399+
"stake-pools"
399400
[ flagFormatJson & setDefault
400401
, flagFormatText
401402
]
@@ -406,8 +407,8 @@ pQueryStakeDistributionCmd era envCli =
406407
fmap QueryStakeDistributionCmd $
407408
QueryStakeDistributionCmdArgs
408409
<$> pQueryCommons era envCli
409-
<*> pFormatFlags
410-
"stake-distribution query output"
410+
<*> pFormatQueryOutputFlags
411+
"stake-distribution"
411412
[ flagFormatJson & setDefault
412413
, flagFormatText
413414
]
@@ -419,8 +420,8 @@ pQueryStakeAddressInfoCmd era envCli =
419420
QueryStakeAddressInfoCmdArgs
420421
<$> pQueryCommons era envCli
421422
<*> pFilterByStakeAddress
422-
<*> pFormatFlags
423-
"stake-address-info query output"
423+
<*> pFormatQueryOutputFlags
424+
"stake-address-info"
424425
[ flagFormatJson & setDefault
425426
, flagFormatYaml
426427
]
@@ -431,8 +432,8 @@ pQueryLedgerStateCmd era envCli =
431432
fmap QueryLedgerStateCmd $
432433
QueryLedgerStateCmdArgs
433434
<$> pQueryCommons era envCli
434-
<*> pFormatFlags
435-
"ledger-state query output"
435+
<*> pFormatQueryOutputFlags
436+
"ledger-state"
436437
[ flagFormatJson & setDefault
437438
, flagFormatText
438439
]
@@ -443,8 +444,8 @@ pQueryLedgerPeerSnapshotCmd era envCli =
443444
fmap QueryLedgerPeerSnapshotCmd $
444445
QueryLedgerPeerSnapshotCmdArgs
445446
<$> pQueryCommons era envCli
446-
<*> pFormatFlags
447-
"ledger-peer-snapshot query output"
447+
<*> pFormatQueryOutputFlags
448+
"ledger-peer-snapshot"
448449
[ flagFormatJson & setDefault
449450
, flagFormatYaml
450451
]
@@ -455,8 +456,8 @@ pQueryProtocolStateCmd era envCli =
455456
fmap QueryProtocolStateCmd $
456457
QueryProtocolStateCmdArgs
457458
<$> pQueryCommons era envCli
458-
<*> pFormatFlags
459-
"protocol-state query output"
459+
<*> pFormatQueryOutputFlags
460+
"protocol-state"
460461
[ flagFormatCborBin
461462
, flagFormatCborHex
462463
, flagFormatJson & setDefault
@@ -483,8 +484,8 @@ pQueryStakeSnapshotCmd era envCli =
483484
QueryStakeSnapshotCmdArgs
484485
<$> pQueryCommons era envCli
485486
<*> pAllStakePoolsOrSome
486-
<*> pFormatFlags
487-
"stake-snapshot query output"
487+
<*> pFormatQueryOutputFlags
488+
"stake-snapshot"
488489
[ flagFormatJson & setDefault
489490
, flagFormatYaml
490491
]
@@ -496,8 +497,8 @@ pQueryPoolStateCmd era envCli =
496497
QueryPoolStateCmdArgs
497498
<$> pQueryCommons era envCli
498499
<*> pAllStakePoolsOrSome
499-
<*> pFormatFlags
500-
"pool-state query output"
500+
<*> pFormatQueryOutputFlags
501+
"pool-state"
501502
[ flagFormatJson & setDefault
502503
, flagFormatYaml
503504
]
@@ -513,8 +514,8 @@ pQueryTxMempoolCmd envCli =
513514
<*> pSocketPath envCli
514515
)
515516
<*> pTxMempoolQuery
516-
<*> pFormatFlags
517-
"tx-mempool query output"
517+
<*> pFormatQueryOutputFlags
518+
"tx-mempool"
518519
[ flagFormatJson & setDefault
519520
, flagFormatYaml
520521
]
@@ -546,8 +547,8 @@ pLeadershipScheduleCmd era envCli =
546547
<*> pStakePoolVerificationKeyOrHashOrFile Nothing
547548
<*> pVrfSigningKeyFile
548549
<*> pWhichLeadershipSchedule
549-
<*> pFormatFlags
550-
"leadership-schedule query output"
550+
<*> pFormatQueryOutputFlags
551+
"leadership-schedule"
551552
[ flagFormatJson & setDefault
552553
, flagFormatText
553554
, flagFormatYaml
@@ -560,8 +561,8 @@ pKesPeriodInfoCmd era envCli =
560561
QueryKesPeriodInfoCmdArgs
561562
<$> pQueryCommons era envCli
562563
<*> pOperationalCertificateFile
563-
<*> pFormatFlags
564-
"kes-period-info query output"
564+
<*> pFormatQueryOutputFlags
565+
"kes-period-info"
565566
[ flagFormatJson & setDefault
566567
, flagFormatYaml
567568
]
@@ -587,8 +588,8 @@ pQueryRefScriptSizeCmd era envCli =
587588
QueryRefScriptSizeCmdArgs
588589
<$> pQueryCommons era envCli
589590
<*> (fromList <$> some pByTxIn)
590-
<*> pFormatFlags
591-
"reference inputs query output"
591+
<*> pFormatQueryOutputFlags
592+
"reference-script-size"
592593
[ flagFormatJson & setDefault
593594
, flagFormatText
594595
]
@@ -692,8 +693,8 @@ pQueryDRepStateCmd era envCli = do
692693
]
693694
]
694695
)
695-
<*> pFormatFlags
696-
"drep-state query output"
696+
<*> pFormatQueryOutputFlags
697+
"drep-state"
697698
[ flagFormatJson & setDefault
698699
, flagFormatYaml
699700
]
@@ -718,8 +719,8 @@ pQueryDRepStakeDistributionCmd era envCli = do
718719
QueryDRepStakeDistributionCmdArgs w
719720
<$> pQueryCommons era envCli
720721
<*> pAllOrOnlyDRepHashSource
721-
<*> pFormatFlags
722-
"drep-stake-distribution query output"
722+
<*> pFormatQueryOutputFlags
723+
"drep-stake-distribution"
723724
[ flagFormatJson & setDefault
724725
, flagFormatYaml
725726
]
@@ -747,8 +748,8 @@ pQueryProposalsCmd era envCli = do
747748
QueryProposalsCmdArgs w
748749
<$> pQueryCommons (convert w) envCli
749750
<*> pAllOrOnlyGovActionIds
750-
<*> pFormatFlags
751-
"proposals query output"
751+
<*> pFormatQueryOutputFlags
752+
"proposals"
752753
[ flagFormatJson & setDefault
753754
, flagFormatYaml
754755
]
@@ -773,8 +774,8 @@ pQuerySPOStakeDistributionCmd era envCli = do
773774
QuerySPOStakeDistributionCmdArgs w
774775
<$> pQueryCommons era envCli
775776
<*> pAllOrOnlySPOHashSource
776-
<*> pFormatFlags
777-
"spo-stake-distribution query output"
777+
<*> pFormatQueryOutputFlags
778+
"spo-stake-distribution"
778779
[ flagFormatJson & setDefault
779780
, flagFormatYaml
780781
]
@@ -801,8 +802,8 @@ pQueryGetCommitteeStateCmd era envCli = do
801802
<*> many pCommitteeColdVerificationKeyOrHashOrFileOrScriptHash
802803
<*> many pCommitteeHotKeyOrHashOrFileOrScriptHash
803804
<*> many pMemberStatus
804-
<*> pFormatFlags
805-
"committee-state query output"
805+
<*> pFormatQueryOutputFlags
806+
"committee-state"
806807
[ flagFormatJson & setDefault
807808
, flagFormatYaml
808809
]
@@ -889,8 +890,8 @@ pQueryStakePoolDefaultVote era envCli = do
889890
QueryStakePoolDefaultVoteCmdArgs w
890891
<$> pQueryCommons era envCli
891892
<*> pSPOHashSource
892-
<*> pFormatFlags
893-
"stake-pool-default-vote query output"
893+
<*> pFormatQueryOutputFlags
894+
"stake-pool-default-vote"
894895
[ flagFormatJson & setDefault
895896
, flagFormatYaml
896897
]
@@ -906,8 +907,8 @@ pQueryNoArgCmdArgs
906907
pQueryNoArgCmdArgs w envCli name =
907908
QueryNoArgCmdArgs w
908909
<$> pQueryCommons (convert w) envCli
909-
<*> pFormatFlags
910-
(name <> " query output")
910+
<*> pFormatQueryOutputFlags
911+
name
911912
[ flagFormatJson & setDefault
912913
, flagFormatYaml
913914
]
@@ -951,3 +952,10 @@ pQueryEraHistoryCmd envCli =
951952
QueryEraHistoryCmdArgs
952953
<$> pQueryCommons ShelleyBasedEraConway envCli
953954
<*> pMaybeOutputFile
955+
956+
pFormatQueryOutputFlags
957+
:: String
958+
-> [Flag (Vary fs)]
959+
-> Parser (Vary fs)
960+
pFormatQueryOutputFlags content =
961+
pFormatFlags $ content <> " query output"

cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_ref-script-size.cli

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Available options:
3535
default)
3636
--immutable-tip Use the immutable tip as a target.
3737
--tx-in TX_IN Transaction input (TxId#TxIx).
38-
--output-json Format reference inputs query output to JSON
38+
--output-json Format reference-script-size query output to JSON
3939
(default).
40-
--output-text Format reference inputs query output to TEXT.
40+
--output-text Format reference-script-size query output to TEXT.
4141
--out-file FILEPATH Optional output file. Default is to write to stdout.
4242
-h,--help Show this help text

cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_ref-script-size.cli

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ Available options:
3535
default)
3636
--immutable-tip Use the immutable tip as a target.
3737
--tx-in TX_IN Transaction input (TxId#TxIx).
38-
--output-json Format reference inputs query output to JSON
38+
--output-json Format reference-script-size query output to JSON
3939
(default).
40-
--output-text Format reference inputs query output to TEXT.
40+
--output-text Format reference-script-size query output to TEXT.
4141
--out-file FILEPATH Optional output file. Default is to write to stdout.
4242
-h,--help Show this help text

0 commit comments

Comments
 (0)