Skip to content

Commit

Permalink
Add --include-stake convenience flag to drep-state query
Browse files Browse the repository at this point in the history
  • Loading branch information
smelc committed Feb 13, 2024
1 parent 07180c3 commit 3f44c29
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 8 deletions.
7 changes: 7 additions & 0 deletions cardano-cli/src/Cardano/CLI/EraBased/Commands/Query.hs
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ module Cardano.CLI.EraBased.Commands.Query
, QueryDRepStateCmdArgs(..)
, QueryDRepStakeDistributionCmdArgs(..)
, renderQueryCmds
, IncludeStake (..)
) where

import Cardano.Api.Shelley hiding (QueryInShelleyBasedEra (..))
Expand Down Expand Up @@ -203,10 +204,16 @@ data QueryDRepStateCmdArgs era = QueryDRepStateCmdArgs
, consensusModeParams :: !ConsensusModeParams
, networkId :: !NetworkId
, drepKeys :: !(AllOrOnly (VerificationKeyOrHashOrFile DRepKey))
, includeStake :: !IncludeStake
, target :: !(Consensus.Target ChainPoint)
, mOutFile :: !(Maybe (File () Out))
} deriving Show

-- | Whether to include the stake, as queried by drep-stake-distribution, in
-- the output of drep-state. This is (computationally) expensive, but sometimes
-- convenient.
data IncludeStake = WithStake | NoStake deriving Show

data QueryDRepStakeDistributionCmdArgs era = QueryDRepStakeDistributionCmdArgs
{ eon :: !(ConwayEraOnwards era)
, nodeSocketPath :: !SocketPath
Expand Down
10 changes: 10 additions & 0 deletions cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs
Original file line number Diff line number Diff line change
Expand Up @@ -335,6 +335,16 @@ pQueryDRepStateCmd era envCli = do
<*> pConsensusModeParams
<*> pNetworkId envCli
<*> pAllOrOnlyDRepVerificationKeyOrHashOrFile
<*> Opt.flag WithStake NoStake (mconcat
[ Opt.long "include-stake"
, Opt.help $ mconcat
[ "Also return the stake associated with each DRep. "
, "The result is the same as with \"drep-stake-distribution\"; "
, "this is a convenience option to obtain all information concerning a DRep at once. "
, "This is a potentially expensive query."
]
]
)
<*> pTarget era
<*> optional pOutputFile

Expand Down
33 changes: 25 additions & 8 deletions cardano-cli/src/Cardano/CLI/EraBased/Run/Query.hs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeOperators #-}

Expand Down Expand Up @@ -1434,6 +1435,7 @@ runQueryDRepState
, Cmd.consensusModeParams
, Cmd.networkId
, Cmd.drepKeys = drepKeys'
, Cmd.includeStake
, Cmd.target
, Cmd.mOutFile
} = conwayEraOnwardsConstraints eon $ do
Expand All @@ -1442,17 +1444,32 @@ runQueryDRepState
let drepKeys = case drepKeys' of
All -> []
Only l -> l
drepCreds <- Set.fromList <$> mapM (firstExceptT QueryCmdDRepKeyError . getDRepCredentialFromVerKeyHashOrFile) drepKeys
drepCreds <- mapM (firstExceptT QueryCmdDRepKeyError . getDRepCredentialFromVerKeyHashOrFile) drepKeys

drepState <- runQuery localNodeConnInfo target $ queryDRepState eon $ Set.fromList drepCreds

drepStakeDistribution <-
case includeStake of
Cmd.WithStake -> runQuery localNodeConnInfo target $
queryDRepStakeDistribution eon (Set.fromList $ Ledger.DRepCredential <$> drepCreds)
Cmd.NoStake -> return mempty

drepState <- runQuery localNodeConnInfo target $ queryDRepState eon drepCreds
writeOutput mOutFile $
second drepStateToJson <$> Map.assocs drepState
drepStateToJson drepStakeDistribution <$> Map.assocs drepState
where
drepStateToJson ds = A.object
[ "expiry" .= (ds ^. Ledger.drepExpiryL)
, "anchor" .= (ds ^. Ledger.drepAnchorL)
, "deposit" .= (ds ^. Ledger.drepDepositL)
]
drepStateToJson stakeDistr (cred, ds) = (cred,) . A.object $
if Map.null stakeDistr
then
[ "expiry" .= (ds ^. Ledger.drepExpiryL)
, "anchor" .= (ds ^. Ledger.drepAnchorL)
, "deposit" .= (ds ^. Ledger.drepDepositL)
]
else
[ "expiry" .= (ds ^. Ledger.drepExpiryL)
, "anchor" .= (ds ^. Ledger.drepAnchorL)
, "deposit" .= (ds ^. Ledger.drepDepositL)
, "stake" .= Map.lookup (Ledger.DRepCredential cred) stakeDistr
]

runQueryDRepStakeDistribution
:: Cmd.QueryDRepStakeDistributionCmdArgs era
Expand Down
1 change: 1 addition & 0 deletions cardano-cli/test/cardano-cli-golden/files/golden/help.cli
Original file line number Diff line number Diff line change
Expand Up @@ -6743,6 +6743,7 @@ Usage: cardano-cli conway query drep-state --socket-path SOCKET_PATH
| --drep-key-hash HASH
)
)
[--include-stake]
[--volatile-tip | --immutable-tip]
[--out-file FILE]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Usage: cardano-cli conway query drep-state --socket-path SOCKET_PATH
| --drep-key-hash HASH
)
)
[--include-stake]
[--volatile-tip | --immutable-tip]
[--out-file FILE]

Expand All @@ -37,6 +38,11 @@ Available options:
Filepath of the DRep verification key.
--drep-key-hash HASH DRep verification key hash (either Bech32-encoded or
hex-encoded).
--include-stake Also return the stake associated with each DRep. The
result is the same as with "drep-stake-distribution";
this is a convenience option to obtain all
information concerning a DRep at once. This is a
potentially expensive query.
--volatile-tip Use the volatile tip as a target. (This is the
default)
--immutable-tip Use the immutable tip as a target.
Expand Down

0 comments on commit 3f44c29

Please sign in to comment.