cardano-api-1.30.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.SerialiseTextEnvelope

Description

TextEnvelope Serialisation

Synopsis

Documentation

class SerialiseAsCBOR a ⇒ HasTextEnvelope a where Source #

Minimal complete definition

textEnvelopeType

Instances

Instances details
HasTextEnvelope UpdateProposal Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

HasTextEnvelope Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

HasTextEnvelope OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

HasTextEnvelope OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

HasTextEnvelope (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (VerificationKey ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

HasTextEnvelope (VerificationKey ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

HasTextEnvelope (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

HasTextEnvelope (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

HasTextEnvelope (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTextEnvelope (SigningKey ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

HasTextEnvelope (SigningKey ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

HasTextEnvelope (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

HasTextEnvelope (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

(IsPlutusScriptLanguage lang, Typeable lang) ⇒ HasTextEnvelope (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

IsScriptLanguage lang ⇒ HasTextEnvelope (Script lang) Source # 
Instance details

Defined in Cardano.Api.Script

IsCardanoEra era ⇒ HasTextEnvelope (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

IsCardanoEra era ⇒ HasTextEnvelope (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx

IsCardanoEra era ⇒ HasTextEnvelope (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx

data TextEnvelope Source #

A TextEnvelope is a structured envelope for serialised binary values with an external format with a semi-readable textual format.

It contains a "type" field, e.g. "PublicKeyByron" or "TxSignedShelley" to indicate the type of the encoded data. This is used as a sanity check and to help readers.

It also contains a "title" field which is free-form, and could be used to indicate the role or purpose to a reader.

newtype TextEnvelopeType Source #

Constructors

TextEnvelopeType String 

newtype TextEnvelopeDescr Source #

Instances

Instances details
Eq TextEnvelopeDescr Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

Show TextEnvelopeDescr Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

IsString TextEnvelopeDescr Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

Semigroup TextEnvelopeDescr Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

FromJSON TextEnvelopeDescr Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

Methods

parseJSON ∷ Value → Parser TextEnvelopeDescr #

parseJSONList ∷ Value → Parser [TextEnvelopeDescr] #

ToJSON TextEnvelopeDescr Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

Methods

toJSONTextEnvelopeDescr → Value #

toEncodingTextEnvelopeDescr → Encoding #

toJSONList ∷ [TextEnvelopeDescr] → Value #

toEncodingList ∷ [TextEnvelopeDescr] → Encoding #

Reading one of several key types

data FromSomeType (c ∷ TypeConstraint) b where Source #

Constructors

FromSomeType ∷ c a ⇒ AsType a → (a → b) → FromSomeType c b 

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 AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AsType TextEnvelope Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

data AsType TxMetadata Source # 
Instance details

Defined in Cardano.Api.TxMetadata

data AsType StakePoolKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType GenesisKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType StakeKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType PaymentKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

data AsType ScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

data AsType ScriptHash Source # 
Instance details

Defined in Cardano.Api.Script

data AsType ScriptInAnyLang Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV2 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV1 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType SimpleScriptV2 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType SimpleScriptV1 Source # 
Instance details

Defined in Cardano.Api.Script

data AsType ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.KeysByron

data AsType ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

data AsType ByronVote Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType ByronUpdateProposal Source # 
Instance details

Defined in Cardano.Api.SpecialByron

data AsType VrfKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

data AsType KesKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

data AsType StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

data AsType StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

data AsType AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ShelleyAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType ByronAddr Source # 
Instance details

Defined in Cardano.Api.Address

data AsType AssetName Source # 
Instance details

Defined in Cardano.Api.Value

data AsType PolicyId Source # 
Instance details

Defined in Cardano.Api.Value

data AsType UpdateProposal Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType PraosNonce Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

data AsType Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

data AsType TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

data AsType OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

data AsType BlockHeader Source # 
Instance details

Defined in Cardano.Api.Block

data AsType (Hash a) Source # 
Instance details

Defined in Cardano.Api.Hash

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

Defined in Cardano.Api.Key

data AsType (SigningKey a) Source # 
Instance details

Defined in Cardano.Api.Key

data AsType (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (SimpleScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (ScriptInEra era) Source # 
Instance details

Defined in Cardano.Api.Script

data AsType (Script lang) Source # 
Instance details

Defined in Cardano.Api.Script

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

Defined in Cardano.Api.Address

data AsType (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

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

Defined in Cardano.Api.TxBody

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

Defined in Cardano.Api.Tx

data AsType (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx

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