cardano-ledger-api-1.15.0.0: Public API for the cardano ledger codebase
Safe HaskellNone
LanguageHaskell2010

Cardano.Ledger.Api.Tx.Cert

Synopsis

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

Associated Types

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

type TxCertUpgradeError era Source #

Methods

getRegPoolTxCert ∷ TxCert era → Maybe (StakePoolParams era) Source #

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

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

Extract staking credential from any certificate that can register such credential

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

Extract staking credential from any certificate that can unregister such credential

Instances

Instances details
EraTxCert AllegraEra 
Instance details

Defined in Cardano.Ledger.Allegra.TxCert

EraTxCert AlonzoEra 
Instance details

Defined in Cardano.Ledger.Alonzo.TxCert

EraTxCert BabbageEra 
Instance details

Defined in Cardano.Ledger.Babbage.TxCert

EraTxCert ConwayEra 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

EraTxCert DijkstraEra 
Instance details

Defined in Cardano.Ledger.Dijkstra.TxCert

EraTxCert MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.TxCert

Associated Types

type TxCert MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.TxCert

type TxCertUpgradeError MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.TxCert

EraTxCert ShelleyEra 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

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 ⇒ StakePoolParams era → TxCert era 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

Any Era

class EraTxCert era ⇒ AnyEraTxCert era where Source #

Minimal complete definition

Nothing

Methods

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

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

anyEraToGenesisDelegTxCert ∷ TxCert era → Maybe GenesisDelegCert Source #

anyEraToMirTxCert ∷ TxCert era → Maybe MIRCert Source #

