Propogate NonZero across all packages with some errors

Author: aniketd

ouroboros-consensus-cardano/ouroboros-consensus-cardano.cabal

@@ -227,6 +227,7 @@ library unstable-byron-testlib
     cardano-crypto-class,
     cardano-crypto-test,
     cardano-crypto-wrapper,
+    cardano-ledger-core,
     cardano-ledger-binary:{cardano-ledger-binary, testlib},
     cardano-ledger-byron,
     cardano-ledger-byron-test,
@@ -260,6 +261,7 @@ test-suite byron-test
     bytestring,
     cardano-crypto-class,
     cardano-crypto-wrapper,
+    cardano-ledger-core,
     cardano-ledger-binary,
     cardano-ledger-byron,
     cardano-ledger-byron-test,

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

@@ -19,6 +19,7 @@ import qualified Cardano.Chain.Common as CC
 import qualified Cardano.Chain.Genesis as Genesis
 import qualified Cardano.Chain.Slotting as CC
 import qualified Cardano.Chain.Update as CC
+import           Cardano.Ledger.BaseTypes (nonZeroOr, unNonZero)
 import           Data.Coerce
 import qualified Data.Set as Set
 import           Numeric.Natural (Natural)
@@ -39,7 +40,7 @@ fromByronBlockNo :: CC.ChainDifficulty -> BlockNo
 fromByronBlockNo = coerce
 
 fromByronBlockCount :: CC.BlockCount -> SecurityParam
-fromByronBlockCount (CC.BlockCount k) = SecurityParam k
+fromByronBlockCount (CC.BlockCount k) = SecurityParam $ nonZeroOr k $ error "Zero found while trying to construct a NonZero"
 
 fromByronEpochSlots :: CC.EpochSlots -> EpochSize
 fromByronEpochSlots (CC.EpochSlots n) = EpochSize n
@@ -56,7 +57,7 @@ toByronSlotNo :: SlotNo -> CC.SlotNumber
 toByronSlotNo = coerce
 
 toByronBlockCount :: SecurityParam -> CC.BlockCount
-toByronBlockCount (SecurityParam k) = CC.BlockCount k
+toByronBlockCount (SecurityParam k) = CC.BlockCount $ unNonZero k
 
 toByronSlotLength :: SlotLength -> Natural
 toByronSlotLength = (fromIntegral :: Integer -> Natural)

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

@@ -50,6 +50,7 @@ import qualified Cardano.Chain.Update.Validation.Endorsement as UPE
 import qualified Cardano.Chain.Update.Validation.Interface as UPI
 import qualified Cardano.Chain.UTxO as CC
 import qualified Cardano.Chain.ValidationMode as CC
+import           Cardano.Ledger.BaseTypes (unNonZero)
 import           Cardano.Ledger.Binary (fromByronCBOR, toByronCBOR)
 import           Cardano.Ledger.Binary.Plain (encodeListLen, enforceSize)
 import           Codec.CBOR.Decoding (Decoder)
@@ -263,7 +264,7 @@ instance LedgerSupportsProtocol ByronBlock where
             , outsideForecastFor    = for
             }
     where
-      SecurityParam k = genesisSecurityParam cfg
+      k = unNonZero $ maxRollbacks $ genesisSecurityParam cfg
       lastSlot        = fromByronSlotNo $ CC.cvsLastSlot st
       at              = NotOrigin lastSlot
 
@@ -282,7 +283,7 @@ byronEraParams genesis = HardFork.EraParams {
     , eraGenesisWin = GenesisWindow (2 * k)
     }
   where
-    SecurityParam k = genesisSecurityParam genesis
+    k = unNonZero $ maxRollbacks $ genesisSecurityParam genesis
 
 -- | Separate variant of 'byronEraParams' to be used for a Byron-only chain.
 byronEraParamsNeverHardForks :: Gen.Config -> HardFork.EraParams

ouroboros-consensus-cardano/src/ouroboros-consensus-cardano/Ouroboros/Consensus/Cardano/Node.hs

