Skip to content

Rollout json pretty and yaml output 2 #1180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ data GovernanceActionViewCmdArgs era
= GovernanceActionViewCmdArgs
{ eon :: !(ConwayEraOnwards era)
, actionFile :: !(ProposalFile In)
, outFormat :: !(Vary [FormatJson, FormatYaml])
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving Show
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,16 +64,16 @@ runGovernanceActionViewCmd
-> CIO e ()
runGovernanceActionViewCmd
Cmd.GovernanceActionViewCmdArgs
{ Cmd.outFormat
, Cmd.actionFile
{ Cmd.actionFile
, Cmd.outputFormat
, Cmd.mOutFile
, Cmd.eon
} = do
proposal <-
fromEitherIOCli $
readProposal eon (actionFile, Nothing)

void $ friendlyProposal outFormat mOutFile eon $ fst proposal
void $ friendlyProposal outputFormat mOutFile eon $ fst proposal

runGovernanceActionInfoCmd
:: forall era e
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ data GovernanceVoteCreateCmdArgs era
data GovernanceVoteViewCmdArgs era
= GovernanceVoteViewCmdArgs
{ eon :: ConwayEraOnwards era
, outFormat :: !(Vary [FormatJson, FormatYaml])
, voteFile :: VoteFile In
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: Maybe (File () Out)
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,10 +91,10 @@ pGovernanceVoteViewCmd era = do
pGovernanceVoteViewCmdArgs :: ConwayEraOnwards era -> Parser (GovernanceVoteViewCmdArgs era)
pGovernanceVoteViewCmdArgs cOnwards =
GovernanceVoteViewCmdArgs cOnwards
<$> pFormatFlags
<$> pFileInDirection "vote-file" "Input filepath of the vote."
<*> pFormatFlags
"governance vote view output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pFileInDirection "vote-file" "Input filepath of the vote."
<*> pMaybeOutputFile
8 changes: 5 additions & 3 deletions cardano-cli/src/Cardano/CLI/EraBased/Governance/Vote/Run.hs
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ runGovernanceVoteViewCmd
runGovernanceVoteViewCmd
Cmd.GovernanceVoteViewCmdArgs
{ eon
, outFormat
, voteFile
, outputFormat
, mOutFile
} = do
let sbe :: ShelleyBasedEra era = convert eon
Expand All @@ -116,12 +116,14 @@ runGovernanceVoteViewCmd
readVoteScriptWitness eon (voteFile, Nothing)

let output =
outFormat
outputFormat
& ( id
. Vary.on (\FormatJson -> Json.encodeJson)
. Vary.on (\FormatYaml -> Json.encodeYaml)
$ Vary.exhaustiveCase
)
$ unVotingProcedures voteProcedures

firstExceptT GovernanceVoteCmdWriteError $ newExceptT $ writeLazyByteStringOutput mOutFile output
firstExceptT GovernanceVoteCmdWriteError
. newExceptT
$ writeLazyByteStringOutput mOutFile output
21 changes: 15 additions & 6 deletions cardano-cli/src/Cardano/CLI/EraBased/Query/Command.hs
Original file line number Diff line number Diff line change
Expand Up @@ -94,48 +94,51 @@ data QueryLeadershipScheduleCmdArgs = QueryLeadershipScheduleCmdArgs
, poolColdVerKeyFile :: !StakePoolKeyHashSource
, vrkSkeyFp :: !(SigningKeyFile In)
, whichSchedule :: !EpochLeadershipSchedule
, format :: !(Vary [FormatJson, FormatText, FormatYaml])
, outputFormat :: !(Vary [FormatJson, FormatText, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryProtocolParametersCmdArgs = QueryProtocolParametersCmdArgs
{ nodeConnInfo :: !LocalNodeConnectInfo
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryTipCmdArgs = QueryTipCmdArgs
{ commons :: !QueryCommons
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryStakePoolsCmdArgs = QueryStakePoolsCmdArgs
{ commons :: !QueryCommons
, format :: !(Vary [FormatJson, FormatText])
, outputFormat :: !(Vary [FormatJson, FormatText])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryStakeDistributionCmdArgs = QueryStakeDistributionCmdArgs
{ commons :: !QueryCommons
, format :: !(Vary [FormatJson, FormatText])
, outputFormat :: !(Vary [FormatJson, FormatText])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryStakeAddressInfoCmdArgs = QueryStakeAddressInfoCmdArgs
{ commons :: !QueryCommons
, addr :: !StakeAddress
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryUTxOCmdArgs = QueryUTxOCmdArgs
{ commons :: !QueryCommons
, queryFilter :: !QueryUTxOFilter
, format :: !(Vary [FormatCbor, FormatJson, FormatText])
, outputFormat :: !(Vary [FormatCbor, FormatJson, FormatText])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)
Expand Down Expand Up @@ -163,6 +166,7 @@ data QueryProtocolStateCmdArgs = QueryProtocolStateCmdArgs
data QueryStakeSnapshotCmdArgs = QueryStakeSnapshotCmdArgs
{ commons :: !QueryCommons
, allOrOnlyPoolIds :: !(AllOrOnly (Hash StakePoolKey))
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)
Expand All @@ -171,20 +175,23 @@ data QueryKesPeriodInfoCmdArgs = QueryKesPeriodInfoCmdArgs
{ commons :: !QueryCommons
, nodeOpCertFp :: !(File () In)
-- ^ Node operational certificate
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryPoolStateCmdArgs = QueryPoolStateCmdArgs
{ commons :: !QueryCommons
, allOrOnlyPoolIds :: !(AllOrOnly (Hash StakePoolKey))
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)

data QueryTxMempoolCmdArgs = QueryTxMempoolCmdArgs
{ nodeConnInfo :: !LocalNodeConnectInfo
, query :: !TxMempoolQuery
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)
Expand All @@ -198,7 +205,7 @@ data QuerySlotNumberCmdArgs = QuerySlotNumberCmdArgs
data QueryRefScriptSizeCmdArgs = QueryRefScriptSizeCmdArgs
{ commons :: !QueryCommons
, transactionInputs :: !(Set TxIn)
, format :: !(Vary [FormatJson, FormatText])
, outputFormat :: !(Vary [FormatJson, FormatText])
, mOutFile :: !(Maybe (File () Out))
}
deriving (Generic, Show)
Expand Down Expand Up @@ -239,6 +246,7 @@ data QuerySPOStakeDistributionCmdArgs era = QuerySPOStakeDistributionCmdArgs
{ eon :: !(ConwayEraOnwards era)
, commons :: !QueryCommons
, spoHashSources :: !(AllOrOnly SPOHashSource)
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving Show
Expand All @@ -264,6 +272,7 @@ data QueryStakePoolDefaultVoteCmdArgs era = QueryStakePoolDefaultVoteCmdArgs
{ eon :: !(ConwayEraOnwards era)
, commons :: !QueryCommons
, spoHashSources :: !SPOHashSource
, outputFormat :: !(Vary [FormatJson, FormatYaml])
, mOutFile :: !(Maybe (File () Out))
}
deriving Show
Expand Down Expand Up @@ -302,7 +311,7 @@ renderQueryCmds = \case
"query kes-period-info"
QueryPoolStateCmd{} ->
"query pool-state"
QueryTxMempoolCmd (QueryTxMempoolCmdArgs _ q _) ->
QueryTxMempoolCmd (QueryTxMempoolCmdArgs _ q _ _) ->
"query tx-mempool" <> renderTxMempoolQuery q
QuerySlotNumberCmd{} ->
"query slot-number"
Expand Down
47 changes: 46 additions & 1 deletion cardano-cli/src/Cardano/CLI/EraBased/Query/Option.hs
Original file line number Diff line number Diff line change
Expand Up @@ -355,13 +355,23 @@ pQueryProtocolParametersCmd envCli =
<*> pNetworkId envCli
<*> pSocketPath envCli
)
<*> pFormatFlags
"protocol-parameters query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQueryTipCmd :: ShelleyBasedEra era -> EnvCli -> Parser (QueryCmds era)
pQueryTipCmd era envCli =
fmap QueryTipCmd $
QueryTipCmdArgs
<$> pQueryCommons era envCli
<*> pFormatFlags
"tip query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQueryUTxOCmd :: ShelleyBasedEra era -> EnvCli -> Parser (QueryCmds era)
Expand Down Expand Up @@ -408,6 +418,11 @@ pQueryStakeAddressInfoCmd era envCli =
QueryStakeAddressInfoCmdArgs
<$> pQueryCommons era envCli
<*> pFilterByStakeAddress
<*> pFormatFlags
"stake-address-info query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQueryLedgerStateCmd :: ShelleyBasedEra era -> EnvCli -> Parser (QueryCmds era)
Expand All @@ -428,7 +443,7 @@ pQueryLedgerPeerSnapshotCmd era envCli =
QueryLedgerPeerSnapshotCmdArgs
<$> pQueryCommons era envCli
<*> pFormatFlags
"ledger-peer-snapshot output"
"ledger-peer-snapshot query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
Expand Down Expand Up @@ -460,6 +475,11 @@ pQueryStakeSnapshotCmd era envCli =
QueryStakeSnapshotCmdArgs
<$> pQueryCommons era envCli
<*> pAllStakePoolsOrSome
<*> pFormatFlags
"stake-snapshot query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQueryPoolStateCmd :: ShelleyBasedEra era -> EnvCli -> Parser (QueryCmds era)
Expand All @@ -468,6 +488,11 @@ pQueryPoolStateCmd era envCli =
QueryPoolStateCmdArgs
<$> pQueryCommons era envCli
<*> pAllStakePoolsOrSome
<*> pFormatFlags
"pool-state query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQueryTxMempoolCmd :: EnvCli -> Parser (QueryCmds era)
Expand All @@ -480,6 +505,11 @@ pQueryTxMempoolCmd envCli =
<*> pSocketPath envCli
)
<*> pTxMempoolQuery
<*> pFormatFlags
"tx-mempool query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile
where
pTxMempoolQuery :: Parser TxMempoolQuery
Expand Down Expand Up @@ -522,6 +552,11 @@ pKesPeriodInfoCmd era envCli =
QueryKesPeriodInfoCmdArgs
<$> pQueryCommons era envCli
<*> pOperationalCertificateFile
<*> pFormatFlags
"kes-period-info query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQuerySlotNumberCmd :: ShelleyBasedEra era -> EnvCli -> Parser (QueryCmds era)
Expand Down Expand Up @@ -715,6 +750,11 @@ pQuerySPOStakeDistributionCmd era envCli = do
QuerySPOStakeDistributionCmdArgs w
<$> pQueryCommons era envCli
<*> pAllOrOnlySPOHashSource
<*> pFormatFlags
"spo-stake-distribution query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQueryGetCommitteeStateCmd
Expand Down Expand Up @@ -821,6 +861,11 @@ pQueryStakePoolDefaultVote era envCli = do
QueryStakePoolDefaultVoteCmdArgs w
<$> pQueryCommons era envCli
<*> pSPOHashSource
<*> pFormatFlags
"stake-pool-default-vote query output"
[ flagFormatJson & setDefault
, flagFormatYaml
]
<*> pMaybeOutputFile

pQueryNoArgCmdArgs
Expand Down
Loading
Loading