| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Test.Ouroboros.Storage.ChainDB.StateMachine.Utils.RunOnRepl
Description
Collection functions and exported symbols to be able to run a 'quickcheck-state-machine' counterexample using the GHC repl.
To test a counterexample first fire up the repl, and enable the
FlexibleContexts and TypeFamilies extensions, and set multi-line input.
cabal new-repl test-storage import Test.Ouroboros.Storage.ChainDB.StateMachine.Utils.RunOnRepl :set -XFlexibleContexts -XTypeFamilies +m
The commands that are part of the counterexample are usually several lines long. Thus it is better to create a local definition for them:
cmds = (<PASTE THE COMMANDS OF THE COUNTEREXAMPLE HERE>)
Note the use of parentheses to prevent GHCi from ending the multiline input prematurely (the copied counterexample in this case).
Then, the model and system under tests can be tested for lockstep agreement by running:
quickCheckCmdsLockStep someClockSkew someChunkInfo counterexample
Where someClockSkew and someChunkInfo are the ones given by the
counterexample found by quickcheck-statemachine.
Synopsis
- quickCheckCmdsLockStep ∷ MaxClockSkew → SmallChunkInfo → Commands (At Cmd TestBlock IO) (At Resp TestBlock IO) → IO ()
- pattern At ∷ Block SlotNo (HeaderHash blk) → Point blk
- pattern Command ∷ t1 blk1 (IterRef blk1 m1 Symbolic) (FollowerRef blk1 m1 Symbolic) → t2 blk2 (IterRef blk2 m2 Symbolic) (FollowerRef blk2 m2 Symbolic) → [Var] → Command (At t1 blk1 m1) (At t2 blk2 m2)
- newtype Commands (cmd ∷ (Type → Type) → Type) (resp ∷ (Type → Type) → Type) = Commands {
- unCommands ∷ [Command cmd resp]
- newtype Reference a (r ∷ Type → Type) = Reference (r a)
- data Symbolic a where
- newtype Var = Var Int
- data Cmd blk it flr
- = AddBlock blk
- | AddFutureBlock blk SlotNo
- | GetCurrentChain
- | GetLedgerDB
- | GetTipBlock
- | GetTipHeader
- | GetTipPoint
- | GetBlockComponent (RealPoint blk)
- | GetGCedBlockComponent (RealPoint blk)
- | GetMaxSlotNo
- | GetIsValid (RealPoint blk)
- | Stream (StreamFrom blk) (StreamTo blk)
- | IteratorNext it
- | IteratorNextGCed it
- | IteratorClose it
- | NewFollower ChainType
- | FollowerInstruction flr
- | FollowerForward flr [Point blk]
- | FollowerClose flr
- | Close
- | Reopen
- | PersistBlks
- | PersistBlksThenGC
- | UpdateLedgerSnapshots
- | WipeVolatileDB
- newtype MaxClockSkew = MaxClockSkew Word64
- newtype Resp blk it flr = Resp {
- getResp ∷ Either (ChainDbError blk) (Success blk it flr)
- data Success blk it flr
- = Unit ()
- | Chain (AnchoredFragment (Header blk))
- | LedgerDB (LedgerDB (ExtLedgerState blk))
- | MbBlock (Maybe blk)
- | MbAllComponents (Maybe (AllComponents blk))
- | MbGCedAllComponents (MaybeGCedBlock (AllComponents blk))
- | MbHeader (Maybe (Header blk))
- | Point (Point blk)
- | IsValid IsValidResult
- | UnknownRange (UnknownRange blk)
- | Iter it
- | IterResult (IteratorResult blk (AllComponents blk))
- | IterResultGCed (IteratorResultGCed blk)
- | Flr flr
- | MbChainUpdate (Maybe (ChainUpdate blk (AllComponents blk)))
- | MbPoint (Maybe (Point blk))
- | MaxSlot MaxSlotNo
- runCmdsLockstep ∷ MaxClockSkew → SmallChunkInfo → Commands (At Cmd Blk IO) (At Resp Blk IO) → Property
- newtype ChainLength = ChainLength Int
- data EBB
- = EBB !EpochNo
- | RegularBlock
- data SmallChunkInfo = SmallChunkInfo ChunkInfo
- data TestBlock = TestBlock {}
- data TestBody = TestBody {}
- newtype TestBodyHash = TestBodyHash Int
- data TestHeader = TestHeader {}
- newtype TestHeaderHash = TestHeaderHash Int
- data Block slot hash = Block {
- blockPointSlot ∷ !slot
- blockPointHash ∷ !hash
- newtype BlockNo = BlockNo {}
- data ChainHash (b ∷ k)
- = GenesisHash
- | BlockHash !(HeaderHash b)
- data ChainType = TentativeChain
- data ChainUpdate (block ∷ k) a = RollBack (Point block)
- data ChunkInfo = UniformChunkSize !ChunkSize
- data ChunkSize = ChunkSize {}
- newtype EpochNo = EpochNo Word64
- newtype SlotNo = SlotNo {}
Running the counterexamples
quickCheckCmdsLockStep ∷ MaxClockSkew → SmallChunkInfo → Commands (At Cmd TestBlock IO) (At Resp TestBlock IO) → IO () Source #
Patterns needed to disambiguate the At and Command symbols printed
pattern Command ∷ t1 blk1 (IterRef blk1 m1 Symbolic) (FollowerRef blk1 m1 Symbolic) → t2 blk2 (IterRef blk2 m2 Symbolic) (FollowerRef blk2 m2 Symbolic) → [Var] → Command (At t1 blk1 m1) (At t2 blk2 m2) Source #
Re-exports needed for compiling a StateMachine inside the repl.
quickcheck-state-machine re-exports
newtype Commands (cmd ∷ (Type → Type) → Type) (resp ∷ (Type → Type) → Type) Source #
Constructors
| Commands | |
Fields
| |
newtype Reference a (r ∷ Type → Type) Source #
Constructors
| Reference (r a) |
Instances
| Foldable (Reference a ∷ (Type → Type) → Type) | |
| Functor (Reference a ∷ (Type → Type) → Type) | |
| Traversable (Reference a ∷ (Type → Type) → Type) | |
Defined in Test.StateMachine.Types.References | |
| Generic (Reference a r) | |
| Typeable a ⇒ Read (Reference a Symbolic) | |
| (Show1 r, Show a) ⇒ Show (Reference a r) | |
| (Eq a, Eq1 r) ⇒ Eq (Reference a r) | |
| (Ord a, Ord1 r) ⇒ Ord (Reference a r) | |
Defined in Test.StateMachine.Types.References | |
| type Rep (Reference a r) | |
Defined in Test.StateMachine.Types.References type Rep (Reference a r) = D1 ('MetaData "Reference" "Test.StateMachine.Types.References" "quickcheck-state-machine-0.9.0-l-no-vendored-treediff-c029f837ba52b49df33e5a61202140048ab4f272304662c29700ab885b8fd02a" 'True) (C1 ('MetaCons "Reference" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (r a)))) | |
Instances
| Generic Var | |
| Read Var | |
| Show Var | |
| Eq Var | |
| Ord Var | |
| type Rep Var | |
Defined in Test.StateMachine.Types.References type Rep Var = D1 ('MetaData "Var" "Test.StateMachine.Types.References" "quickcheck-state-machine-0.9.0-l-no-vendored-treediff-c029f837ba52b49df33e5a61202140048ab4f272304662c29700ab885b8fd02a" 'True) (C1 ('MetaCons "Var" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))) | |
ChainDB.StateMachine re-exports
Commands
Constructors
| AddBlock blk | Advance the current slot to the block's slot (unless smaller than the current slot) and add the block. |
| AddFutureBlock blk SlotNo | Advance the current slot to the given slot, which is guaranteed to be smaller than the block's slot number (such that the block is from the future) and larger or equal to the current slot, and add the block. |
| GetCurrentChain | |
| GetLedgerDB | |
| GetTipBlock | |
| GetTipHeader | |
| GetTipPoint | |
| GetBlockComponent (RealPoint blk) | |
| GetGCedBlockComponent (RealPoint blk) | Only for blocks that may have been garbage collected. |
| GetMaxSlotNo | |
| GetIsValid (RealPoint blk) | |
| Stream (StreamFrom blk) (StreamTo blk) | |
| IteratorNext it | |
| IteratorNextGCed it | Only for blocks that may have been garbage collected. |
| IteratorClose it | |
| NewFollower ChainType | |
| FollowerInstruction flr |
|
| FollowerForward flr [Point blk] | |
| FollowerClose flr | |
| Close | |
| Reopen | |
| PersistBlks | Copy the blocks older than |
| PersistBlksThenGC | Copy the blocks older than The garbage collection procedure of the Chain DB (our system under test)
removes the blocks from the volatile DB without caring about whether
the removed blocks were persisted. Therefore, this part of the Chain DB
logic assumes that copy to the immutable DB took place before
garbage collection. The model uses this assumption as well. As a result,
we cannot perform garbage collection in isolation, since this will break
the model's |
| UpdateLedgerSnapshots | Write a new |
| WipeVolatileDB |
Instances
newtype MaxClockSkew Source #
Max clock skew in number of slots
Constructors
| MaxClockSkew Word64 |
Instances
| Arbitrary MaxClockSkew Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine | |
| Show MaxClockSkew Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine Methods showsPrec ∷ Int → MaxClockSkew → ShowS # show ∷ MaxClockSkew → String # showList ∷ [MaxClockSkew] → ShowS # | |
| Eq MaxClockSkew Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine | |
newtype Resp blk it flr Source #
Responses are either successful termination or an error.
Constructors
| Resp | |
Fields
| |
Instances
| Bifoldable (Resp blk) Source # | |
| Bifunctor (Resp blk) Source # | |
| Bitraversable (Resp blk) Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine Methods bitraverse ∷ Applicative f ⇒ (a → f c) → (b → f d) → Resp blk a b → f (Resp blk c d) # | |
| Foldable (Resp blk it) Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine Methods fold ∷ Monoid m ⇒ Resp blk it m → m # foldMap ∷ Monoid m ⇒ (a → m) → Resp blk it a → m # foldMap' ∷ Monoid m ⇒ (a → m) → Resp blk it a → m # foldr ∷ (a → b → b) → b → Resp blk it a → b # foldr' ∷ (a → b → b) → b → Resp blk it a → b # foldl ∷ (b → a → b) → b → Resp blk it a → b # foldl' ∷ (b → a → b) → b → Resp blk it a → b # foldr1 ∷ (a → a → a) → Resp blk it a → a # foldl1 ∷ (a → a → a) → Resp blk it a → a # toList ∷ Resp blk it a → [a] # length ∷ Resp blk it a → Int # elem ∷ Eq a ⇒ a → Resp blk it a → Bool # maximum ∷ Ord a ⇒ Resp blk it a → a # minimum ∷ Ord a ⇒ Resp blk it a → a # | |
| Traversable (Resp blk it) Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine | |
| Functor (Resp blk it) Source # | |
| (TestConstraints blk, Show it, Show flr) ⇒ Show (Resp blk it flr) Source # | |
| (TestConstraints blk, Eq it, Eq flr) ⇒ Eq (Resp blk it flr) Source # | |
| (TestConstraints blk, Eq1 r) ⇒ Eq (At Resp blk m r) Source # | |
data Success blk it flr Source #
Return type for successful database operations.
Constructors
| Unit () | |
| Chain (AnchoredFragment (Header blk)) | |
| LedgerDB (LedgerDB (ExtLedgerState blk)) | |
| MbBlock (Maybe blk) | |
| MbAllComponents (Maybe (AllComponents blk)) | |
| MbGCedAllComponents (MaybeGCedBlock (AllComponents blk)) | |
| MbHeader (Maybe (Header blk)) | |
| Point (Point blk) | |
| IsValid IsValidResult | |
| UnknownRange (UnknownRange blk) | |
| Iter it | |
| IterResult (IteratorResult blk (AllComponents blk)) | |
| IterResultGCed (IteratorResultGCed blk) | |
| Flr flr | |
| MbChainUpdate (Maybe (ChainUpdate blk (AllComponents blk))) | |
| MbPoint (Maybe (Point blk)) | |
| MaxSlot MaxSlotNo |
Instances
| Bifoldable (Success blk) Source # | |
| Bifunctor (Success blk) Source # | |
| Bitraversable (Success blk) Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine Methods bitraverse ∷ Applicative f ⇒ (a → f c) → (b → f d) → Success blk a b → f (Success blk c d) # | |
| Foldable (Success blk it) Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine Methods fold ∷ Monoid m ⇒ Success blk it m → m # foldMap ∷ Monoid m ⇒ (a → m) → Success blk it a → m # foldMap' ∷ Monoid m ⇒ (a → m) → Success blk it a → m # foldr ∷ (a → b → b) → b → Success blk it a → b # foldr' ∷ (a → b → b) → b → Success blk it a → b # foldl ∷ (b → a → b) → b → Success blk it a → b # foldl' ∷ (b → a → b) → b → Success blk it a → b # foldr1 ∷ (a → a → a) → Success blk it a → a # foldl1 ∷ (a → a → a) → Success blk it a → a # toList ∷ Success blk it a → [a] # null ∷ Success blk it a → Bool # length ∷ Success blk it a → Int # elem ∷ Eq a ⇒ a → Success blk it a → Bool # maximum ∷ Ord a ⇒ Success blk it a → a # minimum ∷ Ord a ⇒ Success blk it a → a # | |
| Traversable (Success blk it) Source # | |
Defined in Test.Ouroboros.Storage.ChainDB.StateMachine | |
| Functor (Success blk it) Source # | |
| (TestConstraints blk, Show it, Show flr) ⇒ Show (Success blk it flr) Source # | |
| (TestConstraints blk, Eq it, Eq flr) ⇒ Eq (Success blk it flr) Source # | |
runCmdsLockstep ∷ MaxClockSkew → SmallChunkInfo → Commands (At Cmd Blk IO) (At Resp Blk IO) → Property Source #
Test packages re-exports
newtype ChainLength Source #
In chain selection, we use BlockNo as a proxy for the block length.
This is entirely correct, except for those dreadful EBBs, which share their
block number with their predecessor. So it is possible that two chains with
the same BlockNo at the tip have a different length because the longer
chain contains more EBBs than the shorter.
For example:
.. :> EBB (100, slotNo 10, blockNo 1) :> (400, slotNo 10, blockNo 2) .. :> (999, slotNo 10, blockNo 2)
The chain selection for this TestBlock looks at the hashes in case of a
BlockNo tie (after prefering the chain ending with an EBB) and will pick
the block with the highest hash. This is to have a more deterministic chain
selection (less implementation specific) which will keep the model better
in sync with the implementation.
In the example above, that would mean picking the second chain, /even though it is shorter/! The implementation does not support switching to a shorter chain.
Note that this is not a problem for Byron, because we don't look at the hashes or anything else in case of a tie (we just prefer a chain ending with an EBB, which must be longer).
Note that is not a problem for Shelley either, where we do look at the certificate number and VRF hash in case of a tie, because there are no EBBs.
This is only an issue when:
* There can be EBBs in the chain
* In case of equal blockNos, we still prefer one over the other because
of some additional condition.
Which is the case for this TestBlock.
To solve this, we store the real chain length inside the block. The only
difference with the BlockNo is that ChainLength takes EBBs into account.
When there is BlockNo tie as in the example above and we would look at
the hashes, we will first look at the ChainLength (and prefer the longest
one). Only if that is equal do we actually look at the hashes. This
guarantees that we never prefer a chain that is shorter.
NOTE: we start counting from 1 (unlike BlockNo, which starts from 0),
because it corresponds to the length.
Constructors
| ChainLength Int |
Instances
Strict variant of Maybe EpochNo
Constructors
| EBB !EpochNo | |
| RegularBlock |
Instances
| Generic EBB Source # | |
| Show EBB Source # | |
| Eq EBB Source # | |
| Hashable EBB Source # | |
| NoThunks EBB Source # | |
| Serialise EBB Source # | |
| ToExpr EBB Source # | |
| type Rep EBB Source # | |
Defined in Test.Ouroboros.Storage.TestBlock type Rep EBB = D1 ('MetaData "EBB" "Test.Ouroboros.Storage.TestBlock" "main" 'False) (C1 ('MetaCons "EBB" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNo)) :+: C1 ('MetaCons "RegularBlock" 'PrefixI 'False) (U1 ∷ Type → Type)) | |
data SmallChunkInfo Source #
Constructors
| SmallChunkInfo ChunkInfo |
Instances
| Arbitrary SmallChunkInfo | |
Defined in Test.Util.ChunkInfo | |
| Show SmallChunkInfo | |
Defined in Test.Util.ChunkInfo Methods showsPrec ∷ Int → SmallChunkInfo → ShowS # show ∷ SmallChunkInfo → String # showList ∷ [SmallChunkInfo] → ShowS # | |
Constructors
| TestBlock | |
Fields
| |
Instances
Constructors
| TestBody | |
Fields
| |
Instances
| Generic TestBody Source # | |
| Show TestBody Source # | |
| Eq TestBody Source # | |
| Hashable TestBody Source # | |
| NoThunks TestBody Source # | |
| Serialise TestBody Source # | |
| ToExpr TestBody Source # | |
| type Rep TestBody Source # | |
Defined in Test.Ouroboros.Storage.TestBlock type Rep TestBody = D1 ('MetaData "TestBody" "Test.Ouroboros.Storage.TestBlock" "main" 'False) (C1 ('MetaCons "TestBody" 'PrefixI 'True) (S1 ('MetaSel ('Just "tbForkNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word) :*: S1 ('MetaSel ('Just "tbIsValid") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))) | |
newtype TestBodyHash Source #
Hash of a TestBody
Constructors
| TestBodyHash Int |
Instances
data TestHeader Source #
Constructors
| TestHeader | |
Fields
| |
Instances
newtype TestHeaderHash Source #
Hash of a TestHeader
Constructors
| TestHeaderHash Int |
Instances
Ouroboros consensus re-exports
Constructors
| Block | |
Fields
| |
Instances
| Generic (Block slot hash) | |
| (Show slot, Show hash) ⇒ Show (Block slot hash) | |
| (Eq slot, Eq hash) ⇒ Eq (Block slot hash) | |
| (Ord slot, Ord hash) ⇒ Ord (Block slot hash) | |
Defined in Ouroboros.Network.Point Methods compare ∷ Block slot hash → Block slot hash → Ordering # (<) ∷ Block slot hash → Block slot hash → Bool # (<=) ∷ Block slot hash → Block slot hash → Bool # (>) ∷ Block slot hash → Block slot hash → Bool # (>=) ∷ Block slot hash → Block slot hash → Bool # | |
| (NoThunks slot, NoThunks hash) ⇒ NoThunks (Block slot hash) | |
| type Rep (Block slot hash) | |
Defined in Ouroboros.Network.Point type Rep (Block slot hash) = D1 ('MetaData "Block" "Ouroboros.Network.Point" "ouroboros-network-api-0.7.2.0-0bea7b823cbda00590f7ea5f9786d7648393f2aa10b0aef7b53ea3ea0094c568" 'False) (C1 ('MetaCons "Block" 'PrefixI 'True) (S1 ('MetaSel ('Just "blockPointSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 slot) :*: S1 ('MetaSel ('Just "blockPointHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 hash))) | |
The 0-based index of the block in the blockchain. BlockNo is <= SlotNo and is only equal at slot N if there is a block for every slot where N <= SlotNo.
Instances
| FromJSON BlockNo | |
| ToJSON BlockNo | |
| Bounded BlockNo | |
| Enum BlockNo | |
Defined in Cardano.Slotting.Block | |
| Generic BlockNo | |
| Num BlockNo | |
| Show BlockNo | |
| FromCBOR BlockNo | |
| ToCBOR BlockNo | |
| NFData BlockNo | |
Defined in Cardano.Slotting.Block | |
| Eq BlockNo | |
| Ord BlockNo | |
| Hashable BlockNo Source # | |
| NoThunks BlockNo | |
| ChainOrder BlockNo | |
Defined in Ouroboros.Consensus.Protocol.Abstract Associated Types type ChainOrderConfig BlockNo Source # Methods preferCandidate ∷ ChainOrderConfig BlockNo → BlockNo → BlockNo → Bool Source # | |
| Condense BlockNo | |
| Serialise BlockNo | |
| type Rep BlockNo | |
Defined in Cardano.Slotting.Block type Rep BlockNo = D1 ('MetaData "BlockNo" "Cardano.Slotting.Block" "cardano-slotting-0.2.0.0-efb016fbe9e168c0ff2b2dc78099f0dcce58de3212bf5f1627b43e6c92636bbb" 'True) (C1 ('MetaCons "BlockNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64))) | |
| type ChainOrderConfig BlockNo | |
Defined in Ouroboros.Consensus.Protocol.Abstract | |
data ChainHash (b ∷ k) Source #
Constructors
| GenesisHash | |
| BlockHash !(HeaderHash b) |
Instances
Chain type
Followers can choose to track changes to the "normal" SelectedChain, or
track the TentativeChain, which might contain a pipelineable header at the
tip.
Constructors
| TentativeChain |
data ChainUpdate (block ∷ k) a Source #
A representation of two actions to update a chain: add a block or roll back to a previous point.
The type parameter a is there to allow a Functor instance. Typically,
it will be instantiated with block itself.
Instances
| Foldable (ChainUpdate block) | |
Defined in Ouroboros.Network.Block Methods fold ∷ Monoid m ⇒ ChainUpdate block m → m # foldMap ∷ Monoid m ⇒ (a → m) → ChainUpdate block a → m # foldMap' ∷ Monoid m ⇒ (a → m) → ChainUpdate block a → m # foldr ∷ (a → b → b) → b → ChainUpdate block a → b # foldr' ∷ (a → b → b) → b → ChainUpdate block a → b # foldl ∷ (b → a → b) → b → ChainUpdate block a → b # foldl' ∷ (b → a → b) → b → ChainUpdate block a → b # foldr1 ∷ (a → a → a) → ChainUpdate block a → a # foldl1 ∷ (a → a → a) → ChainUpdate block a → a # toList ∷ ChainUpdate block a → [a] # null ∷ ChainUpdate block a → Bool # length ∷ ChainUpdate block a → Int # elem ∷ Eq a ⇒ a → ChainUpdate block a → Bool # maximum ∷ Ord a ⇒ ChainUpdate block a → a # minimum ∷ Ord a ⇒ ChainUpdate block a → a # sum ∷ Num a ⇒ ChainUpdate block a → a # product ∷ Num a ⇒ ChainUpdate block a → a # | |
| Traversable (ChainUpdate block) | |
Defined in Ouroboros.Network.Block Methods traverse ∷ Applicative f ⇒ (a → f b) → ChainUpdate block a → f (ChainUpdate block b) # sequenceA ∷ Applicative f ⇒ ChainUpdate block (f a) → f (ChainUpdate block a) # mapM ∷ Monad m ⇒ (a → m b) → ChainUpdate block a → m (ChainUpdate block b) # sequence ∷ Monad m ⇒ ChainUpdate block (m a) → m (ChainUpdate block a) # | |
| Functor (ChainUpdate block) | |
Defined in Ouroboros.Network.Block Methods fmap ∷ (a → b) → ChainUpdate block a → ChainUpdate block b # (<$) ∷ a → ChainUpdate block b → ChainUpdate block a # | |
| (StandardHash block, Show a) ⇒ Show (ChainUpdate block a) | |
Defined in Ouroboros.Network.Block Methods showsPrec ∷ Int → ChainUpdate block a → ShowS # show ∷ ChainUpdate block a → String # showList ∷ [ChainUpdate block a] → ShowS # | |
| (StandardHash block, Eq a) ⇒ Eq (ChainUpdate block a) | |
Defined in Ouroboros.Network.Block Methods (==) ∷ ChainUpdate block a → ChainUpdate block a → Bool # (/=) ∷ ChainUpdate block a → ChainUpdate block a → Bool # | |
Size of the chunks of the immutable DB
This is the key data structure that drives all layout functions.
TODO: Add support for non-uniform ChunkInfo
https://github.com/IntersectMBO/ouroboros-network/issues/1754
Constructors
| UniformChunkSize !ChunkSize | A single, uniform, chunk size If EBBs are present, the chunk size must line up precisely with the epoch size (that is, the number of regular blocks in the chunk must equal the number of regular blocks in an epoch). |
Instances
| Generic ChunkInfo | |
| Show ChunkInfo | |
| NoThunks ChunkInfo | |
| type Rep ChunkInfo | |
Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal type Rep ChunkInfo = D1 ('MetaData "ChunkInfo" "Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "UniformChunkSize" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ChunkSize))) | |
Size of a chunk
The total number of slots available in a chunk is equal to numRegularBlocks
if not chunkCanContainEBB, and numRegularBlocks + 1 otherwise.
Constructors
| ChunkSize | |
Fields
| |
Instances
| Generic ChunkSize | |
| Show ChunkSize | |
| NoThunks ChunkSize | |
| type Rep ChunkSize | |
Defined in Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal type Rep ChunkSize = D1 ('MetaData "ChunkSize" "Ouroboros.Consensus.Storage.ImmutableDB.Chunks.Internal" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "ChunkSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "chunkCanContainEBB") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "numRegularBlocks") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))) | |
An epoch, i.e. the number of the epoch.
Instances
| FromJSON EpochNo | |
| ToJSON EpochNo | |
| Enum EpochNo | |
Defined in Cardano.Slotting.Slot | |
| Generic EpochNo | |
| Show EpochNo | |
| FromCBOR EpochNo | |
| ToCBOR EpochNo | |
| NFData EpochNo | |
Defined in Cardano.Slotting.Slot | |
| Eq EpochNo | |
| Ord EpochNo | |
| NoThunks EpochNo | |
| Condense EpochNo | |
| Serialise EpochNo | |
| type Rep EpochNo | |
Defined in Cardano.Slotting.Slot type Rep EpochNo = D1 ('MetaData "EpochNo" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-efb016fbe9e168c0ff2b2dc78099f0dcce58de3212bf5f1627b43e6c92636bbb" 'True) (C1 ('MetaCons "EpochNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64))) | |
The 0-based index for the Ourboros time slot.