| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Test.Consensus.BlockTree
Synopsis
- data BlockTree blk = BlockTree {
- btTrunk ∷ AnchoredFragment blk
- btBranches ∷ [BlockTreeBranch blk]
- data BlockTreeBranch blk = BlockTreeBranch {
- btbPrefix ∷ AnchoredFragment blk
- btbSuffix ∷ AnchoredFragment blk
- btbTrunkSuffix ∷ AnchoredFragment blk
- btbFull ∷ AnchoredFragment blk
- newtype PathAnchoredAtSource = PathAnchoredAtSource Bool
- addBranch ∷ HasHeader blk ⇒ AnchoredFragment blk → BlockTree blk → Maybe (BlockTree blk)
- addBranch' ∷ HasHeader blk ⇒ AnchoredFragment blk → BlockTree blk → BlockTree blk
- allFragments ∷ BlockTree blk → [AnchoredFragment blk]
- findFragment ∷ HasHeader blk ⇒ Point blk → BlockTree blk → Maybe (AnchoredFragment blk)
- findPath ∷ HasHeader blk ⇒ Point blk → Point blk → BlockTree blk → Maybe (PathAnchoredAtSource, AnchoredFragment blk)
- mkTrunk ∷ AnchoredFragment blk → BlockTree blk
- prettyBlockTree ∷ HasHeader blk ⇒ BlockTree blk → [String]
Documentation
Represent a block tree with a main trunk and branches leaving from the trunk in question. All the branches are represented by their prefix to and suffix from the intersection point.
INVARIANT: The branches' prefixes share the same anchor as the trunk and are fully contained in the trunk.
INVARIANT: The branches' suffixes are anchored in the trunk and do not contain any blocks in common with the trunk.
INVARIANT: The branches' suffixes do not contain any block in common with one another.
INVARIANT: for all BlockTreeBranch{..} in the tree, btTrunk == fromJust $
AF.join btbPrefix btbTrunkSuffix.
REVIEW: Find another name so as not to clash with BlockTree from
`unstable-consensus-testlibTestUtil/TestBlock.hs`.
Constructors
| BlockTree | |
Fields
| |
data BlockTreeBranch blk Source #
Represent a branch of a block tree by a prefix and a suffix. The full fragment (the prefix and suffix catenated) and the trunk suffix (the rest of the trunk after the branch forks off) are provided for practicality.
INVARIANT: the head of btbPrefix is the anchor of btbSuffix.
INVARIANT: btbFull == fromJust $ AF.join btbPrefix btbSuffix.
Constructors
| BlockTreeBranch | |
Fields
| |
Instances
| (StandardHash blk, Show blk) ⇒ Show (BlockTreeBranch blk) Source # | |
Defined in Test.Consensus.BlockTree Methods showsPrec ∷ Int → BlockTreeBranch blk → ShowS # show ∷ BlockTreeBranch blk → String # showList ∷ [BlockTreeBranch blk] → ShowS # | |
addBranch ∷ HasHeader blk ⇒ AnchoredFragment blk → BlockTree blk → Maybe (BlockTree blk) Source #
Add a branch to an existing block tree.
PRECONDITION: The given fragment intersects with the trunk or its anchor.
FIXME: we should enforce that the branch's prefix shares the same anchor as the trunk.
FIXME: we should enforce that the new branch' suffix does not contain any block in common with an existing branch.
addBranch' ∷ HasHeader blk ⇒ AnchoredFragment blk → BlockTree blk → BlockTree blk Source #
Same as addBranch but assumes that the precondition holds.
allFragments ∷ BlockTree blk → [AnchoredFragment blk] Source #
Return all the full fragments from the root of the tree.
findFragment ∷ HasHeader blk ⇒ Point blk → BlockTree blk → Maybe (AnchoredFragment blk) Source #
Look for a point in the block tree and return a fragment going from the root of the tree to the point in question.
findPath ∷ HasHeader blk ⇒ Point blk → Point blk → BlockTree blk → Maybe (PathAnchoredAtSource, AnchoredFragment blk) Source #
findPath source target blockTree finds a path from the source point to
the target point in the blockTree and returns it as an anchored fragment
It returns Nothing when either of source are target are not in the
BlockTree. There are two interesting properties on this fragment:
- Whether the returned fragment is anchored at the
source. - Whether the returned fragment is empty.
Together, those two properties form four interesting cases:
a. If the fragment is anchored at the source and is empty, then source
== target.
b. If the fragment is anchored at the source and is not empty, then
source is an ancestor of target and the fragment contains all the
blocks between them, target included.
c. If the fragment is not anchored at the source and is empty, then
target is an ancestor of source.
d. If the fragment is not anchored at the source and is not empty, then
it is anchored at the youngest common ancestor of both source and
target and contains all the blocks between that ancestor and target.
mkTrunk ∷ AnchoredFragment blk → BlockTree blk Source #
Make a block tree made of only a trunk.