bcc-api-1.99.0
Safe HaskellNone
LanguageHaskell2010

Bcc.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) 
VestedKeyDelegationCertificate (Hash VestedKey) (Hash VestedDelegateKey) (Hash VrfKey) 
MIRCertificate MIRPot MIRTarget 

Instances

Instances details
Eq Certificate Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

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

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

Show Certificate Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

showsPrec ∷ Int → Certificate → ShowS Source #

show ∷ Certificate → String Source #

showList ∷ [Certificate] → ShowS Source #

FromCBOR Certificate Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

fromCBOR ∷ Decoder s Certificate #

label ∷ Proxy Certificate → Text #

ToCBOR Certificate Source # 
Instance details

Defined in Bcc.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 #

HasTypeProxy Certificate Source # 
Instance details

Defined in Bcc.Api.Certificate

Associated Types

data AsType Certificate Source #

Methods

proxyToAsType ∷ Proxy Certificate → AsType Certificate Source #

SerialiseAsCBOR Certificate Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

serialiseToCBOR ∷ Certificate → ByteString Source #

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

HasTextEnvelope Certificate Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

textEnvelopeType ∷ AsType Certificate → TextEnvelopeType Source #

textEnvelopeDefaultDescr ∷ Certificate → TextEnvelopeDescr Source #

data AsType Certificate Source # 
Instance details

Defined in Bcc.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
Eq StakePoolParameters Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

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

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

Show StakePoolParameters Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

showsPrec ∷ Int → StakePoolParameters → ShowS Source #

show ∷ StakePoolParameters → String Source #

showList ∷ [StakePoolParameters] → ShowS 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
Eq StakePoolRelay Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

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

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

Show StakePoolRelay Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

showsPrec ∷ Int → StakePoolRelay → ShowS Source #

show ∷ StakePoolRelay → String Source #

showList ∷ [StakePoolRelay] → ShowS Source #

data StakePoolMetadataReference Source #

Constructors

StakePoolMetadataReference 

Fields

Instances

Instances details
Eq StakePoolMetadataReference Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

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

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

Show StakePoolMetadataReference Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

showsPrec ∷ Int → StakePoolMetadataReference → ShowS Source #

show ∷ StakePoolMetadataReference → String Source #

showList ∷ [StakePoolMetadataReference] → ShowS Source #

Special certificates

makeMIRCertificate ∷ MIRPot → MIRTarget → Certificate Source #

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

makeVestedKeyDelegationCertificate ∷ Hash VestedKey → Hash VestedDelegateKey → Hash VrfKey → Certificate Source #

data MIRTarget Source #

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

Constructors

StakeAddressesMIR [(StakeCredential, Entropic)]

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

SendToReservesMIR Entropic

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

SendToTreasuryMIR Entropic

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

Instances

Instances details
Eq MIRTarget Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

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

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

Show MIRTarget Source # 
Instance details

Defined in Bcc.Api.Certificate

Methods

showsPrec ∷ Int → MIRTarget → ShowS Source #

show ∷ MIRTarget → String Source #

showList ∷ [MIRTarget] → ShowS Source #

Internal conversion functions

toSophieCertificate ∷ Certificate → DCert StandardCrypto Source #

fromSophieCertificate ∷ DCert StandardCrypto → Certificate Source #

toSophiePoolParams ∷ StakePoolParameters → PoolParams StandardCrypto Source #

fromSophiePoolParams ∷ 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 AurumEra Source # 
Instance details

Defined in Bcc.Api.Eras

data AsType AurumEra = AsAurumEra
data AsType JenEra Source # 
Instance details

Defined in Bcc.Api.Eras

data AsType JenEra = AsJenEra
data AsType EvieEra Source # 
Instance details

Defined in Bcc.Api.Eras

data AsType EvieEra = AsEvieEra
data AsType SophieEra Source # 
Instance details

Defined in Bcc.Api.Eras

data AsType SophieEra = AsSophieEra
data AsType ColeEra Source # 
Instance details

Defined in Bcc.Api.Eras

data AsType ColeEra = AsColeEra
data AsType TextEnvelope Source # 
Instance details

Defined in Bcc.Api.SerialiseTextEnvelope

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

Defined in Bcc.Api.TxMetadata

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

