Safe Haskell	None
Language	Haskell2010

Cardano.Ledger.Shelley.Genesis

Contents

Orphan instances

Synopsis

data ShelleyGenesisStaking = ShelleyGenesisStaking {
- sgsPools ∷ ListMap (KeyHash 'StakePool) StakePoolParams
- sgsStake ∷ ListMap (KeyHash 'Staking) (KeyHash 'StakePool)
}
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 'GenesisRole) GenDelegPair)
- sgInitialFunds ∷ ListMap Addr Coin
- sgStaking ∷ ShelleyGenesisStaking
}
data ValidationErr
newtype NominalDiffTimeMicro = NominalDiffTimeMicro Micro
emptyGenesisStaking ∷ ShelleyGenesisStaking
sgActiveSlotCoeff ∷ ShelleyGenesis → ActiveSlotCoeff
genesisUTxO ∷ EraTxOut era ⇒ ShelleyGenesis → UTxO era
initialFundsPseudoTxIn ∷ Addr → TxIn
validateGenesis ∷ ShelleyGenesis → Either [ValidationErr] ()
describeValidationErr ∷ ValidationErr → Text
mkShelleyGlobals ∷ ShelleyGenesis → EpochInfo (Either Text) → Globals
nominalDiffTimeMicroToMicroseconds ∷ NominalDiffTimeMicro → Micro
nominalDiffTimeMicroToSeconds ∷ NominalDiffTimeMicro → Pico
toNominalDiffTimeMicro ∷ NominalDiffTime → Maybe NominalDiffTimeMicro
toNominalDiffTimeMicroWithRounding ∷ NominalDiffTime → NominalDiffTimeMicro
fromNominalDiffTimeMicro ∷ NominalDiffTimeMicro → NominalDiffTime
secondsToNominalDiffTimeMicro ∷ Micro → NominalDiffTimeMicro
sgInitialFundsL ∷ Lens' ShelleyGenesis (ListMap Addr Coin)
sgStakingL ∷ Lens' ShelleyGenesis ShelleyGenesisStaking

Documentation

data ShelleyGenesisStaking Source #

Genesis Shelley staking configuration.

This allows us to configure some initial stake pools and delegation to them, in order to test Praos in a static configuration, without requiring on-chain registration and delegation.

For simplicity, pools defined in the genesis staking do not pay deposits for their registration.

Constructors

ShelleyGenesisStaking

Fields

sgsPools ∷ ListMap (KeyHash 'StakePool) StakePoolParams
Pools to register
The key in this map is the hash of the public key of the _pool_. This need not correspond to any payment or staking key, but must correspond to the cold key held by TPraosIsCoreNode.
sgsStake ∷ ListMap (KeyHash 'Staking) (KeyHash 'StakePool)
Stake-holding key hash credentials and the pools to delegate that stake to. We require the raw staking key hash in order to:
- Avoid pointer addresses, which would be tricky when there's no slot or transaction to point to.
- Avoid script credentials.

Instances

Instances details

FromJSON ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

parseJSON ∷ Value → Parser ShelleyGenesisStaking Source #

parseJSONList ∷ Value → Parser [ShelleyGenesisStaking] Source #

omittedField ∷ Maybe ShelleyGenesisStaking Source #

ToJSON ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toJSON ∷ ShelleyGenesisStaking → Value Source #

toEncoding ∷ ShelleyGenesisStaking → Encoding Source #

toJSONList ∷ [ShelleyGenesisStaking] → Value Source #

toEncodingList ∷ [ShelleyGenesisStaking] → Encoding Source #

omitField ∷ ShelleyGenesisStaking → Bool Source #

DecCBOR ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

decCBOR ∷ Decoder s ShelleyGenesisStaking Source #

dropCBOR ∷ Proxy ShelleyGenesisStaking → Decoder s () Source #

label ∷ Proxy ShelleyGenesisStaking → Text Source #

EncCBOR ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

encCBOR ∷ ShelleyGenesisStaking → Encoding Source #

ToKeyValuePairs ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toKeyValuePairs ∷ KeyValue e kv ⇒ ShelleyGenesisStaking → [kv] Source #

NFData ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

rnf ∷ ShelleyGenesisStaking → () #

Monoid ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

mempty ∷ ShelleyGenesisStaking #

mappend ∷ ShelleyGenesisStaking → ShelleyGenesisStaking → ShelleyGenesisStaking #

mconcat ∷ [ShelleyGenesisStaking] → ShelleyGenesisStaking #

Semigroup ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(<>) ∷ ShelleyGenesisStaking → ShelleyGenesisStaking → ShelleyGenesisStaking #

sconcat ∷ NonEmpty ShelleyGenesisStaking → ShelleyGenesisStaking #

stimes ∷ Integral b ⇒ b → ShelleyGenesisStaking → ShelleyGenesisStaking #

Generic ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Associated Types

type Rep ShelleyGenesisStaking

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

type Rep ShelleyGenesisStaking = D1 ('MetaData "ShelleyGenesisStaking" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-1.18.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyGenesisStaking" 'PrefixI 'True) (S1 ('MetaSel ('Just "sgsPools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListMap (KeyHash 'StakePool) StakePoolParams)) :*: S1 ('MetaSel ('Just "sgsStake") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListMap (KeyHash 'Staking) (KeyHash 'StakePool)))))

