Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.MockChain.Chain

Contents

Chain type and fundamental operations
- Block re-exports
Point type
Chain construction and inspection
Special operations
Conversion to/from AnchoredFragment
Helper functions

Description

Reference implementation of a representation of a block chain

Synopsis

data Chain block
- = Genesis
- | ( Chain block) :> block
valid :: HasFullHeader block => Chain block -> Bool
validExtension :: ( HasCallStack , HasFullHeader block) => Chain block -> block -> Bool
foldChain :: (a -> b -> a) -> a -> Chain b -> a
chainToList :: Chain block -> [block]
class ( StandardHash b, Typeable b) => HasHeader b where
- getHeaderFields :: b -> HeaderFields b
type family HeaderHash b :: Type
newtype Point block = Point {
- getPoint :: WithOrigin ( Block SlotNo ( HeaderHash block))
}
blockPoint :: HasHeader block => block -> Point block
genesis :: Chain b
headPoint :: HasHeader block => Chain block -> Point block
headSlot :: HasHeader block => Chain block -> WithOrigin SlotNo
headHash :: HasHeader block => Chain block -> ChainHash block
headTip :: HasHeader block => Chain block -> Tip block
headBlockNo :: HasHeader block => Chain block -> WithOrigin BlockNo
headAnchor :: HasHeader block => Chain block -> Anchor block
head :: Chain b -> Maybe b
toNewestFirst :: Chain block -> [block]
toOldestFirst :: Chain block -> [block]
fromNewestFirst :: HasHeader block => [block] -> Chain block
fromOldestFirst :: HasHeader block => [block] -> Chain block
drop :: Int -> Chain block -> Chain block
length :: Chain block -> Int
null :: Chain block -> Bool
data ChainUpdate block a
- = AddBlock a
- | RollBack ( Point block)
addBlock :: HasHeader block => block -> Chain block -> Chain block
rollback :: HasHeader block => Point block -> Chain block -> Maybe ( Chain block)
applyChainUpdate :: HasHeader block => ChainUpdate block block -> Chain block -> Maybe ( Chain block)
applyChainUpdates :: HasHeader block => [ ChainUpdate block block] -> Chain block -> Maybe ( Chain block)
pointOnChain :: HasHeader block => Point block -> Chain block -> Bool
pointIsAfter :: HasHeader block => Point block -> Point block -> Chain block -> Bool
successorBlock :: HasHeader block => Point block -> Chain block -> Maybe block
selectChain :: HasHeader block => Chain block -> Chain block -> Chain block
selectPoints :: HasHeader block => [ Int ] -> Chain block -> [ Point block]
findBlock :: (block -> Bool ) -> Chain block -> Maybe block
selectBlockRange :: HasHeader block => Chain block -> Point block -> Point block -> Maybe [block]
findFirstPoint :: HasHeader block => [ Point block] -> Chain block -> Maybe ( Point block)
intersectChains :: HasHeader block => Chain block -> Chain block -> Maybe ( Point block)
isPrefixOf :: Eq block => Chain block -> Chain block -> Bool
fromAnchoredFragment :: HasHeader block => AnchoredFragment block -> Maybe ( Chain block)
toAnchoredFragment :: HasHeader block => Chain block -> AnchoredFragment block
prettyPrintChain :: String -> (block -> String ) -> Chain block -> String

Chain type and fundamental operations

data Chain block Source #

Constructors

Genesis
( Chain block) :> block infixl 5

Instances

Instances details

Functor Chain Source #
Instance details Defined in Ouroboros.Network.MockChain.Chain Methods fmap :: (a -> b) -> Chain a -> Chain b Source # (<$) :: a -> Chain b -> Chain a Source #
Eq block => Eq ( Chain block) Source #
Instance details Defined in Ouroboros.Network.MockChain.Chain Methods (==) :: Chain block -> Chain block -> Bool Source # (/=) :: Chain block -> Chain block -> Bool Source #
Ord block => Ord ( Chain block) Source #
Instance details Defined in Ouroboros.Network.MockChain.Chain Methods compare :: Chain block -> Chain block -> Ordering Source # (<) :: Chain block -> Chain block -> Bool Source # (<=) :: Chain block -> Chain block -> Bool Source # (>) :: Chain block -> Chain block -> Bool Source # (>=) :: Chain block -> Chain block -> Bool Source # max :: Chain block -> Chain block -> Chain block Source # min :: Chain block -> Chain block -> Chain block Source #
Show block => Show ( Chain block) Source #
Instance details Defined in Ouroboros.Network.MockChain.Chain Methods showsPrec :: Int -> Chain block -> ShowS Source # show :: Chain block -> String Source # showList :: [ Chain block] -> ShowS Source #
Serialise block => Serialise ( Chain block) Source #
Instance details Defined in Ouroboros.Network.MockChain.Chain Methods encode :: Chain block -> Encoding Source # decode :: Decoder s ( Chain block) Source # encodeList :: [ Chain block] -> Encoding Source # decodeList :: Decoder s [ Chain block] Source #

