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

Ouroboros.Consensus.Block.Abstract

Synopsis

Protocol

type family BlockProtocol blk Source #

Map block to consensus protocol

Instances

Instances details
type BlockProtocol (Header blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

type BlockProtocol (Header blk) = BlockProtocol blk
type BlockProtocol (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

type BlockProtocol (HardForkBlock xs) = HardForkProtocol xs
type BlockProtocol (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

type BlockProtocol (DualBlock m a) = BlockProtocol m

Configuration

data family BlockConfig blk Source #

Static configuration required to work with this type of blocks

Instances

Instances details
Isomorphic BlockConfig Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ BlockConfig (HardForkBlock '[blk]) → BlockConfig blk Source #

inject ∷ NoHardForks blk ⇒ BlockConfig blk → BlockConfig (HardForkBlock '[blk]) Source #

CanHardFork xs ⇒ NoThunks (BlockConfig (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

noThunks ∷ Context → BlockConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → BlockConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (BlockConfig (HardForkBlock xs)) → String Source #

NoThunks (BlockConfig (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

noThunks ∷ Context → BlockConfig (DualBlock m a) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → BlockConfig (DualBlock m a) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (BlockConfig (DualBlock m a)) → String Source #

newtype BlockConfig (DisableDiffusionPipelining blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.SupportsDiffusionPipelining

newtype BlockConfig (DisableDiffusionPipelining blk) = DisableDiffusionPipeliningBlockConfig (BlockConfig blk)
newtype BlockConfig (SelectViewDiffusionPipelining blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.SupportsDiffusionPipelining

newtype BlockConfig (SelectViewDiffusionPipelining blk) = SelectViewDiffusionPipeliningBlockConfig (BlockConfig blk)
newtype BlockConfig (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

newtype BlockConfig (HardForkBlock xs) = HardForkBlockConfig {}
data BlockConfig (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

data BlockConfig (DualBlock m a) = DualBlockConfig {}

data family CodecConfig blk Source #

Static configuration required for serialisation and deserialisation of types pertaining to this type of block.

Data family instead of type family to get better type inference.

Instances

Instances details
Isomorphic CodecConfig Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ CodecConfig (HardForkBlock '[blk]) → CodecConfig blk Source #

inject ∷ NoHardForks blk ⇒ CodecConfig blk → CodecConfig (HardForkBlock '[blk]) Source #

Generic (CodecConfig (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Associated Types

type Rep (CodecConfig (DualBlock m a)) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

type Rep (CodecConfig (DualBlock m a)) = D1 ('MetaData "CodecConfig" "Ouroboros.Consensus.Ledger.Dual" "ouroboros-consensus-0.25.0.0-inplace" 'False) (C1 ('MetaCons "DualCodecConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "dualCodecConfigMain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CodecConfig m)) :*: S1 ('MetaSel ('Just "dualCodecConfigAux") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CodecConfig a))))

Methods

from ∷ CodecConfig (DualBlock m a) → Rep (CodecConfig (DualBlock m a)) x #

to ∷ Rep (CodecConfig (DualBlock m a)) x → CodecConfig (DualBlock m a) #

CanHardFork xs ⇒ NoThunks (CodecConfig (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

noThunks ∷ Context → CodecConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → CodecConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (CodecConfig (HardForkBlock xs)) → String Source #

(NoThunks (CodecConfig m), NoThunks (CodecConfig a)) ⇒ NoThunks (CodecConfig (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

noThunks ∷ Context → CodecConfig (DualBlock m a) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → CodecConfig (DualBlock m a) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (CodecConfig (DualBlock m a)) → String Source #

type Rep (CodecConfig (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

type Rep (CodecConfig (DualBlock m a)) = D1 ('MetaData "CodecConfig" "Ouroboros.Consensus.Ledger.Dual" "ouroboros-consensus-0.25.0.0-inplace" 'False) (C1 ('MetaCons "DualCodecConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "dualCodecConfigMain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CodecConfig m)) :*: S1 ('MetaSel ('Just "dualCodecConfigAux") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CodecConfig a))))
newtype CodecConfig (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

newtype CodecConfig (HardForkBlock xs) = HardForkCodecConfig {}
data CodecConfig (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

data CodecConfig (DualBlock m a) = DualCodecConfig {}

data family StorageConfig blk Source #

Config needed for the NodeInitStorage class. Defined here to avoid circular dependencies.

Instances

Instances details
Isomorphic StorageConfig Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ StorageConfig (HardForkBlock '[blk]) → StorageConfig blk Source #

inject ∷ NoHardForks blk ⇒ StorageConfig blk → StorageConfig (HardForkBlock '[blk]) Source #

Generic (StorageConfig (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Associated Types

type Rep (StorageConfig (DualBlock m a)) 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

type Rep (StorageConfig (DualBlock m a)) = D1 ('MetaData "StorageConfig" "Ouroboros.Consensus.Ledger.Dual" "ouroboros-consensus-0.25.0.0-inplace" 'False) (C1 ('MetaCons "DualStorageConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "dualStorageConfigMain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StorageConfig m)) :*: S1 ('MetaSel ('Just "dualStorageConfigAux") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StorageConfig a))))

Methods

from ∷ StorageConfig (DualBlock m a) → Rep (StorageConfig (DualBlock m a)) x #

to ∷ Rep (StorageConfig (DualBlock m a)) x → StorageConfig (DualBlock m a) #

CanHardFork xs ⇒ NoThunks (StorageConfig (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

noThunks ∷ Context → StorageConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → StorageConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (StorageConfig (HardForkBlock xs)) → String Source #

(NoThunks (StorageConfig m), NoThunks (StorageConfig a)) ⇒ NoThunks (StorageConfig (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

noThunks ∷ Context → StorageConfig (DualBlock m a) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → StorageConfig (DualBlock m a) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (StorageConfig (DualBlock m a)) → String Source #

type Rep (StorageConfig (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

type Rep (StorageConfig (DualBlock m a)) = D1 ('MetaData "StorageConfig" "Ouroboros.Consensus.Ledger.Dual" "ouroboros-consensus-0.25.0.0-inplace" 'False) (C1 ('MetaCons "DualStorageConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "dualStorageConfigMain") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StorageConfig m)) :*: S1 ('MetaSel ('Just "dualStorageConfigAux") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StorageConfig a))))
newtype StorageConfig (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

newtype StorageConfig (HardForkBlock xs) = HardForkStorageConfig {}
data StorageConfig (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

data StorageConfig (DualBlock m a) = DualStorageConfig {}

Previous hash

class (HasHeader blk, GetHeader blk) ⇒ GetPrevHash blk where Source #

Methods

headerPrevHash ∷ Header blk → ChainHash blk Source #

Get the hash of the predecessor of this block

Instances

Instances details
CanHardFork xs ⇒ GetPrevHash (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

headerPrevHash ∷ Header (HardForkBlock xs) → ChainHash (HardForkBlock xs) Source #

Bridge m a ⇒ GetPrevHash (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

headerPrevHash ∷ Header (DualBlock m a) → ChainHash (DualBlock m a) Source #

blockPrevHash ∷ GetPrevHash blk ⇒ blk → ChainHash blk Source #

Working with headers

class HasHeader (Header blk) ⇒ GetHeader blk where Source #

Methods

getHeader ∷ blk → Header blk Source #

blockMatchesHeader ∷ Header blk → blk → Bool Source #

Check whether the header is the header of the block.

For example, by checking whether the hash of the body stored in the header matches that of the block.

headerIsEBB ∷ Header blk → Maybe EpochNo Source #

When the given header is the header of an Epoch Boundary Block, returns its epoch number.

Instances

Instances details
CanHardFork xs ⇒ GetHeader (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

getHeader ∷ HardForkBlock xs → Header (HardForkBlock xs) Source #

blockMatchesHeader ∷ Header (HardForkBlock xs) → HardForkBlock xs → Bool Source #

headerIsEBB ∷ Header (HardForkBlock xs) → Maybe EpochNo Source #

Bridge m a ⇒ GetHeader (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

getHeader ∷ DualBlock m a → Header (DualBlock m a) Source #

blockMatchesHeader ∷ Header (DualBlock m a) → DualBlock m a → Bool Source #

headerIsEBB ∷ Header (DualBlock m a) → Maybe EpochNo Source #

data family Header blk Source #

Instances

Instances details
Inject Header Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Nary

Methods

inject ∷ ∀ x (xs ∷ [Type]). (CanHardFork xs, HasCanonicalTxIn xs, HasHardForkTxOut xs) ⇒ InjectionIndex xs x → Header x → Header (HardForkBlock xs) Source #

Isomorphic Header Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ Header (HardForkBlock '[blk]) → Header blk Source #

inject ∷ NoHardForks blk ⇒ Header blk → Header (HardForkBlock '[blk]) Source #

CanHardFork xs ⇒ HasNestedContent Header (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

unnest ∷ Header (HardForkBlock xs) → DepPair (NestedCtxt Header (HardForkBlock xs)) Source #

nest ∷ DepPair (NestedCtxt Header (HardForkBlock xs)) → Header (HardForkBlock xs) Source #

SerialiseHFC xs ⇒ ReconstructNestedCtxt Header (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk

Methods

reconstructPrefixLen ∷ proxy (Header (HardForkBlock xs)) → PrefixLen Source #

reconstructNestedCtxt ∷ proxy (Header (HardForkBlock xs)) → ShortByteString → SizeInBytes → SomeSecond (NestedCtxt Header) (HardForkBlock xs) Source #

StandardHash blk ⇒ StandardHash (Header blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

Typeable xs ⇒ ShowProxy (Header (HardForkBlock xs) ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

showProxy ∷ Proxy (Header (HardForkBlock xs)) → String Source #

HasNestedContent Header m ⇒ HasNestedContent Header (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

unnest ∷ Header (DualBlock m a) → DepPair (NestedCtxt Header (DualBlock m a)) Source #

nest ∷ DepPair (NestedCtxt Header (DualBlock m a)) → Header (DualBlock m a) Source #

ReconstructNestedCtxt Header m ⇒ ReconstructNestedCtxt Header (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

reconstructPrefixLen ∷ proxy (Header (DualBlock m a)) → PrefixLen Source #

reconstructNestedCtxt ∷ proxy (Header (DualBlock m a)) → ShortByteString → SizeInBytes → SomeSecond (NestedCtxt Header) (DualBlock m a) Source #

CanHardFork xs ⇒ SameDepIndex (NestedCtxt_ (HardForkBlock xs) Header ∷ Type → Type) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

sameDepIndex ∷ NestedCtxt_ (HardForkBlock xs) Header a → NestedCtxt_ (HardForkBlock xs) Header b → Maybe (a :~: b) Source #

(Typeable m, Typeable a) ⇒ ShowProxy (DualHeader m a ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

showProxy ∷ Proxy (DualHeader m a) → String Source #

CanHardFork xs ⇒ Show (Header (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

showsPrec ∷ Int → Header (HardForkBlock xs) → ShowS #

show ∷ Header (HardForkBlock xs) → String #

showList ∷ [Header (HardForkBlock xs)] → ShowS #

All (Compose Eq Header) xs ⇒ Eq (Header (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

(==) ∷ Header (HardForkBlock xs) → Header (HardForkBlock xs) → Bool #

(/=) ∷ Header (HardForkBlock xs) → Header (HardForkBlock xs) → Bool #

CanHardFork xs ⇒ NoThunks (Header (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

noThunks ∷ Context → Header (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Header (HardForkBlock xs) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Header (HardForkBlock xs)) → String Source #

NoThunks (Header (DualBlock m a)) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

noThunks ∷ Context → Header (DualBlock m a) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → Header (DualBlock m a) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (Header (DualBlock m a)) → String Source #

All CondenseConstraints xs ⇒ Condense (Header (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Condense

Methods

condense ∷ Header (HardForkBlock xs) → String Source #

CanHardFork xs ⇒ HasHeader (Header (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

getHeaderFields ∷ Header (HardForkBlock xs) → HeaderFields (Header (HardForkBlock xs)) Source #

SerialiseHFC xs ⇒ SerialiseNodeToNode (HardForkBlock xs) (Header (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToNode

Methods

encodeNodeToNode ∷ CodecConfig (HardForkBlock xs) → BlockNodeToNodeVersion (HardForkBlock xs) → Header (HardForkBlock xs) → Encoding Source #

decodeNodeToNode ∷ CodecConfig (HardForkBlock xs) → BlockNodeToNodeVersion (HardForkBlock xs) → ∀ s. Decoder s (Header (HardForkBlock xs)) Source #

SerialiseHFC xs ⇒ DecodeDiskDep (NestedCtxt Header) (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk

Methods

decodeDiskDep ∷ CodecConfig (HardForkBlock xs) → NestedCtxt Header (HardForkBlock xs) a → ∀ s. Decoder s (ByteString → a) Source #

SerialiseHFC xs ⇒ DecodeDiskDepIx (NestedCtxt Header) (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk

Methods

decodeDiskDepIx ∷ CodecConfig (HardForkBlock xs) → Decoder s (SomeSecond (NestedCtxt Header) (HardForkBlock xs)) Source #

SerialiseHFC xs ⇒ EncodeDiskDep (NestedCtxt Header) (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk

Methods

encodeDiskDep ∷ CodecConfig (HardForkBlock xs) → NestedCtxt Header (HardForkBlock xs) a → a → Encoding Source #

SerialiseHFC xs ⇒ EncodeDiskDepIx (NestedCtxt Header) (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk

Methods

encodeDiskDepIx ∷ CodecConfig (HardForkBlock xs) → SomeSecond (NestedCtxt Header) (HardForkBlock xs) → Encoding Source #

EncodeDiskDep (NestedCtxt Header) m ⇒ EncodeDiskDep (NestedCtxt Header) (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

encodeDiskDep ∷ CodecConfig (DualBlock m a) → NestedCtxt Header (DualBlock m a) a0 → a0 → Encoding Source #

EncodeDiskDepIx (NestedCtxt Header) m ⇒ EncodeDiskDepIx (NestedCtxt Header) (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

encodeDiskDepIx ∷ CodecConfig (DualBlock m a) → SomeSecond (NestedCtxt Header) (DualBlock m a) → Encoding Source #

Show (Header m) ⇒ Show (DualHeader m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

showsPrec ∷ Int → DualHeader m a → ShowS #

show ∷ DualHeader m a → String #

showList ∷ [DualHeader m a] → ShowS #

Bridge m a ⇒ HasHeader (DualHeader m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

getHeaderFields ∷ DualHeader m a → HeaderFields (DualHeader m a) Source #

All SingleEraBlock xs ⇒ Show (NestedCtxt_ (HardForkBlock xs) Header a) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

showsPrec ∷ Int → NestedCtxt_ (HardForkBlock xs) Header a → ShowS #

show ∷ NestedCtxt_ (HardForkBlock xs) Header a → String #

showList ∷ [NestedCtxt_ (HardForkBlock xs) Header a] → ShowS #

type HeaderHash (Header blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

type HeaderHash (Header blk ∷ Type) = HeaderHash blk
type BlockProtocol (Header blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

type BlockProtocol (Header blk) = BlockProtocol blk
newtype Header (DisableDiffusionPipelining blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.SupportsDiffusionPipelining

newtype Header (DisableDiffusionPipelining blk) = DisableDiffusionPipeliningHeader (Header blk)
newtype Header (SelectViewDiffusionPipelining blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.SupportsDiffusionPipelining

newtype Header (SelectViewDiffusionPipelining blk) = SelectViewDiffusionPipeliningHeader (Header blk)
newtype Header (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

newtype Header (HardForkBlock xs) = HardForkHeader {}
newtype Header (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

newtype Header (DualBlock m a) = DualHeader {}

blockIsEBB ∷ GetHeader blk ⇒ blk → Maybe EpochNo Source #

blockToIsEBB ∷ GetHeader blk ⇒ blk → IsEBB Source #

getBlockHeaderFields ∷ GetHeader blk ⇒ blk → HeaderFields blk Source #

Get the HeaderFields of a block, without requiring 'HasHeader blk'

This is primarily useful as a a simple definition of HasHeader for block types:

instance HasHeader SomeBlock where
  getHeaderFields = getBlockHeaderFields

provided that there is a HasHeader instance for the header.

Unfortunately we cannot give a HasHeader instance once and for all; if we mapped from a header to a block instead we could do

instance HasHeader hdr => HasHeader (Block hdr) where
 ..

but we can't do that when we do things this way around.

headerHash ∷ HasHeader (Header blk) ⇒ Header blk → HeaderHash blk Source #

headerPoint ∷ HasHeader (Header blk) ⇒ Header blk → Point blk Source #

headerToIsEBB ∷ GetHeader blk ⇒ Header blk → IsEBB Source #

Raw hash

class ConvertRawHash blk where Source #

Convert a hash from/to raw bytes

Variants of toRawHash and fromRawHash for ShortByteString are included. Override the default implementations to avoid an extra step in case the HeaderHash is a ShortByteString under the hood.

Minimal complete definition

hashSize, (toRawHash | toShortRawHash), (fromRawHash | fromShortRawHash)

Methods

toRawHash ∷ proxy blk → HeaderHash blk → ByteString Source #

Get the raw bytes from a hash

fromRawHash ∷ proxy blk → ByteString → HeaderHash blk Source #

Construct the hash from a raw hash

PRECONDITION: the bytestring's size must match hashSize

toShortRawHash ∷ proxy blk → HeaderHash blk → ShortByteString Source #

Variant of toRawHash for ShortByteString

fromShortRawHash ∷ proxy blk → ShortByteString → HeaderHash blk Source #

Variant of fromRawHash for ShortByteString

hashSize ∷ proxy blk → Word32 Source #

The size of the hash in number of bytes

Instances

Instances details
CanHardFork xs ⇒ ConvertRawHash (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

toRawHash ∷ proxy (HardForkBlock xs) → HeaderHash (HardForkBlock xs) → ByteString Source #

fromRawHash ∷ proxy (HardForkBlock xs) → ByteString → HeaderHash (HardForkBlock xs) Source #

toShortRawHash ∷ proxy (HardForkBlock xs) → HeaderHash (HardForkBlock xs) → ShortByteString Source #

fromShortRawHash ∷ proxy (HardForkBlock xs) → ShortByteString → HeaderHash (HardForkBlock xs) Source #

hashSize ∷ proxy (HardForkBlock xs) → Word32 Source #

ConvertRawHash m ⇒ ConvertRawHash (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

toRawHash ∷ proxy (DualBlock m a) → HeaderHash (DualBlock m a) → ByteString Source #

fromRawHash ∷ proxy (DualBlock m a) → ByteString → HeaderHash (DualBlock m a) Source #

toShortRawHash ∷ proxy (DualBlock m a) → HeaderHash (DualBlock m a) → ShortByteString Source #

fromShortRawHash ∷ proxy (DualBlock m a) → ShortByteString → HeaderHash (DualBlock m a) Source #

hashSize ∷ proxy (DualBlock m a) → Word32 Source #

decodeRawHash ∷ ConvertRawHash blk ⇒ proxy blk → ∀ s. Decoder s (HeaderHash blk) Source #

encodeRawHash ∷ ConvertRawHash blk ⇒ proxy blk → HeaderHash blk → Encoding Source #

Utilities for working with WithOrigin

succWithOrigin ∷ (Bounded t, Enum t) ⇒ WithOrigin t → t Source #

Return the successor of a WithOrigin value. Useful in combination with SlotNo and BlockNo.

Ouroboros Genesis window

newtype GenesisWindow Source #

Size of the Genesis window, in number of slots.

This is the number of slots that the GDD Governor (Genesis Density Disconnection Governor -- see Governor) will consider when deciding whether to disconnect from a peer. It has to be smaller or equal to the stability window. For instance, for Shelley-based eras, this will be equal to a stability window, that is 3k/f.

Constructors

GenesisWindow 

Fields

Instances

Instances details
Num GenesisWindow Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

Methods

(+) ∷ GenesisWindow → GenesisWindow → GenesisWindow #

(-) ∷ GenesisWindow → GenesisWindow → GenesisWindow #

(*) ∷ GenesisWindow → GenesisWindow → GenesisWindow #

negate ∷ GenesisWindow → GenesisWindow #

abs ∷ GenesisWindow → GenesisWindow #

signum ∷ GenesisWindow → GenesisWindow #

fromInteger ∷ Integer → GenesisWindow #

Show GenesisWindow Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

Methods

showsPrec ∷ Int → GenesisWindow → ShowS #

show ∷ GenesisWindow → String #

showList ∷ [GenesisWindow] → ShowS #

Eq GenesisWindow Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

Methods

(==) ∷ GenesisWindow → GenesisWindow → Bool #

(/=) ∷ GenesisWindow → GenesisWindow → Bool #

Ord GenesisWindow Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

Methods

compare ∷ GenesisWindow → GenesisWindow → Ordering #

(<) ∷ GenesisWindow → GenesisWindow → Bool #

(<=) ∷ GenesisWindow → GenesisWindow → Bool #

(>) ∷ GenesisWindow → GenesisWindow → Bool #

(>=) ∷ GenesisWindow → GenesisWindow → Bool #

max ∷ GenesisWindow → GenesisWindow → GenesisWindow #

min ∷ GenesisWindow → GenesisWindow → GenesisWindow #

NoThunks GenesisWindow Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

Methods

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

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

showTypeOf ∷ Proxy GenesisWindow → String Source #

Re-export basic definitions from ouroboros-network

data ChainHash (b ∷ k) Source #

Constructors

GenesisHash 
BlockHash !(HeaderHash b) 

Instances

Instances details
Isomorphic (ChainHash ∷ Type → Type) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ ChainHash (HardForkBlock '[blk]) → ChainHash blk Source #

inject ∷ NoHardForks blk ⇒ ChainHash blk → ChainHash (HardForkBlock '[blk]) Source #

Generic (ChainHash b) 
Instance details

Defined in Ouroboros.Network.Block

Associated Types

type Rep (ChainHash b) 
Instance details

Defined in Ouroboros.Network.Block

type Rep (ChainHash b) = D1 ('MetaData "ChainHash" "Ouroboros.Network.Block" "ouroboros-network-api-0.13.0.0-5343a8071b3f542ab81b06c59cf16dafcc55f3756ea92962f719c77a1536151d" 'False) (C1 ('MetaCons "GenesisHash" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "BlockHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HeaderHash b))))

Methods

from ∷ ChainHash b → Rep (ChainHash b) x #

to ∷ Rep (ChainHash b) x → ChainHash b #

StandardHash block ⇒ Show (ChainHash block) 
Instance details

Defined in Ouroboros.Network.Block

Methods

showsPrec ∷ Int → ChainHash block → ShowS #

show ∷ ChainHash block → String #

showList ∷ [ChainHash block] → ShowS #

StandardHash block ⇒ Eq (ChainHash block) 
Instance details

Defined in Ouroboros.Network.Block

Methods

(==) ∷ ChainHash block → ChainHash block → Bool #

(/=) ∷ ChainHash block → ChainHash block → Bool #

StandardHash block ⇒ Ord (ChainHash block) 
Instance details

Defined in Ouroboros.Network.Block

Methods

compare ∷ ChainHash block → ChainHash block → Ordering #

(<) ∷ ChainHash block → ChainHash block → Bool #

(<=) ∷ ChainHash block → ChainHash block → Bool #

(>) ∷ ChainHash block → ChainHash block → Bool #

(>=) ∷ ChainHash block → ChainHash block → Bool #

max ∷ ChainHash block → ChainHash block → ChainHash block #

min ∷ ChainHash block → ChainHash block → ChainHash block #

(StandardHash block, Typeable block) ⇒ NoThunks (ChainHash block) 
Instance details

Defined in Ouroboros.Network.Block

Methods

noThunks ∷ Context → ChainHash block → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ChainHash block → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ChainHash block) → String Source #

Condense (HeaderHash b) ⇒ Condense (ChainHash b) Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ ChainHash b → String Source #

Serialise (HeaderHash b) ⇒ Serialise (ChainHash b) 
Instance details

Defined in Ouroboros.Network.Block

Methods

encode ∷ ChainHash b → Encoding Source #

decode ∷ Decoder s (ChainHash b) Source #

encodeList ∷ [ChainHash b] → Encoding Source #

decodeList ∷ Decoder s [ChainHash b] Source #

type Rep (ChainHash b) 
Instance details

Defined in Ouroboros.Network.Block

type Rep (ChainHash b) = D1 ('MetaData "ChainHash" "Ouroboros.Network.Block" "ouroboros-network-api-0.13.0.0-5343a8071b3f542ab81b06c59cf16dafcc55f3756ea92962f719c77a1536151d" 'False) (C1 ('MetaCons "GenesisHash" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "BlockHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HeaderHash b))))

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 Block 
Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

getHeaderFields ∷ Block → HeaderFields Block Source #

HasHeader BlockHeader 
Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

Methods

getHeaderFields ∷ BlockHeader → HeaderFields BlockHeader Source #

CanHardFork xs ⇒ HasHeader (Header (HardForkBlock xs)) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

getHeaderFields ∷ Header (HardForkBlock xs) → HeaderFields (Header (HardForkBlock xs)) Source #

CanHardFork xs ⇒ HasHeader (HardForkBlock xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

Methods

getHeaderFields ∷ HardForkBlock xs → HeaderFields (HardForkBlock xs) Source #

Bridge m a ⇒ HasHeader (DualBlock m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

getHeaderFields ∷ DualBlock m a → HeaderFields (DualBlock m a) Source #

Bridge m a ⇒ HasHeader (DualHeader m a) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

Methods

getHeaderFields ∷ DualHeader m a → HeaderFields (DualHeader m a) Source #

(StandardHash b, Typeable b, Typeable k) ⇒ HasHeader (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

Methods

getHeaderFields ∷ HeaderFields b → HeaderFields (HeaderFields b) Source #

data HeaderFields (b ∷ k) Source #

Header fields we expect to be present in a block

These fields are lazy because they are extracted from a block or block header; this type is not intended for storage.

Constructors

HeaderFields 

Fields

Instances

Instances details
StandardHash b ⇒ StandardHash (HeaderFields b ∷ Type) 
Instance details

Defined in Ouroboros.Network.Block

Generic (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

Associated Types

type Rep (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

type Rep (HeaderFields b) = D1 ('MetaData "HeaderFields" "Ouroboros.Network.Block" "ouroboros-network-api-0.13.0.0-5343a8071b3f542ab81b06c59cf16dafcc55f3756ea92962f719c77a1536151d" 'False) (C1 ('MetaCons "HeaderFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerFieldSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo) :*: (S1 ('MetaSel ('Just "headerFieldBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockNo) :*: S1 ('MetaSel ('Just "headerFieldHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HeaderHash b)))))

Methods

from ∷ HeaderFields b → Rep (HeaderFields b) x #

to ∷ Rep (HeaderFields b) x → HeaderFields b #

StandardHash b ⇒ Show (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

Methods

showsPrec ∷ Int → HeaderFields b → ShowS #

show ∷ HeaderFields b → String #

showList ∷ [HeaderFields b] → ShowS #

StandardHash b ⇒ Eq (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

Methods

(==) ∷ HeaderFields b → HeaderFields b → Bool #

(/=) ∷ HeaderFields b → HeaderFields b → Bool #

StandardHash b ⇒ Ord (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

Methods

compare ∷ HeaderFields b → HeaderFields b → Ordering #

(<) ∷ HeaderFields b → HeaderFields b → Bool #

(<=) ∷ HeaderFields b → HeaderFields b → Bool #

(>) ∷ HeaderFields b → HeaderFields b → Bool #

(>=) ∷ HeaderFields b → HeaderFields b → Bool #

max ∷ HeaderFields b → HeaderFields b → HeaderFields b #

min ∷ HeaderFields b → HeaderFields b → HeaderFields b #

(StandardHash b, Typeable b, Typeable k) ⇒ HasHeader (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

Methods

getHeaderFields ∷ HeaderFields b → HeaderFields (HeaderFields b) Source #

Serialise (HeaderHash b) ⇒ Serialise (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

Methods

encode ∷ HeaderFields b → Encoding Source #

decode ∷ Decoder s (HeaderFields b) Source #

encodeList ∷ [HeaderFields b] → Encoding Source #

decodeList ∷ Decoder s [HeaderFields b] Source #

type HeaderHash (HeaderFields b ∷ Type) 
Instance details

Defined in Ouroboros.Network.Block

type HeaderHash (HeaderFields b ∷ Type) = HeaderHash b
type Rep (HeaderFields b) 
Instance details

Defined in Ouroboros.Network.Block

type Rep (HeaderFields b) = D1 ('MetaData "HeaderFields" "Ouroboros.Network.Block" "ouroboros-network-api-0.13.0.0-5343a8071b3f542ab81b06c59cf16dafcc55f3756ea92962f719c77a1536151d" 'False) (C1 ('MetaCons "HeaderFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "headerFieldSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo) :*: (S1 ('MetaSel ('Just "headerFieldBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BlockNo) :*: S1 ('MetaSel ('Just "headerFieldHash") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (HeaderHash b)))))

type family HeaderHash (b ∷ k) Source #

Header hash

Instances

Instances details
type HeaderHash Block 
Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type HeaderHash Block = ConcreteHeaderHash
type HeaderHash BlockHeader 
Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

type HeaderHash BlockHeader = ConcreteHeaderHash
type HeaderHash (Header blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

type HeaderHash (Header blk ∷ Type) = HeaderHash blk
type HeaderHash (HardForkBlock xs ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

type HeaderHash (HardForkBlock xs ∷ Type) = OneEraHash xs
type HeaderHash (SerialisedHeader blk ∷ Type) Source #

Only needed for the ChainSyncServer

Instance details

Defined in Ouroboros.Consensus.Storage.Serialisation

type HeaderHash (SerialisedHeader blk ∷ Type) = HeaderHash blk
type HeaderHash (DualBlock m a ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

type HeaderHash (DualBlock m a ∷ Type) = HeaderHash m
type HeaderHash (WithPoint blk b ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.ChainDB.API

type HeaderHash (WithPoint blk b ∷ Type) = HeaderHash blk
type HeaderHash (HeaderFields b ∷ Type) 
Instance details

Defined in Ouroboros.Network.Block

type HeaderHash (HeaderFields b ∷ Type) = HeaderHash b
type HeaderHash (Serialised block ∷ Type) 
Instance details

Defined in Ouroboros.Network.Block

type HeaderHash (Serialised block ∷ Type) = HeaderHash block
type HeaderHash (Ticked l ∷ k) Source # 
Instance details

Defined in Ouroboros.Consensus.Ticked

type HeaderHash (Ticked l ∷ k) = HeaderHash l
type HeaderHash (LedgerDB m l blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.API

type HeaderHash (LedgerDB m l blk ∷ Type) = HeaderHash blk
type HeaderHash (Forker m l blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Forker

type HeaderHash (Forker m l blk ∷ Type) = HeaderHash l
type HeaderHash (ReadOnlyForker m l blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.Forker

type HeaderHash (ReadOnlyForker m l blk ∷ Type) = HeaderHash l
type HeaderHash (LedgerState blk ∷ MapKind → Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Basics

type HeaderHash (LedgerState blk ∷ MapKind → Type) = HeaderHash blk
type HeaderHash (ExtLedgerState blk ∷ MapKind → Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

type HeaderHash (ExtLedgerState blk ∷ MapKind → Type) = HeaderHash (LedgerState blk)
type HeaderHash (K (DbChangelog l) ∷ MapKind → Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.DbChangelog

type HeaderHash (K (DbChangelog l) ∷ MapKind → Type) = HeaderHash l

data Point (block ∷ k) where 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.

Bundled Patterns

pattern GenesisPoint ∷ Point block 
pattern BlockPoint ∷ SlotNo → HeaderHash block → Point block 

Instances

Instances details
ShowProxy block ⇒ ShowProxy (Point block ∷ Type) 
Instance details

Defined in Ouroboros.Network.Block

Methods

showProxy ∷ Proxy (Point block) → String Source #

Generic (Point block) 
Instance details

Defined in Ouroboros.Network.Block

Associated Types

type Rep (Point block) 
Instance details

Defined in Ouroboros.Network.Block

type Rep (Point block) = D1 ('MetaData "Point" "Ouroboros.Network.Block" "ouroboros-network-api-0.13.0.0-5343a8071b3f542ab81b06c59cf16dafcc55f3756ea92962f719c77a1536151d" 'True) (C1 ('MetaCons "Point" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WithOrigin (Block SlotNo (HeaderHash block))))))

Methods

from ∷ Point block → Rep (Point block) x #

to ∷ Rep (Point block) x → Point block #

StandardHash block ⇒ Show (Point block) 
Instance details

Defined in Ouroboros.Network.Block

Methods

showsPrec ∷ Int → Point block → ShowS #

show ∷ Point block → String #

showList ∷ [Point block] → ShowS #

StandardHash block ⇒ Eq (Point block) 
Instance details

Defined in Ouroboros.Network.Block

Methods

(==) ∷ Point block → Point block → Bool #

(/=) ∷ Point block → Point block → Bool #

StandardHash block ⇒ Ord (Point block) 
Instance details

Defined in Ouroboros.Network.Block

Methods

compare ∷ Point block → Point block → Ordering #

(<) ∷ Point block → Point block → Bool #

(<=) ∷ Point block → Point block → Bool #

(>) ∷ Point block → Point block → Bool #

(>=) ∷ Point block → Point block → Bool #

max ∷ Point block → Point block → Point block #

min ∷ Point block → Point block → Point block #

StandardHash block ⇒ NoThunks (Point block) 
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 #

Condense (HeaderHash block) ⇒ Condense (Point block) Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ Point block → String Source #

Serialise (HeaderHash block) ⇒ Serialise (Point block) 
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 #

type Rep (Point block) 
Instance details

Defined in Ouroboros.Network.Block

type Rep (Point block) = D1 ('MetaData "Point" "Ouroboros.Network.Block" "ouroboros-network-api-0.13.0.0-5343a8071b3f542ab81b06c59cf16dafcc55f3756ea92962f719c77a1536151d" 'True) (C1 ('MetaCons "Point" 'PrefixI 'True) (S1 ('MetaSel ('Just "getPoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (WithOrigin (Block SlotNo (HeaderHash block))))))

class (Eq (HeaderHash b), Ord (HeaderHash b), Show (HeaderHash b), Typeable (HeaderHash b), NoThunks (HeaderHash b)) ⇒ StandardHash (b ∷ k) Source #

StandardHash summarises the constraints we want header hashes to have

Without this class we would need to write

deriving instance Eq (HeaderHash block) => Eq (ChainHash block)

That requires UndecidableInstances; not a problem by itself, but it also means that we can then not use deriving Eq anywhere else for datatypes that reference Hash, which is very frustrating; see

https://downloads.haskell.org/~ghc/latest/docs/html/users_guide/exts/deriving_inferred.html

Introducing the StandardHash class avoids this problem.

Having these constraints directly as part of the HasHeader class is possible but libraries that use the networking layer may wish to be able to talk about StandardHash independently of HasHeader since the latter may impose yet further constraints.

Instances

Instances details
StandardHash Block 
Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

StandardHash BlockHeader 
Instance details

Defined in Ouroboros.Network.Mock.ConcreteBlock

StandardHash blk ⇒ StandardHash (Header blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Block.Abstract

CanHardFork xs ⇒ StandardHash (HardForkBlock xs ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Block

StandardHash blk ⇒ StandardHash (SerialisedHeader blk ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.Serialisation

StandardHash m ⇒ StandardHash (DualBlock m a ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Dual

StandardHash blk ⇒ StandardHash (WithPoint blk b ∷ Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.ChainDB.API

StandardHash b ⇒ StandardHash (HeaderFields b ∷ Type) 
Instance details

Defined in Ouroboros.Network.Block

StandardHash block ⇒ StandardHash (Serialised block ∷ Type) 
Instance details

Defined in Ouroboros.Network.Block

StandardHash blk ⇒ StandardHash (LedgerState blk ∷ MapKind → Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Basics

(NoThunks (HeaderHash blk), Typeable (HeaderHash blk), Show (HeaderHash blk), Ord (HeaderHash blk), Eq (HeaderHash blk)) ⇒ StandardHash (ExtLedgerState blk ∷ MapKind → Type) Source # 
Instance details

Defined in Ouroboros.Consensus.Ledger.Extended

blockHash ∷ HasHeader b ⇒ b → HeaderHash b Source #

blockNo ∷ HasHeader b ⇒ b → BlockNo Source #

blockPoint ∷ HasHeader block ⇒ block → Point block Source #

blockSlot ∷ HasHeader b ⇒ b → SlotNo Source #

castHash ∷ ∀ {k1} {k2} (b ∷ k1) (b' ∷ k2). Coercible (HeaderHash b) (HeaderHash b') ⇒ ChainHash b → ChainHash b' Source #

castHeaderFields ∷ ∀ {k1} {k2} (b ∷ k1) (b' ∷ k2). HeaderHash b ~ HeaderHash b' ⇒ HeaderFields b → HeaderFields b' Source #

castPoint ∷ ∀ {k1} {k2} (b ∷ k1) (b' ∷ k2). Coercible (HeaderHash b) (HeaderHash b') ⇒ Point b → Point b' Source #

pointHash ∷ ∀ {k} (block ∷ k). Point block → ChainHash block Source #

pointSlot ∷ ∀ {k} (block ∷ k). Point block → WithOrigin SlotNo Source #

Re-export basic definitions from cardano-base

newtype BlockNo Source #

The 0-based index of the block in the blockchain. BlockNo is <= SlotNo and is only equal at slot N if there is a block for every slot where N <= SlotNo.

Constructors

BlockNo 

Fields

Instances

Instances details
FromJSON BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

parseJSON ∷ Value → Parser BlockNo Source #

parseJSONList ∷ Value → Parser [BlockNo] Source #

omittedField ∷ Maybe BlockNo Source #

ToJSON BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

toJSON ∷ BlockNo → Value Source #

toEncoding ∷ BlockNo → Encoding Source #

toJSONList ∷ [BlockNo] → Value Source #

toEncodingList ∷ [BlockNo] → Encoding Source #

omitField ∷ BlockNo → Bool Source #

FromCBOR BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

fromCBOR ∷ Decoder s BlockNo Source #

label ∷ Proxy BlockNo → Text Source #

ToCBOR BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

toCBOR ∷ BlockNo → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy BlockNo → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [BlockNo] → Size Source #

EncCBOR BlockNo 
Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR ∷ BlockNo → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy BlockNo → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [BlockNo] → Size Source #

NFData BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

rnf ∷ BlockNo → () #

Bounded BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

minBound ∷ BlockNo #

maxBound ∷ BlockNo #

Enum BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

succ ∷ BlockNo → BlockNo #

pred ∷ BlockNo → BlockNo #

toEnum ∷ Int → BlockNo #

fromEnum ∷ BlockNo → Int #

enumFrom ∷ BlockNo → [BlockNo] #

enumFromThen ∷ BlockNo → BlockNo → [BlockNo] #

enumFromTo ∷ BlockNo → BlockNo → [BlockNo] #

enumFromThenTo ∷ BlockNo → BlockNo → BlockNo → [BlockNo] #

Generic BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Associated Types

type Rep BlockNo 
Instance details

Defined in Cardano.Slotting.Block

type Rep BlockNo = D1 ('MetaData "BlockNo" "Cardano.Slotting.Block" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "BlockNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from ∷ BlockNo → Rep BlockNo x #

to ∷ Rep BlockNo x → BlockNo #

Num BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

(+) ∷ BlockNo → BlockNo → BlockNo #

(-) ∷ BlockNo → BlockNo → BlockNo #

(*) ∷ BlockNo → BlockNo → BlockNo #

negate ∷ BlockNo → BlockNo #

abs ∷ BlockNo → BlockNo #

signum ∷ BlockNo → BlockNo #

fromInteger ∷ Integer → BlockNo #

Show BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

showsPrec ∷ Int → BlockNo → ShowS #

show ∷ BlockNo → String #

showList ∷ [BlockNo] → ShowS #

Eq BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

(==) ∷ BlockNo → BlockNo → Bool #

(/=) ∷ BlockNo → BlockNo → Bool #

Ord BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

compare ∷ BlockNo → BlockNo → Ordering #

(<) ∷ BlockNo → BlockNo → Bool #

(<=) ∷ BlockNo → BlockNo → Bool #

(>) ∷ BlockNo → BlockNo → Bool #

(>=) ∷ BlockNo → BlockNo → Bool #

max ∷ BlockNo → BlockNo → BlockNo #

min ∷ BlockNo → BlockNo → BlockNo #

NoThunks BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

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

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

showTypeOf ∷ Proxy BlockNo → String Source #

ChainOrder BlockNo Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.Abstract

Associated Types

type ChainOrderConfig BlockNo 
Instance details

Defined in Ouroboros.Consensus.Protocol.Abstract

type ChainOrderConfig BlockNo = ChainOrderConfig (SimpleChainOrder BlockNo)

Methods

preferCandidate ∷ ChainOrderConfig BlockNo → BlockNo → BlockNo → Bool Source #

Condense BlockNo Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ BlockNo → String Source #

Serialise BlockNo 
Instance details

Defined in Cardano.Slotting.Block

Methods

encode ∷ BlockNo → Encoding Source #

decode ∷ Decoder s BlockNo Source #

encodeList ∷ [BlockNo] → Encoding Source #

decodeList ∷ Decoder s [BlockNo] Source #

type Rep BlockNo 
Instance details

Defined in Cardano.Slotting.Block

type Rep BlockNo = D1 ('MetaData "BlockNo" "Cardano.Slotting.Block" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "BlockNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unBlockNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))
type ChainOrderConfig BlockNo Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.Abstract

type ChainOrderConfig BlockNo = ChainOrderConfig (SimpleChainOrder BlockNo)

newtype EpochNo Source #

An epoch, i.e. the number of the epoch.

Constructors

EpochNo 

Fields

Instances

Instances details
FromJSON EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

parseJSON ∷ Value → Parser EpochNo Source #

parseJSONList ∷ Value → Parser [EpochNo] Source #

omittedField ∷ Maybe EpochNo Source #

ToJSON EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toJSON ∷ EpochNo → Value Source #

toEncoding ∷ EpochNo → Encoding Source #

toJSONList ∷ [EpochNo] → Value Source #

toEncodingList ∷ [EpochNo] → Encoding Source #

omitField ∷ EpochNo → Bool Source #

FromCBOR EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

fromCBOR ∷ Decoder s EpochNo Source #

label ∷ Proxy EpochNo → Text Source #

ToCBOR EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR ∷ EpochNo → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy EpochNo → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [EpochNo] → Size Source #

EncCBOR EpochNo 
Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR ∷ EpochNo → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy EpochNo → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [EpochNo] → Size Source #

NFData EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

rnf ∷ EpochNo → () #

Enum EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

succ ∷ EpochNo → EpochNo #

pred ∷ EpochNo → EpochNo #

toEnum ∷ Int → EpochNo #

fromEnum ∷ EpochNo → Int #

enumFrom ∷ EpochNo → [EpochNo] #

enumFromThen ∷ EpochNo → EpochNo → [EpochNo] #

enumFromTo ∷ EpochNo → EpochNo → [EpochNo] #

enumFromThenTo ∷ EpochNo → EpochNo → EpochNo → [EpochNo] #

Generic EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

type Rep EpochNo = D1 ('MetaData "EpochNo" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "EpochNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from ∷ EpochNo → Rep EpochNo x #

to ∷ Rep EpochNo x → EpochNo #

Show EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

showsPrec ∷ Int → EpochNo → ShowS #

show ∷ EpochNo → String #

showList ∷ [EpochNo] → ShowS #

Eq EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) ∷ EpochNo → EpochNo → Bool #

(/=) ∷ EpochNo → EpochNo → Bool #

Ord EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

compare ∷ EpochNo → EpochNo → Ordering #

(<) ∷ EpochNo → EpochNo → Bool #

(<=) ∷ EpochNo → EpochNo → Bool #

(>) ∷ EpochNo → EpochNo → Bool #

(>=) ∷ EpochNo → EpochNo → Bool #

max ∷ EpochNo → EpochNo → EpochNo #

min ∷ EpochNo → EpochNo → EpochNo #

NoThunks EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

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

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

showTypeOf ∷ Proxy EpochNo → String Source #

Condense EpochNo Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ EpochNo → String Source #

Serialise EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

encode ∷ EpochNo → Encoding Source #

decode ∷ Decoder s EpochNo Source #

encodeList ∷ [EpochNo] → Encoding Source #

decodeList ∷ Decoder s [EpochNo] Source #

type Rep EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

type Rep EpochNo = D1 ('MetaData "EpochNo" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "EpochNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

newtype EpochSize Source #

Constructors

EpochSize 

Fields

Instances

Instances details
FromJSON EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

parseJSON ∷ Value → Parser EpochSize Source #

parseJSONList ∷ Value → Parser [EpochSize] Source #

omittedField ∷ Maybe EpochSize Source #

ToJSON EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toJSON ∷ EpochSize → Value Source #

toEncoding ∷ EpochSize → Encoding Source #

toJSONList ∷ [EpochSize] → Value Source #

toEncodingList ∷ [EpochSize] → Encoding Source #

omitField ∷ EpochSize → Bool Source #

FromCBOR EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

fromCBOR ∷ Decoder s EpochSize Source #

label ∷ Proxy EpochSize → Text Source #

ToCBOR EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR ∷ EpochSize → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy EpochSize → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [EpochSize] → Size Source #

EncCBOR EpochSize 
Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR ∷ EpochSize → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy EpochSize → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [EpochSize] → Size Source #

NFData EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

rnf ∷ EpochSize → () #

Enum EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

succ ∷ EpochSize → EpochSize #

pred ∷ EpochSize → EpochSize #

toEnum ∷ Int → EpochSize #

fromEnum ∷ EpochSize → Int #

enumFrom ∷ EpochSize → [EpochSize] #

enumFromThen ∷ EpochSize → EpochSize → [EpochSize] #

enumFromTo ∷ EpochSize → EpochSize → [EpochSize] #

enumFromThenTo ∷ EpochSize → EpochSize → EpochSize → [EpochSize] #

Generic EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

type Rep EpochSize = D1 ('MetaData "EpochSize" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "EpochSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from ∷ EpochSize → Rep EpochSize x #

to ∷ Rep EpochSize x → EpochSize #

Show EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

showsPrec ∷ Int → EpochSize → ShowS #

show ∷ EpochSize → String #

showList ∷ [EpochSize] → ShowS #

Eq EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) ∷ EpochSize → EpochSize → Bool #

(/=) ∷ EpochSize → EpochSize → Bool #

Ord EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

compare ∷ EpochSize → EpochSize → Ordering #

(<) ∷ EpochSize → EpochSize → Bool #

(<=) ∷ EpochSize → EpochSize → Bool #

(>) ∷ EpochSize → EpochSize → Bool #

(>=) ∷ EpochSize → EpochSize → Bool #

max ∷ EpochSize → EpochSize → EpochSize #

min ∷ EpochSize → EpochSize → EpochSize #

NoThunks EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

Methods

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

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

showTypeOf ∷ Proxy EpochSize → String Source #

type Rep EpochSize 
Instance details

Defined in Cardano.Slotting.Slot

type Rep EpochSize = D1 ('MetaData "EpochSize" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "EpochSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

newtype SlotNo Source #

The 0-based index for the Ourboros time slot.

Constructors

SlotNo 

Fields

Instances

Instances details
FromJSON SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

parseJSON ∷ Value → Parser SlotNo Source #

parseJSONList ∷ Value → Parser [SlotNo] Source #

omittedField ∷ Maybe SlotNo Source #

ToJSON SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toJSON ∷ SlotNo → Value Source #

toEncoding ∷ SlotNo → Encoding Source #

toJSONList ∷ [SlotNo] → Value Source #

toEncodingList ∷ [SlotNo] → Encoding Source #

omitField ∷ SlotNo → Bool Source #

FromCBOR SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

fromCBOR ∷ Decoder s SlotNo Source #

label ∷ Proxy SlotNo → Text Source #

ToCBOR SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR ∷ SlotNo → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SlotNo → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SlotNo] → Size Source #

EncCBOR SlotNo 
Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR ∷ SlotNo → Encoding Source #

encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy SlotNo → Size Source #

encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [SlotNo] → Size Source #

NFData SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

rnf ∷ SlotNo → () #

Bounded SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

minBound ∷ SlotNo #

maxBound ∷ SlotNo #

Enum SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

succ ∷ SlotNo → SlotNo #

pred ∷ SlotNo → SlotNo #

toEnum ∷ Int → SlotNo #

fromEnum ∷ SlotNo → Int #

enumFrom ∷ SlotNo → [SlotNo] #

enumFromThen ∷ SlotNo → SlotNo → [SlotNo] #

enumFromTo ∷ SlotNo → SlotNo → [SlotNo] #

enumFromThenTo ∷ SlotNo → SlotNo → SlotNo → [SlotNo] #

Generic SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

type Rep SlotNo = D1 ('MetaData "SlotNo" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "SlotNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSlotNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from ∷ SlotNo → Rep SlotNo x #

to ∷ Rep SlotNo x → SlotNo #

Num SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

(+) ∷ SlotNo → SlotNo → SlotNo #

(-) ∷ SlotNo → SlotNo → SlotNo #

(*) ∷ SlotNo → SlotNo → SlotNo #

negate ∷ SlotNo → SlotNo #

abs ∷ SlotNo → SlotNo #

signum ∷ SlotNo → SlotNo #

fromInteger ∷ Integer → SlotNo #

Show SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

showsPrec ∷ Int → SlotNo → ShowS #

show ∷ SlotNo → String #

showList ∷ [SlotNo] → ShowS #

Eq SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) ∷ SlotNo → SlotNo → Bool #

(/=) ∷ SlotNo → SlotNo → Bool #

Ord SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

compare ∷ SlotNo → SlotNo → Ordering #

(<) ∷ SlotNo → SlotNo → Bool #

(<=) ∷ SlotNo → SlotNo → Bool #

(>) ∷ SlotNo → SlotNo → Bool #

(>=) ∷ SlotNo → SlotNo → Bool #

max ∷ SlotNo → SlotNo → SlotNo #

min ∷ SlotNo → SlotNo → SlotNo #

NoThunks SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

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

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

showTypeOf ∷ Proxy SlotNo → String Source #

Condense SlotNo Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ SlotNo → String Source #

Serialise SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

encode ∷ SlotNo → Encoding Source #

decode ∷ Decoder s SlotNo Source #

encodeList ∷ [SlotNo] → Encoding Source #

decodeList ∷ Decoder s [SlotNo] Source #

ShowProxy SlotNo 
Instance details

Defined in Ouroboros.Network.Util.ShowProxy

Methods

showProxy ∷ Proxy SlotNo → String Source #

(Condense block, HasHeader block, Condense (HeaderHash block)) ⇒ Condense (AnchoredFragment block) Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ AnchoredFragment block → String Source #

SerialiseHFC xs ⇒ SerialiseNodeToClient (HardForkBlock xs) SlotNo Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseNodeToClient

Methods

encodeNodeToClient ∷ CodecConfig (HardForkBlock xs) → BlockNodeToClientVersion (HardForkBlock xs) → SlotNo → Encoding Source #

decodeNodeToClient ∷ CodecConfig (HardForkBlock xs) → BlockNodeToClientVersion (HardForkBlock xs) → ∀ s. Decoder s SlotNo Source #

HasHeader block ⇒ Anchorable (WithOrigin SlotNo) (Anchor block) block 
Instance details

Defined in Ouroboros.Network.AnchoredFragment

Methods

asAnchor ∷ block → Anchor block Source #

getAnchorMeasure ∷ Proxy block → Anchor block → WithOrigin SlotNo Source #

Anchorable (WithOrigin SlotNo) (HeaderStateWithTime blk) (HeaderStateWithTime blk) Source # 
Instance details

Defined in Ouroboros.Consensus.HeaderStateHistory

Methods

asAnchor ∷ HeaderStateWithTime blk → HeaderStateWithTime blk Source #

getAnchorMeasure ∷ Proxy (HeaderStateWithTime blk) → HeaderStateWithTime blk → WithOrigin SlotNo Source #

GetTip l ⇒ Anchorable (WithOrigin SlotNo) (l EmptyMK) (l EmptyMK) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.DbChangelog

Methods

asAnchor ∷ l EmptyMK → l EmptyMK Source #

getAnchorMeasure ∷ Proxy (l EmptyMK) → l EmptyMK → WithOrigin SlotNo Source #

GetTip l ⇒ Anchorable (WithOrigin SlotNo) (StateRef m l) (StateRef m l) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.LedgerSeq

Methods

asAnchor ∷ StateRef m l → StateRef m l Source #

getAnchorMeasure ∷ Proxy (StateRef m l) → StateRef m l → WithOrigin SlotNo Source #

type Rep SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

type Rep SlotNo = D1 ('MetaData "SlotNo" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'True) (C1 ('MetaCons "SlotNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSlotNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

data WithOrigin t Source #

Constructors

Origin 

Bundled Patterns

pattern NotOrigin ∷ t → WithOrigin t

Custom pattern for WithOrigin

This avoids clashing with our (extensive) use of At for testing.

Instances

Instances details
Functor WithOrigin 
Instance details

Defined in Cardano.Slotting.Slot

Methods

fmap ∷ (a → b) → WithOrigin a → WithOrigin b #

(<$) ∷ a → WithOrigin b → WithOrigin a #

Foldable WithOrigin 
Instance details

Defined in Cardano.Slotting.Slot

Methods

fold ∷ Monoid m ⇒ WithOrigin m → m #

foldMap ∷ Monoid m ⇒ (a → m) → WithOrigin a → m #

foldMap' ∷ Monoid m ⇒ (a → m) → WithOrigin a → m #

foldr ∷ (a → b → b) → b → WithOrigin a → b #

foldr' ∷ (a → b → b) → b → WithOrigin a → b #

foldl ∷ (b → a → b) → b → WithOrigin a → b #

foldl' ∷ (b → a → b) → b → WithOrigin a → b #

foldr1 ∷ (a → a → a) → WithOrigin a → a #

foldl1 ∷ (a → a → a) → WithOrigin a → a #

toList ∷ WithOrigin a → [a] #

null ∷ WithOrigin a → Bool #

length ∷ WithOrigin a → Int #

elem ∷ Eq a ⇒ a → WithOrigin a → Bool #

maximum ∷ Ord a ⇒ WithOrigin a → a #

minimum ∷ Ord a ⇒ WithOrigin a → a #

sum ∷ Num a ⇒ WithOrigin a → a #

product ∷ Num a ⇒ WithOrigin a → a #

Traversable WithOrigin 
Instance details

Defined in Cardano.Slotting.Slot

Methods

traverse ∷ Applicative f ⇒ (a → f b) → WithOrigin a → f (WithOrigin b) #

sequenceA ∷ Applicative f ⇒ WithOrigin (f a) → f (WithOrigin a) #

mapM ∷ Monad m ⇒ (a → m b) → WithOrigin a → m (WithOrigin b) #

sequence ∷ Monad m ⇒ WithOrigin (m a) → m (WithOrigin a) #

FromJSON a ⇒ FromJSON (WithOrigin a) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

parseJSON ∷ Value → Parser (WithOrigin a) Source #

parseJSONList ∷ Value → Parser [WithOrigin a] Source #

omittedField ∷ Maybe (WithOrigin a) Source #

ToJSON a ⇒ ToJSON (WithOrigin a) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toJSON ∷ WithOrigin a → Value Source #

toEncoding ∷ WithOrigin a → Encoding Source #

toJSONList ∷ [WithOrigin a] → Value Source #

toEncodingList ∷ [WithOrigin a] → Encoding Source #

omitField ∷ WithOrigin a → Bool Source #

(Serialise t, Typeable t) ⇒ FromCBOR (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

fromCBOR ∷ Decoder s (WithOrigin t) Source #

label ∷ Proxy (WithOrigin t) → Text Source #

(Serialise t, Typeable t) ⇒ ToCBOR (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR ∷ WithOrigin t → Encoding Source #

encodedSizeExpr ∷ (∀ t0. ToCBOR t0 ⇒ Proxy t0 → Size) → Proxy (WithOrigin t) → Size Source #

encodedListSizeExpr ∷ (∀ t0. ToCBOR t0 ⇒ Proxy t0 → Size) → Proxy [WithOrigin t] → Size Source #

(Serialise t, Typeable t) ⇒ EncCBOR (WithOrigin t) 
Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR ∷ WithOrigin t → Encoding Source #

encodedSizeExpr ∷ (∀ t0. EncCBOR t0 ⇒ Proxy t0 → Size) → Proxy (WithOrigin t) → Size Source #

encodedListSizeExpr ∷ (∀ t0. EncCBOR t0 ⇒ Proxy t0 → Size) → Proxy [WithOrigin t] → Size Source #

NFData a ⇒ NFData (WithOrigin a) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

rnf ∷ WithOrigin a → () #

Bounded t ⇒ Bounded (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

minBound ∷ WithOrigin t #

maxBound ∷ WithOrigin t #

Generic (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

type Rep (WithOrigin t) = D1 ('MetaData "WithOrigin" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'False) (C1 ('MetaCons "Origin" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "At" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 t)))

Methods

from ∷ WithOrigin t → Rep (WithOrigin t) x #

to ∷ Rep (WithOrigin t) x → WithOrigin t #

Show t ⇒ Show (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

showsPrec ∷ Int → WithOrigin t → ShowS #

show ∷ WithOrigin t → String #

showList ∷ [WithOrigin t] → ShowS #

Eq t ⇒ Eq (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) ∷ WithOrigin t → WithOrigin t → Bool #

(/=) ∷ WithOrigin t → WithOrigin t → Bool #

Ord t ⇒ Ord (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

compare ∷ WithOrigin t → WithOrigin t → Ordering #

(<) ∷ WithOrigin t → WithOrigin t → Bool #

(<=) ∷ WithOrigin t → WithOrigin t → Bool #

(>) ∷ WithOrigin t → WithOrigin t → Bool #

(>=) ∷ WithOrigin t → WithOrigin t → Bool #

max ∷ WithOrigin t → WithOrigin t → WithOrigin t #

min ∷ WithOrigin t → WithOrigin t → WithOrigin t #

NoThunks t ⇒ NoThunks (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

noThunks ∷ Context → WithOrigin t → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → WithOrigin t → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (WithOrigin t) → String Source #

Condense a ⇒ Condense (WithOrigin a) Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ WithOrigin a → String Source #

(Condense block, HasHeader block, Condense (HeaderHash block)) ⇒ Condense (AnchoredFragment block) Source # 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

Methods

condense ∷ AnchoredFragment block → String Source #

Serialise t ⇒ Serialise (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

Methods

encode ∷ WithOrigin t → Encoding Source #

decode ∷ Decoder s (WithOrigin t) Source #

encodeList ∷ [WithOrigin t] → Encoding Source #

decodeList ∷ Decoder s [WithOrigin t] Source #

HasHeader block ⇒ Anchorable (WithOrigin SlotNo) (Anchor block) block 
Instance details

Defined in Ouroboros.Network.AnchoredFragment

Methods

asAnchor ∷ block → Anchor block Source #

getAnchorMeasure ∷ Proxy block → Anchor block → WithOrigin SlotNo Source #

Anchorable (WithOrigin SlotNo) (HeaderStateWithTime blk) (HeaderStateWithTime blk) Source # 
Instance details

Defined in Ouroboros.Consensus.HeaderStateHistory

Methods

asAnchor ∷ HeaderStateWithTime blk → HeaderStateWithTime blk Source #

getAnchorMeasure ∷ Proxy (HeaderStateWithTime blk) → HeaderStateWithTime blk → WithOrigin SlotNo Source #

GetTip l ⇒ Anchorable (WithOrigin SlotNo) (l EmptyMK) (l EmptyMK) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V1.DbChangelog

Methods

asAnchor ∷ l EmptyMK → l EmptyMK Source #

getAnchorMeasure ∷ Proxy (l EmptyMK) → l EmptyMK → WithOrigin SlotNo Source #

GetTip l ⇒ Anchorable (WithOrigin SlotNo) (StateRef m l) (StateRef m l) Source # 
Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.LedgerSeq

Methods

asAnchor ∷ StateRef m l → StateRef m l Source #

getAnchorMeasure ∷ Proxy (StateRef m l) → StateRef m l → WithOrigin SlotNo Source #

type Rep (WithOrigin t) 
Instance details

Defined in Cardano.Slotting.Slot

type Rep (WithOrigin t) = D1 ('MetaData "WithOrigin" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-2b12715306b9f8011dcd1a9abda3c9a87b5af2551395e7f7113557ad264b8ac9" 'False) (C1 ('MetaCons "Origin" 'PrefixI 'False) (U1 ∷ Type → Type) :+: C1 ('MetaCons "At" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 t)))

fromWithOrigin ∷ t → WithOrigin t → t Source #

withOrigin ∷ b → (t → b) → WithOrigin t → b Source #

withOriginFromMaybe ∷ Maybe t → WithOrigin t Source #

withOriginToMaybe ∷ WithOrigin t → Maybe t Source #