data AsType VestedDelegateExtendedKey = AsVestedDelegateExtendedKey
data AsType VestedDelegateKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType VestedDelegateKey = AsVestedDelegateKey
data AsType VestedExtendedKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType VestedExtendedKey = AsVestedExtendedKey
data AsType VestedKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType VestedKey = AsVestedKey
data AsType GenesisVestedDelegateExtendedKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType GenesisVestedDelegateExtendedKey = AsGenesisVestedDelegateExtendedKey
data AsType GenesisVestedDelegateKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType GenesisVestedDelegateKey = AsGenesisVestedDelegateKey
data AsType GenesisVestedExtendedKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType GenesisVestedExtendedKey = AsGenesisVestedExtendedKey
data AsType GenesisVestedKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType GenesisVestedKey = AsGenesisVestedKey
data AsType VestedUTxOKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

data AsType VestedUTxOKey = AsVestedUTxOKey
data AsType GenesisUTxOKey Source # 
Instance details

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.KeysSophie

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

Defined in Bcc.Api.ScriptData

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

Defined in Bcc.Api.Script

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

Defined in Bcc.Api.Script

data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType ZerepochScriptV1 Source # 
Instance details

Defined in Bcc.Api.Script

data AsType ZerepochScriptV1 = AsZerepochScriptV1
data AsType SimpleScriptV2 Source # 
Instance details

Defined in Bcc.Api.Script

data AsType SimpleScriptV2 = AsSimpleScriptV2
data AsType SimpleScriptV1 Source # 
Instance details

Defined in Bcc.Api.Script

data AsType SimpleScriptV1 = AsSimpleScriptV1
data AsType ColeKeyLegacy Source # 
Instance details

Defined in Bcc.Api.KeysCole

data AsType ColeKeyLegacy = AsColeKeyLegacy
data AsType ColeKey Source # 
Instance details

Defined in Bcc.Api.KeysCole

data AsType ColeKey = AsColeKey
data AsType ColeVote Source # 
Instance details

Defined in Bcc.Api.SpecialCole

data AsType ColeVote = AsColeVote
data AsType ColeUpdateProposal Source # 
Instance details

Defined in Bcc.Api.SpecialCole

data AsType ColeUpdateProposal = AsColeUpdateProposal
data AsType VrfKey Source # 
Instance details

Defined in Bcc.Api.KeysOptimum

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

Defined in Bcc.Api.KeysOptimum

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

Defined in Bcc.Api.StakePoolMetadata

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

Defined in Bcc.Api.Address

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

Defined in Bcc.Api.Address

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

Defined in Bcc.Api.Address

data AsType SophieAddr = AsSophieAddr
data AsType ColeAddr Source # 
Instance details

Defined in Bcc.Api.Address

data AsType ColeAddr = AsColeAddr
data AsType AssetName Source # 
Instance details

Defined in Bcc.Api.Value

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

Defined in Bcc.Api.Value

data AsType PolicyId = AsPolicyId
data AsType UpdateProposal Source # 
Instance details

Defined in Bcc.Api.ProtocolParameters

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

Defined in Bcc.Api.ProtocolParameters

data AsType OptimumNonce = AsOptimumNonce
data AsType Certificate Source # 
Instance details

Defined in Bcc.Api.Certificate

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

Defined in Bcc.Api.TxBody

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

Defined in Bcc.Api.Block

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

Defined in Bcc.Api.OperationalCertificate

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

Defined in Bcc.Api.OperationalCertificate

data AsType OperationalCertificate = AsOperationalCertificate
data AsType (Hash a) Source # 
Instance details

Defined in Bcc.Api.Hash

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

Defined in Bcc.Api.Key

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

Defined in Bcc.Api.Key

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

Defined in Bcc.Api.Script

data AsType (ZerepochScript lang) = AsZerepochScript (AsType lang)
data AsType (SimpleScript lang) Source # 
Instance details

Defined in Bcc.Api.Script

data AsType (SimpleScript lang) = AsSimpleScript (AsType lang)
data AsType (ScriptInEra era) Source # 
Instance details

Defined in Bcc.Api.Script

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

Defined in Bcc.Api.Script

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

Defined in Bcc.Api.Address

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

Defined in Bcc.Api.Address

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

Defined in Bcc.Api.TxBody

data AsType (TxBody era) = AsTxBody (AsType era)
data AsType (KeyWitness era) Source # 
Instance details

Defined in Bcc.Api.Tx

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

Defined in Bcc.Api.Tx

data AsType (Tx era) = AsTx (AsType era)