Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Testing.ConcreteBlock

Contents

Converting slots to times
Creating sample chains
Generator utilities
Orphan instances

Description

Concrete block

The network library should not export a concrete block type at all, except that it might need one in its tests (but not exported). Right now this module serves to isolate this in a specific module so we can identify easily where it is used; eventually it should be simplified and then moved to the network layer tests; the more sophiscated block abstraction (abstracted over an Ouroboros protocol) will live in the consensus layer.

Synopsis

data Block = Block {
- blockHeader :: BlockHeader
- blockBody :: BlockBody
}
data BlockHeader = BlockHeader {
- headerHash :: HeaderHash BlockHeader
- headerPrevHash :: ChainHash BlockHeader
- headerSlot :: SlotNo
- headerBlockNo :: BlockNo
- headerBodyHash :: BodyHash
}
newtype BlockBody = BlockBody ByteString
hashHeader :: BlockHeader -> ConcreteHeaderHash
newtype BodyHash = BodyHash Int
newtype ConcreteHeaderHash = HeaderHash Int
hashBody :: Hashable body => body -> BodyHash
convertSlotToTimeForTestsAssumingNoHardFork :: SlotNo -> UTCTime
mkChain :: [( SlotNo , BlockBody )] -> Chain Block
mkChainSimple :: [ BlockBody ] -> Chain Block
mkAnchoredFragment :: Anchor Block -> [( SlotNo , BlockBody )] -> AnchoredFragment Block
mkAnchoredFragmentSimple :: [ BlockBody ] -> AnchoredFragment Block
mkPartialBlock :: SlotNo -> BlockBody -> Block
mkPartialBlockHeader :: SlotNo -> BlockBody -> BlockHeader
fixupBlock :: HeaderHash block ~ HeaderHash BlockHeader => Anchor block -> Block -> Block
fixupBlockHeader :: HeaderHash block ~ HeaderHash BlockHeader => Anchor block -> BlockHeader -> BlockHeader
fixupBlockAfterBlock :: Block -> Block -> Block
fixupChain :: HasFullHeader b => ( Anchor b -> b -> b) -> [b] -> Chain b
fixupAnchoredFragmentFrom :: HasFullHeader b => Anchor b -> ( Anchor b -> b -> b) -> [b] -> AnchoredFragment b

Documentation

data Block Source #

Our highly-simplified version of a block. It retains the separation between a block header and body, which is a detail needed for the protocols.

Constructors

Block
Fields blockHeader :: BlockHeader blockBody :: BlockBody

Instances

Instances details

