cardano-api-1.30.0
Safe HaskellNone
LanguageHaskell2010

Cardano.Api.Byron

Description

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

Synopsis

Documentation

Cryptographic key interface

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

FromJSON (Hash ScriptData) Source # 
Instance details

Defined in Cardano.Api.ScriptData

Methods

parseJSON ∷ Value → Parser (Hash ScriptData) #

parseJSONList ∷ Value → Parser [Hash ScriptData] #

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 #

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 Byron 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

ByronAddress ∷ Address → Address ByronAddr

Byron addresses were the only supported address type in the original Byron era.

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 #

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

Building transactions

Constructing and inspecting transactions

data TxBody era where Source #

Constructors

ByronTxBody ∷ Annotated Tx ByteStringTxBody ByronEra 

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

Methods

(==)TxIdTxIdBool Source #

(/=)TxIdTxIdBool Source #

Ord TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

compareTxIdTxIdOrdering Source #

(<)TxIdTxIdBool Source #

(<=)TxIdTxIdBool Source #

(>)TxIdTxIdBool Source #

(>=)TxIdTxIdBool Source #

maxTxIdTxIdTxId Source #

minTxIdTxIdTxId Source #

Show TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxIdShowS Source #

showTxIdString Source #

showList ∷ [TxId] → ShowS Source #

IsString TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

fromStringStringTxId Source #

FromJSON TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

parseJSON ∷ Value → Parser TxId #

parseJSONList ∷ Value → Parser [TxId] #

ToJSON TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toJSONTxId → Value #

toEncodingTxId → Encoding #

toJSONList ∷ [TxId] → Value #

toEncodingList ∷ [TxId] → Encoding #

FromJSONKey TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

fromJSONKey ∷ FromJSONKeyFunction TxId

fromJSONKeyList ∷ FromJSONKeyFunction [TxId]

ToJSONKey TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toJSONKey ∷ ToJSONKeyFunction TxId

toJSONKeyList ∷ ToJSONKeyFunction [TxId]

HasTypeProxy TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

Associated Types

data AsType TxId Source #

SerialiseAsRawBytes TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

data AsType TxId Source # 
Instance details

Defined in Cardano.Api.TxBody

data TxIn Source #

Constructors

TxIn TxId TxIx 

Instances

Instances details
Eq TxIn Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

(==)TxInTxInBool Source #

(/=)TxInTxInBool Source #

Ord TxIn Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

compareTxInTxInOrdering Source #

(<)TxInTxInBool Source #

(<=)TxInTxInBool Source #

(>)TxInTxInBool Source #

(>=)TxInTxInBool Source #

maxTxInTxInTxIn Source #

minTxInTxInTxIn Source #

Show TxIn Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxInShowS Source #

showTxInString Source #

showList ∷ [TxIn] → ShowS Source #

FromJSON TxIn Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

parseJSON ∷ Value → Parser TxIn #

parseJSONList ∷ Value → Parser [TxIn] #

ToJSON TxIn Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toJSONTxIn → Value #

toEncodingTxIn → Encoding #

toJSONList ∷ [TxIn] → Value #

toEncodingList ∷ [TxIn] → Encoding #

ToJSONKey TxIn Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

toJSONKey ∷ ToJSONKeyFunction TxIn

toJSONKeyList ∷ ToJSONKeyFunction [TxIn]

data TxOut ctx era Source #

Constructors

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

Instances

Instances details
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 #

newtype TxIx Source #

Constructors

TxIx Word 

Instances

Instances details
Enum TxIx Source # 
Instance details

Defined in Cardano.Api.TxBody

Eq TxIx Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

(==)TxIxTxIxBool Source #

(/=)TxIxTxIxBool Source #

Ord TxIx Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

compareTxIxTxIxOrdering Source #

(<)TxIxTxIxBool Source #

(<=)TxIxTxIxBool Source #

(>)TxIxTxIxBool Source #

(>=)TxIxTxIxBool Source #

maxTxIxTxIxTxIx Source #

minTxIxTxIxTxIx Source #

Show TxIx Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

showsPrecIntTxIxShowS Source #

showTxIxString Source #

showList ∷ [TxIx] → ShowS Source #

FromJSON TxIx Source # 
Instance details

Defined in Cardano.Api.TxBody

Methods

parseJSON ∷ Value → Parser TxIx #

parseJSONList ∷ Value → Parser [TxIx] #

ToJSON TxIx Source # 
Instance details

Defined in Cardano.Api.TxBody

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

Num Lovelace Source # 
Instance details

Defined in Cardano.Api.Value

Ord 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 #

Signing transactions

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

data Tx era where Source #

Constructors

ByronTx ∷ ATxAux ByteStringTx ByronEra 

Instances

