cardano-api-1.36.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Api

Contents

Description

This module provides a library interface for interacting with Cardano as a user of the system.

It is intended to be the complete API covering everything but without exposing constructors that reveal any lower level types.

In the interest of simplicity it glosses over some details of the system. Most simple tools should be able to work just using this interface, however you can go deeper and expose the types from the underlying libraries using Cardano.Api.Byron or Cardano.Api.Shelley.

Synopsis

Eras

data ByronEra Source #

A type used as a tag to distinguish the Byron era.

Instances

Instances details
HasTypeProxy ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType ByronEra Source #

IsCardanoEra ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

FromJSON (EraInMode ByronEra CardanoMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode ByronEra CardanoMode) #

parseJSONList ∷ Value → Parser [EraInMode ByronEra CardanoMode] #

FromJSON (EraInMode ByronEra ByronMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode ByronEra ByronMode) #

parseJSONList ∷ Value → Parser [EraInMode ByronEra ByronMode] #

data AsType ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

data ShelleyEra Source #

A type used as a tag to distinguish the Shelley era.

Instances

Instances details
HasTypeProxy ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType ShelleyEra Source #

IsShelleyBasedEra ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

FromJSON (EraInMode ShelleyEra CardanoMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode ShelleyEra CardanoMode) #

parseJSONList ∷ Value → Parser [EraInMode ShelleyEra CardanoMode] #

FromJSON (EraInMode ShelleyEra ShelleyMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode ShelleyEra ShelleyMode) #

parseJSONList ∷ Value → Parser [EraInMode ShelleyEra ShelleyMode] #

data AsType ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AllegraEra Source #

A type used as a tag to distinguish the Allegra era.

Instances

Instances details
HasTypeProxy AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType AllegraEra Source #

IsShelleyBasedEra AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

FromJSON (EraInMode AllegraEra CardanoMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode AllegraEra CardanoMode) #

parseJSONList ∷ Value → Parser [EraInMode AllegraEra CardanoMode] #

data AsType AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

data MaryEra Source #

A type used as a tag to distinguish the Mary era.

Instances

Instances details
HasTypeProxy MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType MaryEra Source #

IsShelleyBasedEra MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

FromJSON (EraInMode MaryEra CardanoMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode MaryEra CardanoMode) #

parseJSONList ∷ Value → Parser [EraInMode MaryEra CardanoMode] #

data AsType MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AlonzoEra Source #

A type used as a tag to distinguish the Alonzo era.

Instances

Instances details
HasTypeProxy AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType AlonzoEra Source #

IsShelleyBasedEra AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

FromJSON (EraInMode AlonzoEra CardanoMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode AlonzoEra CardanoMode) #

parseJSONList ∷ Value → Parser [EraInMode AlonzoEra CardanoMode] #

data AsType AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

data BabbageEra Source #

A type used as a tag to distinguish the Babbage era.

Instances

Instances details
HasTypeProxy BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType BabbageEra Source #

IsShelleyBasedEra BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

FromJSON (EraInMode BabbageEra CardanoMode) Source # 
Instance details

Defined in Cardano.Api.Modes

Methods

parseJSON ∷ Value → Parser (EraInMode BabbageEra CardanoMode) #

parseJSONList ∷ Value → Parser [EraInMode BabbageEra CardanoMode] #

data AsType BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

data CardanoEra era where Source #

This GADT provides a value-level representation of all the Cardano eras. This enables pattern matching on the era to allow them to be treated in a non-uniform way.

This can be used in combination with the IsCardanoEra class to get access to this value.

In combination this can often enable code that handles all eras, and does so uniformly where possible, and non-uniformly where necessary.

Instances

