Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Shelley.Ledger.Config

Contents

Orphan instances

Synopsis

data family BlockConfig blk
mkShelleyBlockConfig :: ShelleyBasedEra era => ProtVer -> ShelleyGenesis era -> [VKey 'BlockIssuer (EraCrypto era)] -> BlockConfig (ShelleyBlock era)
data family CodecConfig blk
data family StorageConfig blk
data CompactGenesis era
getCompactGenesis :: CompactGenesis era -> ShelleyGenesis era
compactGenesis :: ShelleyGenesis era -> CompactGenesis era

Documentation

data family BlockConfig blk Source #

Static configuration required to work with this type of blocks

Instances

Instances details

ShelleyBasedEra era => Show (BlockConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods showsPrec :: Int -> BlockConfig (ShelleyBlock era) -> ShowS # show :: BlockConfig (ShelleyBlock era) -> String # showList :: [BlockConfig (ShelleyBlock era)] -> ShowS #
Generic (BlockConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Associated Types type Rep (BlockConfig (ShelleyBlock era)) :: Type -> Type # Methods from :: BlockConfig (ShelleyBlock era) -> Rep (BlockConfig (ShelleyBlock era)) x # to :: Rep (BlockConfig (ShelleyBlock era)) x -> BlockConfig (ShelleyBlock era) #
ShelleyBasedEra era => NoThunks (BlockConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods noThunks :: Context -> BlockConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> BlockConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (BlockConfig (ShelleyBlock era)) -> String Source #
type Rep (BlockConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config type Rep (BlockConfig (ShelleyBlock era)) = D1 ('MetaData "BlockConfig" "Ouroboros.Consensus.Shelley.Ledger.Config" "ouroboros-consensus-shelley-0.1.0.0-59swnF21REM9YduArUJWll" '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)))))))
data BlockConfig (ShelleyBlock era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config data BlockConfig (ShelleyBlock era) = ShelleyConfig { shelleyProtocolVersion :: !ProtVer shelleySystemStart :: !SystemStart shelleyNetworkMagic :: !NetworkMagic shelleyBlockIssuerVKeys :: !(Map (KeyHash 'BlockIssuer (EraCrypto era)) (VKey 'BlockIssuer (EraCrypto era))) }

mkShelleyBlockConfig :: ShelleyBasedEra era => ProtVer -> ShelleyGenesis era -> [VKey 'BlockIssuer (EraCrypto era)] -> BlockConfig (ShelleyBlock era) Source #

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 era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Associated Types type Rep (CodecConfig (ShelleyBlock era)) :: Type -> Type # Methods from :: CodecConfig (ShelleyBlock era) -> Rep (CodecConfig (ShelleyBlock era)) x # to :: Rep (CodecConfig (ShelleyBlock era)) x -> CodecConfig (ShelleyBlock era) #
NoThunks (CodecConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods noThunks :: Context -> CodecConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> CodecConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (CodecConfig (ShelleyBlock era)) -> String Source #
type Rep (CodecConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config type Rep (CodecConfig (ShelleyBlock era)) = D1 ('MetaData "CodecConfig" "Ouroboros.Consensus.Shelley.Ledger.Config" "ouroboros-consensus-shelley-0.1.0.0-59swnF21REM9YduArUJWll" 'False) (C1 ('MetaCons "ShelleyCodecConfig" 'PrefixI 'False) (U1 :: Type -> Type))
data CodecConfig (ShelleyBlock era) Source #	No particular codec configuration is needed for Shelley
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config data CodecConfig (ShelleyBlock era) = ShelleyCodecConfig

data family StorageConfig blk Source #

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

Instances

Instances details

Generic (StorageConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Associated Types type Rep (StorageConfig (ShelleyBlock era)) :: Type -> Type # Methods from :: StorageConfig (ShelleyBlock era) -> Rep (StorageConfig (ShelleyBlock era)) x # to :: Rep (StorageConfig (ShelleyBlock era)) x -> StorageConfig (ShelleyBlock era) #
NoThunks (StorageConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods noThunks :: Context -> StorageConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> StorageConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (StorageConfig (ShelleyBlock era)) -> String Source #
type Rep (StorageConfig (ShelleyBlock era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config type Rep (StorageConfig (ShelleyBlock era)) = D1 ('MetaData "StorageConfig" "Ouroboros.Consensus.Shelley.Ledger.Config" "ouroboros-consensus-shelley-0.1.0.0-59swnF21REM9YduArUJWll" 'False) (C1 ('MetaCons "ShelleyStorageConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "shelleyStorageConfigSlotsPerKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "shelleyStorageConfigSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam)))
data StorageConfig (ShelleyBlock era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config data StorageConfig (ShelleyBlock era) = ShelleyStorageConfig { shelleyStorageConfigSlotsPerKESPeriod :: !Word64 shelleyStorageConfigSecurityParam :: !SecurityParam }

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 Methods (==) :: CompactGenesis era -> CompactGenesis era -> Bool # (/=) :: CompactGenesis era -> CompactGenesis era -> Bool #
Show (CompactGenesis era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods showsPrec :: Int -> CompactGenesis era -> ShowS # show :: CompactGenesis era -> String # showList :: [CompactGenesis era] -> ShowS #
Generic (CompactGenesis era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Associated Types type Rep (CompactGenesis era) :: Type -> Type # Methods from :: CompactGenesis era -> Rep (CompactGenesis era) x # to :: Rep (CompactGenesis era) x -> CompactGenesis era #
Era era => ToCBOR (CompactGenesis era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods toCBOR :: CompactGenesis era -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (CompactGenesis era) -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [CompactGenesis era] -> Size Source #
Era era => FromCBOR (CompactGenesis era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods fromCBOR :: Decoder s (CompactGenesis era) Source # label :: Proxy (CompactGenesis era) -> Text Source #
ShelleyBasedEra era => NoThunks (CompactGenesis era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Config Methods noThunks :: Context -> CompactGenesis era -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> CompactGenesis era -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (CompactGenesis era) -> String Source #
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-59swnF21REM9YduArUJWll" 'True) (C1 ('MetaCons "CompactGenesis" 'PrefixI 'True) (S1 ('MetaSel ('Just "getCompactGenesis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ShelleyGenesis era))))

getCompactGenesis :: CompactGenesis era -> ShelleyGenesis era Source #

compactGenesis :: ShelleyGenesis era -> CompactGenesis era Source #

Compacts the given ShelleyGenesis.

Orphan instances

ShelleyBasedEra era => Show (BlockConfig (ShelleyBlock era)) Source #
Instance details Methods showsPrec :: Int -> BlockConfig (ShelleyBlock era) -> ShowS # show :: BlockConfig (ShelleyBlock era) -> String # showList :: [BlockConfig (ShelleyBlock era)] -> ShowS #
Generic (BlockConfig (ShelleyBlock era)) Source #
Instance details Associated Types type Rep (BlockConfig (ShelleyBlock era)) :: Type -> Type # Methods from :: BlockConfig (ShelleyBlock era) -> Rep (BlockConfig (ShelleyBlock era)) x # to :: Rep (BlockConfig (ShelleyBlock era)) x -> BlockConfig (ShelleyBlock era) #
Generic (CodecConfig (ShelleyBlock era)) Source #
Instance details Associated Types type Rep (CodecConfig (ShelleyBlock era)) :: Type -> Type # Methods from :: CodecConfig (ShelleyBlock era) -> Rep (CodecConfig (ShelleyBlock era)) x # to :: Rep (CodecConfig (ShelleyBlock era)) x -> CodecConfig (ShelleyBlock era) #
Generic (StorageConfig (ShelleyBlock era)) Source #
Instance details Associated Types type Rep (StorageConfig (ShelleyBlock era)) :: Type -> Type # Methods from :: StorageConfig (ShelleyBlock era) -> Rep (StorageConfig (ShelleyBlock era)) x # to :: Rep (StorageConfig (ShelleyBlock era)) x -> StorageConfig (ShelleyBlock era) #
ShelleyBasedEra era => NoThunks (BlockConfig (ShelleyBlock era)) Source #
Instance details Methods noThunks :: Context -> BlockConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> BlockConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (BlockConfig (ShelleyBlock era)) -> String Source #
NoThunks (CodecConfig (ShelleyBlock era)) Source #
Instance details Methods noThunks :: Context -> CodecConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> CodecConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (CodecConfig (ShelleyBlock era)) -> String Source #
NoThunks (StorageConfig (ShelleyBlock era)) Source #
Instance details Methods noThunks :: Context -> StorageConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> StorageConfig (ShelleyBlock era) -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (StorageConfig (ShelleyBlock era)) -> String Source #