cardano-ledger-api-1.9.2.2: Public API for the cardano ledger codebase
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Ledger.Api.Tx.Cert

Synopsis

Documentation

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 (EraCrypto era)) Source #

Return a witness key whenever a certificate requires one

getScriptWitnessTxCertEraTxCert era ⇒ TxCert era → Maybe (ScriptHash (EraCrypto era)) Source #

Return a ScriptHash for certificate types that require a witness

pattern RegPoolTxCertEraTxCert era ⇒ PoolParams (EraCrypto era) → TxCert era Source #

pattern RetirePoolTxCertEraTxCert era ⇒ KeyHash 'StakePool (EraCrypto era) → EpochNoTxCert era Source #

lookupRegStakeTxCertEraTxCert era ⇒ TxCert era → Maybe (Credential 'Staking (EraCrypto era)) Source #

Extract staking credential from any certificate that can register such credential

lookupUnRegStakeTxCertEraTxCert era ⇒ TxCert era → Maybe (Credential 'Staking (EraCrypto era)) Source #

Extract staking credential from any certificate that can unregister such credential

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

Shelley Era

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

Conway Era

class ShelleyEraTxCert era ⇒ ConwayEraTxCert era Source #

Instances

Instances details
Crypto c ⇒ ConwayEraTxCert (ConwayEra c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

mkRegDepositTxCertStakeCredential (EraCrypto (ConwayEra c)) → CoinTxCert (ConwayEra c) Source #

getRegDepositTxCertTxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Coin) Source #

mkUnRegDepositTxCertStakeCredential (EraCrypto (ConwayEra c)) → CoinTxCert (ConwayEra c) Source #

getUnRegDepositTxCertTxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Coin) Source #

mkDelegTxCertStakeCredential (EraCrypto (ConwayEra c)) → Delegatee (EraCrypto (ConwayEra c)) → TxCert (ConwayEra c) Source #

getDelegTxCertTxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Delegatee (EraCrypto (ConwayEra c))) Source #

mkRegDepositDelegTxCertStakeCredential (EraCrypto (ConwayEra c)) → Delegatee (EraCrypto (ConwayEra c)) → CoinTxCert (ConwayEra c) Source #

getRegDepositDelegTxCertTxCert (ConwayEra c) → Maybe (StakeCredential (EraCrypto (ConwayEra c)), Delegatee (EraCrypto (ConwayEra c)), Coin) Source #

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

getAuthCommitteeHotKeyTxCertTxCert (ConwayEra c) → Maybe (Credential 'ColdCommitteeRole (EraCrypto (ConwayEra c)), Credential 'HotCommitteeRole (EraCrypto (ConwayEra c))) Source #

mkResignCommitteeColdTxCertCredential 'ColdCommitteeRole (EraCrypto (ConwayEra c)) → StrictMaybe (Anchor (EraCrypto (ConwayEra c))) → TxCert (ConwayEra c) Source #

getResignCommitteeColdTxCertTxCert (ConwayEra c) → Maybe (Credential 'ColdCommitteeRole (EraCrypto (ConwayEra c)), StrictMaybe (Anchor (EraCrypto (ConwayEra c)))) Source #

mkRegDRepTxCertCredential 'DRepRole (EraCrypto (ConwayEra c)) → CoinStrictMaybe (Anchor (EraCrypto (ConwayEra c))) → TxCert (ConwayEra c) Source #

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

mkUnRegDRepTxCertCredential 'DRepRole (EraCrypto (ConwayEra c)) → CoinTxCert (ConwayEra c) Source #

getUnRegDRepTxCertTxCert (ConwayEra c) → Maybe (Credential 'DRepRole (EraCrypto (ConwayEra c)), Coin) Source #

mkUpdateDRepTxCertCredential 'DRepRole (EraCrypto (ConwayEra c)) → StrictMaybe (Anchor (EraCrypto (ConwayEra c))) → TxCert (ConwayEra c) Source #

getUpdateDRepTxCertTxCert (ConwayEra c) → Maybe (Credential 'DRepRole (EraCrypto (ConwayEra c)), StrictMaybe (Anchor (EraCrypto (ConwayEra c)))) Source #

data Delegatee c Source #

First type argument is the deposit

Instances

Instances details
Crypto c ⇒ FromJSON (Delegatee c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Crypto c ⇒ ToJSON (Delegatee c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Generic (Delegatee c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Associated Types

type Rep (Delegatee c) ∷ TypeType Source #

Methods

fromDelegatee c → Rep (Delegatee c) x Source #

toRep (Delegatee c) x → Delegatee c Source #

Show (Delegatee c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Crypto c ⇒ DecCBOR (Delegatee c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Crypto c ⇒ EncCBOR (Delegatee c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

Methods

encCBORDelegatee 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

rnfDelegatee 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

NoThunks (Delegatee c) 
Instance details

Defined in Cardano.Ledger.Conway.TxCert

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.16.0.1-inplace" 'False) (C1 ('MetaCons "DelegStake" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c))) :+: (C1 ('MetaCons "DelegVote" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (DRep c))) :+: C1 ('MetaCons "DelegStakeVote" 'PrefixI 'False) (S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c)) :*: S1 ('MetaSel ('NothingMaybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (DRep c)))))