cardano-api-1.36.0: The cardano api
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Api.Certificate

Description

Certificates embedded in transactions

Synopsis

Documentation

data Certificate Source #

Constructors

StakeAddressRegistrationCertificate StakeCredential 
StakeAddressDeregistrationCertificate StakeCredential 
StakeAddressDelegationCertificate StakeCredential PoolId 
StakePoolRegistrationCertificate StakePoolParameters 
StakePoolRetirementCertificate PoolId EpochNo 
GenesisKeyDelegationCertificate (Hash GenesisKey) (Hash GenesisDelegateKey) (Hash VrfKey) 
MIRCertificate MIRPot MIRTarget 

Instances

Instances details
Show Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

showsPrec ∷ Int → Certificate → ShowS Source #

show ∷ Certificate → String Source #

showList ∷ [Certificate] → ShowS Source #

HasTypeProxy Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Associated Types

data AsType Certificate Source #

Methods

proxyToAsType ∷ Proxy Certificate → AsType Certificate Source #

SerialiseAsCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

serialiseToCBOR ∷ Certificate → ByteString Source #

deserialiseFromCBOR ∷ AsType Certificate → ByteString → Either DecoderError Certificate Source #

HasTextEnvelope Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

textEnvelopeType ∷ AsType Certificate → TextEnvelopeType Source #

textEnvelopeDefaultDescr ∷ Certificate → TextEnvelopeDescr Source #

FromCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

fromCBOR ∷ Decoder s Certificate #

label ∷ Proxy Certificate → Text #

ToCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

toCBOR ∷ Certificate → Encoding #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Certificate → Size #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Certificate] → Size #

Eq Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

(==) ∷ Certificate → Certificate → Bool Source #

(/=) ∷ Certificate → Certificate → Bool Source #

data AsType Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

data AsType Certificate = AsCertificate

Registering stake address and delegating

makeStakeAddressRegistrationCertificate ∷ StakeCredential → Certificate Source #

makeStakeAddressDeregistrationCertificate ∷ StakeCredential → Certificate Source #

makeStakeAddressDelegationCertificate ∷ StakeCredential → PoolId → Certificate Source #

type PoolId = Hash StakePoolKey Source #

Registering stake pools

makeStakePoolRegistrationCertificate ∷ StakePoolParameters → Certificate Source #

makeStakePoolRetirementCertificate ∷ PoolId → EpochNo → Certificate Source #

data StakePoolParameters Source #

Constructors

StakePoolParameters 

Fields

Instances

Instances details
Show StakePoolParameters Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

showsPrec ∷ Int → StakePoolParameters → ShowS Source #

show ∷ StakePoolParameters → String Source #

showList ∷ [StakePoolParameters] → ShowS Source #

Eq StakePoolParameters Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

(==) ∷ StakePoolParameters → StakePoolParameters → Bool Source #

(/=) ∷ StakePoolParameters → StakePoolParameters → Bool Source #

data StakePoolRelay Source #

Constructors

StakePoolRelayIp (Maybe IPv4) (Maybe IPv6) (Maybe PortNumber)

One or both of IPv4 & IPv6

StakePoolRelayDnsARecord ByteString (Maybe PortNumber)

An DNS name pointing to a A or AAAA record.

StakePoolRelayDnsSrvRecord ByteString

A DNS name pointing to a SRV record.

Instances

Instances details
Show StakePoolRelay Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

showsPrec ∷ Int → StakePoolRelay → ShowS Source #

show ∷ StakePoolRelay → String Source #

showList ∷ [StakePoolRelay] → ShowS Source #

Eq StakePoolRelay Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

(==) ∷ StakePoolRelay → StakePoolRelay → Bool Source #

(/=) ∷ StakePoolRelay → StakePoolRelay → Bool Source #

data StakePoolMetadataReference Source #

Constructors

StakePoolMetadataReference 

Fields

Instances

Instances details
Show StakePoolMetadataReference Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

showsPrec ∷ Int → StakePoolMetadataReference → ShowS Source #

show ∷ StakePoolMetadataReference → String Source #

showList ∷ [StakePoolMetadataReference] → ShowS Source #

Eq StakePoolMetadataReference Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

(==) ∷ StakePoolMetadataReference → StakePoolMetadataReference → Bool Source #

(/=) ∷ StakePoolMetadataReference → StakePoolMetadataReference → Bool Source #

Special certificates

makeMIRCertificate ∷ MIRPot → MIRTarget → Certificate Source #

makeGenesisKeyDelegationCertificate ∷ Hash GenesisKey → Hash GenesisDelegateKey → Hash VrfKey → Certificate Source #

data MIRTarget Source #

The MIRTarget determines the target of a MIRCertificate. A MIRCertificate moves lovelace from either the reserves or the treasury to either a collection of stake credentials or to the other pot.

Constructors

StakeAddressesMIR [(StakeCredential, Lovelace)]

