Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Chain.Genesis.Config

Synopsis

data Config = Config {
- configGenesisData ∷ !GenesisData
- configGenesisHash ∷ !GenesisHash
- configReqNetMagic ∷ !RequiresNetworkMagic
- configUTxOConfiguration ∷ !UTxOConfiguration
}
data ConfigurationError
configGenesisHeaderHash ∷ Config → HeaderHash
configK ∷ Config → BlockCount
configSlotSecurityParam ∷ Config → SlotCount
configChainQualityThreshold ∷ Fractional f ⇒ Config → f
configEpochSlots ∷ Config → EpochSlots
configProtocolMagic ∷ Config → ProtocolMagic
configProtocolMagicId ∷ Config → ProtocolMagicId
configGenesisKeyHashes ∷ Config → GenesisKeyHashes
configHeavyDelegation ∷ Config → GenesisDelegation
configStartTime ∷ Config → UTCTime
configNonAvvmBalances ∷ Config → GenesisNonAvvmBalances
configProtocolParameters ∷ Config → ProtocolParameters
configAvvmDistr ∷ Config → GenesisAvvmBalances
mkConfigFromFile ∷ (MonadError ConfigurationError m, MonadIO m) ⇒ RequiresNetworkMagic → FilePath → Hash Raw → m Config

Documentation

data Config Source #

Constructors

Config
Fields configGenesisData ∷ !GenesisData The data needed at genesis configGenesisHash ∷ !GenesisHash The hash of the canonical JSON representation of the `GenesisData` configReqNetMagic ∷ !RequiresNetworkMagic Differentiates between Testnet and Mainet/Staging configUTxOConfiguration ∷ !UTxOConfiguration Extra local data used in UTxO validation rules

Instances

Instances details

Generic Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Associated Types type Rep Config ∷ Type → Type Source # Methods from ∷ Config → Rep Config x Source # to ∷ Rep Config x → Config Source #
Show Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods showsPrec ∷ Int → Config → ShowS Source # show ∷ Config → String Source # showList ∷ [Config] → ShowS Source #
FromCBOR Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods fromCBOR ∷ Decoder s Config Source # label ∷ Proxy Config → Text Source #
ToCBOR Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods toCBOR ∷ Config → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Config → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Config] → Size Source #
DecCBOR Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods decCBOR ∷ Decoder s Config Source # dropCBOR ∷ Proxy Config → Decoder s () Source # label ∷ Proxy Config → Text Source #
EncCBOR Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods encCBOR ∷ Config → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy Config → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Config] → Size Source #
Eq Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods (==) ∷ Config → Config → Bool Source # (/=) ∷ Config → Config → Bool Source #
NoThunks Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods noThunks ∷ Context → Config → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Config → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy Config → String Source #
type Rep Config Source #
Instance details Defined in Cardano.Chain.Genesis.Config type Rep Config = D1 ('MetaData "Config" "Cardano.Chain.Genesis.Config" "cardano-ledger-byron-1.0.1.0-inplace" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configGenesisData") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GenesisData) :: S1 ('MetaSel ('Just "configGenesisHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GenesisHash)) :: (S1 ('MetaSel ('Just "configReqNetMagic") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RequiresNetworkMagic) :*: S1 ('MetaSel ('Just "configUTxOConfiguration") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTxOConfiguration))))

data ConfigurationError Source #

Constructors

ConfigurationGenesisDataError GenesisDataError	An error in constructing `GenesisData`
GenesisHashMismatch GenesisHash (Hash Raw)	The GenesisData canonical JSON hash is different than expected
GenesisHashDecodeError Text	An error occured while decoding the genesis hash.

Instances

Instances details

Show ConfigurationError Source #
Instance details Defined in Cardano.Chain.Genesis.Config Methods showsPrec ∷ Int → ConfigurationError → ShowS Source # show ∷ ConfigurationError → String Source # showList ∷ [ConfigurationError] → ShowS Source #

configGenesisHeaderHash ∷ Config → HeaderHash Source #

configK ∷ Config → BlockCount Source #

configSlotSecurityParam ∷ Config → SlotCount Source #

configChainQualityThreshold ∷ Fractional f ⇒ Config → f Source #

configEpochSlots ∷ Config → EpochSlots Source #

configProtocolMagic ∷ Config → ProtocolMagic Source #

There isn't a full ProtocolMagic in Config, but the requisite ProtocolMagicId and RequiresNetworkMagic are stored separately. We use them to construct and return a ProtocolMagic.

configProtocolMagicId ∷ Config → ProtocolMagicId Source #

configGenesisKeyHashes ∷ Config → GenesisKeyHashes Source #

configHeavyDelegation ∷ Config → GenesisDelegation Source #

configStartTime ∷ Config → UTCTime Source #

configNonAvvmBalances ∷ Config → GenesisNonAvvmBalances Source #

configProtocolParameters ∷ Config → ProtocolParameters Source #

configAvvmDistr ∷ Config → GenesisAvvmBalances Source #

mkConfigFromFile Source #

Arguments

∷ (MonadError ConfigurationError m, MonadIO m)
⇒ RequiresNetworkMagic
→ FilePath
→ Hash Raw	The expected hash of the file
→ m Config

Construct a Config from an external genesis file.

The FilePath refers to a canonical JSON file. It will be hashed and checked against the expected hash, which should be known from config.