Safe Haskell	None
Language	Haskell2010

Cardano.Api.Genesis

Contents

Configuration
Files

Synopsis

data ShelleyGenesis c = ShelleyGenesis {
- sgSystemStart :: !UTCTime
- sgNetworkMagic :: !Word32
- sgNetworkId :: !Network
- sgActiveSlotsCoeff :: !PositiveUnitInterval
- sgSecurityParam :: !Word64
- sgEpochLength :: !EpochSize
- sgSlotsPerKESPeriod :: !Word64
- sgMaxKESEvolutions :: !Word64
- sgSlotLength :: !NominalDiffTimeMicro
- sgUpdateQuorum :: !Word64
- sgMaxLovelaceSupply :: !Word64
- sgProtocolParams :: !(PParams (ShelleyEra c))
- sgGenDelegs :: !(Map (KeyHash 'Genesis c) (GenDelegPair c))
- sgInitialFunds :: ListMap (Addr c) Coin
- sgStaking :: ShelleyGenesisStaking c
}
shelleyGenesisDefaults :: ShelleyGenesis StandardCrypto
type ByronGenesisConfig = Config
type ShelleyGenesisConfig = ShelleyConfig
type AlonzoGenesisConfig = AlonzoGenesis
type ConwayGenesisConfig = ConwayGenesis StandardCrypto
data ShelleyConfig = ShelleyConfig {
- scConfig :: !(ShelleyGenesis StandardCrypto)
- scGenesisHash :: !GenesisHashShelley
}
newtype GenesisHashByron = GenesisHashByron {
- unGenesisHashByron :: Text
}
newtype GenesisHashShelley = GenesisHashShelley {
- unGenesisHashShelley :: Hash Blake2b_256 ByteString
}
newtype GenesisHashAlonzo = GenesisHashAlonzo {
- unGenesisHashAlonzo :: Hash Blake2b_256 ByteString
}
newtype GenesisHashConway = GenesisHashConway {
- unGenesisHashConway :: Hash Blake2b_256 ByteString
}
type ByronGenesisFile = File ByronGenesisConfig
type ShelleyGenesisFile = File ShelleyGenesisConfig
type AlonzoGenesisFile = File AlonzoGenesisConfig
type ConwayGenesisFile = File ConwayGenesisConfig

Documentation

data ShelleyGenesis c #

Constructors

ShelleyGenesis

Fields

sgSystemStart :: !UTCTime
sgNetworkMagic :: !Word32
sgNetworkId :: !Network
sgActiveSlotsCoeff :: !PositiveUnitInterval
sgSecurityParam :: !Word64
sgEpochLength :: !EpochSize
sgSlotsPerKESPeriod :: !Word64
sgMaxKESEvolutions :: !Word64
sgSlotLength :: !NominalDiffTimeMicro
sgUpdateQuorum :: !Word64
sgMaxLovelaceSupply :: !Word64
sgProtocolParams :: !(PParams (ShelleyEra c))
sgGenDelegs :: !(Map (KeyHash 'Genesis c) (GenDelegPair c))
sgInitialFunds :: ListMap (Addr c) Coin
sgStaking :: ShelleyGenesisStaking c

Instances

Instances details

Crypto c => Eq (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods (==) :: ShelleyGenesis c -> ShelleyGenesis c -> Bool Source # (/=) :: ShelleyGenesis c -> ShelleyGenesis c -> Bool Source #
Crypto c => Show (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods showsPrec :: Int -> ShelleyGenesis c -> ShowS Source # show :: ShelleyGenesis c -> String Source # showList :: [ShelleyGenesis c] -> ShowS Source #
Generic (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Associated Types type Rep (ShelleyGenesis c) :: Type -> Type Source # Methods from :: ShelleyGenesis c -> Rep (ShelleyGenesis c) x Source # to :: Rep (ShelleyGenesis c) x -> ShelleyGenesis c Source #
Crypto c => DecCBOR (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods decCBOR :: Decoder s (ShelleyGenesis c) dropCBOR :: Proxy (ShelleyGenesis c) -> Decoder s () label :: Proxy (ShelleyGenesis c) -> Text
Crypto c => EncCBOR (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods encCBOR :: ShelleyGenesis c -> Encoding encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy (ShelleyGenesis c) -> Size encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [ShelleyGenesis c] -> Size
Crypto c => FromCBOR (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods fromCBOR :: Decoder s (ShelleyGenesis c) # label :: Proxy (ShelleyGenesis c) -> Text #
Crypto c => FromJSON (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods parseJSON :: Value -> Parser (ShelleyGenesis c) # parseJSONList :: Value -> Parser [ShelleyGenesis c] # omittedField :: Maybe (ShelleyGenesis c) #
Crypto c => NoThunks (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods noThunks :: Context -> ShelleyGenesis c -> IO (Maybe ThunkInfo) wNoThunks :: Context -> ShelleyGenesis c -> IO (Maybe ThunkInfo) showTypeOf :: Proxy (ShelleyGenesis c) -> String
Crypto c => ToCBOR (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods toCBOR :: ShelleyGenesis c -> Encoding # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (ShelleyGenesis c) -> Size # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ShelleyGenesis c] -> Size #
Crypto c => ToJSON (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods toJSON :: ShelleyGenesis c -> Value # toEncoding :: ShelleyGenesis c -> Encoding # toJSONList :: [ShelleyGenesis c] -> Value # toEncodingList :: [ShelleyGenesis c] -> Encoding # omitField :: ShelleyGenesis c -> Bool #
type Rep (ShelleyGenesis c)
Instance details Defined in Cardano.Ledger.Shelley.Genesis type Rep (ShelleyGenesis c) = D1 ('MetaData "ShelleyGenesis" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-1.8.0.0-8zSwDh4GiF3HDtP87S8Ej2" '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 NominalDiffTimeMicro)) :: (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 (ShelleyEra c))) :: S1 ('MetaSel ('Just "sgGenDelegs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'Genesis c) (GenDelegPair c)))) :: (S1 ('MetaSel ('Just "sgInitialFunds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListMap (Addr c) Coin)) :: S1 ('MetaSel ('Just "sgStaking") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ShelleyGenesisStaking c)))))))

shelleyGenesisDefaults :: ShelleyGenesis StandardCrypto 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.

Configuration

type ByronGenesisConfig = Config Source #

type ShelleyGenesisConfig = ShelleyConfig Source #

type AlonzoGenesisConfig = AlonzoGenesis Source #

type ConwayGenesisConfig = ConwayGenesis StandardCrypto Source #

data ShelleyConfig Source #

Constructors

ShelleyConfig
Fields scConfig :: !(ShelleyGenesis StandardCrypto) scGenesisHash :: !GenesisHashShelley

newtype GenesisHashByron Source #

Constructors

GenesisHashByron
Fields unGenesisHashByron :: Text

Instances

Instances details

Eq GenesisHashByron Source #
Instance details Defined in Cardano.Api.Genesis Methods (==) :: GenesisHashByron -> GenesisHashByron -> Bool Source # (/=) :: GenesisHashByron -> GenesisHashByron -> Bool Source #
Show GenesisHashByron Source #
Instance details Defined in Cardano.Api.Genesis Methods showsPrec :: Int -> GenesisHashByron -> ShowS Source # show :: GenesisHashByron -> String Source # showList :: [GenesisHashByron] -> ShowS Source #

newtype GenesisHashShelley Source #

Constructors

GenesisHashShelley
Fields unGenesisHashShelley :: Hash Blake2b_256 ByteString

Instances

Instances details

Eq GenesisHashShelley Source #
Instance details Defined in Cardano.Api.Genesis Methods (==) :: GenesisHashShelley -> GenesisHashShelley -> Bool Source # (/=) :: GenesisHashShelley -> GenesisHashShelley -> Bool Source #
Show GenesisHashShelley Source #
Instance details Defined in Cardano.Api.Genesis Methods showsPrec :: Int -> GenesisHashShelley -> ShowS Source # show :: GenesisHashShelley -> String Source # showList :: [GenesisHashShelley] -> ShowS Source #

newtype GenesisHashAlonzo Source #

Constructors

GenesisHashAlonzo
Fields unGenesisHashAlonzo :: Hash Blake2b_256 ByteString

Instances

Instances details

Eq GenesisHashAlonzo Source #
Instance details Defined in Cardano.Api.Genesis Methods (==) :: GenesisHashAlonzo -> GenesisHashAlonzo -> Bool Source # (/=) :: GenesisHashAlonzo -> GenesisHashAlonzo -> Bool Source #
Show GenesisHashAlonzo Source #
Instance details Defined in Cardano.Api.Genesis Methods showsPrec :: Int -> GenesisHashAlonzo -> ShowS Source # show :: GenesisHashAlonzo -> String Source # showList :: [GenesisHashAlonzo] -> ShowS Source #

newtype GenesisHashConway Source #

Constructors

GenesisHashConway
Fields unGenesisHashConway :: Hash Blake2b_256 ByteString

Instances

Instances details

Eq GenesisHashConway Source #
Instance details Defined in Cardano.Api.Genesis Methods (==) :: GenesisHashConway -> GenesisHashConway -> Bool Source # (/=) :: GenesisHashConway -> GenesisHashConway -> Bool Source #
Show GenesisHashConway Source #
Instance details Defined in Cardano.Api.Genesis Methods showsPrec :: Int -> GenesisHashConway -> ShowS Source # show :: GenesisHashConway -> String Source # showList :: [GenesisHashConway] -> ShowS Source #

Files

type ByronGenesisFile = File ByronGenesisConfig Source #

type ShelleyGenesisFile = File ShelleyGenesisConfig Source #

type AlonzoGenesisFile = File AlonzoGenesisConfig Source #

type ConwayGenesisFile = File ConwayGenesisConfig Source #