cardano-api-1.36.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Shelley

Description

This module provides a library interface that is intended to be the complete API for Shelley covering everything, including exposing constructors for the lower level types.

Synopsis

Documentation

Genesis

data ShelleyGenesis era #

Constructors

ShelleyGenesis 

Fields

Instances

Instances details
Eq (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Show (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Generic (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Associated Types

type Rep (ShelleyGenesis era) ∷ TypeType Source #

Methods

fromShelleyGenesis era → Rep (ShelleyGenesis era) x Source #

toRep (ShelleyGenesis era) x → ShelleyGenesis era Source #

Era era ⇒ FromJSON (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

parseJSON ∷ Value → Parser (ShelleyGenesis era) #

parseJSONList ∷ Value → Parser [ShelleyGenesis era] #

Era era ⇒ NoThunks (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

noThunks ∷ Context → ShelleyGenesis era → IO (Maybe ThunkInfo)

wNoThunks ∷ Context → ShelleyGenesis era → IO (Maybe ThunkInfo)

showTypeOfProxy (ShelleyGenesis era) → String

Era era ⇒ ToJSON (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toJSONShelleyGenesis era → Value #

toEncodingShelleyGenesis era → Encoding #

toJSONList ∷ [ShelleyGenesis era] → Value #

toEncodingList ∷ [ShelleyGenesis era] → Encoding #

Era era ⇒ FromCBOR (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

fromCBOR ∷ Decoder s (ShelleyGenesis era) #

labelProxy (ShelleyGenesis era) → Text #

Era era ⇒ ToCBOR (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

Methods

toCBORShelleyGenesis era → Encoding #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (ShelleyGenesis era) → Size #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [ShelleyGenesis era] → Size #

type Rep (ShelleyGenesis era) 
Instance details

Defined in Cardano.Ledger.Shelley.Genesis

type Rep (ShelleyGenesis era) = D1 ('MetaData "ShelleyGenesis" "Cardano.Ledger.Shelley.Genesis" "cardano-ledger-shelley-0.1.0.0-6c74b76bbf2d2c042b9e8f7fae64fc07771a40cdade7c8d67a1fa2fb0b676ac8" 'False) (C1 ('MetaCons "ShelleyGenesis" 'PrefixI 'True) (((S1 ('MetaSel ('Just "sgSystemStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UTCTime) :*: (S1 ('MetaSel ('Just "sgNetworkMagic") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word32) :*: S1 ('MetaSel ('Just "sgNetworkId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Network))) :*: ((S1 ('MetaSel ('Just "sgActiveSlotsCoeff") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PositiveUnitInterval) :*: S1 ('MetaSel ('Just "sgSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64)) :*: (S1 ('MetaSel ('Just "sgEpochLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 EpochSize) :*: S1 ('MetaSel ('Just "sgSlotsPerKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64)))) :*: (((S1 ('MetaSel ('Just "sgMaxKESEvolutions") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64) :*: S1 ('MetaSel ('Just "sgSlotLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 NominalDiffTime)) :*: (S1 ('MetaSel ('Just "sgUpdateQuorum") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64) :*: S1 ('MetaSel ('Just "sgMaxLovelaceSupply") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Word64))) :*: ((S1 ('MetaSel ('Just "sgProtocolParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PParams era)) :*: S1 ('MetaSel ('Just "sgGenDelegs") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'Genesis (Crypto era)) (GenDelegPair (Crypto era))))) :*: (S1 ('MetaSel ('Just "sgInitialFunds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ListMap (Addr (Crypto era)) Coin)) :*: S1 ('MetaSel ('Just "sgStaking") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ShelleyGenesisStaking (Crypto era))))))))
type TranslationError (AlonzoEra c) ShelleyGenesis 
Instance details

Defined in Cardano.Ledger.Alonzo.Translation

type TranslationError (AlonzoEra c) ShelleyGenesis = Void
type TranslationError (BabbageEra c) ShelleyGenesis 
Instance details

Defined in Cardano.Ledger.Babbage.Translation

type TranslationError (BabbageEra c) ShelleyGenesis = Void
type TranslationError (AllegraEra c) ShelleyGenesis 
Instance details

Defined in Cardano.Ledger.Allegra.Translation

type TranslationError (AllegraEra c) ShelleyGenesis = Void
type TranslationError (MaryEra c) ShelleyGenesis 
Instance details

Defined in Cardano.Ledger.Mary.Translation

type TranslationError (MaryEra c) ShelleyGenesis = Void

shelleyGenesisDefaultsShelleyGenesis crypto Source #

Some reasonable starting defaults for constructing a ShelleyGenesis.

You must override at least the following fields for this to be useful:

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

Hashes

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)

Payment addresses

Constructing and inspecting Shelley payment addresses

data Address addrtype where 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.

Constructors

ShelleyAddress ∷ Network → PaymentCredential StandardCrypto → StakeReference StandardCrypto → Address ShelleyAddr

Shelley addresses allow delegation. Shelley addresses were introduced in Shelley era and are thus supported from the Shelley era onwards

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)

toShelleyAddrAddressInEra era → Addr StandardCrypto Source #

fromShelleyAddrShelleyBasedEra era → Addr StandardCrypto → AddressInEra era Source #

fromShelleyAddrIsSbeIsShelleyBasedEra era ⇒ Addr StandardCrypto → AddressInEra era Source #

fromShelleyAddrToAny ∷ Addr StandardCrypto → AddressAny Source #

toShelleyStakeCredentialStakeCredential → StakeCredential StandardCrypto Source #

fromShelleyStakeCredential ∷ StakeCredential StandardCrypto → StakeCredential Source #

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

Stake addresses

data StakeAddress where Source #

Constructors

StakeAddress ∷ Network → StakeCredential StandardCrypto → StakeAddress 

Instances

Instances details
Eq StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Ord StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Show StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

FromJSON StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Methods

parseJSON ∷ Value → Parser StakeAddress #

parseJSONList ∷ Value → Parser [StakeAddress] #

ToJSON StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Methods

toJSONStakeAddress → Value #

toEncodingStakeAddress → Encoding #

toJSONList ∷ [StakeAddress] → Value #

toEncodingList ∷ [StakeAddress] → Encoding #

HasTypeProxy StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

Associated Types

data AsType StakeAddress Source #

SerialiseAsRawBytes StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

SerialiseAsBech32 StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

SerialiseAddress StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

data AsType StakeAddress Source # 
Instance details

Defined in Cardano.Api.Address

toShelleyStakeAddrStakeAddress → RewardAcnt StandardCrypto Source #

fromShelleyStakeAddr ∷ RewardAcnt StandardCrypto → StakeAddress Source #

fromShelleyStakeReference ∷ StakeReference StandardCrypto → StakeAddressReference Source #

fromShelleyPaymentCredential ∷ PaymentCredential StandardCrypto → PaymentCredential Source #

Building transactions

Constructing and inspecting transactions

data TxBody era where Source #

Constructors

ShelleyTxBody 

Fields

Instances

Instances details
Eq (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

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

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

Show (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxBody era → ShowS Source #

showTxBody era → String Source #

showList ∷ [TxBody era] → ShowS 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 #

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

Defined in Cardano.Api.TxBody

Methods

serialiseToCBORTxBody era → ByteString Source #

deserialiseFromCBORAsType (TxBody era) → ByteStringEither DecoderError (TxBody era) Source #

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

Defined in Cardano.Api.TxBody

data AsType (TxBody era) Source # 
Instance details

Defined in Cardano.Api.TxBody

data AsType (TxBody era) = AsTxBody (AsType era)

newtype TxId Source #

Constructors

TxId (Hash StandardCrypto EraIndependentTxBody) 

Instances

Instances details
Eq TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

(==)TxIdTxIdBool Source #

(/=)TxIdTxIdBool Source #

Ord TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

compareTxIdTxIdOrdering Source #

(<)TxIdTxIdBool Source #

(<=)TxIdTxIdBool Source #

(>)TxIdTxIdBool Source #

(>=)TxIdTxIdBool Source #

maxTxIdTxIdTxId Source #

minTxIdTxIdTxId Source #

Show TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

showsPrecIntTxIdShowS Source #

showTxIdString Source #

showList ∷ [TxId] → ShowS Source #

IsString TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

fromStringStringTxId Source #

FromJSON TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

parseJSON ∷ Value → Parser TxId #

parseJSONList ∷ Value → Parser [TxId] #

ToJSON TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONTxId → Value #

toEncodingTxId → Encoding #

toJSONList ∷ [TxId] → Value #

toEncodingList ∷ [TxId] → Encoding #

FromJSONKey TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

fromJSONKey ∷ FromJSONKeyFunction TxId

fromJSONKeyList ∷ FromJSONKeyFunction [TxId]

ToJSONKey TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONKey ∷ ToJSONKeyFunction TxId

toJSONKeyList ∷ ToJSONKeyFunction [TxId]

HasTypeProxy TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

Associated Types

data AsType TxId Source #

SerialiseAsRawBytes TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

data AsType TxId Source # 
Instance details

Defined in Cardano.Api.TxIn

toShelleyTxIdTxId → TxId StandardCrypto Source #

fromShelleyTxId ∷ TxId StandardCrypto → TxId Source #

getTxIdShelley ∷ Crypto (ShelleyLedgerEra era) ~ StandardCrypto ⇒ UsesTxBody (ShelleyLedgerEra era) ⇒ ShelleyBasedEra era → TxBody (ShelleyLedgerEra era) → TxId Source #

data TxIn Source #

Constructors

TxIn TxId TxIx 

Instances

Instances details
Eq TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

(==)TxInTxInBool Source #

(/=)TxInTxInBool Source #

Ord TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

compareTxInTxInOrdering Source #

(<)TxInTxInBool Source #

(<=)TxInTxInBool Source #

(>)TxInTxInBool Source #

(>=)TxInTxInBool Source #

maxTxInTxInTxIn Source #

minTxInTxInTxIn Source #

Show TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

showsPrecIntTxInShowS Source #

showTxInString Source #

showList ∷ [TxIn] → ShowS Source #

FromJSON TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

parseJSON ∷ Value → Parser TxIn #

parseJSONList ∷ Value → Parser [TxIn] #

ToJSON TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONTxIn → Value #

toEncodingTxIn → Encoding #

toJSONList ∷ [TxIn] → Value #

toEncodingList ∷ [TxIn] → Encoding #

FromJSONKey TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

fromJSONKey ∷ FromJSONKeyFunction TxIn

fromJSONKeyList ∷ FromJSONKeyFunction [TxIn]

ToJSONKey TxIn Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONKey ∷ ToJSONKeyFunction TxIn

toJSONKeyList ∷ ToJSONKeyFunction [TxIn]

toShelleyTxInTxIn → TxIn StandardCrypto Source #

This function may overflow on the transaction index. Call sites must ensure that all uses of this function are appropriately guarded.

fromShelleyTxIn ∷ TxIn StandardCrypto → TxIn Source #

data TxOut ctx era Source #

Constructors

TxOut (AddressInEra era) (TxOutValue era) (TxOutDatum ctx era) (ReferenceScript era) 

Instances

Instances details
EraCast (TxOut ctx) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → TxOut ctx fromEra → Either EraCastError (TxOut ctx toEra) Source #

Eq (TxOut ctx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

(==)TxOut ctx era → TxOut ctx era → Bool Source #

(/=)TxOut ctx era → TxOut ctx era → Bool Source #

Show (TxOut ctx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxOut ctx era → ShowS Source #

showTxOut ctx era → String Source #

showList ∷ [TxOut ctx era] → ShowS Source #

(IsShelleyBasedEra era, IsCardanoEra era) ⇒ FromJSON (TxOut CtxUTxO era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

parseJSON ∷ Value → Parser (TxOut CtxUTxO era) #

parseJSONList ∷ Value → Parser [TxOut CtxUTxO era] #

(IsShelleyBasedEra era, IsCardanoEra era) ⇒ FromJSON (TxOut CtxTx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

parseJSON ∷ Value → Parser (TxOut CtxTx era) #

parseJSONList ∷ Value → Parser [TxOut CtxTx era] #

IsCardanoEra era ⇒ ToJSON (TxOut ctx era) Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toJSONTxOut ctx era → Value #

toEncodingTxOut ctx era → Encoding #

toJSONList ∷ [TxOut ctx era] → Value #

toEncodingList ∷ [TxOut ctx era] → Encoding #

toShelleyTxOut ∷ ∀ era ledgerera. ShelleyLedgerEra era ~ ledgerera ⇒ ShelleyBasedEra era → TxOut CtxUTxO era → TxOut ledgerera Source #

fromShelleyTxOutShelleyLedgerEra era ~ ledgerera ⇒ ShelleyBasedEra era → TxOut ledgerera → TxOut ctx era Source #

newtype TxIx Source #

Constructors

TxIx Word 

Instances

Instances details
Enum TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Eq TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

(==)TxIxTxIxBool Source #

(/=)TxIxTxIxBool Source #

Ord TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

compareTxIxTxIxOrdering Source #

(<)TxIxTxIxBool Source #

(<=)TxIxTxIxBool Source #

(>)TxIxTxIxBool Source #

(>=)TxIxTxIxBool Source #

maxTxIxTxIxTxIx Source #

minTxIxTxIxTxIx Source #

Show TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

showsPrecIntTxIxShowS Source #

showTxIxString Source #

showList ∷ [TxIx] → ShowS Source #

FromJSON TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

parseJSON ∷ Value → Parser TxIx #

parseJSONList ∷ Value → Parser [TxIx] #

ToJSON TxIx Source # 
Instance details

Defined in Cardano.Api.TxIn

Methods

toJSONTxIx → Value #

toEncodingTxIx → Encoding #

toJSONList ∷ [TxIx] → Value #

toEncodingList ∷ [TxIx] → Encoding #

newtype Lovelace Source #

Constructors

Lovelace Integer 

Instances

Instances details
Enum Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Eq Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Integral Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Num Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Ord Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Real Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Show Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Semigroup Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Monoid Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

FromJSON Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Methods

parseJSON ∷ Value → Parser Lovelace #

parseJSONList ∷ Value → Parser [Lovelace] #

ToJSON Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Methods

toJSONLovelace → Value #

toEncodingLovelace → Encoding #

toJSONList ∷ [Lovelace] → Value #

toEncodingList ∷ [Lovelace] → Encoding #

FromCBOR Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Methods

fromCBOR ∷ Decoder s Lovelace #

labelProxy LovelaceText #

ToCBOR Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Methods

toCBORLovelace → Encoding #

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

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

toMaryValueValue → Value StandardCrypto Source #

fromMaryValue ∷ Value StandardCrypto → Value Source #

calcMinimumDepositValueLovelaceLovelace Source #

Calculate cost of making a UTxO entry for a given Value and mininimum UTxO value derived from the ProtocolParameters

Signing transactions

Creating transaction witnesses one by one, or all in one go.

data Tx era where Source #

Constructors

ShelleyTxShelleyBasedEra era → Tx (ShelleyLedgerEra era) → Tx era 

Instances

Instances details
Eq (InAnyCardanoEra Tx) Source # 
Instance details

Defined in Cardano.Api.Tx

Eq (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx

Methods

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

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

Show (InAnyCardanoEra Tx) Source # 
Instance details

Defined in Cardano.Api.Tx

Show (Tx era) Source # 
Instance details

Defined in Cardano.Api.Tx

Methods

showsPrecIntTx era → ShowS Source #

showTx era → String Source #

showList ∷ [Tx era] → ShowS 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 #

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

Defined in Cardano.Api.Tx

Methods

serialiseToCBORTx era → ByteString Source #

deserialiseFromCBORAsType (Tx era) → ByteStringEither DecoderError (Tx era) Source #

IsCardanoEra era ⇒ HasTextEnvelope (Tx 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)

Incremental signing and separate witnesses

data KeyWitness era where Source #

Constructors

ShelleyBootstrapWitnessShelleyBasedEra era → BootstrapWitness StandardCrypto → KeyWitness era 
ShelleyKeyWitnessShelleyBasedEra era → WitVKey Witness StandardCrypto → KeyWitness era 

Instances

Instances details
Eq (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx

Methods

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

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

Show (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx

Methods

showsPrecIntKeyWitness era → ShowS Source #

showKeyWitness era → String Source #

showList ∷ [KeyWitness era] → ShowS Source #

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

Defined in Cardano.Api.Tx

Associated Types

data AsType (KeyWitness era) Source #

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

Defined in Cardano.Api.Tx

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

Defined in Cardano.Api.Tx

data AsType (KeyWitness era) Source # 
Instance details

Defined in Cardano.Api.Tx

data ShelleySigningKey Source #

We support making key witnesses with both normal and extended signing keys.

Constructors

ShelleyNormalSigningKey (SignKeyDSIGN StandardCrypto)

A normal ed25519 signing key

ShelleyExtendedSigningKey XPrv

An extended ed25519 signing key

makeShelleySignature ∷ SignableRepresentation tosign ⇒ tosign → ShelleySigningKey → SignedDSIGN StandardCrypto tosign Source #

Blocks

fromConsensusBlockConsensusBlockForMode mode ~ block ⇒ LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) (ShelleyEra StandardCrypto)) ⇒ ConsensusMode mode → block → BlockInMode mode Source #

toConsensusBlockConsensusBlockForMode mode ~ block ⇒ LedgerSupportsProtocol (ShelleyBlock (TPraos StandardCrypto) (ShelleyEra StandardCrypto)) ⇒ BlockInMode mode → block Source #

fromConsensusTipConsensusBlockForMode mode ~ block ⇒ ConsensusMode mode → Tip block → ChainTip Source #

toConsensusPointHF ∷ HeaderHash block ~ OneEraHash xs ⇒ ChainPoint → Point block Source #

Convert a Point for multi-era block type

Transaction metadata

Embedding additional structured data within transactions.

Protocol parameters

data ProtocolParameters Source #

The values of the set of updatable protocol parameters. At any particular point on the chain there is a current set of parameters in use.

These parameters can be updated (at epoch boundaries) via an UpdateProposal, which contains a ProtocolParametersUpdate.

The ProtocolParametersUpdate is essentially a diff for the ProtocolParameters.

There are also parameters fixed in the Genesis file. See GenesisParameters.

Constructors

ProtocolParameters 

Fields

Instances

Instances details
Eq ProtocolParameters Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Show ProtocolParameters Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Generic ProtocolParameters Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Associated Types

type Rep ProtocolParametersTypeType Source #

FromJSON ProtocolParameters Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

parseJSON ∷ Value → Parser ProtocolParameters #

parseJSONList ∷ Value → Parser [ProtocolParameters] #

ToJSON ProtocolParameters Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Methods

toJSONProtocolParameters → Value #

toEncodingProtocolParameters → Encoding #

toJSONList ∷ [ProtocolParameters] → Value #

toEncodingList ∷ [ProtocolParameters] → Encoding #

type Rep ProtocolParameters Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

type Rep ProtocolParameters = D1 ('MetaData "ProtocolParameters" "Cardano.Api.ProtocolParameters" "cardano-api-1.36.0-inplace" 'False) (C1 ('MetaCons "ProtocolParameters" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "protocolParamProtocolVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Natural, Natural)) :*: (S1 ('MetaSel ('Just "protocolParamDecentralization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Rational)) :*: S1 ('MetaSel ('Just "protocolParamExtraPraosEntropy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe PraosNonce)))) :*: (S1 ('MetaSel ('Just "protocolParamMaxBlockHeaderSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "protocolParamMaxBlockBodySize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "protocolParamMaxTxSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))) :*: ((S1 ('MetaSel ('Just "protocolParamTxFeeFixed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "protocolParamTxFeePerByte") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "protocolParamMinUTxOValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Lovelace)))) :*: ((S1 ('MetaSel ('Just "protocolParamStakeAddressDeposit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Lovelace) :*: S1 ('MetaSel ('Just "protocolParamStakePoolDeposit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Lovelace)) :*: (S1 ('MetaSel ('Just "protocolParamMinPoolCost") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Lovelace) :*: S1 ('MetaSel ('Just "protocolParamPoolRetireMaxEpoch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EpochNo))))) :*: (((S1 ('MetaSel ('Just "protocolParamStakePoolTargetNum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "protocolParamPoolPledgeInfluence") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational) :*: S1 ('MetaSel ('Just "protocolParamMonetaryExpansion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational))) :*: (S1 ('MetaSel ('Just "protocolParamTreasuryCut") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational) :*: (S1 ('MetaSel ('Just "protocolParamUTxOCostPerWord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Lovelace)) :*: S1 ('MetaSel ('Just "protocolParamCostModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map AnyPlutusScriptVersion CostModel))))) :*: ((S1 ('MetaSel ('Just "protocolParamPrices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExecutionUnitPrices)) :*: (S1 ('MetaSel ('Just "protocolParamMaxTxExUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExecutionUnits)) :*: S1 ('MetaSel ('Just "protocolParamMaxBlockExUnits") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ExecutionUnits)))) :*: ((S1 ('MetaSel ('Just "protocolParamMaxValueSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "protocolParamCollateralPercent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "protocolParamMaxCollateralInputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "protocolParamUTxOCostPerByte") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Lovelace))))))))

Scripts

toShelleyMultiSigSimpleScript SimpleScriptV1 → MultiSig StandardCrypto Source #

Conversion for the MultiSig language used by the Shelley era.

fromShelleyMultiSig ∷ MultiSig StandardCrypto → SimpleScript lang Source #

Conversion for the MultiSig language used by the Shelley era.

toAllegraTimelock ∷ ∀ lang. SimpleScript lang → Timelock StandardCrypto Source #

Conversion for the Timelock language that is shared between the Allegra and Mary eras.

fromAllegraTimelockTimeLocksSupported lang → Timelock StandardCrypto → SimpleScript lang Source #

Conversion for the Timelock language that is shared between the Allegra and Mary eras.

toShelleyScriptHashScriptHash → ScriptHash StandardCrypto Source #

fromShelleyScriptHash ∷ ScriptHash StandardCrypto → ScriptHash Source #

data PlutusScript lang where Source #

Plutus scripts.

Note that Plutus scripts have a binary serialisation but no JSON serialisation.

Instances

Instances details
Eq (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

Methods

(==)PlutusScript lang → PlutusScript lang → Bool Source #

(/=)PlutusScript lang → PlutusScript lang → Bool Source #

Ord (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

Methods

comparePlutusScript lang → PlutusScript lang → Ordering Source #

(<)PlutusScript lang → PlutusScript lang → Bool Source #

(<=)PlutusScript lang → PlutusScript lang → Bool Source #

(>)PlutusScript lang → PlutusScript lang → Bool Source #

(>=)PlutusScript lang → PlutusScript lang → Bool Source #

maxPlutusScript lang → PlutusScript lang → PlutusScript lang Source #

minPlutusScript lang → PlutusScript lang → PlutusScript lang Source #

Show (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

Methods

showsPrecIntPlutusScript lang → ShowS Source #

showPlutusScript lang → String Source #

showList ∷ [PlutusScript lang] → ShowS Source #

(Typeable lang, HasTypeProxy lang) ⇒ FromCBOR (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

Methods

fromCBOR ∷ Decoder s (PlutusScript lang) #

labelProxy (PlutusScript lang) → Text #

(Typeable lang, HasTypeProxy lang) ⇒ ToCBOR (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

Methods

toCBORPlutusScript lang → Encoding #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (PlutusScript lang) → Size #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [PlutusScript lang] → Size #

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

Defined in Cardano.Api.Script

Associated Types

data AsType (PlutusScript lang) Source #

(HasTypeProxy lang, Typeable lang) ⇒ SerialiseAsCBOR (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

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

Defined in Cardano.Api.Script

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

Defined in Cardano.Api.Script

data AsType (PlutusScript lang) Source # 
Instance details

Defined in Cardano.Api.Script

data PlutusScriptOrReferenceInput lang Source #

Scripts can now exist in the UTxO at a transaction output. We can reference these scripts via specification of a reference transaction input in order to witness spending inputs, withdrawals, certificates or to mint tokens. This datatype encapsulates this concept.

toAlonzoDataScriptData → Data ledgerera Source #

fromAlonzoData ∷ Data ledgerera → ScriptData Source #

Reference Scripts

data ReferenceScript era where Source #

A reference scripts is a script that can exist at a transaction output. This greatly reduces the size of transactions that use scripts as the script no longer has to be added to the transaction, they can now be referenced via a transaction output.

Instances

Instances details
EraCast ReferenceScript Source # 
Instance details

Defined in Cardano.Api.Script

Methods

eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → ReferenceScript fromEra → Either EraCastError (ReferenceScript toEra) Source #

Eq (ReferenceScript era) Source # 
Instance details

Defined in Cardano.Api.Script

Show (ReferenceScript era) Source # 
Instance details

Defined in Cardano.Api.Script

IsCardanoEra era ⇒ FromJSON (ReferenceScript era) Source # 
Instance details

Defined in Cardano.Api.Script

Methods

parseJSON ∷ Value → Parser (ReferenceScript era) #

parseJSONList ∷ Value → Parser [ReferenceScript era] #

IsCardanoEra era ⇒ ToJSON (ReferenceScript era) Source # 
Instance details

Defined in Cardano.Api.Script

Methods

toJSONReferenceScript era → Value #

toEncodingReferenceScript era → Encoding #

toJSONList ∷ [ReferenceScript era] → Value #

toEncodingList ∷ [ReferenceScript era] → Encoding #

refScriptToShelleyScriptCardanoEra era → ReferenceScript era → StrictMaybe (Script (ShelleyLedgerEra era)) Source #

Certificates

data Certificate Source #

Instances

Instances details
Eq Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Show Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

FromCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

fromCBOR ∷ Decoder s Certificate #

labelProxy CertificateText #

ToCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

Methods

toCBORCertificate → 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 Cardano.Api.Certificate

Associated Types

data AsType Certificate Source #

SerialiseAsCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

HasTextEnvelope Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

data AsType Certificate Source # 
Instance details

Defined in Cardano.Api.Certificate

toShelleyCertificateCertificate → DCert StandardCrypto Source #

fromShelleyCertificate ∷ DCert StandardCrypto → Certificate Source #

Operational certificates