@@ -561,7 +561,7 @@ protocolInfoCardano paramsCardano
     praosParams = PraosParams
       { praosSlotsPerKESPeriod = SL.sgSlotsPerKESPeriod genesisShelley,
         praosLeaderF = SL.mkActiveSlotCoeff $ SL.sgActiveSlotsCoeff genesisShelley,
-        praosSecurityParam = SecurityParam $ SL.unNonZero $ SL.sgSecurityParam genesisShelley,
+        praosSecurityParam = SecurityParam $ SL.sgSecurityParam genesisShelley,
         praosMaxKESEvo = SL.sgMaxKESEvolutions genesisShelley,
         praosMaxMajorPV = maxMajorProtVer,
         praosRandomnessStabilisationWindow =
@@ -592,7 +592,7 @@ protocolInfoCardano paramsCardano
           (toTriggerHardFork triggerHardForkAllegra)
 
     kShelley :: SecurityParam
-    kShelley = SecurityParam $ SL.unNonZero $ sgSecurityParam genesisShelley
+    kShelley = SecurityParam $ sgSecurityParam genesisShelley
 
     -- Allegra
 

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

@@ -18,10 +18,6 @@ module Ouroboros.Consensus.Shelley.HFEras (
   , StandardShelleyBlock
   ) where
 
-import           Cardano.Crypto.DSIGN (Signable)
-import           Cardano.Crypto.Hash (Hash)
-import           Cardano.Ledger.Hashes (EraIndependentTxBody, HASH)
-import           Cardano.Ledger.Keys (DSIGN)
 import           Ouroboros.Consensus.Protocol.Praos (Praos)
 import qualified Ouroboros.Consensus.Protocol.Praos as Praos
 import           Ouroboros.Consensus.Protocol.TPraos (StandardCrypto, TPraos)

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

@@ -21,6 +21,7 @@ module Ouroboros.Consensus.Shelley.Node.Common (
   ) where
 
 import           Cardano.Crypto.KES (UnsoundPureSignKeyKES)
+import           Cardano.Ledger.BaseTypes (unNonZero)
 import qualified Cardano.Ledger.Keys as SL
 import qualified Cardano.Ledger.Shelley.API as SL
 import           Cardano.Ledger.Slot
@@ -106,6 +107,7 @@ instance ShelleyCompatible proto era => NodeInitStorage (ShelleyBlock proto era)
     simpleChunkInfo
       . EpochSize
       . (* 10)
+      . unNonZero
       . maxRollbacks
       . shelleyStorageConfigSecurityParam
 

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

@@ -8,7 +8,6 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeApplications #-}
 {-# LANGUAGE TypeFamilies #-}
-{-# LANGUAGE TypeOperators #-}
 
 {-# OPTIONS_GHC -Wno-orphans     #-}
 
@@ -27,8 +26,8 @@ import           Ouroboros.Consensus.Block
 import           Ouroboros.Consensus.Config (configConsensus)
 import qualified Ouroboros.Consensus.Ledger.SupportsMempool as Mempool
 import qualified Ouroboros.Consensus.Protocol.Ledger.HotKey as HotKey
-import           Ouroboros.Consensus.Protocol.Praos (Praos, PraosCrypto,
-                     PraosParams (..), praosCheckCanForge)
+import           Ouroboros.Consensus.Protocol.Praos (Praos, PraosParams (..),
+                     praosCheckCanForge)
 import           Ouroboros.Consensus.Protocol.Praos.Common
                      (PraosCanBeLeader (praosCanBeLeaderOpCert))
 import           Ouroboros.Consensus.Shelley.Ledger (ShelleyBlock,

ouroboros-consensus-cardano/src/unstable-byron-testlib/Test/Consensus/Byron/Examples.hs

@@ -1,5 +1,7 @@
+{-# LANGUAGE DataKinds #-}
 {-# LANGUAGE DisambiguateRecordFields #-}
 {-# LANGUAGE OverloadedStrings #-}
+{-# LANGUAGE TypeApplications #-}
 
 {-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}
 
@@ -28,6 +30,7 @@ import qualified Cardano.Chain.Byron.API as CC
 import qualified Cardano.Chain.Common as CC
 import qualified Cardano.Chain.Update.Validation.Interface as CC.UPI
 import qualified Cardano.Chain.UTxO as CC
+import           Cardano.Ledger.BaseTypes (knownNonZeroBounded)
 import           Control.Monad.Except (runExcept)
 import qualified Data.Map.Strict as Map
 import           Ouroboros.Consensus.Block
@@ -62,7 +65,7 @@ import           Test.Util.Serialisation.SomeResult (SomeResult (..))
 -- 'S.WindowSize', because 'decodeByronChainDepState' only takes the
 -- 'SecurityParam' and uses it as the basis for the 'S.WindowSize'.
 secParam :: SecurityParam
-secParam = SecurityParam 2
+secParam = SecurityParam $ knownNonZeroBounded @2
 
 windowSize :: S.WindowSize
 windowSize = S.WindowSize 2

ouroboros-consensus-cardano/src/unstable-byron-testlib/Test/Consensus/Byron/Generators.hs

@@ -1,5 +1,7 @@
+{-# LANGUAGE DataKinds #-}
 {-# LANGUAGE FlexibleInstances #-}
 {-# LANGUAGE GADTs #-}
+{-# LANGUAGE TypeApplications #-}
 
 {-# OPTIONS_GHC -Wno-orphans #-}
 
@@ -28,6 +30,7 @@ import qualified Cardano.Chain.Update.Validation.Registration as CC.Reg
 import qualified Cardano.Chain.UTxO as CC.UTxO
 import           Cardano.Crypto (ProtocolMagicId (..))
 import           Cardano.Crypto.Hashing (Hash)
+import           Cardano.Ledger.BaseTypes (knownNonZeroBounded)
 import           Cardano.Ledger.Binary (decCBOR, encCBOR)
 import           Control.Monad (replicateM)
 import           Data.Coerce (coerce)
@@ -63,7 +66,7 @@ import           Test.Util.Serialisation.SomeResult (SomeResult (..))
 
 -- | Matches that from the 'CC.dummyConfig'
 k :: SecurityParam
-k = SecurityParam 10
+k = SecurityParam $ knownNonZeroBounded @10
 
 -- | Matches that from the 'CC.dummyConfig'
 epochSlots :: EpochSlots

ouroboros-consensus-cardano/src/unstable-byron-testlib/Test/ThreadNet/Infra/Byron/Genesis.hs

@@ -10,6 +10,7 @@ import qualified Cardano.Chain.Common as Common
 import qualified Cardano.Chain.Genesis as Genesis
 import qualified Cardano.Chain.Update as Update
 import qualified Cardano.Crypto as Crypto
+import           Cardano.Ledger.BaseTypes (unNonZero)
 import           Control.Monad.Except (runExceptT)
 import           Ouroboros.Consensus.BlockchainTime
 import           Ouroboros.Consensus.Byron.Ledger.Conversions
@@ -37,7 +38,7 @@ byronPBftParams paramK numCoreNodes = PBftParams
       n = fromIntegral x where NumCoreNodes x = numCoreNodes
 
       k :: Num a => a
-      k = fromIntegral x where SecurityParam x = paramK
+      k = fromIntegral x where x = unNonZero $ maxRollbacks paramK
 
 -- Instead of using 'Dummy.dummyConfig', which hard codes the number of rich
 -- men (= CoreNodes for us) to 4, we generate a dummy config with the given
@@ -62,7 +63,7 @@ generateGenesisConfig slotLen params =
                 -- The nodes are the richmen
                 { Genesis.tboRichmen = fromIntegral numCoreNodes }
           }
-        , Genesis.gsK = Common.BlockCount $ maxRollbacks pbftSecurityParam
+        , Genesis.gsK = Common.BlockCount $ unNonZero $ maxRollbacks pbftSecurityParam
         , Genesis.gsProtocolParameters = gsProtocolParameters
           { Update.ppSlotDuration = toByronSlotLength slotLen
           }

ouroboros-consensus-cardano/src/unstable-byron-testlib/Test/ThreadNet/Infra/Byron/TrackUpdates.hs

@@ -24,6 +24,7 @@ import qualified Cardano.Chain.Update.Validation.Registration as Registration
 import           Cardano.Chain.Update.Vote (AVote)
 import qualified Cardano.Chain.Update.Vote as Vote
 import qualified Cardano.Crypto as Crypto
+import           Cardano.Ledger.BaseTypes (unNonZero)
 import           Cardano.Ledger.Binary (ByteSpan, DecCBOR (..), EncCBOR (..))
 import           Control.Exception (assert)
 import           Control.Monad (guard)
@@ -106,7 +107,7 @@ mkUpdateLabels params numSlots genesisConfig nodeJoinPlan topology result
     -- a block forged in slot @s@ becomes immutable/stable in slot @s + twoK@
     -- according to the Byron Chain Density invariant
     twoK :: SlotNo
-    twoK = SlotNo $ 2 * maxRollbacks pbftSecurityParam
+    twoK = SlotNo $ 2 * unNonZero (maxRollbacks pbftSecurityParam)
 
     -- the number of slots in an epoch
     epochSlots :: SlotNo

ouroboros-consensus-cardano/src/unstable-cardano-testlib/Test/ThreadNet/Infra/TwoEras.hs

@@ -35,6 +35,7 @@ module Test.ThreadNet.Infra.TwoEras (
 import qualified Cardano.Chain.Common as CC.Common
 import           Cardano.Chain.ProtocolConstants (kEpochSlots)
 import           Cardano.Chain.Slotting (unEpochSlots)
+import           Cardano.Ledger.BaseTypes (unNonZero)
 import qualified Cardano.Ledger.BaseTypes as SL
 import qualified Cardano.Protocol.TPraos.Rules.Overlay as SL
 import           Cardano.Slotting.EpochInfo
@@ -91,7 +92,7 @@ genTestConfig k (EpochSize epochSize1, EpochSize epochSize2) = do
     initSeed <- arbitrary
 
     numSlots <- do
-      let wiggle = min epochSize1 (2 * maxRollbacks k)
+      let wiggle = min epochSize1 (2 * unNonZero (maxRollbacks k))
 
           approachSecondEra     =
               choose (0, wiggle)     <&> \t -> epochSize1 + t - wiggle
@@ -140,10 +141,12 @@ genTestConfig k (EpochSize epochSize1, EpochSize epochSize2) = do
 
 -- | Generate 'setupPartition'
 genPartition :: NumCoreNodes -> NumSlots -> SecurityParam -> Gen Partition
-genPartition (NumCoreNodes n) (NumSlots t) (SecurityParam k) = do
+genPartition (NumCoreNodes n) (NumSlots t) (SecurityParam k') = do
     let ultimateSlot :: Word64
         ultimateSlot = assert (t > 0) $ t - 1
 
+        k = unNonZero k'
+
         crop :: Word64 -> Word64
         crop s = min ultimateSlot s
 
@@ -227,7 +230,7 @@ genPartition (NumCoreNodes n) (NumSlots t) (SecurityParam k) = do
           , (1,  Just $ 4 * k + 1)
           , (1,  Just $ 4 * k + 1 + quorum)
           , (20, assert (numFirstEraEpochs == (1 :: Int)) $
-                 Just $ byronEpochSize (SecurityParam k))
+                 Just $ byronEpochSize (SecurityParam k'))
           ]
 
     -- Position the partition so that it at least abuts the focus slot.
@@ -448,7 +451,7 @@ mkMessageDelay part = CalcMessageDelay $
 
 byronEpochSize :: SecurityParam -> Word64
 byronEpochSize (SecurityParam k) =
-    unEpochSlots $ kEpochSlots $ CC.Common.BlockCount k
+    unEpochSlots $ kEpochSlots $ CC.Common.BlockCount $ unNonZero k
 
 shelleyEpochSize :: SecurityParam -> Word64
 shelleyEpochSize k = unEpochSize $ Shelley.mkEpochSize k activeSlotCoeff
@@ -463,15 +466,15 @@ isFirstEraBlock = \case
 -- PREREQUISITE: The number must not be greater than @k@.
 diffK :: SecurityParam -> Word64 -> String
 diffK (SecurityParam k) v =
-    assert (k >= v) $
-    "k - " <> show (k - v)
+    assert (unNonZero k >= v) $
+    "k - " <> show (unNonZero k - v)
 
 -- | Render a number as the nearest tenths of @k@
 approxFracK :: SecurityParam -> Word64 -> String
 approxFracK (SecurityParam k) v =
     "k * " <> show (fromIntegral tenths / 10 :: Double)
   where
-    ratio  = toRational v / toRational k
+    ratio  = toRational v / toRational (unNonZero k)
     tenths = round (ratio * 10) :: Int
 
 -- | <https://en.wikipedia.org/wiki/Monus>

ouroboros-consensus-cardano/src/unstable-shelley-testlib/Test/ThreadNet/Infra/Shelley.hs

@@ -47,8 +47,7 @@ import           Cardano.Crypto.VRF (SignKeyVRF, deriveVerKeyVRF, genKeyVRF,
                      seedSizeVRF)
 import qualified Cardano.Ledger.Allegra.Scripts as SL
 import           Cardano.Ledger.Alonzo (AlonzoEra)
-import           Cardano.Ledger.BaseTypes (boundRational)
-import           Cardano.Ledger.BaseTypes.NonZero (nonZeroOr)
+import           Cardano.Ledger.BaseTypes (boundRational, unNonZero)
 import           Cardano.Ledger.Hashes (EraIndependentTxBody,
                      HashAnnotated (..), SafeHash, hashAnnotated)
 import qualified Cardano.Ledger.Keys as LK
@@ -272,7 +271,7 @@ mkEpochSize (SecurityParam k) f =
     n = numerator   f
     d = denominator f
 
-    (q, r) = quotRem (10 * k * fromInteger d) (fromInteger n)
+    (q, r) = quotRem (10 * unNonZero k * fromInteger d) (fromInteger n)
 
 -- | Note: a KES algorithm supports a particular max number of KES evolutions,
 -- but we can configure a potentially lower maximum for the ledger, that's why
@@ -297,7 +296,7 @@ mkGenesisConfig pVer k f d maxLovelaceSupply slotLength kesCfg coreNodes =
     , sgNetworkMagic          = 0
     , sgNetworkId             = networkId
     , sgActiveSlotsCoeff      = unsafeBoundRational f
-    , sgSecurityParam         = nonZeroOr (maxRollbacks k) $ error "The security parameter cannot be zero."
+    , sgSecurityParam         = maxRollbacks k
     , sgEpochLength           = mkEpochSize k f
     , sgSlotsPerKESPeriod     = slotsPerEvolution kesCfg
     , sgMaxKESEvolutions      = maxEvolutions     kesCfg