Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Mock.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

Generic Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Associated Types

type Rep Block

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type Rep Block = D1 ('MetaData "Block" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" 'False) (C1 ('MetaCons "Block" 'PrefixI 'True) (S1 ('MetaSel ('Just "blockHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockHeader) :*: S1 ('MetaSel ('Just "blockBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockBody)))

Methods

from :: Block -> Rep Block x #

to :: Rep Block x -> Block #

Show Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

showsPrec :: Int -> Block -> ShowS #

show :: Block -> String #

showList :: [Block] -> ShowS #

Eq Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

(==) :: Block -> Block -> Bool #

(/=) :: Block -> Block -> Bool #

HasFullHeader Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

blockPrevHash :: Block -> ChainHash Block #

blockInvariant :: Block -> Bool #

HasHeader Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

getHeaderFields :: Block -> HeaderFields Block #

Serialise Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

encode :: Block -> Encoding #

decode :: Decoder s Block #

encodeList :: [Block] -> Encoding #

decodeList :: Decoder s [Block] #

StandardHash Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

ShowProxy Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

showProxy :: Proxy Block -> String #

type Rep Block Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type Rep Block = D1 ('MetaData "Block" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" '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.Mock.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

Generic BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Associated Types

type Rep BlockHeader

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type Rep BlockHeader = D1 ('MetaData "BlockHeader" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" '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)))))

Methods

from :: BlockHeader -> Rep BlockHeader x #

to :: Rep BlockHeader x -> BlockHeader #

Show BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

showsPrec :: Int -> BlockHeader -> ShowS #

show :: BlockHeader -> String #

showList :: [BlockHeader] -> ShowS #

Eq BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

(==) :: BlockHeader -> BlockHeader -> Bool #

(/=) :: BlockHeader -> BlockHeader -> Bool #

HasFullHeader BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

blockPrevHash :: BlockHeader -> ChainHash BlockHeader #

blockInvariant :: BlockHeader -> Bool #

HasHeader BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

getHeaderFields :: BlockHeader -> HeaderFields BlockHeader #

Serialise BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

encode :: BlockHeader -> Encoding #

decode :: Decoder s BlockHeader #

encodeList :: [BlockHeader] -> Encoding #

decodeList :: Decoder s [BlockHeader] #

StandardHash BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

ShowProxy BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

showProxy :: Proxy BlockHeader -> String #

type Rep BlockHeader Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type Rep BlockHeader = D1 ('MetaData "BlockHeader" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" '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.Mock.ConcreteBlock

type HeaderHash BlockHeader = ConcreteHeaderHash

newtype BlockBody Source #

Constructors

BlockBody ByteString

Instances

Instances details

IsString BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

fromString :: String -> BlockBody #

Generic BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Associated Types

type Rep BlockBody
Instance details Defined in Ouroboros.Network.Mock.ConcreteBlock type Rep BlockBody = D1 ('MetaData "BlockBody" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" 'True) (C1 ('MetaCons "BlockBody" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

Methods

from :: BlockBody -> Rep BlockBody x #

to :: Rep BlockBody x -> BlockBody #

Show BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

showsPrec :: Int -> BlockBody -> ShowS #

show :: BlockBody -> String #

showList :: [BlockBody] -> ShowS #

Eq BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

(==) :: BlockBody -> BlockBody -> Bool #

(/=) :: BlockBody -> BlockBody -> Bool #

Ord BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

compare :: BlockBody -> BlockBody -> Ordering #

(<) :: BlockBody -> BlockBody -> Bool #

(<=) :: BlockBody -> BlockBody -> Bool #

(>) :: BlockBody -> BlockBody -> Bool #

(>=) :: BlockBody -> BlockBody -> Bool #

max :: BlockBody -> BlockBody -> BlockBody #

min :: BlockBody -> BlockBody -> BlockBody #

Hashable BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

hashWithSalt :: Int -> BlockBody -> Int #

hash :: BlockBody -> Int #

Serialise BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

encode :: BlockBody -> Encoding #

decode :: Decoder s BlockBody #

encodeList :: [BlockBody] -> Encoding #

decodeList :: Decoder s [BlockBody] #

type Rep BlockBody Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type Rep BlockBody = D1 ('MetaData "BlockBody" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" '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

Generic BodyHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Associated Types

type Rep BodyHash
Instance details Defined in Ouroboros.Network.Mock.ConcreteBlock type Rep BodyHash = D1 ('MetaData "BodyHash" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" 'True) (C1 ('MetaCons "BodyHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: BodyHash -> Rep BodyHash x #

to :: Rep BodyHash x -> BodyHash #

Show BodyHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

showsPrec :: Int -> BodyHash -> ShowS #

show :: BodyHash -> String #

showList :: [BodyHash] -> ShowS #

Eq BodyHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

(==) :: BodyHash -> BodyHash -> Bool #

(/=) :: BodyHash -> BodyHash -> Bool #

Ord BodyHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

compare :: BodyHash -> BodyHash -> Ordering #

(<) :: BodyHash -> BodyHash -> Bool #

(<=) :: BodyHash -> BodyHash -> Bool #

(>) :: BodyHash -> BodyHash -> Bool #

(>=) :: BodyHash -> BodyHash -> Bool #

max :: BodyHash -> BodyHash -> BodyHash #

min :: BodyHash -> BodyHash -> BodyHash #

Hashable BodyHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

hashWithSalt :: Int -> BodyHash -> Int #

hash :: BodyHash -> Int #

Serialise BodyHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

encode :: BodyHash -> Encoding #

decode :: Decoder s BodyHash #

encodeList :: [BodyHash] -> Encoding #

decodeList :: Decoder s [BodyHash] #

type Rep BodyHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type Rep BodyHash = D1 ('MetaData "BodyHash" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" '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

Generic ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Associated Types

type Rep ConcreteHeaderHash
Instance details Defined in Ouroboros.Network.Mock.ConcreteBlock type Rep ConcreteHeaderHash = D1 ('MetaData "ConcreteHeaderHash" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" 'True) (C1 ('MetaCons "HeaderHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

Methods

from :: ConcreteHeaderHash -> Rep ConcreteHeaderHash x #

to :: Rep ConcreteHeaderHash x -> ConcreteHeaderHash #

Show ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

showsPrec :: Int -> ConcreteHeaderHash -> ShowS #

show :: ConcreteHeaderHash -> String #

showList :: [ConcreteHeaderHash] -> ShowS #

Eq ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

(==) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool #

(/=) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool #

Ord ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

compare :: ConcreteHeaderHash -> ConcreteHeaderHash -> Ordering #

(<) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool #

(<=) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool #

(>) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool #

(>=) :: ConcreteHeaderHash -> ConcreteHeaderHash -> Bool #

max :: ConcreteHeaderHash -> ConcreteHeaderHash -> ConcreteHeaderHash #

min :: ConcreteHeaderHash -> ConcreteHeaderHash -> ConcreteHeaderHash #

Hashable ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

hashWithSalt :: Int -> ConcreteHeaderHash -> Int #

hash :: ConcreteHeaderHash -> Int #

NoThunks ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

noThunks :: Context -> ConcreteHeaderHash -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> ConcreteHeaderHash -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy ConcreteHeaderHash -> String #

Serialise ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

encode :: ConcreteHeaderHash -> Encoding #

decode :: Decoder s ConcreteHeaderHash #

encodeList :: [ConcreteHeaderHash] -> Encoding #

decodeList :: Decoder s [ConcreteHeaderHash] #

type Rep ConcreteHeaderHash Source #

Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type Rep ConcreteHeaderHash = D1 ('MetaData "ConcreteHeaderHash" "Ouroboros.Network.Mock.ConcreteBlock" "ouroboros-network-mock-0.1.1.2-inplace" '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 BlockNo Source #
Instance details Methods hashWithSalt :: Int -> BlockNo -> Int # hash :: BlockNo -> Int #
Hashable SlotNo Source #
Instance details Methods hashWithSalt :: Int -> SlotNo -> Int # hash :: SlotNo -> Int #
(StandardHash b, 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 # hash :: ChainHash b -> Int #