ouroboros-consensus-0.27.0.0: Consensus layer for the Ouroboros blockchain protocol
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Storage.Common

Synopsis

Indexing

tipIsGenesis ∷ WithOrigin r → Bool Source #

PrefixLen

newtype PrefixLen Source #

Number of bytes from the start of a block needed to reconstruct the nested context.

See reconstructPrefixLen.

Constructors

PrefixLen 

Fields

Instances

Instances details
Generic PrefixLen Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Associated Types

type Rep PrefixLen 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep PrefixLen = D1 ('MetaData "PrefixLen" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'True) (C1 ('MetaCons "PrefixLen" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPrefixLen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

Methods

from ∷ PrefixLen → Rep PrefixLen x #

to ∷ Rep PrefixLen x → PrefixLen #

Show PrefixLen Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

showsPrec ∷ Int → PrefixLen → ShowS #

show ∷ PrefixLen → String #

showList ∷ [PrefixLen] → ShowS #

Eq PrefixLen Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

(==) ∷ PrefixLen → PrefixLen → Bool #

(/=) ∷ PrefixLen → PrefixLen → Bool #

Ord PrefixLen Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

compare ∷ PrefixLen → PrefixLen → Ordering #

(<) ∷ PrefixLen → PrefixLen → Bool #

(<=) ∷ PrefixLen → PrefixLen → Bool #

(>) ∷ PrefixLen → PrefixLen → Bool #

(>=) ∷ PrefixLen → PrefixLen → Bool #

max ∷ PrefixLen → PrefixLen → PrefixLen #

min ∷ PrefixLen → PrefixLen → PrefixLen #

NoThunks PrefixLen Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

noThunks ∷ Context → PrefixLen → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PrefixLen → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy PrefixLen → String Source #

type Rep PrefixLen Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep PrefixLen = D1 ('MetaData "PrefixLen" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'True) (C1 ('MetaCons "PrefixLen" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPrefixLen") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word8)))

addPrefixLen ∷ Word8 → PrefixLen → PrefixLen Source #

takePrefix ∷ PrefixLen → ByteString → ShortByteString Source #

BinaryBlockInfo

data BinaryBlockInfo Source #

Information about the serialised block.

Constructors

BinaryBlockInfo 

Fields

  • headerOffset ∷ !Word16

    The offset within the serialised block at which the header starts.

  • headerSize ∷ !Word16

    How many bytes the header is long. Extracting the headerSize bytes from serialised block starting from headerOffset should yield the header. Before passing the extracted bytes to the decoder for headers, an envelope can be around using nodeAddHeaderEnvelope.

Instances

Instances details
Generic BinaryBlockInfo Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Associated Types

type Rep BinaryBlockInfo 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep BinaryBlockInfo = D1 ('MetaData "BinaryBlockInfo" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'False) (C1 ('MetaCons "BinaryBlockInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerOffset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16) :*: S1 ('MetaSel ('Just "headerSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16)))

Methods

from ∷ BinaryBlockInfo → Rep BinaryBlockInfo x #

to ∷ Rep BinaryBlockInfo x → BinaryBlockInfo #

Show BinaryBlockInfo Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

showsPrec ∷ Int → BinaryBlockInfo → ShowS #

show ∷ BinaryBlockInfo → String #

showList ∷ [BinaryBlockInfo] → ShowS #

Eq BinaryBlockInfo Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

(==) ∷ BinaryBlockInfo → BinaryBlockInfo → Bool #

(/=) ∷ BinaryBlockInfo → BinaryBlockInfo → Bool #

type Rep BinaryBlockInfo Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep BinaryBlockInfo = D1 ('MetaData "BinaryBlockInfo" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'False) (C1 ('MetaCons "BinaryBlockInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerOffset") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16) :*: S1 ('MetaSel ('Just "headerSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word16)))

extractHeader ∷ BinaryBlockInfo → ByteString → ByteString Source #

Extract the header from the given ByteString using the BinaryBlockInfo.

Iterator bounds

data StreamFrom blk Source #

The lower bound for an iterator

Hint: use StreamFromExclusive genesisPoint to start streaming from Genesis.

Constructors

StreamFromInclusive !(RealPoint blk) 
StreamFromExclusive !(Point blk) 

Instances

Instances details
Generic (StreamFrom blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Associated Types

type Rep (StreamFrom blk) 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep (StreamFrom blk) = D1 ('MetaData "StreamFrom" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'False) (C1 ('MetaCons "StreamFromInclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "StreamFromExclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Point blk))))

Methods

from ∷ StreamFrom blk → Rep (StreamFrom blk) x #

to ∷ Rep (StreamFrom blk) x → StreamFrom blk #

StandardHash blk ⇒ Show (StreamFrom blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

showsPrec ∷ Int → StreamFrom blk → ShowS #

show ∷ StreamFrom blk → String #

showList ∷ [StreamFrom blk] → ShowS #

StandardHash blk ⇒ Eq (StreamFrom blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

(==) ∷ StreamFrom blk → StreamFrom blk → Bool #

(/=) ∷ StreamFrom blk → StreamFrom blk → Bool #

(StandardHash blk, Typeable blk) ⇒ NoThunks (StreamFrom blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

noThunks ∷ Context → StreamFrom blk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → StreamFrom blk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (StreamFrom blk) → String Source #

type Rep (StreamFrom blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep (StreamFrom blk) = D1 ('MetaData "StreamFrom" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'False) (C1 ('MetaCons "StreamFromInclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "StreamFromExclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Point blk))))

newtype StreamTo blk Source #

Constructors

StreamToInclusive (RealPoint blk) 

Instances

Instances details
Generic (StreamTo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Associated Types

type Rep (StreamTo blk) 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep (StreamTo blk) = D1 ('MetaData "StreamTo" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'True) (C1 ('MetaCons "StreamToInclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))))

Methods

from ∷ StreamTo blk → Rep (StreamTo blk) x #

to ∷ Rep (StreamTo blk) x → StreamTo blk #

StandardHash blk ⇒ Show (StreamTo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

showsPrec ∷ Int → StreamTo blk → ShowS #

show ∷ StreamTo blk → String #

showList ∷ [StreamTo blk] → ShowS #

StandardHash blk ⇒ Eq (StreamTo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

(==) ∷ StreamTo blk → StreamTo blk → Bool #

(/=) ∷ StreamTo blk → StreamTo blk → Bool #

(StandardHash blk, Typeable blk) ⇒ NoThunks (StreamTo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

noThunks ∷ Context → StreamTo blk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → StreamTo blk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (StreamTo blk) → String Source #

type Rep (StreamTo blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

type Rep (StreamTo blk) = D1 ('MetaData "StreamTo" "Ouroboros.Consensus.Storage.Common" "ouroboros-consensus-0.27.0.0-inplace" 'True) (C1 ('MetaCons "StreamToInclusive" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))))

validBounds ∷ StandardHash blk ⇒ StreamFrom blk → StreamTo blk → Bool Source #

Check whether the bounds make sense

An example of bounds that don't make sense:

StreamFromExclusive (BlockPoint 3 ..)
StreamToInclusive   (RealPoint  3 ..)

This function does not check whether the bounds correspond to existing blocks.

BlockComponent

data BlockComponent blk a where Source #

Which component of the block to read from a database: the whole block, its header, its hash, the block size, ..., or combinations thereof.

NOTE: when requesting multiple components, we will not optimise/cache them.

Constructors

GetVerifiedBlock ∷ ∀ blk. BlockComponent blk blk

Verify the integrity of the block by checking its signature and/or hashes. The interpreter should throw an exception when the block does not pass the check.

GetBlock ∷ ∀ blk. BlockComponent blk blk 
GetRawBlock ∷ ∀ blk. BlockComponent blk ByteString 
GetHeader ∷ ∀ blk. BlockComponent blk (Header blk) 
GetRawHeader ∷ ∀ blk. BlockComponent blk ByteString 
GetHash ∷ ∀ blk. BlockComponent blk (HeaderHash blk) 
GetSlot ∷ ∀ blk. BlockComponent blk SlotNo 
GetIsEBB ∷ ∀ blk. BlockComponent blk IsEBB 
GetBlockSize ∷ ∀ blk. BlockComponent blk SizeInBytes 
GetHeaderSize ∷ ∀ blk. BlockComponent blk Word16 
GetNestedCtxt ∷ ∀ blk. BlockComponent blk (SomeSecond (NestedCtxt Header) blk) 
GetPure ∷ ∀ a blk. a → BlockComponent blk a 
GetApply ∷ ∀ blk a1 a. BlockComponent blk (a1 → a) → BlockComponent blk a1 → BlockComponent blk a 

Instances

Instances details
Applicative (BlockComponent blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

pure ∷ a → BlockComponent blk a #

(<*>) ∷ BlockComponent blk (a → b) → BlockComponent blk a → BlockComponent blk b #

liftA2 ∷ (a → b → c) → BlockComponent blk a → BlockComponent blk b → BlockComponent blk c #

(*>) ∷ BlockComponent blk a → BlockComponent blk b → BlockComponent blk b #

(<*) ∷ BlockComponent blk a → BlockComponent blk b → BlockComponent blk a #

Functor (BlockComponent blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Common

Methods

fmap ∷ (a → b) → BlockComponent blk a → BlockComponent blk b #

(<$) ∷ a → BlockComponent blk b → BlockComponent blk a #

Re-exports

data SizeInBytes Source #

Instances

Instances details
NFData SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

rnf ∷ SizeInBytes → () #

Monoid SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

mempty ∷ SizeInBytes #

mappend ∷ SizeInBytes → SizeInBytes → SizeInBytes #

mconcat ∷ [SizeInBytes] → SizeInBytes #

Semigroup SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

(<>) ∷ SizeInBytes → SizeInBytes → SizeInBytes #

sconcat ∷ NonEmpty SizeInBytes → SizeInBytes #

stimes ∷ Integral b ⇒ b → SizeInBytes → SizeInBytes #

Enum SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

succ ∷ SizeInBytes → SizeInBytes #

pred ∷ SizeInBytes → SizeInBytes #

toEnum ∷ Int → SizeInBytes #

fromEnum ∷ SizeInBytes → Int #

enumFrom ∷ SizeInBytes → [SizeInBytes] #

enumFromThen ∷ SizeInBytes → SizeInBytes → [SizeInBytes] #

enumFromTo ∷ SizeInBytes → SizeInBytes → [SizeInBytes] #

enumFromThenTo ∷ SizeInBytes → SizeInBytes → SizeInBytes → [SizeInBytes] #

Generic SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Associated Types

type Rep SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

type Rep SizeInBytes = D1 ('MetaData "SizeInBytes" "Ouroboros.Network.SizeInBytes" "ouroboros-network-api-0.14.0.0-69dbac5e0532eb6364ae721ab096f98fcd95bd03c7a08c58ce8ab2287362a381" 'True) (C1 ('MetaCons "SizeInBytes" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

Methods

from ∷ SizeInBytes → Rep SizeInBytes x #

to ∷ Rep SizeInBytes x → SizeInBytes #

Num SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

(+) ∷ SizeInBytes → SizeInBytes → SizeInBytes #

(-) ∷ SizeInBytes → SizeInBytes → SizeInBytes #

(*) ∷ SizeInBytes → SizeInBytes → SizeInBytes #

negate ∷ SizeInBytes → SizeInBytes #

abs ∷ SizeInBytes → SizeInBytes #

signum ∷ SizeInBytes → SizeInBytes #

fromInteger ∷ Integer → SizeInBytes #

Integral SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

quot ∷ SizeInBytes → SizeInBytes → SizeInBytes #

rem ∷ SizeInBytes → SizeInBytes → SizeInBytes #

div ∷ SizeInBytes → SizeInBytes → SizeInBytes #

mod ∷ SizeInBytes → SizeInBytes → SizeInBytes #

quotRem ∷ SizeInBytes → SizeInBytes → (SizeInBytes, SizeInBytes) #

divMod ∷ SizeInBytes → SizeInBytes → (SizeInBytes, SizeInBytes) #

toInteger ∷ SizeInBytes → Integer #

Real SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

toRational ∷ SizeInBytes → Rational #

Show SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

showsPrec ∷ Int → SizeInBytes → ShowS #

show ∷ SizeInBytes → String #

showList ∷ [SizeInBytes] → ShowS #

Eq SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

(==) ∷ SizeInBytes → SizeInBytes → Bool #

(/=) ∷ SizeInBytes → SizeInBytes → Bool #

Ord SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

compare ∷ SizeInBytes → SizeInBytes → Ordering #

(<) ∷ SizeInBytes → SizeInBytes → Bool #

(<=) ∷ SizeInBytes → SizeInBytes → Bool #

(>) ∷ SizeInBytes → SizeInBytes → Bool #

(>=) ∷ SizeInBytes → SizeInBytes → Bool #

max ∷ SizeInBytes → SizeInBytes → SizeInBytes #

min ∷ SizeInBytes → SizeInBytes → SizeInBytes #

BoundedMeasure SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

maxBound ∷ SizeInBytes Source #

Measure SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

zero ∷ SizeInBytes Source #

plus ∷ SizeInBytes → SizeInBytes → SizeInBytes Source #

min ∷ SizeInBytes → SizeInBytes → SizeInBytes Source #

max ∷ SizeInBytes → SizeInBytes → SizeInBytes Source #

NoThunks SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

Methods

noThunks ∷ Context → SizeInBytes → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → SizeInBytes → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy SizeInBytes → String Source #

type Rep SizeInBytes 
Instance details

Defined in Ouroboros.Network.SizeInBytes

type Rep SizeInBytes = D1 ('MetaData "SizeInBytes" "Ouroboros.Network.SizeInBytes" "ouroboros-network-api-0.14.0.0-69dbac5e0532eb6364ae721ab096f98fcd95bd03c7a08c58ce8ab2287362a381" 'True) (C1 ('MetaCons "SizeInBytes" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSizeInBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))