valid :: HasFullHeader block => Chain block -> Bool Source #

validExtension :: ( HasCallStack , HasFullHeader block) => Chain block -> block -> Bool Source #

foldChain :: (a -> b -> a) -> a -> Chain b -> a Source #

chainToList :: Chain block -> [block] Source #

Make a list from a Chain , in newest-to-oldest order.

Block re-exports

class ( StandardHash b, Typeable b) => HasHeader b where Source #

Abstract over the shape of blocks (or indeed just block headers)

Methods

getHeaderFields :: b -> HeaderFields b Source #

Instances

Instances details

HasHeader BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods getHeaderFields :: BlockHeader -> HeaderFields BlockHeader Source #
HasHeader Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock Methods getHeaderFields :: Block -> HeaderFields Block Source #
( StandardHash b, Typeable b) => HasHeader ( HeaderFields b) Source #
Instance details Defined in Ouroboros.Network.Block Methods getHeaderFields :: HeaderFields b -> HeaderFields ( HeaderFields b) Source #

type family HeaderHash b :: Type Source #

Header hash

Instances

Instances details

type HeaderHash BlockHeader Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type HeaderHash BlockHeader = ConcreteHeaderHash
type HeaderHash Block Source #
Instance details Defined in Ouroboros.Network.Testing.ConcreteBlock type HeaderHash Block = ConcreteHeaderHash
type HeaderHash ( Serialised block) Source #
Instance details Defined in Ouroboros.Network.Block type HeaderHash ( Serialised block) = HeaderHash block
type HeaderHash ( HeaderFields b) Source #
Instance details Defined in Ouroboros.Network.Block type HeaderHash ( HeaderFields b) = HeaderHash b

Point type

newtype Point block Source #

A point on the chain is identified by its Slot and HeaderHash .

The Slot tells us where to look and the HeaderHash either simply serves as a check, or in some contexts it disambiguates blocks from different forks that were in the same slot.

It's a newtype rather than a type synonym, because using a type synonym would lead to ambiguity, since HeaderHash is a non-injective type family.

Constructors

Point
Fields getPoint :: WithOrigin ( Block SlotNo ( HeaderHash block))

Instances

Instances details

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

blockPoint :: HasHeader block => block -> Point block Source #

Chain construction and inspection

Genesis

genesis :: Chain b Source #

Head inspection

headPoint :: HasHeader block => Chain block -> Point block Source #

headSlot :: HasHeader block => Chain block -> WithOrigin SlotNo Source #

headHash :: HasHeader block => Chain block -> ChainHash block Source #

headTip :: HasHeader block => Chain block -> Tip block Source #

headBlockNo :: HasHeader block => Chain block -> WithOrigin BlockNo Source #

headAnchor :: HasHeader block => Chain block -> Anchor block Source #

Basic operations

head :: Chain b -> Maybe b Source #

toNewestFirst :: Chain block -> [block] Source #

Produce the list of blocks, from most recent back to genesis

toOldestFirst :: Chain block -> [block] Source #

Produce the list of blocks, from genesis to the most recent

fromNewestFirst :: HasHeader block => [block] -> Chain block Source #

Make a chain from a list of blocks. The head of the list is the head of the chain.

fromOldestFirst :: HasHeader block => [block] -> Chain block Source #

Construct chain from list of blocks from oldest to newest

drop :: Int -> Chain block -> Chain block Source #

length :: Chain block -> Int Source #

null :: Chain block -> Bool Source #

Update type and operations

data ChainUpdate block 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.

Constructors

AddBlock a
RollBack ( Point block)

Instances

Instances details

