Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Shelley.Node.TPraos

Synopsis

newtype MaxMajorProtVer = MaxMajorProtVer {
- getMaxMajorProtVer :: Natural
}
data ProtocolParamsAllegra c = ProtocolParamsAllegra {
- allegraProtVer :: ProtVer
- allegraMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AllegraEra c))
}
data ProtocolParamsAlonzo c = ProtocolParamsAlonzo {
- alonzoProtVer :: ProtVer
- alonzoMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AlonzoEra c))
}
data ProtocolParamsMary c = ProtocolParamsMary {
- maryProtVer :: ProtVer
- maryMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( MaryEra c))
}
data ProtocolParamsShelley c = ProtocolParamsShelley {
- shelleyProtVer :: ProtVer
- shelleyMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( ShelleyEra c))
}
data ProtocolParamsShelleyBased era = ProtocolParamsShelleyBased {
- shelleyBasedGenesis :: ShelleyGenesis era
- shelleyBasedInitialNonce :: Nonce
- shelleyBasedLeaderCredentials :: [ ShelleyLeaderCredentials ( EraCrypto era)]
}
data Nonce
- = Nonce !( Hash Blake2b_256 Nonce )
- | NeutralNonce
data ProtVer = ProtVer {
- pvMajor :: ! Natural
- pvMinor :: ! Natural
}
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))
}
data ShelleyGenesisStaking crypto = ShelleyGenesisStaking {
- sgsPools :: !( Map ( KeyHash ' StakePool crypto) ( PoolParams crypto))
- sgsStake :: !( Map ( KeyHash ' Staking crypto) ( KeyHash ' StakePool crypto))
}
emptyGenesisStaking :: ShelleyGenesisStaking crypto
data ShelleyLeaderCredentials c = ShelleyLeaderCredentials {
}
protocolInfoShelley :: forall m c. ( IOLike m, PraosCrypto c, ShelleyCompatible ( TPraos c) ( ShelleyEra c), TxLimits ( ShelleyBlock ( TPraos c) ( ShelleyEra c))) => ProtocolParamsShelleyBased ( ShelleyEra c) -> ProtocolParamsShelley c -> ProtocolInfo m ( ShelleyBlock ( TPraos c) ( ShelleyEra c))
protocolInfoTPraosShelleyBased :: forall m era c. ( IOLike m, PraosCrypto c, ShelleyCompatible ( TPraos c) era, TxLimits ( ShelleyBlock ( TPraos c) era), c ~ EraCrypto era) => ProtocolParamsShelleyBased era -> TranslationContext era -> ProtVer -> Overrides ( ShelleyBlock ( TPraos c) era) -> ProtocolInfo m ( ShelleyBlock ( TPraos c) era)
registerGenesisStaking :: forall era. ShelleyBasedEra era => ShelleyGenesisStaking ( EraCrypto era) -> NewEpochState era -> NewEpochState era
registerInitialFunds :: forall era. ( ShelleyBasedEra era, HasCallStack ) => Map ( Addr ( EraCrypto era)) Coin -> NewEpochState era -> NewEpochState era
shelleyBlockForging :: forall m era c. ( ShelleyCompatible ( TPraos c) era, PraosCrypto c, c ~ EraCrypto era, TxLimits ( ShelleyBlock ( TPraos c) era), IOLike m) => TPraosParams -> Overrides ( ShelleyBlock ( TPraos c) era) -> ShelleyLeaderCredentials ( EraCrypto era) -> m ( BlockForging m ( ShelleyBlock ( TPraos c) era))
shelleySharedBlockForging :: forall m c era. ( PraosCrypto c, ShelleyEraWithCrypto c ( TPraos c) era, IOLike m) => HotKey c m -> ( SlotNo -> KESPeriod ) -> ShelleyLeaderCredentials c -> Overrides ( ShelleyBlock ( TPraos c) era) -> BlockForging m ( ShelleyBlock ( TPraos c) era)
validateGenesis :: ShelleyBasedEra era => ShelleyGenesis era -> Either String ()

Documentation

newtype MaxMajorProtVer Source #

The maximum major protocol version.

Must be at least the current major protocol version. For Cardano mainnet, the Shelley era has major protocol verison 2 .

Constructors

MaxMajorProtVer
Fields getMaxMajorProtVer :: Natural

Instances

Instances details

Eq MaxMajorProtVer
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods (==) :: MaxMajorProtVer -> MaxMajorProtVer -> Bool Source # (/=) :: MaxMajorProtVer -> MaxMajorProtVer -> Bool Source #
Show MaxMajorProtVer
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods showsPrec :: Int -> MaxMajorProtVer -> ShowS Source # show :: MaxMajorProtVer -> String Source # showList :: [ MaxMajorProtVer ] -> ShowS Source #
Generic MaxMajorProtVer
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Associated Types type Rep MaxMajorProtVer :: Type -> Type Source # Methods from :: MaxMajorProtVer -> Rep MaxMajorProtVer x Source # to :: Rep MaxMajorProtVer x -> MaxMajorProtVer Source #
NoThunks MaxMajorProtVer
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods noThunks :: Context -> MaxMajorProtVer -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> MaxMajorProtVer -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy MaxMajorProtVer -> String Source #
type Rep MaxMajorProtVer
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common type Rep MaxMajorProtVer = D1 (' MetaData "MaxMajorProtVer" "Ouroboros.Consensus.Protocol.Praos.Common" "ouroboros-consensus-protocol-0.1.0.1-zKRBoYOfUlKsvZd6xB0lb" ' True ) ( C1 (' MetaCons "MaxMajorProtVer" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getMaxMajorProtVer") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Natural )))

data ProtocolParamsAllegra c Source #

Parameters needed to run Allegra

Constructors

ProtocolParamsAllegra
Fields allegraProtVer :: ProtVer allegraMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AllegraEra c))

data ProtocolParamsAlonzo c Source #

Parameters needed to run Alonzo

Constructors

ProtocolParamsAlonzo
Fields alonzoProtVer :: ProtVer alonzoMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( AlonzoEra c))

data ProtocolParamsMary c Source #

Parameters needed to run Mary

Constructors

ProtocolParamsMary
Fields maryProtVer :: ProtVer maryMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( MaryEra c))

data ProtocolParamsShelley c Source #

Parameters needed to run Shelley

Constructors

ProtocolParamsShelley
Fields shelleyProtVer :: ProtVer shelleyMaxTxCapacityOverrides :: Overrides ( ShelleyBlock ( TPraos c) ( ShelleyEra c))

data ProtocolParamsShelleyBased era Source #

Parameters common to all Shelley-based ledgers.

When running a chain with multiple Shelley-based eras, in addition to the per-era protocol parameters, one value of ProtocolParamsShelleyBased will be needed, which is shared among all Shelley-based eras.

The era parameter determines from which era the genesis config will be used.

Constructors

ProtocolParamsShelleyBased
Fields shelleyBasedGenesis :: ShelleyGenesis era shelleyBasedInitialNonce :: Nonce The initial nonce, typically derived from the hash of Genesis config JSON file. WARNING: chains using different values of this parameter will be mutually incompatible. shelleyBasedLeaderCredentials :: [ ShelleyLeaderCredentials ( EraCrypto era)]

data Nonce Source #

Evolving nonce type.

Constructors

Nonce !( Hash Blake2b_256 Nonce )
NeutralNonce	Identity element

Instances

Instances details

Eq Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods (==) :: Nonce -> Nonce -> Bool Source # (/=) :: Nonce -> Nonce -> Bool Source #
Ord Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods compare :: Nonce -> Nonce -> Ordering Source # (<) :: Nonce -> Nonce -> Bool Source # (<=) :: Nonce -> Nonce -> Bool Source # (>) :: Nonce -> Nonce -> Bool Source # (>=) :: Nonce -> Nonce -> Bool Source # max :: Nonce -> Nonce -> Nonce Source # min :: Nonce -> Nonce -> Nonce Source #
Show Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods showsPrec :: Int -> Nonce -> ShowS Source # show :: Nonce -> String Source # showList :: [ Nonce ] -> ShowS Source #
Generic Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Associated Types type Rep Nonce :: Type -> Type Source # Methods from :: Nonce -> Rep Nonce x Source # to :: Rep Nonce x -> Nonce Source #
NFData Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods rnf :: Nonce -> () Source #
ToJSON Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods toJSON :: Nonce -> Value Source # toEncoding :: Nonce -> Encoding Source # toJSONList :: [ Nonce ] -> Value Source # toEncodingList :: [ Nonce ] -> Encoding Source #
FromJSON Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods parseJSON :: Value -> Parser Nonce Source # parseJSONList :: Value -> Parser [ Nonce ] Source #
ToCBOR Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods toCBOR :: Nonce -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy Nonce -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ Nonce ] -> Size Source #
FromCBOR Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods fromCBOR :: Decoder s Nonce Source # label :: Proxy Nonce -> Text Source #
NoThunks Nonce
Instance details Defined in Cardano.Ledger.BaseTypes Methods noThunks :: Context -> Nonce -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Nonce -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Nonce -> String Source #
type Rep Nonce
Instance details Defined in Cardano.Ledger.BaseTypes type Rep Nonce = D1 (' MetaData "Nonce" "Cardano.Ledger.BaseTypes" "cardano-ledger-core-0.1.0.0-3EJt5rxsPizAWHDEqGPh9V" ' False ) ( C1 (' MetaCons "Nonce" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Hash Blake2b_256 Nonce ))) :+: C1 (' MetaCons "NeutralNonce" ' PrefixI ' False ) ( U1 :: Type -> Type ))