Eq Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods (==) :: Block -> Block -> Bool Source # (/=) :: Block -> Block -> Bool Source #
Show Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods showsPrec :: Int -> Block -> ShowS Source # show :: Block -> String Source # showList :: [ Block ] -> ShowS Source #
Generic Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Associated Types type Rep Block :: Type -> Type Source # Methods from :: Block -> Rep Block x Source # to :: Rep Block x -> Block Source #
Serialise Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods encode :: Block -> Encoding Source # decode :: Decoder s Block Source # encodeList :: [ Block ] -> Encoding Source # decodeList :: Decoder s [ Block ] Source #
StandardHash Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock
HasFullHeader Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods blockPrevHash :: Block -> ChainHash Block Source # blockInvariant :: Block -> Bool Source #
HasHeader Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods getHeaderFields :: Block -> HeaderFields Block Source #
ShowProxy Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods showProxy :: Proxy Block -> String Source #
type Rep Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type Rep Block = D1 (' MetaData "Block" "Ouroboros.Network.Testing.ConcreteBlock" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" ' False ) ( C1 (' MetaCons "Block" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "blockHeader") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockHeader ) :*: S1 (' MetaSel (' Just "blockBody") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockBody )))
type HeaderHash Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type HeaderHash Block = ConcreteHeaderHash

data BlockHeader Source #

A block header. It retains simplified versions of all the essential elements.

Constructors

BlockHeader
Fields headerHash :: HeaderHash BlockHeader The cached `HeaderHash` of this header. headerPrevHash :: ChainHash BlockHeader The `headerHash` of the previous block header headerSlot :: SlotNo The Ouroboros time slot index of this block headerBlockNo :: BlockNo The block index from the Genesis headerBodyHash :: BodyHash The hash of the corresponding block body

Instances

Instances details

Eq BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods (==) :: BlockHeader -> BlockHeader -> Bool Source # (/=) :: BlockHeader -> BlockHeader -> Bool Source #
Show BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods showsPrec :: Int -> BlockHeader -> ShowS Source # show :: BlockHeader -> String Source # showList :: [ BlockHeader ] -> ShowS Source #
Generic BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Associated Types type Rep BlockHeader :: Type -> Type Source # Methods from :: BlockHeader -> Rep BlockHeader x Source # to :: Rep BlockHeader x -> BlockHeader Source #
Serialise BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods encode :: BlockHeader -> Encoding Source # decode :: Decoder s BlockHeader Source # encodeList :: [ BlockHeader ] -> Encoding Source # decodeList :: Decoder s [ BlockHeader ] Source #
StandardHash BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock
HasFullHeader BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods blockPrevHash :: BlockHeader -> ChainHash BlockHeader Source # blockInvariant :: BlockHeader -> Bool Source #
HasHeader BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods getHeaderFields :: BlockHeader -> HeaderFields BlockHeader Source #
ShowProxy BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods showProxy :: Proxy BlockHeader -> String Source #
type Rep BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type Rep BlockHeader = D1 (' MetaData "BlockHeader" "Ouroboros.Network.Testing.ConcreteBlock" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" ' False ) ( C1 (' MetaCons "BlockHeader" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "headerHash") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( HeaderHash BlockHeader )) :: S1 (' MetaSel (' Just "headerPrevHash") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( ChainHash BlockHeader ))) :: ( S1 (' MetaSel (' Just "headerSlot") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 SlotNo ) :: ( S1 (' MetaSel (' Just "headerBlockNo") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockNo ) :: S1 (' MetaSel (' Just "headerBodyHash") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BodyHash )))))
type HeaderHash BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type HeaderHash BlockHeader = ConcreteHeaderHash

newtype BlockBody Source #

Constructors

BlockBody ByteString

Instances

Instances details

Eq BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods (==) :: BlockBody -> BlockBody -> Bool Source # (/=) :: BlockBody -> BlockBody -> Bool Source #
Ord BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods compare :: BlockBody -> BlockBody -> Ordering Source # (<) :: BlockBody -> BlockBody -> Bool Source # (<=) :: BlockBody -> BlockBody -> Bool Source # (>) :: BlockBody -> BlockBody -> Bool Source # (>=) :: BlockBody -> BlockBody -> Bool Source # max :: BlockBody -> BlockBody -> BlockBody Source # min :: BlockBody -> BlockBody -> BlockBody Source #
Show BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods showsPrec :: Int -> BlockBody -> ShowS Source # show :: BlockBody -> String Source # showList :: [ BlockBody ] -> ShowS Source #
IsString BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods fromString :: String -> BlockBody Source #
Generic BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Associated Types type Rep BlockBody :: Type -> Type Source # Methods from :: BlockBody -> Rep BlockBody x Source # to :: Rep BlockBody x -> BlockBody Source #
Hashable BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods hashWithSalt :: Int -> BlockBody -> Int Source # hash :: BlockBody -> Int Source #
Serialise BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods encode :: BlockBody -> Encoding Source # decode :: Decoder s BlockBody Source # encodeList :: [ BlockBody ] -> Encoding Source # decodeList :: Decoder s [ BlockBody ] Source #
type Rep BlockBody Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type Rep BlockBody = D1 (' MetaData "BlockBody" "Ouroboros.Network.Testing.ConcreteBlock" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" ' True ) ( C1 (' MetaCons "BlockBody" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ByteString )))

hashHeader :: BlockHeader -> ConcreteHeaderHash Source #

Compute the HeaderHash of the BlockHeader .

newtype BodyHash Source #

The hash of all the information in a BlockBody .

Constructors

BodyHash Int

Instances

Instances details

Eq BodyHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods (==) :: BodyHash -> BodyHash -> Bool Source # (/=) :: BodyHash -> BodyHash -> Bool Source #
Ord BodyHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods compare :: BodyHash -> BodyHash -> Ordering Source # (<) :: BodyHash -> BodyHash -> Bool Source # (<=) :: BodyHash -> BodyHash -> Bool Source # (>) :: BodyHash -> BodyHash -> Bool Source # (>=) :: BodyHash -> BodyHash -> Bool Source # max :: BodyHash -> BodyHash -> BodyHash Source # min :: BodyHash -> BodyHash -> BodyHash Source #
Show BodyHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods showsPrec :: Int -> BodyHash -> ShowS Source # show :: BodyHash -> String Source # showList :: [ BodyHash ] -> ShowS Source #
Generic BodyHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Associated Types type Rep BodyHash :: Type -> Type Source # Methods from :: BodyHash -> Rep BodyHash x Source # to :: Rep BodyHash x -> BodyHash Source #
Hashable BodyHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods hashWithSalt :: Int -> BodyHash -> Int Source # hash :: BodyHash -> Int Source #
Serialise BodyHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods encode :: BodyHash -> Encoding Source # decode :: Decoder s BodyHash Source # encodeList :: [ BodyHash ] -> Encoding Source # decodeList :: Decoder s [ BodyHash ] Source #
type Rep BodyHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type Rep BodyHash = D1 (' MetaData "BodyHash" "Ouroboros.Network.Testing.ConcreteBlock" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" ' True ) ( C1 (' MetaCons "BodyHash" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int )))

newtype ConcreteHeaderHash Source #

The hash of all the information in a BlockHeader .

Constructors

HeaderHash Int

Instances

Instances details

Eq ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods (==) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool Source # (/=) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool Source #
Ord ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods compare :: ConcreteHeaderHash -> ConcreteHeaderHash -> Ordering Source # (<) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool Source # (<=) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool Source # (>) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool Source # (>=) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool Source # max :: ConcreteHeaderHash -> ConcreteHeaderHash -> ConcreteHeaderHash Source # min :: ConcreteHeaderHash -> ConcreteHeaderHash -> ConcreteHeaderHash Source #
Show ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods showsPrec :: Int -> ConcreteHeaderHash -> ShowS Source # show :: ConcreteHeaderHash -> String Source # showList :: [ ConcreteHeaderHash ] -> ShowS Source #
Generic ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Associated Types type Rep ConcreteHeaderHash :: Type -> Type Source # Methods from :: ConcreteHeaderHash -> Rep ConcreteHeaderHash x Source # to :: Rep ConcreteHeaderHash x -> ConcreteHeaderHash Source #
Hashable ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods hashWithSalt :: Int -> ConcreteHeaderHash -> Int Source # hash :: ConcreteHeaderHash -> Int Source #
NoThunks ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods noThunks :: Context -> ConcreteHeaderHash -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ConcreteHeaderHash -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ConcreteHeaderHash -> String Source #
Serialise ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods encode :: ConcreteHeaderHash -> Encoding Source # decode :: Decoder s ConcreteHeaderHash Source # encodeList :: [ ConcreteHeaderHash ] -> Encoding Source # decodeList :: Decoder s [ ConcreteHeaderHash ] Source #
type Rep ConcreteHeaderHash Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type Rep ConcreteHeaderHash = D1 (' MetaData "ConcreteHeaderHash" "Ouroboros.Network.Testing.ConcreteBlock" "ouroboros-network-0.1.0.1-2UgqzRSdBh49QYumtriFSI" ' True ) ( C1 (' MetaCons "HeaderHash" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Int )))

hashBody :: Hashable body => body -> BodyHash Source #

Converting slots to times

convertSlotToTimeForTestsAssumingNoHardFork :: SlotNo -> UTCTime Source #

Arbitrarily but consistently converts slots UTCTimes.

It is only intended for use in tests. Notably it assumes a fixed system start time, slot length, and the absence of a hard fork (ie no HardForkCombinator). This is how it's available as a pure function.

Creating sample chains

mkChain :: [( SlotNo , BlockBody )] -> Chain Block Source #

This takes the blocks in order from oldest to newest .

mkChainSimple :: [ BlockBody ] -> Chain Block Source #

mkAnchoredFragment :: Anchor Block -> [( SlotNo , BlockBody )] -> AnchoredFragment Block Source #

mkAnchoredFragmentSimple :: [ BlockBody ] -> AnchoredFragment Block Source #

Generator utilities

mkPartialBlock :: SlotNo -> BlockBody -> Block Source #

mkPartialBlockHeader :: SlotNo -> BlockBody -> BlockHeader Source #

fixupBlock :: HeaderHash block ~ HeaderHash BlockHeader => Anchor block -> Block -> Block Source #

Fix up a block so that it fits on top of the given anchor. Only the block number, the previous hash and the block hash are updated; the slot number and the signers are kept intact.

fixupBlockHeader :: HeaderHash block ~ HeaderHash BlockHeader => Anchor block -> BlockHeader -> BlockHeader Source #

Fixup block header to fit it on top of a chain. Only block number and previous hash are updated; the slot and signer are kept unchanged.

fixupBlockAfterBlock :: Block -> Block -> Block Source #

Fixup a block so to fit it on top of a given previous block.

fixupChain :: HasFullHeader b => ( Anchor b -> b -> b) -> [b] -> Chain b Source #

Fix up the block number and hashes of a Chain . This also fixes up the first block to chain-on from genesis, since by construction the Chain type starts from genesis.

fixupAnchoredFragmentFrom :: HasFullHeader b => Anchor b -> ( Anchor b -> b -> b) -> [b] -> AnchoredFragment b Source #

Orphan instances

Hashable SlotNo Source #
Instance details Methods hashWithSalt :: Int -> SlotNo -> Int Source # hash :: SlotNo -> Int Source #
Hashable BlockNo Source #
Instance details Methods hashWithSalt :: Int -> BlockNo -> Int Source # hash :: BlockNo -> Int Source #
Hashable ( HeaderHash b) => Hashable ( ChainHash b) Source #	`Hashable` instance for `Hash` We don't insist that `Hashable` in `StandardHash` because `Hashable` is only used in the network layer tests . This requires `UndecidableInstances` because `Hashable (HeaderHash b)` is no smaller than `Hashable (ChainHash b)` .
Instance details Methods hashWithSalt :: Int -> ChainHash b -> Int Source # hash :: ChainHash b -> Int Source #