Safe Haskell | None |
---|---|
Language | Haskell2010 |
Cardano.Api.Certificate
Description
Certificates embedded in transactions
Synopsis
- data Certificate era where
- ShelleyRelatedCertificate :: ShelleyToBabbageEra era -> ShelleyTxCert (ShelleyLedgerEra era) -> Certificate era
- ConwayCertificate :: ConwayEraOnwards era -> ConwayTxCert (ShelleyLedgerEra era) -> Certificate era
- data StakeAddressRequirements era where
- data StakeDelegationRequirements era where
- makeStakeAddressDelegationCertificate :: StakeDelegationRequirements era -> Certificate era
- makeStakeAddressRegistrationCertificate :: StakeAddressRequirements era -> Certificate era
- makeStakeAddressUnregistrationCertificate :: StakeAddressRequirements era -> Certificate era
- type PoolId = Hash StakePoolKey
- data StakePoolRegistrationRequirements era where
- StakePoolRegistrationRequirementsConwayOnwards :: ConwayEraOnwards era -> PoolParams (EraCrypto (ShelleyLedgerEra era)) -> StakePoolRegistrationRequirements era
- StakePoolRegistrationRequirementsPreConway :: ShelleyToBabbageEra era -> PoolParams (EraCrypto (ShelleyLedgerEra era)) -> StakePoolRegistrationRequirements era
- data StakePoolRetirementRequirements era where
- makeStakePoolRegistrationCertificate :: StakePoolRegistrationRequirements era -> Certificate era
- makeStakePoolRetirementCertificate :: StakePoolRetirementRequirements era -> Certificate era
- data StakePoolParameters = StakePoolParameters {}
- data StakePoolRelay
- = StakePoolRelayIp (Maybe IPv4) (Maybe IPv6) (Maybe PortNumber)
- | StakePoolRelayDnsARecord ByteString (Maybe PortNumber)
- | StakePoolRelayDnsSrvRecord ByteString
- data StakePoolMetadataReference = StakePoolMetadataReference {}
- data CommitteeColdkeyResignationRequirements era where
- CommitteeColdkeyResignationRequirements :: ConwayEraOnwards era -> KeyHash ColdCommitteeRole (EraCrypto (ShelleyLedgerEra era)) -> Maybe (Anchor (EraCrypto (ShelleyLedgerEra era))) -> CommitteeColdkeyResignationRequirements era
- data CommitteeHotKeyAuthorizationRequirements era where
- data DRepRegistrationRequirements era where
- DRepRegistrationRequirements :: ConwayEraOnwards era -> Credential DRepRole (EraCrypto (ShelleyLedgerEra era)) -> Lovelace -> DRepRegistrationRequirements era
- data DRepUnregistrationRequirements era where
- DRepUnregistrationRequirements :: ConwayEraOnwards era -> Credential DRepRole (EraCrypto (ShelleyLedgerEra era)) -> Lovelace -> DRepUnregistrationRequirements era
- makeCommitteeColdkeyResignationCertificate :: CommitteeColdkeyResignationRequirements era -> Certificate era
- makeCommitteeHotKeyAuthorizationCertificate :: CommitteeHotKeyAuthorizationRequirements era -> Certificate era
- makeDrepRegistrationCertificate :: DRepRegistrationRequirements era -> Maybe (Anchor (EraCrypto (ShelleyLedgerEra era))) -> Certificate era
- makeDrepUnregistrationCertificate :: DRepUnregistrationRequirements era -> Certificate era
- makeStakeAddressAndDRepDelegationCertificate :: ConwayEraOnwards era -> StakeCredential -> Delegatee (EraCrypto (ShelleyLedgerEra era)) -> Lovelace -> Certificate era
- data DRepMetadataReference = DRepMetadataReference {
- drepMetadataURL :: Text
- drepMetadataHash :: Hash DRepMetadata
- data GenesisKeyDelegationRequirements ere where
- data MirCertificateRequirements era where
- MirCertificateRequirements :: ShelleyToBabbageEra era -> MIRPot -> MIRTarget (EraCrypto (ShelleyLedgerEra era)) -> MirCertificateRequirements era
- makeMIRCertificate :: MirCertificateRequirements era -> Certificate era
- makeGenesisKeyDelegationCertificate :: GenesisKeyDelegationRequirements era -> Certificate era
- data MIRTarget c
- = StakeAddressesMIR !(Map (Credential 'Staking c) DeltaCoin)
- | SendToOppositePotMIR !Coin
- data MIRPot
- selectStakeCredentialWitness :: Certificate era -> Maybe StakeCredential
- toShelleyCertificate :: Certificate era -> TxCert (ShelleyLedgerEra era)
- fromShelleyCertificate :: ShelleyBasedEra era -> TxCert (ShelleyLedgerEra era) -> Certificate era
- toShelleyPoolParams :: StakePoolParameters -> PoolParams StandardCrypto
- fromShelleyPoolParams :: PoolParams StandardCrypto -> StakePoolParameters
- data family AsType t
- filterUnRegCreds :: Certificate era -> Maybe StakeCredential
- filterUnRegDRepCreds :: Certificate era -> Maybe (Credential DRepRole StandardCrypto)
Documentation
data Certificate era where Source #
Constructors
ShelleyRelatedCertificate :: ShelleyToBabbageEra era -> ShelleyTxCert (ShelleyLedgerEra era) -> Certificate era | |
ConwayCertificate :: ConwayEraOnwards era -> ConwayTxCert (ShelleyLedgerEra era) -> Certificate era |
Instances
Registering stake address and delegating
data StakeAddressRequirements era where Source #
Constructors
StakeAddrRegistrationConway :: ConwayEraOnwards era -> Lovelace -> StakeCredential -> StakeAddressRequirements era | |
StakeAddrRegistrationPreConway :: ShelleyToBabbageEra era -> StakeCredential -> StakeAddressRequirements era |
data StakeDelegationRequirements era where Source #
Constructors
StakeDelegationRequirementsConwayOnwards :: ConwayEraOnwards era -> StakeCredential -> Delegatee (EraCrypto (ShelleyLedgerEra era)) -> StakeDelegationRequirements era | |
StakeDelegationRequirementsPreConway :: ShelleyToBabbageEra era -> StakeCredential -> PoolId -> StakeDelegationRequirements era |
makeStakeAddressDelegationCertificate :: StakeDelegationRequirements era -> Certificate era Source #
makeStakeAddressUnregistrationCertificate :: StakeAddressRequirements era -> Certificate era Source #
type PoolId = Hash StakePoolKey Source #
Registering stake pools
data StakePoolRegistrationRequirements era where Source #
Constructors
data StakePoolRetirementRequirements era where Source #
Constructors
makeStakePoolRegistrationCertificate :: StakePoolRegistrationRequirements era -> Certificate era Source #
makeStakePoolRetirementCertificate :: StakePoolRetirementRequirements era -> Certificate era Source #
data StakePoolParameters Source #
Constructors
StakePoolParameters | |
Fields |
Instances
Eq StakePoolParameters Source # | |
Defined in Cardano.Api.Certificate Methods (==) :: StakePoolParameters -> StakePoolParameters -> Bool Source # (/=) :: StakePoolParameters -> StakePoolParameters -> Bool Source # | |
Show StakePoolParameters Source # | |
Defined in Cardano.Api.Certificate |
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 |
StakePoolRelayDnsSrvRecord ByteString | A DNS name pointing to a |
Instances
Eq StakePoolRelay Source # | |
Defined in Cardano.Api.Certificate Methods (==) :: StakePoolRelay -> StakePoolRelay -> Bool Source # (/=) :: StakePoolRelay -> StakePoolRelay -> Bool Source # | |
Show StakePoolRelay Source # | |
Defined in Cardano.Api.Certificate |
data StakePoolMetadataReference Source #
Constructors
StakePoolMetadataReference | |
Fields |
Instances
Eq StakePoolMetadataReference Source # | |
Defined in Cardano.Api.Certificate Methods (==) :: StakePoolMetadataReference -> StakePoolMetadataReference -> Bool Source # (/=) :: StakePoolMetadataReference -> StakePoolMetadataReference -> Bool Source # | |
Show StakePoolMetadataReference Source # | |
Defined in Cardano.Api.Certificate |
Conway specific certificates
data CommitteeColdkeyResignationRequirements era where Source #
Constructors
CommitteeColdkeyResignationRequirements :: ConwayEraOnwards era -> KeyHash ColdCommitteeRole (EraCrypto (ShelleyLedgerEra era)) -> Maybe (Anchor (EraCrypto (ShelleyLedgerEra era))) -> CommitteeColdkeyResignationRequirements era |
data CommitteeHotKeyAuthorizationRequirements era where Source #
Constructors
data DRepRegistrationRequirements era where Source #
Constructors
DRepRegistrationRequirements :: ConwayEraOnwards era -> Credential DRepRole (EraCrypto (ShelleyLedgerEra era)) -> Lovelace -> DRepRegistrationRequirements era |
data DRepUnregistrationRequirements era where Source #
Constructors
DRepUnregistrationRequirements :: ConwayEraOnwards era -> Credential DRepRole (EraCrypto (ShelleyLedgerEra era)) -> Lovelace -> DRepUnregistrationRequirements era |
makeCommitteeColdkeyResignationCertificate :: CommitteeColdkeyResignationRequirements era -> Certificate era Source #
makeCommitteeHotKeyAuthorizationCertificate :: CommitteeHotKeyAuthorizationRequirements era -> Certificate era Source #
makeDrepRegistrationCertificate :: DRepRegistrationRequirements era -> Maybe (Anchor (EraCrypto (ShelleyLedgerEra era))) -> Certificate era Source #
makeStakeAddressAndDRepDelegationCertificate :: ConwayEraOnwards era -> StakeCredential -> Delegatee (EraCrypto (ShelleyLedgerEra era)) -> Lovelace -> Certificate era Source #
Registering DReps
data DRepMetadataReference Source #
Constructors
DRepMetadataReference | |
Fields
|
Instances
Eq DRepMetadataReference Source # | |
Defined in Cardano.Api.Certificate Methods (==) :: DRepMetadataReference -> DRepMetadataReference -> Bool Source # (/=) :: DRepMetadataReference -> DRepMetadataReference -> Bool Source # | |
Show DRepMetadataReference Source # | |
Defined in Cardano.Api.Certificate |
Special certificates
data GenesisKeyDelegationRequirements ere where Source #
Constructors
GenesisKeyDelegationRequirements :: ShelleyToBabbageEra era -> Hash GenesisKey -> Hash GenesisDelegateKey -> Hash VrfKey -> GenesisKeyDelegationRequirements era |
data MirCertificateRequirements era where Source #
Constructors
MirCertificateRequirements :: ShelleyToBabbageEra era -> MIRPot -> MIRTarget (EraCrypto (ShelleyLedgerEra era)) -> MirCertificateRequirements era |
makeMIRCertificate :: MirCertificateRequirements era -> Certificate era Source #
makeGenesisKeyDelegationCertificate :: GenesisKeyDelegationRequirements era -> Certificate era Source #
Constructors
StakeAddressesMIR !(Map (Credential 'Staking c) DeltaCoin) | |
SendToOppositePotMIR !Coin |
Instances
Constructors
ReservesMIR | |
TreasuryMIR |
Instances
Bounded MIRPot | |
Enum MIRPot | |
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 # | |
Eq MIRPot | |
Ord MIRPot | |
Defined in Cardano.Ledger.Shelley.TxCert | |
Show MIRPot | |
Generic MIRPot | |
NFData MIRPot | |
Defined in Cardano.Ledger.Shelley.TxCert | |
DecCBOR MIRPot | |
EncCBOR MIRPot | |
Defined in Cardano.Ledger.Shelley.TxCert Methods encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy MIRPot -> Size encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [MIRPot] -> Size | |
NoThunks MIRPot | |
ToExpr MIRPot | |
Defined in Cardano.Ledger.Shelley.TxCert | |
ToJSON MIRPot Source # | |
Defined in Cardano.Api.Orphans | |
type Rep MIRPot | |
Defined in Cardano.Ledger.Shelley.TxCert |
selectStakeCredentialWitness :: Certificate 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 conversion functions
toShelleyCertificate :: Certificate era -> TxCert (ShelleyLedgerEra era) Source #
fromShelleyCertificate :: ShelleyBasedEra era -> TxCert (ShelleyLedgerEra era) -> Certificate era Source #
Data family instances
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
Internal functions
filterUnRegCreds :: Certificate era -> Maybe StakeCredential Source #
filterUnRegDRepCreds :: Certificate era -> Maybe (Credential DRepRole StandardCrypto) Source #