Methods

from ∷ ShelleyGenesisStaking → Rep ShelleyGenesisStaking x #

to ∷ Rep ShelleyGenesisStaking x → ShelleyGenesisStaking #

Show ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

showsPrec ∷ Int → ShelleyGenesisStaking → ShowS #

show ∷ ShelleyGenesisStaking → String #

showList ∷ [ShelleyGenesisStaking] → ShowS #

Eq ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(==) ∷ ShelleyGenesisStaking → ShelleyGenesisStaking → Bool #

(/=) ∷ ShelleyGenesisStaking → ShelleyGenesisStaking → Bool #

NoThunks ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

noThunks ∷ Context → ShelleyGenesisStaking → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ShelleyGenesisStaking → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy ShelleyGenesisStaking → String Source #

type Rep ShelleyGenesisStaking Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

type Rep ShelleyGenesisStaking = D1 ('MetaData "ShelleyGenesisStaking" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-1.18.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyGenesisStaking" 'PrefixI 'True) (S1 ('MetaSel ('Just "sgsPools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListMap (KeyHash 'StakePool) StakePoolParams)) :*: S1 ('MetaSel ('Just "sgsStake") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListMap (KeyHash 'Staking) (KeyHash 'StakePool)))))

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 'GenesisRole) 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 Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

parseJSON ∷ Value → Parser ShelleyGenesis Source #

parseJSONList ∷ Value → Parser [ShelleyGenesis] Source #

omittedField ∷ Maybe ShelleyGenesis Source #

ToJSON ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toJSON ∷ ShelleyGenesis → Value Source #

toEncoding ∷ ShelleyGenesis → Encoding Source #

toJSONList ∷ [ShelleyGenesis] → Value Source #

toEncodingList ∷ [ShelleyGenesis] → Encoding Source #

omitField ∷ ShelleyGenesis → Bool Source #

FromCBOR ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

fromCBOR ∷ Decoder s ShelleyGenesis Source #

label ∷ Proxy ShelleyGenesis → Text Source #

ToCBOR ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toCBOR ∷ ShelleyGenesis → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy ShelleyGenesis → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ShelleyGenesis] → Size Source #

DecCBOR ShelleyGenesis Source #

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 Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

encCBOR ∷ ShelleyGenesis → Encoding Source #

ToKeyValuePairs ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toKeyValuePairs ∷ KeyValue e kv ⇒ ShelleyGenesis → [kv] Source #

NFData ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

rnf ∷ ShelleyGenesis → () #

Generic ShelleyGenesis Source #

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 #

to ∷ Rep ShelleyGenesis x → ShelleyGenesis #

Show ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

showsPrec ∷ Int → ShelleyGenesis → ShowS #

show ∷ ShelleyGenesis → String #

showList ∷ [ShelleyGenesis] → ShowS #

Eq ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(==) ∷ ShelleyGenesis → ShelleyGenesis → Bool #

(/=) ∷ ShelleyGenesis → ShelleyGenesis → Bool #

NoThunks ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

noThunks ∷ Context → ShelleyGenesis → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ShelleyGenesis → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy ShelleyGenesis → String Source #

type Rep ShelleyGenesis Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

data ValidationErr Source #

Constructors

EpochNotLongEnough EpochSize Word64 Rational EpochSize
MaxKESEvolutionsUnsupported Word64 Word
QuorumTooSmall Word64 Word64 Word64

Instances

Instances details

Show ValidationErr Source #
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods showsPrec ∷ Int → ValidationErr → ShowS # show ∷ ValidationErr → String # showList ∷ [ValidationErr] → ShowS #
Eq ValidationErr Source #
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods (==) ∷ ValidationErr → ValidationErr → Bool # (/=) ∷ ValidationErr → ValidationErr → Bool #

newtype NominalDiffTimeMicro Source #

Unlike NominalDiffTime that supports Pico precision, this type only supports Micro precision.

Constructors

NominalDiffTimeMicro Micro

Instances

Instances details

FromJSON NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

parseJSON ∷ Value → Parser NominalDiffTimeMicro Source #

parseJSONList ∷ Value → Parser [NominalDiffTimeMicro] Source #

omittedField ∷ Maybe NominalDiffTimeMicro Source #

ToJSON NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toJSON ∷ NominalDiffTimeMicro → Value Source #

toEncoding ∷ NominalDiffTimeMicro → Encoding Source #

toJSONList ∷ [NominalDiffTimeMicro] → Value Source #

toEncodingList ∷ [NominalDiffTimeMicro] → Encoding Source #

omitField ∷ NominalDiffTimeMicro → Bool Source #

DecCBOR NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

