Skip to content

Commit

Permalink
More constraints for the standard features ShelleyBasedEra, ShelleyTo…
Browse files Browse the repository at this point in the history
…BabbageEra and BabbageEraOnwards.
  • Loading branch information
newhoggy committed Jul 27, 2023
1 parent f198e8e commit 048b145
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 56 deletions.
72 changes: 38 additions & 34 deletions cardano-api/internal/Cardano/Api/Eras/Constraints.hs
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
{-# LANGUAGE ConstraintKinds #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE GADTs #-}
Expand All @@ -7,42 +8,31 @@
{-# LANGUAGE TypeFamilyDependencies #-}
{-# LANGUAGE TypeOperators #-}


-- | Cardano eras, sometimes we have to distinguish them.
--
module Cardano.Api.Eras.Constraints
( withShelleyBasedEraConstraintsForLedger
, cardanoEraConstraints
( cardanoEraConstraints
, withShelleyBasedEraConstraintsForLedger
, shelleyBasedEraConstraints
) where

import Cardano.Api.Eras.Core
import Cardano.Api.Query.Types

import qualified Cardano.Crypto.Hash.Class as C
import qualified Cardano.Ledger.Api as L
import Cardano.Ledger.Binary (FromCBOR)

import Data.Aeson (ToJSON)
import Data.Typeable (Typeable)

withShelleyBasedEraConstraintsForLedger :: ()
=> ShelleyLedgerEra era ~ ledgerera
=> ShelleyBasedEra era
-> ( ()
=> L.EraCrypto ledgerera ~ L.StandardCrypto
=> L.EraTx ledgerera
=> L.EraTxBody ledgerera
=> L.Era ledgerera
=> a
)
-> a
withShelleyBasedEraConstraintsForLedger = \case
ShelleyBasedEraShelley -> id
ShelleyBasedEraAllegra -> id
ShelleyBasedEraMary -> id
ShelleyBasedEraAlonzo -> id
ShelleyBasedEraBabbage -> id
ShelleyBasedEraConway -> id
type CardanoEraConstraint era =
( Typeable era
, IsCardanoEra era
)

cardanoEraConstraints :: CardanoEra era -> (Typeable era => IsCardanoEra era => a) -> a
cardanoEraConstraints :: ()
=> CardanoEra era
-> (CardanoEraConstraint era => a)
-> a
cardanoEraConstraints = \case
ByronEra -> id
ShelleyEra -> id
Expand All @@ -52,18 +42,24 @@ cardanoEraConstraints = \case
BabbageEra -> id
ConwayEra -> id

type ShelleyBasedEraConstraints era ledgerera =
( C.HashAlgorithm (L.HASH (L.EraCrypto ledgerera))
, L.Crypto (L.EraCrypto ledgerera)
, L.Era ledgerera
, L.EraCrypto ledgerera ~ L.StandardCrypto
, L.EraPParams ledgerera
, L.EraTx ledgerera
, L.EraTxBody ledgerera
, FromCBOR (DebugLedgerState era)
, IsShelleyBasedEra era
, ToJSON (DebugLedgerState era)
, Typeable era
)

shelleyBasedEraConstraints :: ()
=> ShelleyLedgerEra era ~ ledgerera
=> ShelleyBasedEra era
-> (()
=> Typeable era
=> IsShelleyBasedEra era
=> L.EraCrypto (ShelleyLedgerEra era) ~ L.StandardCrypto
=> L.Crypto (L.EraCrypto (ShelleyLedgerEra era))
=> L.EraPParams (ShelleyLedgerEra era)
=> IsShelleyBasedEra era
=> L.Era (ShelleyLedgerEra era)
=> C.HashAlgorithm (L.HASH (L.EraCrypto (ShelleyLedgerEra era)))
=> a)
-> (ShelleyBasedEraConstraints era ledgerera => a)
-> a
shelleyBasedEraConstraints = \case
ShelleyBasedEraShelley -> id
Expand All @@ -72,3 +68,11 @@ shelleyBasedEraConstraints = \case
ShelleyBasedEraAlonzo -> id
ShelleyBasedEraBabbage -> id
ShelleyBasedEraConway -> id

-- Deprecated: Use shelleyBasedEraConstraints instead.
withShelleyBasedEraConstraintsForLedger :: ()
=> ShelleyLedgerEra era ~ ledgerera
=> ShelleyBasedEra era
-> (ShelleyBasedEraConstraints era ledgerera => a)
-> a
withShelleyBasedEraConstraintsForLedger = shelleyBasedEraConstraints
2 changes: 0 additions & 2 deletions cardano-api/internal/Cardano/Api/Eras/Core.hs
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilyDependencies #-}
{-# LANGUAGE TypeOperators #-}


-- | Cardano eras, sometimes we have to distinguish them.
--
Expand Down
27 changes: 17 additions & 10 deletions cardano-api/internal/Cardano/Api/Feature/ConwayEraOnwards.hs
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ import Cardano.Api.Eras
import Cardano.Api.Query.Types

import Cardano.Binary
import Cardano.Crypto.Hash.Class (HashAlgorithm)
import qualified Cardano.Crypto.Hash.Class as C
import qualified Cardano.Ledger.Api as L

import Data.Aeson
import Data.Typeable (Typeable)

data ConwayEraOnwards era where
ConwayEraOnwardsConway :: ConwayEraOnwards ConwayEra
Expand All @@ -45,19 +46,25 @@ data AnyConwayEraOnwards where

deriving instance Show AnyConwayEraOnwards

type ConwayEraOnwardsConstraints era =
( FromCBOR (DebugLedgerState era)
, HashAlgorithm (L.HASH (L.EraCrypto (ShelleyLedgerEra era)))
type ConwayEraOnwardsConstraints era ledgerera =
( C.HashAlgorithm (L.HASH (L.EraCrypto ledgerera))
, L.ConwayEraTxBody ledgerera
, L.Crypto (L.EraCrypto ledgerera)
, L.Era ledgerera
, L.EraCrypto ledgerera ~ L.StandardCrypto
, L.EraPParams ledgerera
, L.EraTx ledgerera
, L.EraTxBody ledgerera
, FromCBOR (DebugLedgerState era)
, IsShelleyBasedEra era
, L.ConwayEraTxBody (ShelleyLedgerEra era)
, L.Era (ShelleyLedgerEra era)
, L.EraCrypto (ShelleyLedgerEra era) ~ L.StandardCrypto
, ToJSON (DebugLedgerState era)
, Typeable era
)

conwayEraOnwardsConstraints
:: ConwayEraOnwards era
-> (ConwayEraOnwardsConstraints era => a)
conwayEraOnwardsConstraints :: ()
=> ShelleyLedgerEra era ~ ledgerera
=> ConwayEraOnwards era
-> (ConwayEraOnwardsConstraints era ledgerera => a)
-> a
conwayEraOnwardsConstraints = \case
ConwayEraOnwardsConway -> id
Expand Down
25 changes: 16 additions & 9 deletions cardano-api/internal/Cardano/Api/Feature/ShelleyToBabbageEra.hs
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ import Cardano.Api.Eras
import Cardano.Api.Query.Types

import Cardano.Binary
import Cardano.Crypto.Hash.Class (HashAlgorithm)
import qualified Cardano.Crypto.Hash.Class as C
import qualified Cardano.Ledger.Api as L

import Data.Aeson
import Data.Typeable (Typeable)

data ShelleyToBabbageEra era where
ShelleyToBabbageEraShelley :: ShelleyToBabbageEra ShelleyEra
Expand All @@ -44,23 +45,29 @@ instance FeatureInEra ShelleyToBabbageEra where
BabbageEra -> yes ShelleyToBabbageEraBabbage
ConwayEra -> no

type ShelleyToBabbageEraConstraints era =
( FromCBOR (DebugLedgerState era)
, HashAlgorithm (L.HASH (L.EraCrypto (ShelleyLedgerEra era)))
type ShelleyToBabbageEraConstraints era ledgerera =
( C.HashAlgorithm (L.HASH (L.EraCrypto ledgerera))
, L.Crypto (L.EraCrypto ledgerera)
, L.Era ledgerera
, L.EraCrypto ledgerera ~ L.StandardCrypto
, L.EraPParams ledgerera
, L.EraTx ledgerera
, L.EraTxBody ledgerera
, FromCBOR (DebugLedgerState era)
, IsShelleyBasedEra era
, L.Era (ShelleyLedgerEra era)
, L.EraCrypto (ShelleyLedgerEra era) ~ L.StandardCrypto
, ToJSON (DebugLedgerState era)
, Typeable era
)

data AnyShelleyToBabbageEra where
AnyShelleyToBabbageEra :: ShelleyToBabbageEra era -> AnyShelleyToBabbageEra

deriving instance Show AnyShelleyToBabbageEra

shelleyToBabbageEraConstraints
:: ShelleyToBabbageEra era
-> (ShelleyToBabbageEraConstraints era => a)
shelleyToBabbageEraConstraints :: ()
=> ShelleyLedgerEra era ~ ledgerera
=> ShelleyToBabbageEra era
-> (ShelleyToBabbageEraConstraints era ledgerera => a)
-> a
shelleyToBabbageEraConstraints = \case
ShelleyToBabbageEraShelley -> id
Expand Down
2 changes: 1 addition & 1 deletion cardano-api/internal/Cardano/Api/Query/Types.hs
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ module Cardano.Api.Query.Types
, toDebugLedgerStatePair
) where

import Cardano.Api.Eras
import Cardano.Api.Eras.Core

import Cardano.Binary
import Cardano.Ledger.Binary
Expand Down

0 comments on commit 048b145

Please sign in to comment.