cardano-ledger-api-1.13.0.0: Public API for the cardano ledger codebase
Safe HaskellSafe-Inferred
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

getRegPoolTxCertTxCert era → Maybe PoolParams Source #

getRetirePoolTxCertTxCert era → Maybe (KeyHash 'StakePool, EpochNo) Source #

lookupRegStakeTxCertTxCert era → Maybe (Credential 'Staking) Source #

Extract staking credential from any certificate that can register such credential

lookupUnRegStakeTxCertTxCert era → Maybe (Credential 'Staking) Source #

Extract staking credential from any certificate that can unregister such credential

upgradeTxCertEraTxCert 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.

getVKeyWitnessTxCertEraTxCert era ⇒ TxCert era → Maybe (KeyHash 'Witness) Source #

Return a witness key whenever a certificate requires one

getScriptWitnessTxCertEraTxCert era ⇒ TxCert era → Maybe ScriptHash Source #

Return a ScriptHash for certificate types that require a witness

pattern RegPoolTxCertEraTxCert era ⇒ PoolParamsTxCert era Source #

isRegStakeTxCertEraTxCert era ⇒ TxCert era → Bool Source #

Check if supplied TxCert is a stake registering certificate

isUnRegStakeTxCertEraTxCert 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

anyEraToRegTxCertTxCert era → Maybe (Credential 'Staking) Source #

anyEraToUnRegTxCertTxCert era → Maybe (Credential 'Staking) Source #

anyEraToGenesisDelegTxCertTxCert era → Maybe GenesisDelegCert Source #

anyEraToMirTxCertTxCert era → Maybe MIRCert Source #

anyEraToRegDepositTxCertTxCert era → Maybe (Credential 'Staking, Coin) Source #

anyEraToUnRegDepositTxCertTxCert era → Maybe (Credential 'Staking, Coin) Source #

anyEraToDelegTxCertTxCert era → Maybe (Credential 'Staking, Delegatee) Source #

anyEraToRegDepositDelegTxCertTxCert era → Maybe (Credential 'Staking, Delegatee, Coin) Source #

anyEraToAuthCommitteeHotKeyTxCertTxCert era → Maybe (Credential 'ColdCommitteeRole, Credential 'HotCommitteeRole) Source #

anyEraToResignCommitteeColdTxCertTxCert era → Maybe (Credential 'ColdCommitteeRole, StrictMaybe Anchor) Source #

anyEraToRegDRepTxCertTxCert era → Maybe (Credential 'DRepRole, Coin, StrictMaybe Anchor) Source #

anyEraToUnRegDRepTxCertTxCert era → Maybe (Credential 'DRepRole, Coin) Source #

anyEraToUpdateDRepTxCertTxCert 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 AnyEraMirTxCertAnyEraTxCert era ⇒ MIRCertTxCert era Source #

Shelley Era

pattern MirTxCert ∷ (ShelleyEraTxCert era, AtMostEra "Babbage" era) ⇒ MIRCertTxCert 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

mkRegDepositTxCertStakeCredentialCoinTxCert ConwayEra Source #

getRegDepositTxCertTxCert ConwayEraMaybe (StakeCredential, Coin) Source #

mkUnRegDepositTxCertStakeCredentialCoinTxCert ConwayEra Source #

getUnRegDepositTxCertTxCert ConwayEraMaybe (StakeCredential, Coin) Source #

mkDelegTxCertStakeCredentialDelegateeTxCert ConwayEra Source #

getDelegTxCertTxCert ConwayEraMaybe (StakeCredential, Delegatee) Source #

mkRegDepositDelegTxCertStakeCredentialDelegateeCoinTxCert ConwayEra Source #

getRegDepositDelegTxCertTxCert ConwayEraMaybe (StakeCredential, Delegatee, Coin) Source #

mkAuthCommitteeHotKeyTxCertCredential 'ColdCommitteeRoleCredential 'HotCommitteeRoleTxCert ConwayEra Source #

getAuthCommitteeHotKeyTxCertTxCert ConwayEraMaybe (Credential 'ColdCommitteeRole, Credential 'HotCommitteeRole) Source #

mkResignCommitteeColdTxCertCredential 'ColdCommitteeRoleStrictMaybe AnchorTxCert ConwayEra Source #

getResignCommitteeColdTxCertTxCert ConwayEraMaybe (Credential 'ColdCommitteeRole, StrictMaybe Anchor) Source #

mkRegDRepTxCertCredential 'DRepRoleCoinStrictMaybe AnchorTxCert ConwayEra Source #

getRegDRepTxCertTxCert ConwayEraMaybe (Credential 'DRepRole, Coin, StrictMaybe Anchor) Source #

mkUnRegDRepTxCertCredential 'DRepRoleCoinTxCert ConwayEra Source #

getUnRegDRepTxCertTxCert ConwayEraMaybe (Credential 'DRepRole, Coin) Source #

mkUpdateDRepTxCertCredential 'DRepRoleStrictMaybe AnchorTxCert ConwayEra Source #

getUpdateDRepTxCertTxCert ConwayEraMaybe (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

Generic Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Associated Types

type Rep DelegateeTypeType #

Methods

fromDelegateeRep Delegatee x #

toRep Delegatee x → Delegatee #

Show Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

showsPrecIntDelegateeShowS #

showDelegateeString #

showList ∷ [Delegatee] → ShowS #

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

rnfDelegatee → () #

Eq Delegatee 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

(==)DelegateeDelegateeBool #

(/=)DelegateeDelegateeBool #

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