Safe Haskell	None
Language	Haskell2010

Cardano.Api.Shelley.Genesis

Synopsis

data ShelleyGenesis era = ShelleyGenesis {
- sgSystemStart :: !UTCTime
- sgNetworkMagic :: !Word32
- sgNetworkId :: !Network
- sgActiveSlotsCoeff :: !Rational
- sgSecurityParam :: !Word64
- sgEpochLength :: !EpochSize
- sgSlotsPerKESPeriod :: !Word64
- sgMaxKESEvolutions :: !Word64
- sgSlotLength :: !NominalDiffTime
- sgUpdateQuorum :: !Word64
- sgMaxLovelaceSupply :: !Word64
- sgProtocolParams :: !(PParams era)
- sgGenDelegs :: !(Map (KeyHash 'Genesis (Crypto era)) (GenDelegPair (Crypto era)))
- sgInitialFunds :: !(Map (Addr era) Coin)
- sgStaking :: !(ShelleyGenesisStaking era)
}
shelleyGenesisDefaults :: ShelleyGenesis crypto

Documentation

data ShelleyGenesis era Source #

Shelley genesis information

Note that this is needed only for a pure Shelley network, hence it being defined here rather than in its own module. In mainnet, Shelley will transition naturally from Byron, and thus will never have its own genesis information.

Constructors

ShelleyGenesis

Fields

sgSystemStart :: !UTCTime
sgNetworkMagic :: !Word32
sgNetworkId :: !Network
sgActiveSlotsCoeff :: !Rational
sgSecurityParam :: !Word64
sgEpochLength :: !EpochSize
sgSlotsPerKESPeriod :: !Word64
sgMaxKESEvolutions :: !Word64
sgSlotLength :: !NominalDiffTime
sgUpdateQuorum :: !Word64
sgMaxLovelaceSupply :: !Word64
sgProtocolParams :: !(PParams era)
sgGenDelegs :: !(Map (KeyHash 'Genesis (Crypto era)) (GenDelegPair (Crypto era)))
sgInitialFunds :: !(Map (Addr era) Coin)
sgStaking :: !(ShelleyGenesisStaking era)

Instances

Instances details

Eq (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Methods (==) :: ShelleyGenesis era -> ShelleyGenesis era -> Bool # (/=) :: ShelleyGenesis era -> ShelleyGenesis era -> Bool #
Show (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Methods showsPrec :: Int -> ShelleyGenesis era -> ShowS # show :: ShelleyGenesis era -> String # showList :: [ShelleyGenesis era] -> ShowS #
Generic (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Associated Types type Rep (ShelleyGenesis era) :: Type -> Type # Methods from :: ShelleyGenesis era -> Rep (ShelleyGenesis era) x # to :: Rep (ShelleyGenesis era) x -> ShelleyGenesis era #
Era era => ToJSON (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Methods toJSON :: ShelleyGenesis era -> Value Source # toEncoding :: ShelleyGenesis era -> Encoding Source # toJSONList :: [ShelleyGenesis era] -> Value Source # toEncodingList :: [ShelleyGenesis era] -> Encoding Source #
Era era => FromJSON (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Methods parseJSON :: Value -> Parser (ShelleyGenesis era) Source # parseJSONList :: Value -> Parser [ShelleyGenesis era] Source #
Era era => ToCBOR (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Methods toCBOR :: ShelleyGenesis era -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (ShelleyGenesis era) -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ShelleyGenesis era] -> Size Source #
Era era => FromCBOR (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Methods fromCBOR :: Decoder s (ShelleyGenesis era) Source # label :: Proxy (ShelleyGenesis era) -> Text Source #
Era era => NoThunks (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis Methods noThunks :: Context -> ShelleyGenesis era -> IO (Maybe ThunkInfo) Source # wNoThunks :: Context -> ShelleyGenesis era -> IO (Maybe ThunkInfo) Source # showTypeOf :: Proxy (ShelleyGenesis era) -> String Source #
type Rep (ShelleyGenesis era)
Instance details Defined in Shelley.Spec.Ledger.Genesis type Rep (ShelleyGenesis era) = D1 ('MetaData "ShelleyGenesis" "Shelley.Spec.Ledger.Genesis" "shelley-spec-ledger-0.1.0.0-92kyZKZr7Mp7w3ug0LA6KH" 'False) (C1 ('MetaCons "ShelleyGenesis" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sgSystemStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :: (S1 ('MetaSel ('Just "sgNetworkMagic") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word32) :: S1 ('MetaSel ('Just "sgNetworkId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Network))) :: ((S1 ('MetaSel ('Just "sgActiveSlotsCoeff") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Rational) :: S1 ('MetaSel ('Just "sgSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64)) :: (S1 ('MetaSel ('Just "sgEpochLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 EpochSize) :: S1 ('MetaSel ('Just "sgSlotsPerKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64)))) :: (((S1 ('MetaSel ('Just "sgMaxKESEvolutions") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64) :: S1 ('MetaSel ('Just "sgSlotLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NominalDiffTime)) :: (S1 ('MetaSel ('Just "sgUpdateQuorum") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64) :: S1 ('MetaSel ('Just "sgMaxLovelaceSupply") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64))) :: ((S1 ('MetaSel ('Just "sgProtocolParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era)) :: S1 ('MetaSel ('Just "sgGenDelegs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'Genesis (Crypto era)) (GenDelegPair (Crypto era))))) :: (S1 ('MetaSel ('Just "sgInitialFunds") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Addr era) Coin)) :: S1 ('MetaSel ('Just "sgStaking") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ShelleyGenesisStaking era)))))))
type TranslationError (AllegraEra c) ShelleyGenesis
Instance details Defined in Cardano.Ledger.Allegra.Translation type TranslationError (AllegraEra c) ShelleyGenesis = Void
type TranslationError (MaryEra c) ShelleyGenesis
Instance details Defined in Cardano.Ledger.Mary.Translation type TranslationError (MaryEra c) ShelleyGenesis = Void

shelleyGenesisDefaults :: ShelleyGenesis crypto Source #

Some reasonable starting defaults for constructing a ShelleyGenesis.

You must override at least the following fields for this to be useful:

sgSystemStart the time of the first block
sgNetworkMagic to a suitable testnet or mainnet network magic number.
sgGenDelegs to have some initial nodes
sgInitialFunds to have any money in the system
sgMaxLovelaceSupply must be at least the sum of the sgInitialFunds but more if you want to allow for rewards.