Expose querySupportedVersions (#1437)

This PR exposes a `querySupportedVersions` function that provides the
list of versions in which a query is available, to be used by
`cardano-api`

Author: jasagredo

ouroboros-consensus-cardano/changelog.d/js-query-version.md

@@ -0,0 +1,4 @@
+### Breaking
+
+- Define `blockQueryIsSupportedOnVersion` for Byron and Shelley.
+  - For Shelley, this is just a relocation of the now gone `querySupportedVersion` function.

ouroboros-consensus-cardano/src/byron/Ouroboros/Consensus/Byron/Ledger/Ledger.hs

@@ -200,6 +200,7 @@ data instance BlockQuery ByronBlock :: Type -> Type where
 instance BlockSupportsLedgerQuery ByronBlock where
   answerBlockQuery _cfg GetUpdateInterfaceState (ExtLedgerState ledgerState _) =
     CC.cvsUpdateState (byronLedgerState ledgerState)
+  blockQueryIsSupportedOnVersion GetUpdateInterfaceState = const True
 
 instance SameDepIndex (BlockQuery ByronBlock) where
   sameDepIndex GetUpdateInterfaceState GetUpdateInterfaceState = Just Refl

ouroboros-consensus-cardano/src/shelley/Ouroboros/Consensus/Shelley/Ledger/Query.hs

@@ -23,7 +23,6 @@ module Ouroboros.Consensus.Shelley.Ledger.Query (
   , NonMyopicMemberRewards (..)
   , StakeSnapshot (..)
   , StakeSnapshots (..)
-  , querySupportedVersion
     -- * Serialisation
   , decodeShelleyQuery
   , decodeShelleyResult
@@ -509,6 +508,53 @@ instance
       hst = headerState ext
       st  = shelleyLedgerState lst
 
+  -- | Is the given query supported by the given 'ShelleyNodeToClientVersion'?
+  blockQueryIsSupportedOnVersion = \case
+    GetLedgerTip                               -> const True
+    GetEpochNo                                 -> const True
+    GetNonMyopicMemberRewards {}               -> const True
+    GetCurrentPParams                          -> const True
+    GetProposedPParamsUpdates                  -> (< v12)
+    GetStakeDistribution                       -> const True
+    GetUTxOByAddress {}                        -> const True
+    GetUTxOWhole                               -> const True
+    DebugEpochState                            -> const True
+    GetCBOR q                                  -> blockQueryIsSupportedOnVersion q
+    GetFilteredDelegationsAndRewardAccounts {} -> const True
+    GetGenesisConfig                           -> const True
+    DebugNewEpochState                         -> const True
+    DebugChainDepState                         -> const True
+    GetRewardProvenance                        -> const True
+    GetUTxOByTxIn {}                           -> const True
+    GetStakePools                              -> const True
+    GetStakePoolParams {}                      -> const True
+    GetRewardInfoPools                         -> const True
+    GetPoolState {}                            -> const True
+    GetStakeSnapshots {}                       -> const True
+    GetPoolDistr {}                            -> const True
+    GetStakeDelegDeposits {}                   -> const True
+    GetConstitution                            -> (>= v8)
+    GetGovState                                -> (>= v8)
+    GetDRepState {}                            -> (>= v8)
+    GetDRepStakeDistr {}                       -> (>= v8)
+    GetCommitteeMembersState {}                -> (>= v8)
+    GetFilteredVoteDelegatees {}               -> (>= v8)
+    GetAccountState {}                         -> (>= v8)
+    GetSPOStakeDistr {}                        -> (>= v8)
+    GetProposals {}                            -> (>= v9)
+    GetRatifyState {}                          -> (>= v9)
+    GetFuturePParams {}                        -> (>= v10)
+    GetBigLedgerPeerSnapshot                   -> (>= v11)
+    QueryStakePoolDefaultVote {}               -> (>= v12)
+    -- WARNING: when adding a new query, a new @ShelleyNodeToClientVersionX@
+    -- must be added. See #2830 for a template on how to do this.
+   where
+    v8  = ShelleyNodeToClientVersion8
+    v9  = ShelleyNodeToClientVersion9
+    v10 = ShelleyNodeToClientVersion10
+    v11 = ShelleyNodeToClientVersion11
+    v12 = ShelleyNodeToClientVersion12
+
 instance SameDepIndex (BlockQuery (ShelleyBlock proto era)) where
   sameDepIndex GetLedgerTip GetLedgerTip
     = Just Refl
@@ -703,54 +749,6 @@ instance ShelleyCompatible proto era => ShowQuery (BlockQuery (ShelleyBlock prot
       GetBigLedgerPeerSnapshot                   -> show
       QueryStakePoolDefaultVote {}               -> show
 
--- | Is the given query supported by the given 'ShelleyNodeToClientVersion'?
-querySupportedVersion :: BlockQuery (ShelleyBlock proto era) result -> ShelleyNodeToClientVersion -> Bool
-querySupportedVersion = \case
-    GetLedgerTip                               -> const True
-    GetEpochNo                                 -> const True
-    GetNonMyopicMemberRewards {}               -> const True
-    GetCurrentPParams                          -> const True
-    GetProposedPParamsUpdates                  -> (< v12)
-    GetStakeDistribution                       -> const True
-    GetUTxOByAddress {}                        -> const True
-    GetUTxOWhole                               -> const True
-    DebugEpochState                            -> const True
-    GetCBOR q                                  -> querySupportedVersion q
-    GetFilteredDelegationsAndRewardAccounts {} -> const True
-    GetGenesisConfig                           -> const True
-    DebugNewEpochState                         -> const True
-    DebugChainDepState                         -> const True
-    GetRewardProvenance                        -> const True
-    GetUTxOByTxIn {}                           -> const True
-    GetStakePools                              -> const True
-    GetStakePoolParams {}                      -> const True
-    GetRewardInfoPools                         -> const True
-    GetPoolState {}                            -> const True
-    GetStakeSnapshots {}                       -> const True
-    GetPoolDistr {}                            -> const True
-    GetStakeDelegDeposits {}                   -> const True
-    GetConstitution                            -> (>= v8)
-    GetGovState                                -> (>= v8)
-    GetDRepState {}                            -> (>= v8)
-    GetDRepStakeDistr {}                       -> (>= v8)
-    GetCommitteeMembersState {}                -> (>= v8)
-    GetFilteredVoteDelegatees {}               -> (>= v8)
-    GetAccountState {}                         -> (>= v8)
-    GetSPOStakeDistr {}                        -> (>= v8)
-    GetProposals {}                            -> (>= v9)
-    GetRatifyState {}                          -> (>= v9)
-    GetFuturePParams {}                        -> (>= v10)
-    GetBigLedgerPeerSnapshot                   -> (>= v11)
-    QueryStakePoolDefaultVote {}               -> (>= v12)
-    -- WARNING: when adding a new query, a new @ShelleyNodeToClientVersionX@
-    -- must be added. See #2830 for a template on how to do this.
-  where
-    v8  = ShelleyNodeToClientVersion8
-    v9  = ShelleyNodeToClientVersion9
-    v10 = ShelleyNodeToClientVersion10
-    v11 = ShelleyNodeToClientVersion11
-    v12 = ShelleyNodeToClientVersion12
-
 {-------------------------------------------------------------------------------
   Auxiliary
 -------------------------------------------------------------------------------}

ouroboros-consensus-cardano/src/shelley/Ouroboros/Consensus/Shelley/Node/Serialisation.hs

@@ -32,6 +32,7 @@ import           Ouroboros.Consensus.HardFork.Combinator.PartialConfig
 import           Ouroboros.Consensus.HardFork.History.EpochInfo
 import           Ouroboros.Consensus.HardFork.Simple
 import           Ouroboros.Consensus.HeaderValidation
+import           Ouroboros.Consensus.Ledger.Query
 import           Ouroboros.Consensus.Ledger.SupportsMempool (GenTxId)
 import           Ouroboros.Consensus.Node.Run
 import           Ouroboros.Consensus.Node.Serialisation
@@ -294,7 +295,7 @@ instance ShelleyBasedEra era => SerialiseNodeToClient (ShelleyBlock proto era) (
 instance ShelleyCompatible proto era
       => SerialiseNodeToClient (ShelleyBlock proto era) (SomeSecond BlockQuery (ShelleyBlock proto era)) where
   encodeNodeToClient _ version (SomeSecond q)
-    | querySupportedVersion q version
+    | blockQueryIsSupportedOnVersion q version
     = encodeShelleyQuery q
     | otherwise
     = throw $ ShelleyEncoderUnsupportedQuery (SomeSecond q) version

ouroboros-consensus-cardano/src/unstable-shelley-testlib/Test/Consensus/Shelley/Generators.hs

@@ -278,5 +278,5 @@ instance CanMock proto era
       => Arbitrary (WithVersion ShelleyNodeToClientVersion (SomeSecond BlockQuery (ShelleyBlock proto era))) where
   arbitrary = do
       query@(SomeSecond q) <- arbitrary
-      version <- arbitrary `suchThat` querySupportedVersion q
+      version <- arbitrary `suchThat` blockQueryIsSupportedOnVersion q
       return $ WithVersion version query

ouroboros-consensus-diffusion/changelog.d/js-query-version.md

@@ -0,0 +1 @@
+<!-- empty, only two redundant constraints were removed -->

ouroboros-consensus-diffusion/src/ouroboros-consensus-diffusion/Ouroboros/Consensus/Network/NodeToClient.hs

@@ -180,7 +180,6 @@ type ClientCodecs blk  m =
 defaultCodecs :: forall m blk.
                  ( MonadST m
                  , SerialiseNodeToClientConstraints blk
-                 , ShowQuery (BlockQuery blk)
                  , StandardHash blk
                  , Serialise (HeaderHash blk)
                  )
@@ -241,7 +240,6 @@ defaultCodecs ccfg version networkVersion = Codecs {
 clientCodecs :: forall m blk.
                 ( MonadST m
                 , SerialiseNodeToClientConstraints blk
-                , ShowQuery (BlockQuery blk)
                 , StandardHash blk
                 , Serialise (HeaderHash blk)
                 )

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/HardFork/Combinator/A.hs

@@ -358,6 +358,7 @@ data instance BlockQuery BlockA result
 
 instance BlockSupportsLedgerQuery BlockA where
   answerBlockQuery _ qry = case qry of {}
+  blockQueryIsSupportedOnVersion qry _ = case qry of {}
 
 instance SameDepIndex (BlockQuery BlockA) where
   sameDepIndex qry _qry' = case qry of {}

ouroboros-consensus-diffusion/test/consensus-test/Test/Consensus/HardFork/Combinator/B.hs

@@ -291,6 +291,7 @@ data instance BlockQuery BlockB result
 
 instance BlockSupportsLedgerQuery BlockB where
   answerBlockQuery _ qry = case qry of {}
+  blockQueryIsSupportedOnVersion qry _ = case qry of {}
 
 instance SameDepIndex (BlockQuery BlockB) where
   sameDepIndex qry _qry' = case qry of {}

ouroboros-consensus/changelog.d/js-query-version.md

@@ -0,0 +1,4 @@
+### Breaking
+
+- Add method `blockQueryIsSupportedOnVersion` to `BlockSupportsLedgerQuery`.
+- Export new function `querySupportedVersions`.