cardano-api
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Compatible.Certificate

Synopsis

Types that vary across the hardfork boundary

type family Delegatee era where ... Source #

Equations

Delegatee DijkstraEra = Delegatee 
Delegatee ConwayEra = Delegatee 
Delegatee BabbageEra = Hash StakePoolKey 
Delegatee AlonzoEra = Hash StakePoolKey 
Delegatee MaryEra = Hash StakePoolKey 
Delegatee AllegraEra = Hash StakePoolKey 
Delegatee ShelleyEra = Hash StakePoolKey 

Registering stake address and delegating

makeStakeAddressDelegationCertificate :: IsShelleyBasedEra era => StakeCredential -> Delegatee era -> Certificate (ShelleyLedgerEra era) Source #

makeStakeAddressRegistrationCertificate :: IsShelleyBasedEra era => StakeRegistrationRequirements era -> Certificate (ShelleyLedgerEra era) Source #

makeStakeAddressUnregistrationCertificate :: IsShelleyBasedEra era => StakeCredential -> Certificate (ShelleyLedgerEra era) Source #

data StakeCredentialAndDeposit Source #

Constructors

StakeCredentialAndDeposit StakeCredential Coin 

type family StakeRegistrationRequirements era where ... Source #

Equations

StakeRegistrationRequirements DijkstraEra = StakeCredentialAndDeposit 
StakeRegistrationRequirements ConwayEra = StakeCredentialAndDeposit 
StakeRegistrationRequirements BabbageEra = StakeCredential 
StakeRegistrationRequirements AlonzoEra = StakeCredential 
StakeRegistrationRequirements MaryEra = StakeCredential 
StakeRegistrationRequirements AllegraEra = StakeCredential 
StakeRegistrationRequirements ShelleyEra = StakeCredential 

Registering stake pools

makeStakePoolRegistrationCertificate :: IsShelleyBasedEra era => PoolParams -> Certificate (ShelleyLedgerEra era) Source #

makeStakePoolRetirementCertificate :: IsShelleyBasedEra era => Hash StakePoolKey -> EpochNo -> Certificate (ShelleyLedgerEra era) Source #

Special certificates

makeMIRCertificate :: MIRPot -> MIRTarget -> Certificate (ShelleyLedgerEra BabbageEra) Source #

makeGenesisKeyDelegationCertificate :: Hash GenesisKey -> Hash GenesisDelegateKey -> Hash VrfKey -> Certificate (ShelleyLedgerEra BabbageEra) Source #

data MIRTarget Source #

MIRTarget specifies if funds from either the reserves or the treasury are to be handed out to a collection of reward accounts or instead transfered to the opposite pot.

Constructors