anyEraToRegDepositTxCert ∷ TxCert era → Maybe (Credential 'Staking, Coin) Source #

anyEraToUnRegDepositTxCert ∷ TxCert era → Maybe (Credential 'Staking, Coin) Source #

anyEraToDelegTxCert ∷ TxCert era → Maybe (Credential 'Staking, Delegatee) Source #

anyEraToRegDepositDelegTxCert ∷ TxCert era → Maybe (Credential 'Staking, Delegatee, Coin) Source #

anyEraToAuthCommitteeHotKeyTxCert ∷ TxCert era → Maybe (Credential 'ColdCommitteeRole, Credential 'HotCommitteeRole) Source #

anyEraToResignCommitteeColdTxCert ∷ TxCert era → Maybe (Credential 'ColdCommitteeRole, StrictMaybe Anchor) Source #

anyEraToRegDRepTxCert ∷ TxCert era → Maybe (Credential 'DRepRole, Coin, StrictMaybe Anchor) Source #

anyEraToUnRegDRepTxCert ∷ TxCert era → Maybe (Credential 'DRepRole, Coin) Source #

anyEraToUpdateDRepTxCert ∷ TxCert era → Maybe (Credential 'DRepRole, StrictMaybe Anchor) Source #

Instances

Instances details
AnyEraTxCert AllegraEra Source # 
Instance details

Defined in Cardano.Ledger.Api.Tx.Cert

AnyEraTxCert AlonzoEra Source # 
Instance details

Defined in Cardano.Ledger.Api.Tx.Cert

AnyEraTxCert BabbageEra Source # 
Instance details

Defined in Cardano.Ledger.Api.Tx.Cert

AnyEraTxCert ConwayEra Source # 
Instance details

Defined in Cardano.Ledger.Api.Tx.Cert

AnyEraTxCert DijkstraEra Source # 
Instance details

Defined in Cardano.Ledger.Api.Tx.Cert

AnyEraTxCert MaryEra Source # 
Instance details

Defined in Cardano.Ledger.Api.Tx.Cert

AnyEraTxCert ShelleyEra Source # 
Instance details

Defined in Cardano.Ledger.Api.Tx.Cert

pattern AnyEraMirTxCert ∷ AnyEraTxCert era ⇒ MIRCert → TxCert era Source #

Shelley Era

class (EraTxCert era, AtMostEra "Conway" era) ⇒ ShelleyEraTxCert era where Source #

All of the Shelley related certificate functionality that has been fully deprecated in Dijkstra.

Instances

Instances details
ShelleyEraTxCert AllegraEra 
Instance details

Defined in Cardano.Ledger.Allegra.TxCert

ShelleyEraTxCert AlonzoEra 
Instance details

Defined in Cardano.Ledger.Alonzo.TxCert

ShelleyEraTxCert BabbageEra 
Instance details

Defined in Cardano.Ledger.Babbage.TxCert

ShelleyEraTxCert ConwayEra 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

ShelleyEraTxCert MaryEra 
Instance details

Defined in Cardano.Ledger.Mary.TxCert

ShelleyEraTxCert ShelleyEra 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

pattern MirTxCert ∷ (ShelleyEraTxCert era, AtMostEra "Babbage" era) ⇒ MIRCert → TxCert era Source #

Conway Era

class EraTxCert era ⇒ ConwayEraTxCert era where Source #

Instances

Instances details
ConwayEraTxCert ConwayEra 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

mkRegDepositTxCert ∷ Credential 'Staking → Coin → TxCert ConwayEra Source #

getRegDepositTxCert ∷ TxCert ConwayEra → Maybe (Credential 'Staking, Coin) Source #

mkUnRegDepositTxCert ∷ Credential 'Staking → Coin → TxCert ConwayEra Source #

getUnRegDepositTxCert ∷ TxCert ConwayEra → Maybe (Credential 'Staking, Coin) Source #

mkDelegTxCert ∷ Credential 'Staking → Delegatee → TxCert ConwayEra Source #

getDelegTxCert ∷ TxCert ConwayEra → Maybe (Credential 'Staking, Delegatee) Source #

mkRegDepositDelegTxCert ∷ Credential 'Staking → Delegatee → Coin → TxCert ConwayEra Source #

getRegDepositDelegTxCert ∷ TxCert ConwayEra → Maybe (Credential 'Staking, 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 #

ConwayEraTxCert DijkstraEra 
Instance details

Defined in Cardano.Ledger.Dijkstra.TxCert

Methods

mkRegDepositTxCert ∷ Credential 'Staking → Coin → TxCert DijkstraEra Source #

getRegDepositTxCert ∷ TxCert DijkstraEra → Maybe (Credential 'Staking, Coin) Source #

mkUnRegDepositTxCert ∷ Credential 'Staking → Coin → TxCert DijkstraEra Source #

getUnRegDepositTxCert ∷ TxCert DijkstraEra → Maybe (Credential 'Staking, Coin) Source #

mkDelegTxCert ∷ Credential 'Staking → Delegatee → TxCert DijkstraEra Source #

getDelegTxCert ∷ TxCert DijkstraEra → Maybe (Credential 'Staking, Delegatee) Source #

mkRegDepositDelegTxCert ∷ Credential 'Staking → Delegatee → Coin → TxCert DijkstraEra Source #

getRegDepositDelegTxCert ∷ TxCert DijkstraEra → Maybe (Credential 'Staking, Delegatee, Coin) Source #

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

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

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

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

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

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

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

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

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

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

data Delegatee Source #

First type argument is the deposit

Instances

Instances details
FromJSON Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

ToJSON Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

DecCBOR Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

EncCBOR Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

NFData Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

rnf ∷ Delegatee → () #

Generic Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Associated Types

type Rep Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

from ∷ Delegatee → Rep Delegatee x #

to ∷ Rep Delegatee x → Delegatee #

Show Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

showsPrec ∷ Int → Delegatee → ShowS #

show ∷ Delegatee → String #

showList ∷ [Delegatee] → ShowS #

Eq Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

(==) ∷ Delegatee → Delegatee → Bool #

(/=) ∷ Delegatee → Delegatee → Bool #

Ord Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

NoThunks Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

type Rep Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert