Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Core.TxCert

Synopsis

class (Era era, ToJSON (TxCert era), DecCBOR (TxCert era), EncCBOR (TxCert era), ToCBOR (TxCert era), FromCBOR (TxCert era), NoThunks (TxCert era), NFData (TxCert era), Show (TxCert era), Eq (TxCert era)) ⇒ EraTxCert era where
- type TxCert era = (r ∷ Type) | r → era
- type TxCertUpgradeError era ∷ Type
- upgradeTxCert ∷ EraTxCert (PreviousEra era) ⇒ TxCert (PreviousEra era) → Either (TxCertUpgradeError era) (TxCert era)
- getVKeyWitnessTxCert ∷ TxCert era → Maybe (KeyHash 'Witness (EraCrypto era))
- getScriptWitnessTxCert ∷ TxCert era → Maybe (ScriptHash (EraCrypto era))
- mkRegPoolTxCert ∷ PoolParams (EraCrypto era) → TxCert era
- getRegPoolTxCert ∷ TxCert era → Maybe (PoolParams (EraCrypto era))
- mkRetirePoolTxCert ∷ KeyHash 'StakePool (EraCrypto era) → EpochNo → TxCert era
- getRetirePoolTxCert ∷ TxCert era → Maybe (KeyHash 'StakePool (EraCrypto era), EpochNo)
- lookupRegStakeTxCert ∷ TxCert era → Maybe (Credential 'Staking (EraCrypto era))
- lookupUnRegStakeTxCert ∷ TxCert era → Maybe (Credential 'Staking (EraCrypto era))
- getTotalDepositsTxCerts ∷ Foldable f ⇒ PParams era → (KeyHash 'StakePool (EraCrypto era) → Bool) → f (TxCert era) → Coin
- getTotalRefundsTxCerts ∷ Foldable f ⇒ PParams era → (Credential 'Staking (EraCrypto era) → Maybe Coin) → (Credential 'DRepRole (EraCrypto era) → Maybe Coin) → f (TxCert era) → Coin
pattern RegPoolTxCert ∷ EraTxCert era ⇒ PoolParams (EraCrypto era) → TxCert era
pattern RetirePoolTxCert ∷ EraTxCert era ⇒ KeyHash 'StakePool (EraCrypto era) → EpochNo → TxCert era
data Delegation c = Delegation {
- dDelegator ∷ !(StakeCredential c)
- dDelegatee ∷ !(KeyHash 'StakePool c)
}
data PoolCert c
- = RegPool !(PoolParams c)
- | RetirePool !(KeyHash 'StakePool c) !EpochNo
getPoolCertTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (PoolCert (EraCrypto era))
poolCWitness ∷ PoolCert c → Credential 'StakePool c
poolCertKeyHashWitness ∷ PoolCert c → KeyHash 'Witness c
isRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Bool
isUnRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Bool

Documentation

class (Era era, ToJSON (TxCert era), DecCBOR (TxCert era), EncCBOR (TxCert era), ToCBOR (TxCert era), FromCBOR (TxCert era), NoThunks (TxCert era), NFData (TxCert era), Show (TxCert era), Eq (TxCert era)) ⇒ EraTxCert era where Source #

Associated Types

type TxCert era = (r ∷ Type) | r → era Source #

type TxCertUpgradeError era ∷ Type Source #

type TxCertUpgradeError era = Void

Methods

upgradeTxCert ∷ EraTxCert (PreviousEra era) ⇒ TxCert (PreviousEra era) → Either (TxCertUpgradeError era) (TxCert era) Source #

Every era, except Shelley, must be able to upgrade a TxCert from a previous era. However, not all certificates can be upgraded, because some eras lose some of the certificates, thus return type is an Either. Eg. from Babbage to Conway: MIR and Genesis certificates were removed.

getVKeyWitnessTxCert ∷ TxCert era → Maybe (KeyHash 'Witness (EraCrypto era)) Source #

Return a witness key whenever a certificate requires one

getScriptWitnessTxCert ∷ TxCert era → Maybe (ScriptHash (EraCrypto era)) Source #

Return a ScriptHash for certificate types that require a witness

mkRegPoolTxCert ∷ PoolParams (EraCrypto era) → TxCert era Source #

getRegPoolTxCert ∷ TxCert era → Maybe (PoolParams (EraCrypto era)) Source #

mkRetirePoolTxCert ∷ KeyHash 'StakePool (EraCrypto era) → EpochNo → TxCert era Source #

getRetirePoolTxCert ∷ TxCert era → Maybe (KeyHash 'StakePool (EraCrypto era), EpochNo) Source #

lookupRegStakeTxCert ∷ TxCert era → Maybe (Credential 'Staking (EraCrypto era)) Source #

Extract staking credential from any certificate that can register such credential

lookupUnRegStakeTxCert ∷ TxCert era → Maybe (Credential 'Staking (EraCrypto era)) Source #

Extract staking credential from any certificate that can unregister such credential

getTotalDepositsTxCerts Source #

Arguments

∷ Foldable f
⇒ PParams era
→ (KeyHash 'StakePool (EraCrypto era) → Bool)	Check whether stake pool is registered or not
→ f (TxCert era)
→ Coin

Compute the total deposits from a list of certificates.

getTotalRefundsTxCerts Source #

Arguments

∷ Foldable f
⇒ PParams era
→ (Credential 'Staking (EraCrypto era) → Maybe Coin)	Lookup current deposit for Staking credential if one is registered
→ (Credential 'DRepRole (EraCrypto era) → Maybe Coin)	Lookup current deposit for DRep credential if one is registered
→ f (TxCert era)
→ Coin

Compute the total refunds from a list of certificates.

pattern RegPoolTxCert ∷ EraTxCert era ⇒ PoolParams (EraCrypto era) → TxCert era Source #

pattern RetirePoolTxCert ∷ EraTxCert era ⇒ KeyHash 'StakePool (EraCrypto era) → EpochNo → TxCert era Source #

data Delegation c Source #

Deprecated: No longer used

The delegation of one stake key to another.

Constructors

Delegation	Deprecated: No longer used
Fields dDelegator ∷ !(StakeCredential c) dDelegatee ∷ !(KeyHash 'StakePool c)

Instances

Instances details

Generic (Delegation c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Associated Types type Rep (Delegation c) ∷ Type → Type Source # Methods from ∷ Delegation c → Rep (Delegation c) x Source # to ∷ Rep (Delegation c) x → Delegation c Source #
Show (Delegation c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods showsPrec ∷ Int → Delegation c → ShowS Source # show ∷ Delegation c → String Source # showList ∷ [Delegation c] → ShowS Source #
NFData (Delegation c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods rnf ∷ Delegation c → () Source #
Eq (Delegation c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods (==) ∷ Delegation c → Delegation c → Bool Source # (/=) ∷ Delegation c → Delegation c → Bool Source #
NoThunks (Delegation c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods noThunks ∷ Context → Delegation c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Delegation c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Delegation c) → String Source #
type Rep (Delegation c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert type Rep (Delegation c) = D1 ('MetaData "Delegation" "Cardano.Ledger.Core.TxCert" "cardano-ledger-core-1.12.0.0-inplace" 'False) (C1 ('MetaCons "Delegation" 'PrefixI 'True) (S1 ('MetaSel ('Just "dDelegator") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StakeCredential c)) :*: S1 ('MetaSel ('Just "dDelegatee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c))))

data PoolCert c Source #

Constructors

RegPool !(PoolParams c)	A stake pool registration certificate.
RetirePool !(KeyHash 'StakePool c) !EpochNo	A stake pool retirement certificate.

Instances

Instances details

Crypto c ⇒ ToJSON (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods toJSON ∷ PoolCert c → Value Source # toEncoding ∷ PoolCert c → Encoding Source # toJSONList ∷ [PoolCert c] → Value Source # toEncodingList ∷ [PoolCert c] → Encoding Source # omitField ∷ PoolCert c → Bool Source #
Generic (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Associated Types type Rep (PoolCert c) ∷ Type → Type Source # Methods from ∷ PoolCert c → Rep (PoolCert c) x Source # to ∷ Rep (PoolCert c) x → PoolCert c Source #
Show (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods showsPrec ∷ Int → PoolCert c → ShowS Source # show ∷ PoolCert c → String Source # showList ∷ [PoolCert c] → ShowS Source #
NFData (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods rnf ∷ PoolCert c → () Source #
Eq (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods (==) ∷ PoolCert c → PoolCert c → Bool Source # (/=) ∷ PoolCert c → PoolCert c → Bool Source #
Ord (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods compare ∷ PoolCert c → PoolCert c → Ordering Source # (<) ∷ PoolCert c → PoolCert c → Bool Source # (<=) ∷ PoolCert c → PoolCert c → Bool Source # (>) ∷ PoolCert c → PoolCert c → Bool Source # (>=) ∷ PoolCert c → PoolCert c → Bool Source # max ∷ PoolCert c → PoolCert c → PoolCert c Source # min ∷ PoolCert c → PoolCert c → PoolCert c Source #
NoThunks (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert Methods noThunks ∷ Context → PoolCert c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PoolCert c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PoolCert c) → String Source #
type Rep (PoolCert c) Source #
Instance details Defined in Cardano.Ledger.Core.TxCert type Rep (PoolCert c) = D1 ('MetaData "PoolCert" "Cardano.Ledger.Core.TxCert" "cardano-ledger-core-1.12.0.0-inplace" 'False) (C1 ('MetaCons "RegPool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PoolParams c))) :+: C1 ('MetaCons "RetirePool" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNo)))

getPoolCertTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (PoolCert (EraCrypto era)) Source #

poolCWitness ∷ PoolCert c → Credential 'StakePool c Source #

Deprecated: As useless. PoolIds have nothing to do with credentials

poolCertKeyHashWitness ∷ PoolCert c → KeyHash 'Witness c Source #

isRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Bool Source #

Check if supplied TxCert is a stake registering certificate

isUnRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Bool Source #

Check if supplied TxCert is a stake un-registering certificate