Use StakeAddressesMIR to make the target of a MIRCertificate a mapping of stake credentials to lovelace.

SendToReservesMIR Lovelace

Use SendToReservesMIR to make the target of a MIRCertificate the reserves pot.

SendToTreasuryMIR Lovelace

Use SendToTreasuryMIR to make the target of a MIRCertificate the treasury pot.

Instances

Instances details
Show MIRTarget Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

showsPrec ∷ Int → MIRTarget → ShowS Source #

show ∷ MIRTarget → String Source #

showList ∷ [MIRTarget] → ShowS Source #

Eq MIRTarget Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

(==) ∷ MIRTarget → MIRTarget → Bool Source #

(/=) ∷ MIRTarget → MIRTarget → Bool Source #

Internal conversion functions

toShelleyCertificate ∷ Certificate → DCert StandardCrypto Source #

fromShelleyCertificate ∷ DCert StandardCrypto → Certificate Source #

toShelleyPoolParams ∷ StakePoolParameters → PoolParams StandardCrypto Source #

fromShelleyPoolParams ∷ PoolParams StandardCrypto → StakePoolParameters Source #

Data family instances

data family AsType t Source #

A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.

Values of this type are passed to deserialisation functions for example.

Instances

Instances details
data AsType AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

data AsType AddressAny = AsAddressAny
data AsType ByronAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ByronAddr = AsByronAddr
data AsType ShelleyAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ShelleyAddr = AsShelleyAddr
data AsType StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

data AsType StakeAddress = AsStakeAddress
data AsType BlockHeader Source # 
Instance details

Defined in Cardano.Api.Block

data AsType BlockHeader = AsBlockHeader
data AsType Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

data AsType Certificate = AsCertificate
data AsType AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType AllegraEra = AsAllegraEra
data AsType AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType AlonzoEra = AsAlonzoEra
data AsType BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType BabbageEra = AsBabbageEra
data AsType ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ByronEra = AsByronEra
data AsType ConwayEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ConwayEra = AsConwayEra
data AsType MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType MaryEra = AsMaryEra
data AsType ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ShelleyEra = AsShelleyEra
data AsType ByronKey Source # 
Instance details

Defined in Cardano.Api.Keys.Byron

data AsType ByronKey = AsByronKey
data AsType ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.Keys.Byron

data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType KesKey Source # 
Instance details

Defined in Cardano.Api.Keys.Praos

data AsType KesKey = AsKesKey
data AsType VrfKey Source # 
Instance details

Defined in Cardano.Api.Keys.Praos

data AsType VrfKey = AsVrfKey
data AsType GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType GenesisKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisKey = AsGenesisKey
data AsType GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType PaymentKey = AsPaymentKey
data AsType StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakeKey = AsStakeKey
data AsType StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Keys.Shelley

data AsType StakePoolKey = AsStakePoolKey
data AsType OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType OperationalCertificate = AsOperationalCertificate
data AsType OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType PraosNonce Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType PraosNonce = AsPraosNonce
data AsType UpdateProposal Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType UpdateProposal = AsUpdateProposal
data AsType PlutusScriptV1 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType PlutusScriptV2 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType ScriptHash Source # 
Instance details

Defined in Cardano.Api.Script

data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang Source # 
Instance details

Defined in Cardano.Api.Script

data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType SimpleScript' Source # 
Instance details

Defined in Cardano.Api.Script

data AsType SimpleScript' = AsSimpleScript
data AsType HashableScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

data AsType ScriptData = AsScriptData
data AsType TextEnvelope Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

data AsType TextEnvelope = AsTextEnvelope
data AsType ByronUpdateProposal Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ByronVote Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType ByronVote = AsByronVote
data AsType StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

data AsType TxId = AsTxId
data AsType TxMetadata Source # 
Instance details

Defined in Cardano.Api.TxMetadata

data AsType TxMetadata = AsTxMetadata
data AsType AssetName Source # 
Instance details

Defined in Cardano.Api.Value

data AsType AssetName = AsAssetName
data AsType PolicyId Source # 
Instance details

Defined in Cardano.Api.Value

data AsType PolicyId = AsPolicyId
data AsType (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (AddressInEra era) Source # 
Instance details

Defined in Cardano.Api.Address

data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Hash a) Source # 
Instance details

Defined in Cardano.Api.Hash

data AsType (Hash a) = AsHash (AsType a)
data AsType (SigningKey a) Source # 
Instance details

Defined in Cardano.Api.Keys.Class

data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (VerificationKey a) Source # 
Instance details

Defined in Cardano.Api.Keys.Class

data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (Script lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (Script lang) = AsScript (AsType lang)
data AsType (ScriptInEra era) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx

data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx

data AsType (Tx era) = AsTx (AsType era)
data AsType (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data AsType (TxBody era) = AsTxBody (AsType era)