Instances details
Eq (CardanoEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

(==)CardanoEra era → CardanoEra era → Bool Source #

(/=)CardanoEra era → CardanoEra era → Bool Source #

Ord (CardanoEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

compareCardanoEra era → CardanoEra era → Ordering Source #

(<)CardanoEra era → CardanoEra era → Bool Source #

(<=)CardanoEra era → CardanoEra era → Bool Source #

(>)CardanoEra era → CardanoEra era → Bool Source #

(>=)CardanoEra era → CardanoEra era → Bool Source #

maxCardanoEra era → CardanoEra era → CardanoEra era Source #

minCardanoEra era → CardanoEra era → CardanoEra era Source #

Show (CardanoEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

showsPrecIntCardanoEra era → ShowS Source #

showCardanoEra era → String Source #

showList ∷ [CardanoEra era] → ShowS Source #

ToJSON (CardanoEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

toJSONCardanoEra era → Value #

toEncodingCardanoEra era → Encoding #

toJSONList ∷ [CardanoEra era] → Value #

toEncodingList ∷ [CardanoEra era] → Encoding #

TestEquality CardanoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

testEquality ∷ ∀ (a ∷ k) (b ∷ k). CardanoEra a → CardanoEra b → Maybe (a :~: b) Source #

class HasTypeProxy era ⇒ IsCardanoEra era where Source #

The class of Cardano eras. This allows uniform handling of all Cardano eras, but also non-uniform by making case distinctions on the CardanoEra constructors, or the CardanoEraStyle constructors via cardanoEraStyle.

Methods

cardanoEraCardanoEra era Source #

Instances

Instances details
IsCardanoEra BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

IsCardanoEra ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

data AnyCardanoEra where Source #

Constructors

AnyCardanoEraIsCardanoEra era ⇒ CardanoEra era → AnyCardanoEra 

Instances

Instances details
Bounded AnyCardanoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Enum AnyCardanoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Eq AnyCardanoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Show AnyCardanoEra Source # 
Instance details

Defined in Cardano.Api.Eras

FromJSON AnyCardanoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

parseJSON ∷ Value → Parser AnyCardanoEra #

parseJSONList ∷ Value → Parser [AnyCardanoEra] #

ToJSON AnyCardanoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

toJSONAnyCardanoEra → Value #

toEncodingAnyCardanoEra → Encoding #

toJSONList ∷ [AnyCardanoEra] → Value #

toEncodingList ∷ [AnyCardanoEra] → Encoding #

anyCardanoEraCardanoEra era → AnyCardanoEra Source #

Like the AnyCardanoEra constructor but does not demand a IsCardanoEra class constraint.

data InAnyCardanoEra thing where Source #

This pairs up some era-dependent type with a CardanoEra value that tells us what era it is, but hides the era type. This is useful when the era is not statically known, for example when deserialising from a file.

Constructors

InAnyCardanoEraIsCardanoEra era ⇒ CardanoEra era → thing era → InAnyCardanoEra thing 

Instances

Instances details
Eq (InAnyCardanoEra Tx) Source # 
Instance details

Defined in Cardano.Api.Tx

Show (InAnyCardanoEra Tx) Source # 
Instance details

Defined in Cardano.Api.Tx

Shelley-based eras

data ShelleyBasedEra era where Source #

While the Byron and Shelley eras are quite different, there are several eras that are based on Shelley with only minor differences. It is useful to be able to treat the Shelley-based eras in a mostly-uniform way.

Values of this type witness the fact that the era is Shelley-based. This can be used to constrain the era to being a Shelley-based on. It allows non-uniform handling making case distinctions on the constructor.

Instances

Instances details
Eq (ShelleyBasedEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

Ord (ShelleyBasedEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

Show (ShelleyBasedEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

NFData (ShelleyBasedEra era) Source # 
Instance details

Defined in Cardano.Api.Eras

Methods

rnfShelleyBasedEra era → () Source #

class IsCardanoEra era ⇒ IsShelleyBasedEra era where Source #

The class of eras that are based on Shelley. This allows uniform handling of Shelley-based eras, but also non-uniform by making case distinctions on the ShelleyBasedEra constructors.

data InAnyShelleyBasedEra thing where Source #

This pairs up some era-dependent type with a ShelleyBasedEra value that tells us what era it is, but hides the era type. This is useful when the era is not statically known, for example when deserialising from a file.

Constructors

InAnyShelleyBasedEraIsShelleyBasedEra era ⇒ ShelleyBasedEra era → thing era → InAnyShelleyBasedEra thing 

data CardanoEraStyle era where Source #

This is the same essential information as CardanoEra but instead of a flat set of alternative eras, it is factored into the legcy Byron era and the current Shelley-based eras.

This way of factoring the eras is useful because in many cases the major differences are between the Byron and Shelley-based eras, and the Shelley-based eras can often be treated uniformly.

Instances

Instances details
Eq (CardanoEraStyle era) Source # 
Instance details

Defined in Cardano.Api.Eras

Ord (CardanoEraStyle era) Source # 
Instance details

Defined in Cardano.Api.Eras

Show (CardanoEraStyle era) Source # 
Instance details

Defined in Cardano.Api.Eras

Deprecated

type Byron = ByronEra Source #

Deprecated: Use ByronEra or ByronAddr as appropriate

type Shelley = ShelleyEra Source #

Deprecated: Use ShelleyEra or ShelleyAddr as appropriate

type Allegra = AllegraEra Source #

Deprecated: Use AllegraEra instead

type Mary = MaryEra Source #

Deprecated: Use MaryEra instead

Type tags

class HasTypeProxy t where Source #

Associated Types

data 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.

Methods

proxyToAsTypeProxy t → AsType t Source #

Instances

Instances details
HasTypeProxy BabbageEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType BabbageEra Source #

HasTypeProxy AlonzoEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType AlonzoEra Source #

HasTypeProxy MaryEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType MaryEra Source #

HasTypeProxy AllegraEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType AllegraEra Source #

HasTypeProxy ShelleyEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType ShelleyEra Source #

HasTypeProxy ByronEra Source # 
Instance details

Defined in Cardano.Api.Eras

Associated Types

data AsType ByronEra Source #

HasTypeProxy TxMetadata Source # 
Instance details

Defined in Cardano.Api.TxMetadata

Associated Types

data AsType TxMetadata Source #

HasTypeProxy TextEnvelope Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

Associated Types

data AsType TextEnvelope Source #

HasTypeProxy TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Associated Types

data AsType TxId Source #

HasTypeProxy StakePoolKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType StakePoolKey Source #

HasTypeProxy GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType GenesisUTxOKey Source #

HasTypeProxy GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

HasTypeProxy GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType GenesisDelegateKey Source #

HasTypeProxy GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType GenesisExtendedKey Source #

HasTypeProxy GenesisKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType GenesisKey Source #

HasTypeProxy StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType StakeExtendedKey Source #

HasTypeProxy StakeKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType StakeKey Source #

HasTypeProxy PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType PaymentExtendedKey Source #

HasTypeProxy PaymentKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Associated Types

data AsType PaymentKey Source #

HasTypeProxy ScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

Associated Types

data AsType ScriptData Source #

HasTypeProxy ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.KeysByron

Associated Types

data AsType ByronKeyLegacy Source #

HasTypeProxy ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

Associated Types

data AsType ByronKey Source #

HasTypeProxy ByronVote Source # 
Instance details

Defined in Cardano.Api.SpecialByron

Associated Types

data AsType ByronVote Source #

HasTypeProxy ByronUpdateProposal Source # 
Instance details

Defined in Cardano.Api.SpecialByron

Associated Types

data AsType ByronUpdateProposal Source #

HasTypeProxy VrfKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Associated Types

data AsType VrfKey Source #

HasTypeProxy KesKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Associated Types

data AsType KesKey Source #

HasTypeProxy ScriptHash Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType ScriptHash Source #

HasTypeProxy ScriptInAnyLang Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType ScriptInAnyLang Source #

HasTypeProxy PlutusScriptV2 Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType PlutusScriptV2 Source #

HasTypeProxy PlutusScriptV1 Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType PlutusScriptV1 Source #

HasTypeProxy SimpleScriptV2 Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType SimpleScriptV2 Source #

HasTypeProxy SimpleScriptV1 Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType SimpleScriptV1 Source #

HasTypeProxy StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

Associated Types

data AsType StakePoolMetadata Source #

HasTypeProxy StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType StakeAddress Source #

HasTypeProxy AddressAny Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType AddressAny Source #

HasTypeProxy ShelleyAddr Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType ShelleyAddr Source #

HasTypeProxy ByronAddr Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType ByronAddr Source #

HasTypeProxy AssetName Source # 
Instance details

Defined in Cardano.Api.Value

Associated Types

data AsType AssetName Source #

HasTypeProxy PolicyId Source # 
Instance details

Defined in Cardano.Api.Value

Associated Types

data AsType PolicyId Source #

HasTypeProxy UpdateProposal Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Associated Types

data AsType UpdateProposal Source #

HasTypeProxy PraosNonce Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Associated Types

data AsType PraosNonce Source #

HasTypeProxy Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Associated Types

data AsType Certificate Source #

HasTypeProxy OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

HasTypeProxy OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

Associated Types

data AsType OperationalCertificate Source #

HasTypeProxy BlockHeader Source # 
Instance details

Defined in Cardano.Api.Block

Associated Types

data AsType BlockHeader Source #

HasTypeProxy a ⇒ HasTypeProxy (Hash a) Source # 
Instance details

Defined in Cardano.Api.Hash

Associated Types

data AsType (Hash a) Source #

Methods

proxyToAsTypeProxy (Hash a) → AsType (Hash a) Source #

HasTypeProxy a ⇒ HasTypeProxy (VerificationKey a) Source # 
Instance details

Defined in Cardano.Api.Key

Associated Types

data AsType (VerificationKey a) Source #

HasTypeProxy a ⇒ HasTypeProxy (SigningKey a) Source # 
Instance details

Defined in Cardano.Api.Key

Associated Types

data AsType (SigningKey a) Source #

HasTypeProxy lang ⇒ HasTypeProxy (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType (PlutusScript lang) Source #

HasTypeProxy lang ⇒ HasTypeProxy (SimpleScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType (SimpleScript lang) Source #

HasTypeProxy era ⇒ HasTypeProxy (ScriptInEra era) Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType (ScriptInEra era) Source #

HasTypeProxy lang ⇒ HasTypeProxy (Script lang) Source # 
Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType (Script lang) Source #

Methods

proxyToAsTypeProxy (Script lang) → AsType (Script lang) Source #

HasTypeProxy era ⇒ HasTypeProxy (AddressInEra era) Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType (AddressInEra era) Source #

HasTypeProxy addrtype ⇒ HasTypeProxy (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType (Address addrtype) Source #

Methods

proxyToAsTypeProxy (Address addrtype) → AsType (Address addrtype) Source #

HasTypeProxy era ⇒ HasTypeProxy (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Associated Types

data AsType (TxBody era) Source #

Methods

proxyToAsTypeProxy (TxBody era) → AsType (TxBody era) Source #

HasTypeProxy era ⇒ HasTypeProxy (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx

Associated Types

data AsType (KeyWitness era) Source #

HasTypeProxy era ⇒ HasTypeProxy (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx

Associated Types

data AsType (Tx era) Source #

Methods

proxyToAsTypeProxy (Tx era) → AsType (Tx era) Source #

Cryptographic key interface

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

castVerificationKeyCastVerificationKeyRole keyroleA keyroleB ⇒ VerificationKey keyroleA → VerificationKey keyroleB Source #

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

castSigningKeyCastSigningKeyRole keyroleA keyroleB ⇒ SigningKey keyroleA → SigningKey keyroleB Source #

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

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

Generate a SigningKey using a seed from operating system entropy.

generateInsecureSigningKey ∷ (Key keyrole, SerialiseAsRawBytes (SigningKey keyrole)) ⇒ StdGen → AsType keyrole → IO (SigningKey keyrole, StdGen) Source #

Hashes

In Cardano most keys are identified by their hash, and hashes are used in many other places.

data family Hash keyrole ∷ Type Source #

Instances

Instances details
Eq (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Eq (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Eq (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Eq (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Eq (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Eq (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Eq (Hash StakePoolMetadata) Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

Eq (Hash BlockHeader) Source # 
Instance details

Defined in Cardano.Api.Block

Ord (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Ord (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Ord (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Ord (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Ord (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Ord (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Ord (Hash BlockHeader) Source # 
Instance details

Defined in Cardano.Api.Block

Show (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Show (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Show (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Show (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Show (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Show (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Show (Hash StakePoolMetadata) Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

Show (Hash BlockHeader) Source # 
Instance details

Defined in Cardano.Api.Block

IsString (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

IsString (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

IsString (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

IsString (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

IsString (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

IsString (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

IsString (Hash BlockHeader) Source # 
Instance details

Defined in Cardano.Api.Block

FromJSON (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

parseJSON ∷ Value → Parser (Hash StakePoolKey) #

parseJSONList ∷ Value → Parser [Hash StakePoolKey] #

FromJSON (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Methods

parseJSON ∷ Value → Parser (Hash ScriptData) #

parseJSONList ∷ Value → Parser [Hash ScriptData] #

FromJSON (Hash BlockHeader) Source # 
Instance details

Defined in Cardano.Api.Block

Methods

parseJSON ∷ Value → Parser (Hash BlockHeader) #

parseJSONList ∷ Value → Parser [Hash BlockHeader] #

ToJSON (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toJSONHash StakePoolKey → Value #

toEncodingHash StakePoolKey → Encoding #

toJSONList ∷ [Hash StakePoolKey] → Value #

toEncodingList ∷ [Hash StakePoolKey] → Encoding #

ToJSON (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Methods

toJSONHash ScriptData → Value #

toEncodingHash ScriptData → Encoding #

toJSONList ∷ [Hash ScriptData] → Value #

toEncodingList ∷ [Hash ScriptData] → Encoding #

ToJSON (Hash BlockHeader) Source # 
Instance details

Defined in Cardano.Api.Block

Methods

toJSONHash BlockHeader → Value #

toEncodingHash BlockHeader → Encoding #

toJSONList ∷ [Hash BlockHeader] → Value #

toEncodingList ∷ [Hash BlockHeader] → Encoding #

FromCBOR (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

fromCBOR ∷ Decoder s (Hash StakePoolKey) #

labelProxy (Hash StakePoolKey) → Text #

FromCBOR (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

fromCBOR ∷ Decoder s (Hash GenesisUTxOKey) #

labelProxy (Hash GenesisUTxOKey) → Text #

FromCBOR (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

FromCBOR (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

FromCBOR (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

FromCBOR (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

fromCBOR ∷ Decoder s (Hash GenesisKey) #

labelProxy (Hash GenesisKey) → Text #

FromCBOR (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

FromCBOR (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

fromCBOR ∷ Decoder s (Hash StakeKey) #

labelProxy (Hash StakeKey) → Text #

FromCBOR (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

FromCBOR (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

fromCBOR ∷ Decoder s (Hash PaymentKey) #

labelProxy (Hash PaymentKey) → Text #

FromCBOR (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Methods

fromCBOR ∷ Decoder s (Hash ByronKeyLegacy) #

labelProxy (Hash ByronKeyLegacy) → Text #

FromCBOR (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Methods

fromCBOR ∷ Decoder s (Hash ByronKey) #

labelProxy (Hash ByronKey) → Text #

FromCBOR (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Methods

fromCBOR ∷ Decoder s (Hash VrfKey) #

labelProxy (Hash VrfKey) → Text #

FromCBOR (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Methods

fromCBOR ∷ Decoder s (Hash KesKey) #

labelProxy (Hash KesKey) → Text #

ToCBOR (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash StakePoolKey → Encoding #

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

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

ToCBOR (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash GenesisUTxOKey → Encoding #

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

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

ToCBOR (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash GenesisDelegateExtendedKey → Encoding #

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

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

ToCBOR (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash GenesisDelegateKey → Encoding #

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

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

ToCBOR (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash GenesisExtendedKey → Encoding #

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

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

ToCBOR (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash GenesisKey → Encoding #

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

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

ToCBOR (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash StakeExtendedKey → Encoding #

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

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

ToCBOR (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash StakeKey → Encoding #

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

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

ToCBOR (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash PaymentExtendedKey → Encoding #

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

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

ToCBOR (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toCBORHash PaymentKey → Encoding #

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

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

ToCBOR (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Methods

toCBORHash ByronKeyLegacy → Encoding #

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

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

ToCBOR (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Methods

toCBORHash ByronKey → Encoding #

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

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

ToCBOR (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Methods

toCBORHash VrfKey → Encoding #

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

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

ToCBOR (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

Methods

toCBORHash KesKey → Encoding #

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

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

FromJSONKey (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Methods

fromJSONKey ∷ FromJSONKeyFunction (Hash ScriptData)

fromJSONKeyList ∷ FromJSONKeyFunction [Hash ScriptData]

ToJSONKey (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

Methods

toJSONKey ∷ ToJSONKeyFunction (Hash StakePoolKey)

toJSONKeyList ∷ ToJSONKeyFunction [Hash StakePoolKey]

ToJSONKey (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Methods

toJSONKey ∷ ToJSONKeyFunction (Hash ScriptData)

toJSONKeyList ∷ ToJSONKeyFunction [Hash ScriptData]

HasTypeProxy a ⇒ HasTypeProxy (Hash a) Source # 
Instance details

Defined in Cardano.Api.Hash

Associated Types

data AsType (Hash a) Source #

Methods

proxyToAsTypeProxy (Hash a) → AsType (Hash a) Source #

SerialiseAsCBOR (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsCBOR (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

SerialiseAsCBOR (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

SerialiseAsCBOR (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

SerialiseAsCBOR (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

SerialiseAsRawBytes (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash GenesisUTxOKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash GenesisDelegateExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash GenesisDelegateKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash GenesisExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash GenesisKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash StakeExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash StakeKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash PaymentExtendedKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash PaymentKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

SerialiseAsRawBytes (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

SerialiseAsRawBytes (Hash ByronKeyLegacy) Source # 
Instance details

Defined in Cardano.Api.KeysByron

SerialiseAsRawBytes (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

SerialiseAsRawBytes (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

SerialiseAsRawBytes (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.KeysPraos

SerialiseAsRawBytes (Hash StakePoolMetadata) Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

SerialiseAsRawBytes (Hash BlockHeader) Source # 
Instance details

Defined in Cardano.Api.Block

SerialiseAsBech32 (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash StakePoolKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash StakePoolKey = StakePoolKeyHash (KeyHash 'StakePool StandardCrypto)
newtype Hash GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash GenesisUTxOKey = GenesisUTxOKeyHash (KeyHash 'Payment StandardCrypto)
newtype Hash GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash GenesisDelegateExtendedKey = GenesisDelegateExtendedKeyHash (KeyHash 'Staking StandardCrypto)
newtype Hash GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash GenesisDelegateKey = GenesisDelegateKeyHash (KeyHash 'GenesisDelegate StandardCrypto)
newtype Hash GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash GenesisExtendedKey = GenesisExtendedKeyHash (KeyHash 'Staking StandardCrypto)
newtype Hash GenesisKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash GenesisKey = GenesisKeyHash (KeyHash 'Genesis StandardCrypto)
newtype Hash StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash StakeExtendedKey = StakeExtendedKeyHash (KeyHash 'Staking StandardCrypto)
newtype Hash StakeKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash StakeKey = StakeKeyHash (KeyHash 'Staking StandardCrypto)
newtype Hash PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash PaymentExtendedKey = PaymentExtendedKeyHash (KeyHash 'Payment StandardCrypto)
newtype Hash PaymentKey Source # 
Instance details

Defined in Cardano.Api.KeysShelley

newtype Hash PaymentKey = PaymentKeyHash (KeyHash 'Payment StandardCrypto)
newtype Hash ScriptData Source # 
Instance details

Defined in Cardano.Api.ScriptData

newtype Hash ScriptData = ScriptDataHash (DataHash StandardCrypto)
newtype Hash ByronKeyLegacy Source # 
Instance details

Defined in Cardano.Api.KeysByron

newtype Hash ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

newtype Hash ByronKey = ByronKeyHash KeyHash
newtype Hash VrfKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

newtype Hash VrfKey = VrfKeyHash (Hash StandardCrypto (VerKeyVRF StandardCrypto))
newtype Hash KesKey Source # 
Instance details

Defined in Cardano.Api.KeysPraos

newtype Hash KesKey = KesKeyHash (Hash StandardCrypto (VerKeyKES StandardCrypto))
newtype Hash StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

newtype Hash StakePoolMetadata = StakePoolMetadataHash (Hash StandardCrypto ByteString)
newtype Hash BlockHeader Source #

For now at least we use a fixed concrete hash type for all modes and era. The different eras do use different types, but it's all the same underlying representation.

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)

castHashCastHash roleA roleB ⇒ Hash roleA → Hash roleB Source #

Payment addresses

Constructing and inspecting normal payment addresses

data Address addrtype Source #

Addresses are used as locations where assets live. The address determines the rights needed to spend assets at the address: in particular holding some signing key or being able to satisfy the conditions of a script.

There are currently two types of address:

  • Byron addresses, which use the type tag ByronAddr; and
  • Shelley addresses, which use the type tag ShelleyAddr. Notably, Shelley addresses support scripts and stake delegation.

The address type is subtly from the ledger era in which each address type is valid: while Byron addresses are the only choice in the Byron era, the Shelley era and all subsequent eras support both Byron and Shelley addresses. The Address type param only says the type of the address (either Byron or Shelley). The AddressInEra type connects the address type with the era in which it is supported.

Instances

Instances details
Eq (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

(==)Address addrtype → Address addrtype → Bool Source #

(/=)Address addrtype → Address addrtype → Bool Source #

Ord (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

compareAddress addrtype → Address addrtype → Ordering Source #

(<)Address addrtype → Address addrtype → Bool Source #

(<=)Address addrtype → Address addrtype → Bool Source #

(>)Address addrtype → Address addrtype → Bool Source #

(>=)Address addrtype → Address addrtype → Bool Source #

maxAddress addrtype → Address addrtype → Address addrtype Source #

minAddress addrtype → Address addrtype → Address addrtype Source #

Show (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

showsPrecIntAddress addrtype → ShowS Source #

showAddress addrtype → String Source #

showList ∷ [Address addrtype] → ShowS Source #

NFData (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Methods

rnfAddress addrtype → () Source #

HasTypeProxy addrtype ⇒ HasTypeProxy (Address addrtype) Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType (Address addrtype) Source #

Methods

proxyToAsTypeProxy (Address addrtype) → AsType (Address addrtype) Source #

SerialiseAsRawBytes (Address ShelleyAddr) Source # 
Instance details

Defined in Cardano.Api.Address

SerialiseAsRawBytes (Address ByronAddr) Source # 
Instance details

Defined in Cardano.Api.Address

SerialiseAsBech32 (Address ShelleyAddr) Source # 
Instance details

Defined in Cardano.Api.Address

SerialiseAddress (Address ShelleyAddr) Source # 
Instance details

Defined in Cardano.Api.Address

SerialiseAddress (Address ByronAddr) 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 NetworkId Source #

Constructors

Mainnet 
Testnet !NetworkMagic 

Instances

Instances details
Eq NetworkId Source # 
Instance details

Defined in Cardano.Api.NetworkId

Show NetworkId Source # 
Instance details

Defined in Cardano.Api.NetworkId

Byron addresses

data ByronKey Source #

Byron-era payment keys. Used for Byron addresses and witnessing transactions that spend from these addresses.

These use Ed25519 but with a 32byte "chaincode" used in HD derivation. The inclusion of the chaincode is a design mistake but one that cannot be corrected for the Byron era. The Shelley era PaymentKeys do not include a chaincode. It is safe to use a zero or random chaincode for new Byron keys.

This is a type level tag, used with other interfaces like Key.

Instances

Instances details
HasTypeProxy ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

Associated Types

data AsType ByronKey Source #

Key ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

IsByronKey ByronKey Source # 
Instance details

Defined in Cardano.Api.KeysByron

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

Eq (Hash ByronKey) Source # 
Instance details

Defined in Cardano.Api.KeysByron

Eq (VerificationKey ByronKey) Source # 
Instance details

Def