ouroboros-consensus-shelley-0.1.0.0: Shelley ledger integration in the Ouroboros consensus layer
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Shelley.Ledger.Config

Synopsis

Documentation

data family BlockConfig blk Source #

Static configuration required to work with this type of blocks

Instances

Instances details
ShelleyBasedEra era ⇒ Show (BlockConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Methods

showsPrecIntBlockConfig (ShelleyBlock proto era) → ShowS Source #

showBlockConfig (ShelleyBlock proto era) → String Source #

showList ∷ [BlockConfig (ShelleyBlock proto era)] → ShowS Source #

Generic (BlockConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Associated Types

type Rep (BlockConfig (ShelleyBlock proto era)) ∷ TypeType Source #

Methods

fromBlockConfig (ShelleyBlock proto era) → Rep (BlockConfig (ShelleyBlock proto era)) x Source #

toRep (BlockConfig (ShelleyBlock proto era)) x → BlockConfig (ShelleyBlock proto era) Source #

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

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

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

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

showTypeOfProxy (BlockConfig (HardForkBlock xs)) → String #

ShelleyBasedEra era ⇒ NoThunks (BlockConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Methods

noThunks ∷ Context → BlockConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → BlockConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

showTypeOfProxy (BlockConfig (ShelleyBlock proto era)) → String #

type Rep (BlockConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

type Rep (BlockConfig (ShelleyBlock proto era)) = D1 ('MetaData "BlockConfig" "Ouroboros.Consensus.Shelley.Ledger.Config" "ouroboros-consensus-shelley-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "shelleyProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtVer) :*: S1 ('MetaSel ('Just "shelleySystemStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SystemStart)) :*: (S1 ('MetaSel ('Just "shelleyNetworkMagic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NetworkMagic) :*: S1 ('MetaSel ('Just "shelleyBlockIssuerVKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'BlockIssuer (EraCrypto era)) (VKey 'BlockIssuer (EraCrypto era)))))))
newtype BlockConfig (HardForkBlock xs) 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

data BlockConfig (ShelleyBlock proto era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

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
Generic (CodecConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Associated Types

type Rep (CodecConfig (ShelleyBlock proto era)) ∷ TypeType Source #

Methods

fromCodecConfig (ShelleyBlock proto era) → Rep (CodecConfig (ShelleyBlock proto era)) x Source #

toRep (CodecConfig (ShelleyBlock proto era)) x → CodecConfig (ShelleyBlock proto era) Source #

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

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

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

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

showTypeOfProxy (CodecConfig (HardForkBlock xs)) → String #

NoThunks (CodecConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Methods

noThunks ∷ Context → CodecConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → CodecConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

showTypeOfProxy (CodecConfig (ShelleyBlock proto era)) → String #

type Rep (CodecConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

type Rep (CodecConfig (ShelleyBlock proto era)) = D1 ('MetaData "CodecConfig" "Ouroboros.Consensus.Shelley.Ledger.Config" "ouroboros-consensus-shelley-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyCodecConfig" 'PrefixI 'False) (U1TypeType))
newtype CodecConfig (HardForkBlock xs) 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

data CodecConfig (ShelleyBlock proto era) Source #

No particular codec configuration is needed for Shelley

Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

data family StorageConfig blk Source #

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

Instances

Instances details
Generic (StorageConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Associated Types

type Rep (StorageConfig (ShelleyBlock proto era)) ∷ TypeType Source #

Methods

fromStorageConfig (ShelleyBlock proto era) → Rep (StorageConfig (ShelleyBlock proto era)) x Source #

toRep (StorageConfig (ShelleyBlock proto era)) x → StorageConfig (ShelleyBlock proto era) Source #

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

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

Methods

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

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

showTypeOfProxy (StorageConfig (HardForkBlock xs)) → String #

NoThunks (StorageConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Methods

noThunks ∷ Context → StorageConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → StorageConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

showTypeOfProxy (StorageConfig (ShelleyBlock proto era)) → String #

type Rep (StorageConfig (ShelleyBlock proto era)) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

type Rep (StorageConfig (ShelleyBlock proto era)) = D1 ('MetaData "StorageConfig" "Ouroboros.Consensus.Shelley.Ledger.Config" "ouroboros-consensus-shelley-0.1.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyStorageConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "shelleyStorageConfigSlotsPerKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "shelleyStorageConfigSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam)))
newtype StorageConfig (HardForkBlock xs) 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

data StorageConfig (ShelleyBlock proto era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

mkShelleyBlockConfigShelleyBasedEra era ⇒ ProtVerShelleyGenesis era → [VKey 'BlockIssuer (EraCrypto era)] → BlockConfig (ShelleyBlock proto era) Source #

opaque

data CompactGenesis era Source #

Compact variant of ShelleyGenesis with some fields erased that are only used on start-up and that should not be kept in memory forever.

Concretely:

  • The sgInitialFunds field is erased. It is only used to set up the initial UTxO in tests and testnets.
  • The sgStaking field is erased. It is only used to register initial stake pools in tests and benchmarks.

Instances

Instances details
Eq (CompactGenesis era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Show (CompactGenesis era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Generic (CompactGenesis era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Associated Types

type Rep (CompactGenesis era) ∷ TypeType Source #

Methods

fromCompactGenesis era → Rep (CompactGenesis era) x Source #

toRep (CompactGenesis era) x → CompactGenesis era Source #

ShelleyBasedEra era ⇒ NoThunks (CompactGenesis era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Methods

noThunks ∷ Context → CompactGenesis era → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → CompactGenesis era → IO (Maybe ThunkInfo) #

showTypeOfProxy (CompactGenesis era) → String #

Era era ⇒ FromCBOR (CompactGenesis era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Methods

fromCBOR ∷ Decoder s (CompactGenesis era)

labelProxy (CompactGenesis era) → Text

Era era ⇒ ToCBOR (CompactGenesis era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

Methods

toCBORCompactGenesis era → Encoding

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (CompactGenesis era) → Size

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [CompactGenesis era] → Size

type Rep (CompactGenesis era) Source # 
Instance details

Defined in Ouroboros.Consensus.Shelley.Ledger.Config

type Rep (CompactGenesis era) = D1 ('MetaData "CompactGenesis" "Ouroboros.Consensus.Shelley.Ledger.Config" "ouroboros-consensus-shelley-0.1.0.0-inplace" 'True) (C1 ('MetaCons "CompactGenesis" 'PrefixI 'True) (S1 ('MetaSel ('Just "getCompactGenesis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ShelleyGenesis era))))

Orphan instances

ShelleyBasedEra era ⇒ Show (BlockConfig (ShelleyBlock proto era)) Source # 
Instance details

Methods

showsPrecIntBlockConfig (ShelleyBlock proto era) → ShowS Source #

showBlockConfig (ShelleyBlock proto era) → String Source #

showList ∷ [BlockConfig (ShelleyBlock proto era)] → ShowS Source #

Generic (BlockConfig (ShelleyBlock proto era)) Source # 
Instance details

Associated Types

type Rep (BlockConfig (ShelleyBlock proto era)) ∷ TypeType Source #

Methods

fromBlockConfig (ShelleyBlock proto era) → Rep (BlockConfig (ShelleyBlock proto era)) x Source #

toRep (BlockConfig (ShelleyBlock proto era)) x → BlockConfig (ShelleyBlock proto era) Source #

Generic (CodecConfig (ShelleyBlock proto era)) Source # 
Instance details

Associated Types

type Rep (CodecConfig (ShelleyBlock proto era)) ∷ TypeType Source #

Methods

fromCodecConfig (ShelleyBlock proto era) → Rep (CodecConfig (ShelleyBlock proto era)) x Source #

toRep (CodecConfig (ShelleyBlock proto era)) x → CodecConfig (ShelleyBlock proto era) Source #

Generic (StorageConfig (ShelleyBlock proto era)) Source # 
Instance details

Associated Types

type Rep (StorageConfig (ShelleyBlock proto era)) ∷ TypeType Source #

Methods

fromStorageConfig (ShelleyBlock proto era) → Rep (StorageConfig (ShelleyBlock proto era)) x Source #

toRep (StorageConfig (ShelleyBlock proto era)) x → StorageConfig (ShelleyBlock proto era) Source #

ShelleyBasedEra era ⇒ NoThunks (BlockConfig (ShelleyBlock proto era)) Source # 
Instance details

Methods

noThunks ∷ Context → BlockConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → BlockConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

showTypeOfProxy (BlockConfig (ShelleyBlock proto era)) → String #

NoThunks (CodecConfig (ShelleyBlock proto era)) Source # 
Instance details

Methods

noThunks ∷ Context → CodecConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → CodecConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

showTypeOfProxy (CodecConfig (ShelleyBlock proto era)) → String #

NoThunks (StorageConfig (ShelleyBlock proto era)) Source # 
Instance details

Methods

noThunks ∷ Context → StorageConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

wNoThunks ∷ Context → StorageConfig (ShelleyBlock proto era) → IO (Maybe ThunkInfo) #

showTypeOfProxy (StorageConfig (ShelleyBlock proto era)) → String #