Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Api.Tx.Cert

Contents

Shelley Era
Conway Era

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), Ord (TxCert era), Eq (TxCert era)) ⇒ EraTxCert era where
- type TxCert era = (r ∷ Type) | r → era
- type TxCertUpgradeError era
upgradeTxCert ∷ EraTxCert era ⇒ TxCert (PreviousEra era) → Either (TxCertUpgradeError era) (TxCert era)
getVKeyWitnessTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (KeyHash 'Witness (EraCrypto era))
getScriptWitnessTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (ScriptHash (EraCrypto era))
pattern RegPoolTxCert ∷ EraTxCert era ⇒ PoolParams (EraCrypto era) → TxCert era
pattern RetirePoolTxCert ∷ EraTxCert era ⇒ KeyHash 'StakePool (EraCrypto era) → EpochNo → TxCert era
lookupRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (Credential 'Staking (EraCrypto era))
lookupUnRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (Credential 'Staking (EraCrypto era))
isRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Bool
isUnRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Bool
class EraTxCert era ⇒ ShelleyEraTxCert era
pattern MirTxCert ∷ (ShelleyEraTxCert era, ProtVerAtMost era 8) ⇒ MIRCert (EraCrypto era) → TxCert era
pattern GenesisDelegTxCert ∷ (ShelleyEraTxCert era, ProtVerAtMost era 8) ⇒ KeyHash 'Genesis (EraCrypto era) → KeyHash 'GenesisDelegate (EraCrypto era) → VRFVerKeyHash 'GenDelegVRF (EraCrypto era) → TxCert era
pattern RegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential (EraCrypto era) → TxCert era
pattern UnRegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential (EraCrypto era) → TxCert era
pattern DelegStakeTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential (EraCrypto era) → KeyHash 'StakePool (EraCrypto era) → TxCert era
class ShelleyEraTxCert era ⇒ ConwayEraTxCert era
getDelegateeTxCert ∷ ConwayEraTxCert era ⇒ TxCert era → Maybe (Delegatee (EraCrypto era))
data Delegatee c
- = DelegStake !(KeyHash 'StakePool c)
- | DelegVote !(DRep c)
- | DelegStakeVote !(KeyHash 'StakePool c) !(DRep c)
getStakePoolDelegatee ∷ Delegatee c → Maybe (KeyHash 'StakePool c)
pattern RegDepositTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Coin → TxCert era
pattern UnRegDepositTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Coin → TxCert era
pattern DelegTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Delegatee (EraCrypto era) → TxCert era
pattern RegDepositDelegTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Delegatee (EraCrypto era) → Coin → TxCert era
pattern AuthCommitteeHotKeyTxCert ∷ ConwayEraTxCert era ⇒ Credential 'ColdCommitteeRole (EraCrypto era) → Credential 'HotCommitteeRole (EraCrypto era) → TxCert era
pattern ResignCommitteeColdTxCert ∷ ConwayEraTxCert era ⇒ Credential 'ColdCommitteeRole (EraCrypto era) → StrictMaybe (Anchor (EraCrypto era)) → TxCert era
pattern RegDRepTxCert ∷ ConwayEraTxCert era ⇒ Credential 'DRepRole (EraCrypto era) → Coin → StrictMaybe (Anchor (EraCrypto era)) → TxCert era
pattern UnRegDRepTxCert ∷ ConwayEraTxCert era ⇒ Credential 'DRepRole (EraCrypto era) → Coin → TxCert era

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), Ord (TxCert era), Eq (TxCert era)) ⇒ EraTxCert era Source #

Minimal complete definition

upgradeTxCert, getVKeyWitnessTxCert, getScriptWitnessTxCert, mkRegPoolTxCert, getRegPoolTxCert, mkRetirePoolTxCert, getRetirePoolTxCert, lookupRegStakeTxCert, lookupUnRegStakeTxCert, getTotalDepositsTxCerts, getTotalRefundsTxCerts

Associated Types

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

type TxCertUpgradeError era Source #

type TxCertUpgradeError era = Void

upgradeTxCert ∷ EraTxCert 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 ∷ EraTxCert era ⇒ TxCert era → Maybe (KeyHash 'Witness (EraCrypto era)) Source #

Return a witness key whenever a certificate requires one

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

Return a ScriptHash for certificate types that require a witness

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

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

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

Extract staking credential from any certificate that can register such credential

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

Extract staking credential from any certificate that can unregister such credential

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

Shelley Era

Complete set of patterns for Shelley through Babbage TxCert:

TxCert =
  RegPoolTxCert
  RetirePoolTxCert
  RegTxCert
  UnRegTxCert
  DelegStakeTxCert
  MirTxCert
  GenesisDelegTxCert

class EraTxCert era ⇒ ShelleyEraTxCert era Source #

Minimal complete definition

mkRegTxCert, getRegTxCert, mkUnRegTxCert, getUnRegTxCert, mkDelegStakeTxCert, getDelegStakeTxCert, mkGenesisDelegTxCert, getGenesisDelegTxCert, mkMirTxCert, getMirTxCert

Instances

Instances details

Crypto c ⇒ ShelleyEraTxCert (ShelleyEra c)

Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

mkRegTxCert ∷ StakeCredential (EraCrypto (ShelleyEra c)) → TxCert (ShelleyEra c) Source #

getRegTxCert ∷ TxCert (ShelleyEra c) → Maybe (StakeCredential (EraCrypto (ShelleyEra c))) Source #

mkUnRegTxCert ∷ StakeCredential (EraCrypto (ShelleyEra c)) → TxCert (ShelleyEra c) Source #

getUnRegTxCert ∷ TxCert (ShelleyEra c) → Maybe (StakeCredential (EraCrypto (ShelleyEra c))) Source #

mkDelegStakeTxCert ∷ StakeCredential (EraCrypto (ShelleyEra c)) → KeyHash 'StakePool (EraCrypto (ShelleyEra c)) → TxCert (ShelleyEra c) Source #

getDelegStakeTxCert ∷ TxCert (ShelleyEra c) → Maybe (StakeCredential (EraCrypto (ShelleyEra c)), KeyHash 'StakePool (EraCrypto (ShelleyEra c))) Source #

mkGenesisDelegTxCert ∷ GenesisDelegCert (EraCrypto (ShelleyEra c)) → TxCert (ShelleyEra c) Source #

getGenesisDelegTxCert ∷ TxCert (ShelleyEra c) → Maybe (GenesisDelegCert (EraCrypto (ShelleyEra c))) Source #

mkMirTxCert ∷ MIRCert (EraCrypto (ShelleyEra c)) → TxCert (ShelleyEra c) Source #

getMirTxCert ∷ TxCert (ShelleyEra c) → Maybe (MIRCert (EraCrypto (ShelleyEra c))) Source #

pattern MirTxCert ∷ (ShelleyEraTxCert era, ProtVerAtMost era 8) ⇒ MIRCert (EraCrypto era) → TxCert era Source #

pattern GenesisDelegTxCert ∷ (ShelleyEraTxCert era, ProtVerAtMost era 8) ⇒ KeyHash 'Genesis (EraCrypto era) → KeyHash 'GenesisDelegate (EraCrypto era) → VRFVerKeyHash 'GenDelegVRF (EraCrypto era) → TxCert era Source #

pattern RegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential (EraCrypto era) → TxCert era Source #

pattern UnRegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential (EraCrypto era) → TxCert era Source #

pattern DelegStakeTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential (EraCrypto era) → KeyHash 'StakePool (EraCrypto era) → TxCert era Source #

Conway Era

Complete set of patterns for Conway TxCert:

TxCert =
  RegPoolTxCert
  RetirePoolTxCert
  RegTxCert
  UnRegTxCert
  RegDepositTxCert
  UnRegDepositTxCert
  DelegTxCert
  RegDepositDelegTxCert
  AuthCommitteeHotKeyTxCert
  ResignCommitteeColdTxCert
  RegDRepTxCert
  UnRegDRepTxCert

class ShelleyEraTxCert era ⇒ ConwayEraTxCert era Source #

Minimal complete definition

mkRegDepositTxCert, getRegDepositTxCert, mkUnRegDepositTxCert, getUnRegDepositTxCert, mkDelegTxCert, getDelegTxCert, mkRegDepositDelegTxCert, getRegDepositDelegTxCert, mkAuthCommitteeHotKeyTxCert, getAuthCommitteeHotKeyTxCert, mkResignCommitteeColdTxCert, getResignCommitteeColdTxCert, mkRegDRepTxCert, getRegDRepTxCert, mkUnRegDRepTxCert, getUnRegDRepTxCert, mkUpdateDRepTxCert, getUpdateDRepTxCert

Instances

Instances details

Crypto c ⇒ ConwayEraTxCert (ConwayEra c)

Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

mkRegDepositTxCert ∷ StakeCredential (EraCrypto (ConwayEra c)) → Coin → TxCert (ConwayEra c) Source #

getRegDepositTxCert ∷ TxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Coin) Source #

mkUnRegDepositTxCert ∷ StakeCredential (EraCrypto (ConwayEra c)) → Coin → TxCert (ConwayEra c) Source #

getUnRegDepositTxCert ∷ TxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Coin) Source #

mkDelegTxCert ∷ StakeCredential (EraCrypto (ConwayEra c)) → Delegatee (EraCrypto (ConwayEra c)) → TxCert (ConwayEra c) Source #

getDelegTxCert ∷ TxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Delegatee (EraCrypto (ConwayEra c))) Source #

mkRegDepositDelegTxCert ∷ StakeCredential (EraCrypto (ConwayEra c)) → Delegatee (EraCrypto (ConwayEra c)) → Coin → TxCert (ConwayEra c) Source #

getRegDepositDelegTxCert ∷ TxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Delegatee (EraCrypto (ConwayEra c)), Coin) Source #

mkAuthCommitteeHotKeyTxCert ∷ Credential 'ColdCommitteeRole (EraCrypto (ConwayEra c)) → Credential 'HotCommitteeRole (EraCrypto (ConwayEra c)) → TxCert (ConwayEra c) Source #

getAuthCommitteeHotKeyTxCert ∷ TxCert (ConwayEra c) → Maybe (Credential 'ColdCommitteeRole (EraCrypto (ConwayEra c)), Credential 'HotCommitteeRole (EraCrypto (ConwayEra c))) Source #

mkResignCommitteeColdTxCert ∷ Credential 'ColdCommitteeRole (EraCrypto (ConwayEra c)) → StrictMaybe (Anchor (EraCrypto (ConwayEra c))) → TxCert (ConwayEra c) Source #

getResignCommitteeColdTxCert ∷ TxCert (ConwayEra c) → Maybe (Credential 'ColdCommitteeRole (EraCrypto (ConwayEra c)), StrictMaybe (Anchor (EraCrypto (ConwayEra c)))) Source #

mkRegDRepTxCert ∷ Credential 'DRepRole (EraCrypto (ConwayEra c)) → Coin → StrictMaybe (Anchor (EraCrypto (ConwayEra c))) → TxCert (ConwayEra c) Source #

getRegDRepTxCert ∷ TxCert (ConwayEra c) → Maybe (Credential 'DRepRole (EraCrypto (ConwayEra c)), Coin, StrictMaybe (Anchor (EraCrypto (ConwayEra c)))) Source #

mkUnRegDRepTxCert ∷ Credential 'DRepRole (EraCrypto (ConwayEra c)) → Coin → TxCert (ConwayEra c) Source #

getUnRegDRepTxCert ∷ TxCert (ConwayEra c) → Maybe (Credential 'DRepRole (EraCrypto (ConwayEra c)), Coin) Source #

mkUpdateDRepTxCert ∷ Credential 'DRepRole (EraCrypto (ConwayEra c)) → StrictMaybe (Anchor (EraCrypto (ConwayEra c))) → TxCert (ConwayEra c) Source #

getUpdateDRepTxCert ∷ TxCert (ConwayEra c) → Maybe (Credential 'DRepRole (EraCrypto (ConwayEra c)), StrictMaybe (Anchor (EraCrypto (ConwayEra c)))) Source #

getDelegateeTxCert ∷ ConwayEraTxCert era ⇒ TxCert era → Maybe (Delegatee (EraCrypto era)) Source #

data Delegatee c Source #

First type argument is the deposit

Constructors

DelegStake !(KeyHash 'StakePool c)
DelegVote !(DRep c)
DelegStakeVote !(KeyHash 'StakePool c) !(DRep c)

Instances

Instances details

Crypto c ⇒ FromJSON (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods parseJSON ∷ Value → Parser (Delegatee c) Source # parseJSONList ∷ Value → Parser [Delegatee c] Source # omittedField ∷ Maybe (Delegatee c) Source #
Crypto c ⇒ ToJSON (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods toJSON ∷ Delegatee c → Value Source # toEncoding ∷ Delegatee c → Encoding Source # toJSONList ∷ [Delegatee c] → Value Source # toEncodingList ∷ [Delegatee c] → Encoding Source # omitField ∷ Delegatee c → Bool Source #
Generic (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Associated Types type Rep (Delegatee c) ∷ Type → Type Source # Methods from ∷ Delegatee c → Rep (Delegatee c) x Source # to ∷ Rep (Delegatee c) x → Delegatee c Source #
Show (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods showsPrec ∷ Int → Delegatee c → ShowS Source # show ∷ Delegatee c → String Source # showList ∷ [Delegatee c] → ShowS Source #
Crypto c ⇒ DecCBOR (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods decCBOR ∷ Decoder s (Delegatee c) Source # dropCBOR ∷ Proxy (Delegatee c) → Decoder s () Source # label ∷ Proxy (Delegatee c) → Text Source #
Crypto c ⇒ EncCBOR (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods encCBOR ∷ Delegatee c → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Delegatee c) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Delegatee c] → Size Source #
NFData (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods rnf ∷ Delegatee c → () Source #
Eq (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods (==) ∷ Delegatee c → Delegatee c → Bool Source # (/=) ∷ Delegatee c → Delegatee c → Bool Source #
Ord (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods compare ∷ Delegatee c → Delegatee c → Ordering Source # (<) ∷ Delegatee c → Delegatee c → Bool Source # (<=) ∷ Delegatee c → Delegatee c → Bool Source # (>) ∷ Delegatee c → Delegatee c → Bool Source # (>=) ∷ Delegatee c → Delegatee c → Bool Source # max ∷ Delegatee c → Delegatee c → Delegatee c Source # min ∷ Delegatee c → Delegatee c → Delegatee c Source #
NoThunks (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert Methods noThunks ∷ Context → Delegatee c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Delegatee c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Delegatee c) → String Source #
type Rep (Delegatee c)
Instance details Defined in Cardano.Ledger.Conway.TxCert type Rep (Delegatee c) = D1 ('MetaData "Delegatee" "Cardano.Ledger.Conway.TxCert" "cardano-ledger-conway-1.18.0.0-inplace" 'False) (C1 ('MetaCons "DelegStake" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c))) :+: (C1 ('MetaCons "DelegVote" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (DRep c))) :+: C1 ('MetaCons "DelegStakeVote" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c)) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (DRep c)))))

getStakePoolDelegatee ∷ Delegatee c → Maybe (KeyHash 'StakePool c) Source #

pattern RegDepositTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Coin → TxCert era Source #

pattern UnRegDepositTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Coin → TxCert era Source #

pattern DelegTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Delegatee (EraCrypto era) → TxCert era Source #

pattern RegDepositDelegTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential (EraCrypto era) → Delegatee (EraCrypto era) → Coin → TxCert era Source #

pattern AuthCommitteeHotKeyTxCert ∷ ConwayEraTxCert era ⇒ Credential 'ColdCommitteeRole (EraCrypto era) → Credential 'HotCommitteeRole (EraCrypto era) → TxCert era Source #

pattern ResignCommitteeColdTxCert ∷ ConwayEraTxCert era ⇒ Credential 'ColdCommitteeRole (EraCrypto era) → StrictMaybe (Anchor (EraCrypto era)) → TxCert era Source #

pattern RegDRepTxCert ∷ ConwayEraTxCert era ⇒ Credential 'DRepRole (EraCrypto era) → Coin → StrictMaybe (Anchor (EraCrypto era)) → TxCert era Source #

pattern UnRegDRepTxCert ∷ ConwayEraTxCert era ⇒ Credential 'DRepRole (EraCrypto era) → Coin → TxCert era Source #