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)
getScriptWitnessTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe ScriptHash
pattern RegPoolTxCert ∷ EraTxCert era ⇒ PoolParams → TxCert era
pattern RetirePoolTxCert ∷ EraTxCert era ⇒ KeyHash 'StakePool → EpochNo → TxCert era
lookupRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (Credential 'Staking)
lookupUnRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (Credential 'Staking)
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 → TxCert era
pattern GenesisDelegTxCert ∷ (ShelleyEraTxCert era, ProtVerAtMost era 8) ⇒ KeyHash 'Genesis → KeyHash 'GenesisDelegate → VRFVerKeyHash 'GenDelegVRF → TxCert era
pattern RegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential → TxCert era
pattern UnRegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential → TxCert era
pattern DelegStakeTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential → KeyHash 'StakePool → TxCert era
class ShelleyEraTxCert era ⇒ ConwayEraTxCert era
getDelegateeTxCert ∷ ConwayEraTxCert era ⇒ TxCert era → Maybe Delegatee
data Delegatee
- = DelegStake !(KeyHash 'StakePool)
- | DelegVote !DRep
- | DelegStakeVote !(KeyHash 'StakePool) !DRep
getStakePoolDelegatee ∷ Delegatee → Maybe (KeyHash 'StakePool)
pattern RegDepositTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential → Coin → TxCert era
pattern UnRegDepositTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential → Coin → TxCert era
pattern DelegTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential → Delegatee → TxCert era
pattern RegDepositDelegTxCert ∷ ConwayEraTxCert era ⇒ StakeCredential → Delegatee → Coin → TxCert era
pattern AuthCommitteeHotKeyTxCert ∷ ConwayEraTxCert era ⇒ Credential 'ColdCommitteeRole → Credential 'HotCommitteeRole → TxCert era
pattern ResignCommitteeColdTxCert ∷ ConwayEraTxCert era ⇒ Credential 'ColdCommitteeRole → StrictMaybe Anchor → TxCert era
pattern RegDRepTxCert ∷ ConwayEraTxCert era ⇒ Credential 'DRepRole → Coin → StrictMaybe Anchor → TxCert era
pattern UnRegDRepTxCert ∷ ConwayEraTxCert era ⇒ Credential 'DRepRole → 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) Source #

Return a witness key whenever a certificate requires one

getScriptWitnessTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe ScriptHash Source #

Return a ScriptHash for certificate types that require a witness

pattern RegPoolTxCert ∷ EraTxCert era ⇒ PoolParams → TxCert era Source #

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

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

Extract staking credential from any certificate that can register such credential

lookupUnRegStakeTxCert ∷ EraTxCert era ⇒ TxCert era → Maybe (Credential 'Staking) 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

ShelleyEraTxCert ShelleyEra

Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

mkRegTxCert ∷ StakeCredential → TxCert ShelleyEra Source #

getRegTxCert ∷ TxCert ShelleyEra → Maybe StakeCredential Source #

mkUnRegTxCert ∷ StakeCredential → TxCert ShelleyEra Source #

getUnRegTxCert ∷ TxCert ShelleyEra → Maybe StakeCredential Source #

mkDelegStakeTxCert ∷ StakeCredential → KeyHash 'StakePool → TxCert ShelleyEra Source #

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

mkGenesisDelegTxCert ∷ GenesisDelegCert → TxCert ShelleyEra Source #

getGenesisDelegTxCert ∷ TxCert ShelleyEra → Maybe GenesisDelegCert Source #

mkMirTxCert ∷ MIRCert → TxCert ShelleyEra Source #

getMirTxCert ∷ TxCert ShelleyEra → Maybe MIRCert Source #

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

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

pattern RegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential → TxCert era Source #

pattern UnRegTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential → TxCert era Source #

pattern DelegStakeTxCert ∷ ShelleyEraTxCert era ⇒ StakeCredential → KeyHash 'StakePool → 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

ConwayEraTxCert ConwayEra

Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

mkRegDepositTxCert ∷ StakeCredential → Coin → TxCert ConwayEra Source #

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

mkUnRegDepositTxCert ∷ StakeCredential → Coin → TxCert ConwayEra Source #

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

mkDelegTxCert ∷ StakeCredential → Delegatee → TxCert ConwayEra Source #

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

mkRegDepositDelegTxCert ∷ StakeCredential → Delegatee → Coin → TxCert ConwayEra Source #

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

mkAuthCommitteeHotKeyTxCert ∷ Credential 'ColdCommitteeRole → Credential 'HotCommitteeRole → TxCert ConwayEra Source #

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

mkResignCommitteeColdTxCert ∷ Credential 'ColdCommitteeRole → StrictMaybe Anchor → TxCert ConwayEra Source #

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

mkRegDRepTxCert ∷ Credential 'DRepRole → Coin → StrictMaybe Anchor → TxCert ConwayEra Source #

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

mkUnRegDRepTxCert ∷ Credential 'DRepRole → Coin → TxCert ConwayEra Source #

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

mkUpdateDRepTxCert ∷ Credential 'DRepRole → StrictMaybe Anchor → TxCert ConwayEra Source #

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

getDelegateeTxCert ∷ ConwayEraTxCert era ⇒ TxCert era → Maybe Delegatee Source #

data Delegatee Source #

First type argument is the deposit

Constructors

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

Instances

Instances details

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

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

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

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

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

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

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

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

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

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