StakeAddressesMIR !(Map (Credential 'Staking) DeltaCoin) 
SendToOppositePotMIR !Coin 

Instances

Instances details
ToJSON MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

toJSON :: MIRTarget -> Value #

toEncoding :: MIRTarget -> Encoding #

toJSONList :: [MIRTarget] -> Value #

toEncodingList :: [MIRTarget] -> Encoding #

omitField :: MIRTarget -> Bool #

DecCBOR MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

decCBOR :: Decoder s MIRTarget Source #

dropCBOR :: Proxy MIRTarget -> Decoder s () Source #

label :: Proxy MIRTarget -> Text Source #

EncCBOR MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

encCBOR :: MIRTarget -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy MIRTarget -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [MIRTarget] -> Size Source #

NFData MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

rnf :: MIRTarget -> () Source #

Generic MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Associated Types

type Rep MIRTarget 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

type Rep MIRTarget = D1 ('MetaData "MIRTarget" "Cardano.Ledger.Shelley.TxCert" "cardano-ledger-shelley-1.17.0.0-8e14283c15bc91bd3f0b85771c7cee64dfa0626b22db973e40e4d97419c57431" 'False) (C1 ('MetaCons "StakeAddressesMIR" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking) DeltaCoin))) :+: C1 ('MetaCons "SendToOppositePotMIR" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)))

Methods

from :: MIRTarget -> Rep MIRTarget x Source #

to :: Rep MIRTarget x -> MIRTarget Source #

Show MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

showsPrec :: Int -> MIRTarget -> ShowS Source #

show :: MIRTarget -> String Source #

showList :: [MIRTarget] -> ShowS Source #

Eq MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

(==) :: MIRTarget -> MIRTarget -> Bool Source #

(/=) :: MIRTarget -> MIRTarget -> Bool Source #

Ord MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

compare :: MIRTarget -> MIRTarget -> Ordering Source #

(<) :: MIRTarget -> MIRTarget -> Bool Source #

(<=) :: MIRTarget -> MIRTarget -> Bool Source #

(>) :: MIRTarget -> MIRTarget -> Bool Source #

(>=) :: MIRTarget -> MIRTarget -> Bool Source #

max :: MIRTarget -> MIRTarget -> MIRTarget Source #

min :: MIRTarget -> MIRTarget -> MIRTarget Source #

NoThunks MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

noThunks :: Context -> MIRTarget -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> MIRTarget -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy MIRTarget -> String #

type Rep MIRTarget Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

type Rep MIRTarget = D1 ('MetaData "MIRTarget" "Cardano.Ledger.Shelley.TxCert" "cardano-ledger-shelley-1.17.0.0-8e14283c15bc91bd3f0b85771c7cee64dfa0626b22db973e40e4d97419c57431" 'False) (C1 ('MetaCons "StakeAddressesMIR" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (Credential 'Staking) DeltaCoin))) :+: C1 ('MetaCons "SendToOppositePotMIR" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Coin)))

data MIRPot Source #

Constructors

ReservesMIR 
TreasuryMIR 

Instances

Instances details
ToJSON MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

toJSON :: MIRPot -> Value #

toEncoding :: MIRPot -> Encoding #

toJSONList :: [MIRPot] -> Value #

toEncodingList :: [MIRPot] -> Encoding #

omitField :: MIRPot -> Bool #

DecCBOR MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

decCBOR :: Decoder s MIRPot Source #

dropCBOR :: Proxy MIRPot -> Decoder s () Source #

label :: Proxy MIRPot -> Text Source #

EncCBOR MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

encCBOR :: MIRPot -> Encoding Source #

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy MIRPot -> Size Source #

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [MIRPot] -> Size Source #

NFData MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

rnf :: MIRPot -> () Source #

Bounded MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

minBound :: MIRPot Source #

maxBound :: MIRPot Source #

Enum MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

succ :: MIRPot -> MIRPot Source #

pred :: MIRPot -> MIRPot Source #

toEnum :: Int -> MIRPot Source #

fromEnum :: MIRPot -> Int Source #

enumFrom :: MIRPot -> [MIRPot] Source #

enumFromThen :: MIRPot -> MIRPot -> [MIRPot] Source #

enumFromTo :: MIRPot -> MIRPot -> [MIRPot] Source #

enumFromThenTo :: MIRPot -> MIRPot -> MIRPot -> [MIRPot] Source #

Generic MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Associated Types

type Rep MIRPot 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

type Rep MIRPot = D1 ('MetaData "MIRPot" "Cardano.Ledger.Shelley.TxCert" "cardano-ledger-shelley-1.17.0.0-8e14283c15bc91bd3f0b85771c7cee64dfa0626b22db973e40e4d97419c57431" 'False) (C1 ('MetaCons "ReservesMIR" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TreasuryMIR" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: MIRPot -> Rep MIRPot x Source #

to :: Rep MIRPot x -> MIRPot Source #

Show MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

showsPrec :: Int -> MIRPot -> ShowS Source #

show :: MIRPot -> String Source #

showList :: [MIRPot] -> ShowS Source #

Eq MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

(==) :: MIRPot -> MIRPot -> Bool Source #

(/=) :: MIRPot -> MIRPot -> Bool Source #

Ord MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

compare :: MIRPot -> MIRPot -> Ordering Source #

(<) :: MIRPot -> MIRPot -> Bool Source #

(<=) :: MIRPot -> MIRPot -> Bool Source #

(>) :: MIRPot -> MIRPot -> Bool Source #

(>=) :: MIRPot -> MIRPot -> Bool Source #

max :: MIRPot -> MIRPot -> MIRPot Source #

min :: MIRPot -> MIRPot -> MIRPot Source #

NoThunks MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

Methods

noThunks :: Context -> MIRPot -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> MIRPot -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy MIRPot -> String #

type Rep MIRPot Source # 
Instance details

Defined in Cardano.Ledger.Shelley.TxCert

type Rep MIRPot = D1 ('MetaData "MIRPot" "Cardano.Ledger.Shelley.TxCert" "cardano-ledger-shelley-1.17.0.0-8e14283c15bc91bd3f0b85771c7cee64dfa0626b22db973e40e4d97419c57431" 'False) (C1 ('MetaCons "ReservesMIR" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TreasuryMIR" 'PrefixI 'False) (U1 :: Type -> Type))

selectStakeCredentialWitness :: IsShelleyBasedEra era => Certificate (ShelleyLedgerEra era) -> Maybe StakeCredential Source #

Get the stake credential witness for a certificate that requires it. Only stake address deregistration and delegation requires witnessing (witness can be script or key).

Internal

getTxCertWitness :: ShelleyBasedEra era -> TxCert (ShelleyLedgerEra era) -> Maybe StakeCredential Source #