Functor ( ChainUpdate block) Source #
Instance details Defined in Ouroboros.Network.Block Methods fmap :: (a -> b) -> ChainUpdate block a -> ChainUpdate block b Source # (<$) :: a -> ChainUpdate block b -> ChainUpdate block a Source #
Foldable ( ChainUpdate block) Source #
Instance details Defined in Ouroboros.Network.Block Methods fold :: Monoid m => ChainUpdate block m -> m Source # foldMap :: Monoid m => (a -> m) -> ChainUpdate block a -> m Source # foldMap' :: Monoid m => (a -> m) -> ChainUpdate block a -> m Source # foldr :: (a -> b -> b) -> b -> ChainUpdate block a -> b Source # foldr' :: (a -> b -> b) -> b -> ChainUpdate block a -> b Source # foldl :: (b -> a -> b) -> b -> ChainUpdate block a -> b Source # foldl' :: (b -> a -> b) -> b -> ChainUpdate block a -> b Source # foldr1 :: (a -> a -> a) -> ChainUpdate block a -> a Source # foldl1 :: (a -> a -> a) -> ChainUpdate block a -> a Source # toList :: ChainUpdate block a -> [a] Source # null :: ChainUpdate block a -> Bool Source # length :: ChainUpdate block a -> Int Source # elem :: Eq a => a -> ChainUpdate block a -> Bool Source # maximum :: Ord a => ChainUpdate block a -> a Source # minimum :: Ord a => ChainUpdate block a -> a Source # sum :: Num a => ChainUpdate block a -> a Source # product :: Num a => ChainUpdate block a -> a Source #
Traversable ( ChainUpdate block) Source #
Instance details Defined in Ouroboros.Network.Block Methods traverse :: Applicative f => (a -> f b) -> ChainUpdate block a -> f ( ChainUpdate block b) Source # sequenceA :: Applicative f => ChainUpdate block (f a) -> f ( ChainUpdate block a) Source # mapM :: Monad m => (a -> m b) -> ChainUpdate block a -> m ( ChainUpdate block b) Source # sequence :: Monad m => ChainUpdate block (m a) -> m ( ChainUpdate block a) Source #
( StandardHash block, Eq a) => Eq ( ChainUpdate block a) Source #
Instance details Defined in Ouroboros.Network.Block Methods (==) :: ChainUpdate block a -> ChainUpdate block a -> Bool Source # (/=) :: ChainUpdate block a -> ChainUpdate block a -> Bool Source #
( StandardHash block, Show a) => Show ( ChainUpdate block a) Source #
Instance details Defined in Ouroboros.Network.Block Methods showsPrec :: Int -> ChainUpdate block a -> ShowS Source # show :: ChainUpdate block a -> String Source # showList :: [ ChainUpdate block a] -> ShowS Source #

addBlock :: HasHeader block => block -> Chain block -> Chain block Source #

rollback :: HasHeader block => Point block -> Chain block -> Maybe ( Chain block) Source #

applyChainUpdate :: HasHeader block => ChainUpdate block block -> Chain block -> Maybe ( Chain block) Source #

applyChainUpdates :: HasHeader block => [ ChainUpdate block block] -> Chain block -> Maybe ( Chain block) Source #

Special operations

pointOnChain :: HasHeader block => Point block -> Chain block -> Bool Source #

pointIsAfter :: HasHeader block => Point block -> Point block -> Chain block -> Bool Source #

Check whether the first point is after the second point on the chain. Usually, this can simply be checked using the SlotNo s, but some blocks may have the same SlotNo .

When the first point equals the second point, the answer will be False .

PRECONDITION: both points are on the chain.

successorBlock :: HasHeader block => Point block -> Chain block -> Maybe block Source #

selectChain :: HasHeader block => Chain block -> Chain block -> Chain block Source #

selectPoints :: HasHeader block => [ Int ] -> Chain block -> [ Point block] Source #

Select a bunch of Point s based on offsets from the head of the chain. This is used in the chain consumer protocol as part of finding the intersection between a local and remote chain.

The typical pattern is to use a selection of offsets covering the last K blocks, biased towards more recent blocks. For example:

selectPoints (0 : [ fib n | n <- [1 .. 17] ])

findBlock :: (block -> Bool ) -> Chain block -> Maybe block Source #

selectBlockRange :: HasHeader block => Chain block -> Point block -> Point block -> Maybe [block] Source #

findFirstPoint :: HasHeader block => [ Point block] -> Chain block -> Maybe ( Point block) Source #

intersectChains :: HasHeader block => Chain block -> Chain block -> Maybe ( Point block) Source #

isPrefixOf :: Eq block => Chain block -> Chain block -> Bool Source #

Conversion to/from AnchoredFragment

fromAnchoredFragment :: HasHeader block => AnchoredFragment block -> Maybe ( Chain block) Source #

Convert an AnchoredFragment to a Chain .

The anchor of the fragment must be genesisPoint , otherwise Nothing is returned.

toAnchoredFragment :: HasHeader block => Chain block -> AnchoredFragment block Source #

Convert a Chain to an AnchoredFragment .

The anchor of the fragment will be genesisPoint .

Helper functions

prettyPrintChain :: String -> (block -> String ) -> Chain block -> String Source #