Safe Haskell	None
Language	Haskell2010

Cardano.Api.Genesis

Contents

Configuration
Files
Protocol parameters fixed in the genesis file
Utilities

Synopsis

data ShelleyGenesis = ShelleyGenesis {
- sgSystemStart :: !UTCTime
- sgNetworkMagic :: !Word32
- sgNetworkId :: !Network
- sgActiveSlotsCoeff :: !PositiveUnitInterval
- sgSecurityParam :: !(NonZero Word64)
- sgEpochLength :: !EpochSize
- sgSlotsPerKESPeriod :: !Word64
- sgMaxKESEvolutions :: !Word64
- sgSlotLength :: !NominalDiffTimeMicro
- sgUpdateQuorum :: !Word64
- sgMaxLovelaceSupply :: !Word64
- sgProtocolParams :: !(PParams ShelleyEra)
- sgGenDelegs :: !(Map (KeyHash 'Genesis) GenDelegPair)
- sgInitialFunds :: ListMap Addr Coin
- sgStaking :: ShelleyGenesisStaking
}
shelleyGenesisDefaults :: ShelleyGenesis
alonzoGenesisDefaults :: CardanoEra era -> AlonzoGenesis
decodeAlonzoGenesis :: forall era t (m :: Type -> Type). MonadTransError String t m => Maybe (CardanoEra era) -> ByteString -> t m AlonzoGenesis
conwayGenesisDefaults :: ConwayGenesis
type ByronGenesisConfig = Config
type ShelleyGenesisConfig = ShelleyConfig
type AlonzoGenesisConfig = AlonzoGenesis
type ConwayGenesisConfig = ConwayGenesis
data ShelleyConfig = ShelleyConfig {
- scConfig :: !ShelleyGenesis
- 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
data GenesisParameters era = GenesisParameters {
- protocolParamSystemStart :: UTCTime
- protocolParamNetworkId :: NetworkId
- protocolParamActiveSlotsCoefficient :: Rational
- protocolParamSecurity :: NonZero Word64
- protocolParamEpochLength :: EpochSize
- protocolParamSlotLength :: NominalDiffTime
- protocolParamSlotsPerKESPeriod :: Int
- protocolParamMaxKESEvolutions :: Int
- protocolParamUpdateQuorum :: Int
- protocolParamMaxLovelaceSupply :: Coin
- protocolInitialUpdateableProtocolParameters :: PParams (ShelleyLedgerEra era)
}
newtype EpochSize = EpochSize {
- unEpochSize :: Word64
}
unsafeBoundedRational :: (HasCallStack, Typeable r, BoundedRational r) => Rational -> r

Documentation

data ShelleyGenesis 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 :: !PositiveUnitInterval
sgSecurityParam :: !(NonZero Word64)
sgEpochLength :: !EpochSize
sgSlotsPerKESPeriod :: !Word64
sgMaxKESEvolutions :: !Word64
sgSlotLength :: !NominalDiffTimeMicro
sgUpdateQuorum :: !Word64
sgMaxLovelaceSupply :: !Word64
sgProtocolParams :: !(PParams ShelleyEra)
sgGenDelegs :: !(Map (KeyHash 'Genesis) GenDelegPair)
sgInitialFunds :: ListMap Addr Coin
sgInitialFunds is intentionally kept lazy, as it can otherwise cause out-of-memory problems in testing and benchmarking.
sgStaking :: ShelleyGenesisStaking
sgStaking is intentionally kept lazy, as it can otherwise cause out-of-memory problems in testing and benchmarking.

Instances

Instances details

FromJSON ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

parseJSON :: Value -> Parser ShelleyGenesis #

parseJSONList :: Value -> Parser [ShelleyGenesis] #

omittedField :: Maybe ShelleyGenesis #

ToJSON ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toJSON :: ShelleyGenesis -> Value #

toEncoding :: ShelleyGenesis -> Encoding #

toJSONList :: [ShelleyGenesis] -> Value #

toEncodingList :: [ShelleyGenesis] -> Encoding #

omitField :: ShelleyGenesis -> Bool #

Generic ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Associated Types

type Rep ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

from :: ShelleyGenesis -> Rep ShelleyGenesis x Source #

to :: Rep ShelleyGenesis x -> ShelleyGenesis Source #

Show ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

showsPrec :: Int -> ShelleyGenesis -> ShowS Source #

show :: ShelleyGenesis -> String Source #

showList :: [ShelleyGenesis] -> ShowS Source #

FromCBOR ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

fromCBOR :: Decoder s ShelleyGenesis Source #

label :: Proxy ShelleyGenesis -> Text Source #

ToCBOR ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toCBOR :: ShelleyGenesis -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy ShelleyGenesis -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ShelleyGenesis] -> Size Source #

DecCBOR ShelleyGenesis

Genesis are always encoded with the version of era they are defined in.

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

decCBOR :: Decoder s ShelleyGenesis Source #

dropCBOR :: Proxy ShelleyGenesis -> Decoder s () Source #

label :: Proxy ShelleyGenesis -> Text Source #

EncCBOR ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

encCBOR :: ShelleyGenesis -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy ShelleyGenesis -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [ShelleyGenesis] -> Size Source #

Eq ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(==) :: ShelleyGenesis -> ShelleyGenesis -> Bool Source #

(/=) :: ShelleyGenesis -> ShelleyGenesis -> Bool Source #

NoThunks ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

noThunks :: Context -> ShelleyGenesis -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> ShelleyGenesis -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy ShelleyGenesis -> String #

type Rep ShelleyGenesis

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

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

alonzoGenesisDefaults :: CardanoEra era -> AlonzoGenesis Source #

Some reasonable starting defaults for constructing a AlonzoGenesis. Based on https://github.com/IntersectMBO/cardano-node/blob/master/cardano-testnet/src/Testnet/Defaults.hs The era determines Plutus V2 cost model parameters: * Conway: 185 * <= Babbage: 175

decodeAlonzoGenesis Source #

Arguments

:: forall era t (m :: Type -> Type). MonadTransError String t m
=> Maybe (CardanoEra era)	An optional era witness in which we're reading the genesis
-> ByteString	Genesis JSON
-> t m AlonzoGenesis

Decode Alonzo genesis in an optionally era sensitive way.

Because the Plutus V2 cost model has changed between Babbage and Conway era, we need to know the era if we want to decde Alonzo Genesis with a cost model baked in. If the V2 cost model is present in genesis, you need to provide an era witness.

When an era witness is provided, for Plutus V2 model the function additionally: 1. Does extra cost model parameters name validation: Checks for mandatory 175 parameters if provided in a map form. 2. If >= Conway: adds defaults for new 10 parameters, if they were not provided (maxBound) 3. Removes extra parameters above the max count: Babbage - 175, Conway - 185.

conwayGenesisDefaults :: ConwayGenesis Source #

Some reasonable starting defaults for constructing a ConwayGenesis. Based on https://github.com/IntersectMBO/cardano-node/blob/master/cardano-testnet/src/Testnet/Defaults.hs

Configuration

type ByronGenesisConfig = Config Source #

type ShelleyGenesisConfig = ShelleyConfig Source #

type AlonzoGenesisConfig = AlonzoGenesis Source #

type ConwayGenesisConfig = ConwayGenesis Source #

data ShelleyConfig Source #

Constructors

ShelleyConfig
Fields scConfig :: !ShelleyGenesis scGenesisHash :: !GenesisHashShelley

newtype GenesisHashByron Source #

Constructors

GenesisHashByron
Fields unGenesisHashByron :: Text

Instances

Instances details

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

newtype GenesisHashShelley Source #

Constructors

GenesisHashShelley
Fields unGenesisHashShelley :: Hash Blake2b_256 ByteString

Instances

Instances details

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

newtype GenesisHashAlonzo Source #

Constructors

GenesisHashAlonzo
Fields unGenesisHashAlonzo :: Hash Blake2b_256 ByteString

Instances

Instances details

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

newtype GenesisHashConway Source #

Constructors

GenesisHashConway
Fields unGenesisHashConway :: Hash Blake2b_256 ByteString

Instances

Instances details

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

Files

type ByronGenesisFile = File ByronGenesisConfig Source #

type ShelleyGenesisFile = File ShelleyGenesisConfig Source #

type AlonzoGenesisFile = File AlonzoGenesisConfig Source #

type ConwayGenesisFile = File ConwayGenesisConfig Source #

Protocol parameters fixed in the genesis file

data GenesisParameters era Source #

Constructors

GenesisParameters

Fields

protocolParamSystemStart :: UTCTime
The reference time the system started. The time of slot zero. The time epoch against which all Ouroboros time slots are measured.
protocolParamNetworkId :: NetworkId
The network identifier for this blockchain instance. This distinguishes the mainnet from testnets, and different testnets from each other.
protocolParamActiveSlotsCoefficient :: Rational
The Ouroboros Praos active slot coefficient, aka f.
protocolParamSecurity :: NonZero Word64
The Ouroboros security parameters, aka k. This is the maximum number of blocks the node would ever be prepared to roll back by.
Clients of the node following the chain should be prepared to handle the node switching forks up to this long.
protocolParamEpochLength :: EpochSize
The number of Ouroboros time slots in an Ouroboros epoch.
protocolParamSlotLength :: NominalDiffTime
The time duration of a slot.
protocolParamSlotsPerKESPeriod :: Int
For Ouroboros Praos, the length of a KES period as a number of time slots. The KES keys get evolved once per KES period.
protocolParamMaxKESEvolutions :: Int
The maximum number of times a KES key can be evolved before it is no longer considered valid. This can be less than the maximum number of times given the KES key size. For example the mainnet KES key size would allow 64 evolutions, but the max KES evolutions param is 62.
protocolParamUpdateQuorum :: Int
In the Shelley era, prior to decentralised governance, this is the number of genesis key delegates that need to agree for an update proposal to be enacted.
protocolParamMaxLovelaceSupply :: Coin
The maximum supply for Lovelace. This determines the initial value of the reserves.
protocolInitialUpdateableProtocolParameters :: PParams (ShelleyLedgerEra era)
The initial values of the updateable ProtocolParameters.

newtype EpochSize Source #

Constructors

EpochSize
Fields unEpochSize :: Word64

Instances

Instances details

FromJSON EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

parseJSON :: Value -> Parser EpochSize #

parseJSONList :: Value -> Parser [EpochSize] #

omittedField :: Maybe EpochSize #

ToJSON EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

toJSON :: EpochSize -> Value #

toEncoding :: EpochSize -> Encoding #

toJSONList :: [EpochSize] -> Value #

toEncodingList :: [EpochSize] -> Encoding #

omitField :: EpochSize -> Bool #

Enum EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

succ :: EpochSize -> EpochSize Source #

pred :: EpochSize -> EpochSize Source #

toEnum :: Int -> EpochSize Source #

fromEnum :: EpochSize -> Int Source #

enumFrom :: EpochSize -> [EpochSize] Source #

enumFromThen :: EpochSize -> EpochSize -> [EpochSize] Source #

enumFromTo :: EpochSize -> EpochSize -> [EpochSize] Source #

enumFromThenTo :: EpochSize -> EpochSize -> EpochSize -> [EpochSize] Source #

Generic EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep EpochSize
Instance details Defined in Cardano.Slotting.Slot type Rep EpochSize = D1 ('MetaData "EpochSize" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-5e3cb584da1cb4492348d9102c3fae026617ad9eee92a938e6b627df3b251a08" 'True) (C1 ('MetaCons "EpochSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: EpochSize -> Rep EpochSize x Source #

to :: Rep EpochSize x -> EpochSize Source #

Show EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

showsPrec :: Int -> EpochSize -> ShowS Source #

show :: EpochSize -> String Source #

showList :: [EpochSize] -> ShowS Source #

FromCBOR EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

fromCBOR :: Decoder s EpochSize Source #

label :: Proxy EpochSize -> Text Source #

ToCBOR EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR :: EpochSize -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy EpochSize -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [EpochSize] -> Size Source #

DecCBOR EpochSize

Instance details

Defined in Cardano.Ledger.Binary.Decoding.DecCBOR

Methods

decCBOR :: Decoder s EpochSize Source #

dropCBOR :: Proxy EpochSize -> Decoder s () Source #

label :: Proxy EpochSize -> Text Source #

EncCBOR EpochSize

Instance details

Defined in Cardano.Ledger.Binary.Encoding.EncCBOR

Methods

encCBOR :: EpochSize -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy EpochSize -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [EpochSize] -> Size Source #

NFData EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

rnf :: EpochSize -> () Source #

Eq EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) :: EpochSize -> EpochSize -> Bool Source #

(/=) :: EpochSize -> EpochSize -> Bool Source #

Ord EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

compare :: EpochSize -> EpochSize -> Ordering Source #

(<) :: EpochSize -> EpochSize -> Bool Source #

(<=) :: EpochSize -> EpochSize -> Bool Source #

(>) :: EpochSize -> EpochSize -> Bool Source #

(>=) :: EpochSize -> EpochSize -> Bool Source #

max :: EpochSize -> EpochSize -> EpochSize Source #

min :: EpochSize -> EpochSize -> EpochSize Source #

NoThunks EpochSize

Instance details

Defined in Cardano.Slotting.Slot

Methods

noThunks :: Context -> EpochSize -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> EpochSize -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy EpochSize -> String #

type Rep EpochSize

Instance details

Defined in Cardano.Slotting.Slot

type Rep EpochSize = D1 ('MetaData "EpochSize" "Cardano.Slotting.Slot" "cardano-slotting-0.2.0.0-5e3cb584da1cb4492348d9102c3fae026617ad9eee92a938e6b627df3b251a08" 'True) (C1 ('MetaCons "EpochSize" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Utilities

unsafeBoundedRational :: (HasCallStack, Typeable r, BoundedRational r) => Rational -> r Source #

Convert Rational to a bounded rational. Throw an exception when the rational is out of bounds.