data ProtVer Source #

Constructors

ProtVer
Fields pvMajor :: ! Natural pvMinor :: ! Natural

Instances

Instances details

Eq ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods (==) :: ProtVer -> ProtVer -> Bool Source # (/=) :: ProtVer -> ProtVer -> Bool Source #
Ord ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods compare :: ProtVer -> ProtVer -> Ordering Source # (<) :: ProtVer -> ProtVer -> Bool Source # (<=) :: ProtVer -> ProtVer -> Bool Source # (>) :: ProtVer -> ProtVer -> Bool Source # (>=) :: ProtVer -> ProtVer -> Bool Source # max :: ProtVer -> ProtVer -> ProtVer Source # min :: ProtVer -> ProtVer -> ProtVer Source #
Show ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods showsPrec :: Int -> ProtVer -> ShowS Source # show :: ProtVer -> String Source # showList :: [ ProtVer ] -> ShowS Source #
Generic ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Associated Types type Rep ProtVer :: Type -> Type Source # Methods from :: ProtVer -> Rep ProtVer x Source # to :: Rep ProtVer x -> ProtVer Source #
NFData ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods rnf :: ProtVer -> () Source #
ToJSON ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods toJSON :: ProtVer -> Value Source # toEncoding :: ProtVer -> Encoding Source # toJSONList :: [ ProtVer ] -> Value Source # toEncodingList :: [ ProtVer ] -> Encoding Source #
FromJSON ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods parseJSON :: Value -> Parser ProtVer Source # parseJSONList :: Value -> Parser [ ProtVer ] Source #
ToCBOR ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods toCBOR :: ProtVer -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ProtVer -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ ProtVer ] -> Size Source #
FromCBOR ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods fromCBOR :: Decoder s ProtVer Source # label :: Proxy ProtVer -> Text Source #
ToCBORGroup ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods toCBORGroup :: ProtVer -> Encoding Source # encodedGroupSizeExpr :: ( forall x. ToCBOR x => Proxy x -> Size ) -> Proxy ProtVer -> Size Source # listLen :: ProtVer -> Word Source # listLenBound :: Proxy ProtVer -> Word Source #
FromCBORGroup ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods fromCBORGroup :: Decoder s ProtVer Source #
NoThunks ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes Methods noThunks :: Context -> ProtVer -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ProtVer -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ProtVer -> String Source #
HasField "_protocolVersion" ( RewardSnapShot crypto) ProtVer	RewardSnapShot can act as a Proxy for PParams when only the protocol version is needed.
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods getField :: RewardSnapShot crypto -> ProtVer Source #
HasField "_protocolVersion" ( FreeVars crypto) ProtVer	FreeVars can act as a Proxy for PParams when only the protocol version is needed.
Instance details Defined in Cardano.Ledger.Shelley.RewardUpdate Methods getField :: FreeVars crypto -> ProtVer Source #
type Rep ProtVer
Instance details Defined in Cardano.Ledger.BaseTypes type Rep ProtVer = D1 (' MetaData "ProtVer" "Cardano.Ledger.BaseTypes" "cardano-ledger-core-0.1.0.0-3EJt5rxsPizAWHDEqGPh9V" ' False ) ( C1 (' MetaCons "ProtVer" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "pvMajor") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Natural ) :*: S1 (' MetaSel (' Just "pvMinor") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Natural )))

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 :: ! 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 => ToJSON ( ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.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 Cardano.Ledger.Shelley.Genesis Methods parseJSON :: Value -> Parser ( ShelleyGenesis era) Source # parseJSONList :: Value -> Parser [ ShelleyGenesis era] Source #
Era era => ToCBOR ( ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.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 Cardano.Ledger.Shelley.Genesis Methods fromCBOR :: Decoder s ( ShelleyGenesis era) Source # label :: Proxy ( ShelleyGenesis era) -> Text Source #
Era era => NoThunks ( ShelleyGenesis era)
Instance details Defined in Cardano.Ledger.Shelley.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 Cardano.Ledger.Shelley.Genesis type Rep ( ShelleyGenesis era) = D1 (' MetaData "ShelleyGenesis" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' 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 ( BabbageEra c) ShelleyGenesis
Instance details Defined in Cardano.Ledger.Babbage.Translation type TranslationError ( BabbageEra 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

data ShelleyGenesisStaking crypto 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 :: !( Map ( KeyHash ' StakePool crypto) ( PoolParams crypto))

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 :: !( Map ( KeyHash ' Staking crypto) ( KeyHash ' StakePool crypto))
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

Eq ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods (==) :: ShelleyGenesisStaking crypto -> ShelleyGenesisStaking crypto -> Bool Source # (/=) :: ShelleyGenesisStaking crypto -> ShelleyGenesisStaking crypto -> Bool Source #
Show ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods showsPrec :: Int -> ShelleyGenesisStaking crypto -> ShowS Source # show :: ShelleyGenesisStaking crypto -> String Source # showList :: [ ShelleyGenesisStaking crypto] -> ShowS Source #
Generic ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Associated Types type Rep ( ShelleyGenesisStaking crypto) :: Type -> Type Source # Methods from :: ShelleyGenesisStaking crypto -> Rep ( ShelleyGenesisStaking crypto) x Source # to :: Rep ( ShelleyGenesisStaking crypto) x -> ShelleyGenesisStaking crypto Source #
Crypto crypto => ToJSON ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods toJSON :: ShelleyGenesisStaking crypto -> Value Source # toEncoding :: ShelleyGenesisStaking crypto -> Encoding Source # toJSONList :: [ ShelleyGenesisStaking crypto] -> Value Source # toEncodingList :: [ ShelleyGenesisStaking crypto] -> Encoding Source #
Crypto crypto => FromJSON ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods parseJSON :: Value -> Parser ( ShelleyGenesisStaking crypto) Source # parseJSONList :: Value -> Parser [ ShelleyGenesisStaking crypto] Source #
Crypto crypto => ToCBOR ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods toCBOR :: ShelleyGenesisStaking crypto -> Encoding Source # encodedSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy ( ShelleyGenesisStaking crypto) -> Size Source # encodedListSizeExpr :: ( forall t. ToCBOR t => Proxy t -> Size ) -> Proxy [ ShelleyGenesisStaking crypto] -> Size Source #
Crypto crypto => FromCBOR ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods fromCBOR :: Decoder s ( ShelleyGenesisStaking crypto) Source # label :: Proxy ( ShelleyGenesisStaking crypto) -> Text Source #
NoThunks ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis Methods noThunks :: Context -> ShelleyGenesisStaking crypto -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ShelleyGenesisStaking crypto -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( ShelleyGenesisStaking crypto) -> String Source #
type Rep ( ShelleyGenesisStaking crypto)
Instance details Defined in Cardano.Ledger.Shelley.Genesis type Rep ( ShelleyGenesisStaking crypto) = D1 (' MetaData "ShelleyGenesisStaking" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-0.1.0.0-4LNBTpyKcsy6EW18a3tTt2" ' False ) ( C1 (' MetaCons "ShelleyGenesisStaking" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "sgsPools") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( KeyHash ' StakePool crypto) ( PoolParams crypto))) :*: S1 (' MetaSel (' Just "sgsStake") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( Map ( KeyHash ' Staking crypto) ( KeyHash ' StakePool crypto)))))

emptyGenesisStaking :: ShelleyGenesisStaking crypto Source #

Empty genesis staking

data ShelleyLeaderCredentials c Source #

Constructors

ShelleyLeaderCredentials

Fields

shelleyLeaderCredentialsInitSignKey :: SignKeyKES c

The unevolved signing KES key (at evolution 0).

Note that this is not inside ShelleyCanBeLeader since it gets evolved automatically, whereas ShelleyCanBeLeader does not change.
shelleyLeaderCredentialsCanBeLeader :: PraosCanBeLeader c
shelleyLeaderCredentialsLabel :: Text

Identifier for this set of credentials.

Useful when the node is running with multiple sets of credentials.

protocolInfoShelley :: forall m c. ( IOLike m, PraosCrypto c, ShelleyCompatible ( TPraos c) ( ShelleyEra c), TxLimits ( ShelleyBlock ( TPraos c) ( ShelleyEra c))) => ProtocolParamsShelleyBased ( ShelleyEra c) -> ProtocolParamsShelley c -> ProtocolInfo m ( ShelleyBlock ( TPraos c) ( ShelleyEra c)) Source #

protocolInfoTPraosShelleyBased :: forall m era c. ( IOLike m, PraosCrypto c, ShelleyCompatible ( TPraos c) era, TxLimits ( ShelleyBlock ( TPraos c) era), c ~ EraCrypto era) => ProtocolParamsShelleyBased era -> TranslationContext era -> ProtVer -> Overrides ( ShelleyBlock ( TPraos c) era) -> ProtocolInfo m ( ShelleyBlock ( TPraos c) era) Source #

registerGenesisStaking :: forall era. ShelleyBasedEra era => ShelleyGenesisStaking ( EraCrypto era) -> NewEpochState era -> NewEpochState era Source #

Register the initial staking information in the NewEpochState .

HERE BE DRAGONS! This function is intended to help in testing.

In production, the genesis should not contain any initial staking.

Any existing staking information is overridden, but the UTxO is left untouched.

TODO adapt and reuse registerGenesisStaking from cardano-ledger-specs .

registerInitialFunds :: forall era. ( ShelleyBasedEra era, HasCallStack ) => Map ( Addr ( EraCrypto era)) Coin -> NewEpochState era -> NewEpochState era Source #

Register the initial funds in the NewEpochState .

HERE BE DRAGONS! This function is intended to help in testing.

In production, the genesis should not contain any initial funds.

The given funds are added to the existing UTxO.

PRECONDITION: the given funds must not be part of the existing UTxO. > forall (addr, _) in initialFunds. > Map.notElem (SL.initialFundsPseudoTxIn addr) existingUTxO

PROPERTY: > genesisUTxO genesis > == genesisUTxO' (sgInitialFunds genesis) > == extractUTxO (registerInitialFunds (sgInitialFunds genesis) > NewEpochState )

TODO move to cardano-ledger-specs .

shelleyBlockForging :: forall m era c. ( ShelleyCompatible ( TPraos c) era, PraosCrypto c, c ~ EraCrypto era, TxLimits ( ShelleyBlock ( TPraos c) era), IOLike m) => TPraosParams -> Overrides ( ShelleyBlock ( TPraos c) era) -> ShelleyLeaderCredentials ( EraCrypto era) -> m ( BlockForging m ( ShelleyBlock ( TPraos c) era)) Source #

Create a BlockForging record for a single era.

In case the same credentials should be shared across multiple Shelley-based eras, use shelleySharedBlockForging .

shelleySharedBlockForging :: forall m c era. ( PraosCrypto c, ShelleyEraWithCrypto c ( TPraos c) era, IOLike m) => HotKey c m -> ( SlotNo -> KESPeriod ) -> ShelleyLeaderCredentials c -> Overrides ( ShelleyBlock ( TPraos c) era) -> BlockForging m ( ShelleyBlock ( TPraos c) era) Source #

Create a BlockForging record safely using a given Hotkey .

The name of the era (separated by a _ ) will be appended to each forgeLabel .

validateGenesis :: ShelleyBasedEra era => ShelleyGenesis era -> Either String () Source #

Check the validity of the genesis config. To be used in conjunction with assertWithMsg .