Safe Haskell	None
Language	Haskell2010

Cardano.Api.Shelley.Genesis

Synopsis

data ShelleyGenesis era = ShelleyGenesis {
- sgSystemStart ∷ !UTCTime
- sgNetworkMagic ∷ !Word32
- sgNetworkId ∷ !Network
- sgActiveSlotsCoeff ∷ !PositiveUnitInterval
- 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 (Crypto era)) Coin)
- sgStaking ∷ !(ShelleyGenesisStaking (Crypto era))
}
shelleyGenesisDefaults ∷ ShelleyGenesis crypto

Documentation

data ShelleyGenesis era #

Constructors

ShelleyGenesis

Fields

sgSystemStart ∷ !UTCTime
sgNetworkMagic ∷ !Word32
sgNetworkId ∷ !Network
sgActiveSlotsCoeff ∷ !PositiveUnitInterval
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 (Crypto era)) Coin)
sgStaking ∷ !(ShelleyGenesisStaking (Crypto era))

Instances

Instances details

Eq (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods (==) ∷ ShelleyGenesis era → ShelleyGenesis era → Bool Source # (/=) ∷ ShelleyGenesis era → ShelleyGenesis era → Bool Source #
Show (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods showsPrec ∷ Int → ShelleyGenesis era → ShowS Source # show ∷ ShelleyGenesis era → String Source # showList ∷ [ShelleyGenesis era] → ShowS Source #
Generic (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Associated Types type Rep (ShelleyGenesis era) ∷ Type → Type Source # Methods from ∷ ShelleyGenesis era → Rep (ShelleyGenesis era) x Source # to ∷ Rep (ShelleyGenesis era) x → ShelleyGenesis era Source #
Era era ⇒ FromJSON (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods parseJSON ∷ Value → Parser (ShelleyGenesis era) # parseJSONList ∷ Value → Parser [ShelleyGenesis era] #
Era era ⇒ NoThunks (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods noThunks ∷ Context → ShelleyGenesis era → IO (Maybe ThunkInfo) wNoThunks ∷ Context → ShelleyGenesis era → IO (Maybe ThunkInfo) showTypeOf ∷ Proxy (ShelleyGenesis era) → String
Era era ⇒ ToJSON (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods toJSON ∷ ShelleyGenesis era → Value # toEncoding ∷ ShelleyGenesis era → Encoding # toJSONList ∷ [ShelleyGenesis era] → Value # toEncodingList ∷ [ShelleyGenesis era] → Encoding #
Era era ⇒ FromCBOR (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods fromCBOR ∷ Decoder s (ShelleyGenesis era) # label ∷ Proxy (ShelleyGenesis era) → Text #
Era era ⇒ ToCBOR (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods toCBOR ∷ ShelleyGenesis era → Encoding # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (ShelleyGenesis era) → Size # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ShelleyGenesis era] → Size #
type Rep (ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.Genesis type Rep (ShelleyGenesis era) = D1 ('MetaData "ShelleyGenesis" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-0.1.0.0-00c41dc5811f2db214dc4d57f89c154c84197f8eafd467a35fe42b93b2889f86" '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 PositiveUnitInterval) :: 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 (Crypto era)) Coin)) :: S1 ('MetaSel ('Just "sgStaking") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ShelleyGenesisStaking (Crypto era))))))))
type TranslationError (AlonzoEra c) ShelleyGenesis
Instance details Defined in Cardano.Ledger.Alonzo.Translation type TranslationError (AlonzoEra c) ShelleyGenesis = Void
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.