Instances details
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 (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

ByronKeyWitness ∷ TxInWitness → KeyWitness ByronEra 

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 WitnessNetworkIdOrByronAddress Source #

Either a network ID or a Byron address to be used in constructing a Shelley bootstrap witness.

Constructors

WitnessNetworkId !NetworkId

Network ID.

If this value is used in the construction of a Shelley bootstrap witness, the result will not consist of a derivation path. If that is required, specify a WitnessByronAddress value instead.

WitnessByronAddress !(Address ByronAddr)

Byron address.

If this value is used in the construction of a Shelley bootstrap witness, both the network ID and derivation path will be extracted from the address and used in the construction of the witness.

Errors

class Show e ⇒ Error e where Source #

Methods

displayError ∷ e → String Source #

Instances

Instances details
Error () Source # 
Instance details

Defined in Cardano.Api.Error

Methods

displayError ∷ () → String Source #

Error JsonDecodeError Source # 
Instance details

Defined in Cardano.Api.SerialiseJSON

Error TextEnvelopeError Source # 
Instance details

Defined in Cardano.Api.SerialiseTextEnvelope

Error TxMetadataJsonSchemaError Source # 
Instance details

Defined in Cardano.Api.TxMetadata

Error TxMetadataJsonError Source # 
Instance details

Defined in Cardano.Api.TxMetadata

Error TxMetadataRangeError Source # 
Instance details

Defined in Cardano.Api.TxMetadata

Error Bech32DecodeError Source # 
Instance details

Defined in Cardano.Api.SerialiseBech32

Error ScriptDataJsonSchemaError Source # 
Instance details

Defined in Cardano.Api.ScriptData

Error ScriptDataJsonError Source # 
Instance details

Defined in Cardano.Api.ScriptData

Error ScriptDataRangeError Source # 
Instance details

Defined in Cardano.Api.ScriptData

Error StakePoolMetadataValidationError Source # 
Instance details

Defined in Cardano.Api.StakePoolMetadata

Error ProtocolParametersError Source # 
Instance details

Defined in Cardano.Api.ProtocolParameters

Error TxBodyError Source # 
Instance details

Defined in Cardano.Api.TxBody

Error OperationalCertIssueError Source # 
Instance details

Defined in Cardano.Api.OperationalCertificate

Error MinimumUTxOError Source # 
Instance details

Defined in Cardano.Api.Fees

Error TxBodyErrorAutoBalance Source # 
Instance details

Defined in Cardano.Api.Fees

Error TransactionValidityIntervalError Source # 
Instance details

Defined in Cardano.Api.Fees

Error ScriptExecutionError Source # 
Instance details

Defined in Cardano.Api.Fees

Error e ⇒ Error (FileError e) Source # 
Instance details

Defined in Cardano.Api.Error

data FileError e Source #

Instances

Instances details
Show e ⇒ Show (FileError e) Source # 
Instance details

Defined in Cardano.Api.Error

Error e ⇒ Error (FileError e) Source # 
Instance details

Defined in Cardano.Api.Error

Low level protocol interaction with a Cardano node

data ByronMode Source #

The Byron-only consensus mode consists of only the Byron era.

This was used on the mainnet before the deployment of the multi-era CardanoMode. It is now of little practical use, though it illustrates how a single-era consensus mode works. It may be sensible to remove this at some stage.

Instances

Instances details
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 ConsensusMode mode where Source #

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

Instances

Instances details
Show (ConsensusMode mode) Source # 
Instance details

Defined in Cardano.Api.Modes

data LocalNodeClientProtocols block point tip tx txerr query m Source #

The protocols we can use with a local node. Use in conjunction with connectToLocalNode.

These protocols use the types from the rest of this API. The conversion to/from the types used by the underlying wire formats is handled by connectToLocalNode.

Constructors

LocalNodeClientProtocols (LocalChainSyncClient block point tip m) (Maybe (LocalTxSubmissionClient tx txerr m ())) (Maybe (LocalStateQueryClient block point query m ())) 

Chain sync protocol

newtype ChainSyncClient header point tip (m ∷ TypeType) a #

Constructors

ChainSyncClient 

Fields

Local tx submission

newtype LocalTxSubmissionClient tx reject (m ∷ TypeType) a #

Constructors

LocalTxSubmissionClient (m (LocalTxClientStIdle tx reject m a)) 

Local state query

newtype LocalStateQueryClient block point (query ∷ TypeType) (m ∷ TypeType) a #

Constructors

LocalStateQueryClient 

Fields

Address

newtype NetworkMagic #

Constructors

NetworkMagic 

Instances

Instances details
Eq NetworkMagic 
Instance details

Defined in Ouroboros.Network.Magic

Show NetworkMagic 
Instance details

Defined in Ouroboros.Network.Magic

Generic NetworkMagic 
Instance details

Defined in Ouroboros.Network.Magic

Associated Types

type Rep NetworkMagicTypeType Source #

NoThunks NetworkMagic 
Instance details

Defined in Ouroboros.Network.Magic

Methods

noThunks ∷ Context → NetworkMagicIO (Maybe ThunkInfo)

wNoThunks ∷ Context → NetworkMagicIO (Maybe ThunkInfo)

showTypeOfProxy NetworkMagicString

type Rep NetworkMagic 
Instance details

Defined in Ouroboros.Network.Magic

type Rep NetworkMagic = D1 ('MetaData "NetworkMagic" "Ouroboros.Network.Magic" "ouroboros-network-0.1.0.0-523b248b5f8d9dde6454efa2708c5ba8134413041a21face0e365dffb72931b2" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

Update Proposal

data ByronProtocolParametersUpdate Source #

Constructors

ByronProtocolParametersUpdate 

Fields

makeByronUpdateProposalNetworkId → ProtocolVersion → SoftwareVersion → SystemTag → InstallerHash → SomeByronSigningKeyByronProtocolParametersUpdateByronUpdateProposal Source #

Vote

newtype ByronVote Source #

Byron era votes

Constructors

ByronVote 

Fields

toByronLedgertoByronVoteByronVote → GenTx ByronBlock Source #

Conversions

fromByronTxIn ∷ TxIn → TxIn Source #

toByronNetworkMagicNetworkId → NetworkMagic Source #

toByronProtocolMagicIdNetworkId → ProtocolMagicId Source #

toByronRequiresNetworkMagicNetworkId → RequiresNetworkMagic Source #