cardano-api-1.30.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Key

Synopsis

Documentation

class (Eq (VerificationKey keyrole), Show (VerificationKey keyrole), SerialiseAsRawBytes (Hash keyrole), HasTextEnvelope (VerificationKey keyrole), HasTextEnvelope (SigningKey keyrole)) ⇒ Key keyrole where Source #

An interface for cryptographic keys used for signatures with a SigningKey and a VerificationKey key.

This interface does not provide actual signing or verifying functions since this API is concerned with the management of keys: generating and serialising.

Associated Types

data VerificationKey keyrole ∷ Type Source #

The type of cryptographic verification key, for each key role.

data SigningKey keyrole ∷ Type Source #

The type of cryptographic signing key, for each key role.

Methods

getVerificationKeySigningKey keyrole → VerificationKey keyrole Source #

Get the corresponding verification key from a signing key.

deterministicSigningKeyAsType keyrole → Seed → SigningKey keyrole Source #

Generate a SigningKey deterministically, given a Seed. The required size of the seed is given by deterministicSigningKeySeedSize.

deterministicSigningKeySeedSizeAsType keyrole → Word Source #

verificationKeyHashVerificationKey keyrole → Hash keyrole Source #

Instances

Instances details
Key StakePoolKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key GenesisKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key StakeKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key PaymentKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Key ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.KeysByron

Key ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

Key VrfKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Key KesKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

generateSigningKeyKey keyrole ⇒ AsType keyrole → IO (SigningKey keyrole) Source #

Generate a SigningKey using a seed from operating system entropy.

class CastVerificationKeyRole keyroleA keyroleB where Source #

Some key roles share the same representation and it is sometimes legitimate to change the role of a key.

Methods

castVerificationKeyVerificationKey keyroleA → VerificationKey keyroleB Source #

Change the role of a VerificationKey, if the representation permits.

Instances

Instances details
CastVerificationKeyRole GenesisUTxOKey PaymentKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

CastVerificationKeyRole GenesisDelegateExtendedKey GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

CastVerificationKeyRole GenesisDelegateKey StakePoolKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

CastVerificationKeyRole GenesisExtendedKey GenesisKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

CastVerificationKeyRole StakeExtendedKey StakeKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

CastVerificationKeyRole PaymentExtendedKey PaymentKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

CastVerificationKeyRole ByronKeyLegacy ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

CastVerificationKeyRole ByronKey PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

CastVerificationKeyRole ByronKey PaymentKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

class CastSigningKeyRole keyroleA keyroleB where Source #

Methods

castSigningKeySigningKey keyroleA → SigningKey keyroleB Source #

Change the role of a SigningKey, if the representation permits.

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)