decCBOR ∷ Decoder s NominalDiffTimeMicro Source #

dropCBOR ∷ Proxy NominalDiffTimeMicro → Decoder s () Source #

label ∷ Proxy NominalDiffTimeMicro → Text Source #

EncCBOR NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

encCBOR ∷ NominalDiffTimeMicro → Encoding Source #

NFData NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

rnf ∷ NominalDiffTimeMicro → () #

Generic NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Associated Types

type Rep NominalDiffTimeMicro
Instance details Defined in Cardano.Ledger.Shelley.Genesis type Rep NominalDiffTimeMicro = D1 ('MetaData "NominalDiffTimeMicro" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "NominalDiffTimeMicro" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Micro)))

Methods

from ∷ NominalDiffTimeMicro → Rep NominalDiffTimeMicro x #

to ∷ Rep NominalDiffTimeMicro x → NominalDiffTimeMicro #

Num NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(+) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → NominalDiffTimeMicro #

(-) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → NominalDiffTimeMicro #

(*) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → NominalDiffTimeMicro #

negate ∷ NominalDiffTimeMicro → NominalDiffTimeMicro #

abs ∷ NominalDiffTimeMicro → NominalDiffTimeMicro #

signum ∷ NominalDiffTimeMicro → NominalDiffTimeMicro #

fromInteger ∷ Integer → NominalDiffTimeMicro #

Fractional NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(/) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → NominalDiffTimeMicro #

recip ∷ NominalDiffTimeMicro → NominalDiffTimeMicro #

fromRational ∷ Rational → NominalDiffTimeMicro #

Real NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toRational ∷ NominalDiffTimeMicro → Rational #

Show NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

showsPrec ∷ Int → NominalDiffTimeMicro → ShowS #

show ∷ NominalDiffTimeMicro → String #

showList ∷ [NominalDiffTimeMicro] → ShowS #

Eq NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

(==) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → Bool #

(/=) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → Bool #

Ord NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

compare ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → Ordering #

(<) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → Bool #

(<=) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → Bool #

(>) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → Bool #

(>=) ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → Bool #

max ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → NominalDiffTimeMicro #

min ∷ NominalDiffTimeMicro → NominalDiffTimeMicro → NominalDiffTimeMicro #

NoThunks NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

noThunks ∷ Context → NominalDiffTimeMicro → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → NominalDiffTimeMicro → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy NominalDiffTimeMicro → String Source #

type Rep NominalDiffTimeMicro Source #

Instance details

Defined in Cardano.Ledger.Shelley.Genesis

type Rep NominalDiffTimeMicro = D1 ('MetaData "NominalDiffTimeMicro" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-1.18.0.0-inplace" 'True) (C1 ('MetaCons "NominalDiffTimeMicro" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Micro)))

emptyGenesisStaking ∷ ShelleyGenesisStaking Source #

Empty genesis staking

sgActiveSlotCoeff ∷ ShelleyGenesis → ActiveSlotCoeff Source #

genesisUTxO ∷ EraTxOut era ⇒ ShelleyGenesis → UTxO era Source #

initialFundsPseudoTxIn ∷ Addr → TxIn Source #

Compute the TxIn of the initial UTxO pseudo-transaction corresponding to the given address in the genesis initial funds.

The Shelley initial UTxO is constructed from the sgInitialFunds which is not a full UTxO but just a map from addresses to coin values.

This gets turned into a UTxO by making a pseudo-transaction for each address, with the 0th output being the coin value. So to spend from the initial UTxO we need this same TxIn to use as an input to the spending transaction.

validateGenesis ∷ ShelleyGenesis → Either [ValidationErr] () Source #

Do some basic sanity checking on the Shelley genesis file.

describeValidationErr ∷ ValidationErr → Text Source #

mkShelleyGlobals ∷ ShelleyGenesis → EpochInfo (Either Text) → Globals Source #

nominalDiffTimeMicroToMicroseconds ∷ NominalDiffTimeMicro → Micro Source #

nominalDiffTimeMicroToSeconds ∷ NominalDiffTimeMicro → Pico Source #

toNominalDiffTimeMicro ∷ NominalDiffTime → Maybe NominalDiffTimeMicro Source #

toNominalDiffTimeMicroWithRounding ∷ NominalDiffTime → NominalDiffTimeMicro Source #

fromNominalDiffTimeMicro ∷ NominalDiffTimeMicro → NominalDiffTime Source #

secondsToNominalDiffTimeMicro ∷ Micro → NominalDiffTimeMicro Source #

sgInitialFundsL ∷ Lens' ShelleyGenesis (ListMap Addr Coin) Source #

sgStakingL ∷ Lens' ShelleyGenesis ShelleyGenesisStaking Source #

Orphan instances

EraGenesis ShelleyEra Source #

Instance details

Associated Types

type Genesis ShelleyEra
Instance details Defined in Cardano.Ledger.Shelley.Genesis type Genesis ShelleyEra = ShelleyGenesis