cardano-api-1.22.1
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

Era

data Shelley Source #

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

Instances

Instances details
Eq (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: Tx Shelley -> Tx Shelley -> Bool #

(/=) :: Tx Shelley -> Tx Shelley -> Bool #

Eq (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (TxOut Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Ord (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (TxOut Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAddress (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsBech32 (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Witness Shelley) Source #

HasTypeProxy (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Tx Shelley) Source #

HasTypeProxy (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (TxBody Shelley) Source #

HasTypeProxy (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Address Shelley) Source #

data AsType (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

class HasTypeProxy t where Source #

Associated Types

data AsType t Source #

A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.

Values of this type are passed to

Methods

proxyToAsType :: Proxy t -> AsType t Source #

Instances

Instances details
HasTypeProxy VrfKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType VrfKey Source #

HasTypeProxy KesKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType KesKey Source #

HasTypeProxy StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType StakePoolKey Source #

HasTypeProxy GenesisUTxOKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType GenesisUTxOKey Source #

HasTypeProxy GenesisDelegateExtendedKey Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy GenesisDelegateKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType GenesisDelegateKey Source #

HasTypeProxy GenesisExtendedKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType GenesisExtendedKey Source #

HasTypeProxy GenesisKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType GenesisKey Source #

HasTypeProxy StakeExtendedKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType StakeExtendedKey Source #

HasTypeProxy StakeKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType StakeKey Source #

HasTypeProxy PaymentExtendedKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType PaymentExtendedKey Source #

HasTypeProxy PaymentKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType PaymentKey Source #

HasTypeProxy ByronKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType ByronKey Source #

HasTypeProxy OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType OperationalCertificate Source #

HasTypeProxy UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType UpdateProposal Source #

HasTypeProxy TxMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType TxMetadata Source #

HasTypeProxy StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType StakePoolMetadata Source #

HasTypeProxy Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType Certificate Source #

HasTypeProxy Script Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType Script Source #

HasTypeProxy TxId Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType TxId Source #

HasTypeProxy StakeAddress Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType StakeAddress Source #

HasTypeProxy (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Witness Shelley) Source #

HasTypeProxy (Witness Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Witness Byron) Source #

HasTypeProxy (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Tx Shelley) Source #

HasTypeProxy (Tx Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Tx Byron) Source #

HasTypeProxy (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (TxBody Shelley) Source #

HasTypeProxy (TxBody Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (TxBody Byron) Source #

HasTypeProxy (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Address Shelley) Source #

HasTypeProxy (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Address Byron) Source #

HasTypeProxy a => HasTypeProxy (Hash a) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Hash a) Source #

Methods

proxyToAsType :: Proxy (Hash a) -> AsType (Hash a) Source #

HasTypeProxy a => HasTypeProxy (VerificationKey a) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (VerificationKey a) Source #

Methods

proxyToAsType :: Proxy (VerificationKey a) -> AsType (VerificationKey a) Source #

HasTypeProxy a => HasTypeProxy (SigningKey a) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (SigningKey a) Source #

Methods

proxyToAsType :: Proxy (SigningKey a) -> AsType (SigningKey a) Source #

Cryptographic key interface

Payment addresses

Constructing and inspecting Shelley payment addresses

data Address era where Source #

Constructors

ShelleyAddress :: Network -> PaymentCredential StandardShelley -> StakeReference StandardShelley -> Address Shelley

Shelley addresses are only valid in the Shelley era.

Instances

Instances details
Eq (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Ord (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Ord (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAddress (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAddress (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsBech32 (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Address Shelley) Source #

HasTypeProxy (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Address Byron) Source #

data AsType (Address Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType (Address Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

data NetworkId Source #

Constructors

Mainnet 
Testnet !NetworkMagic 

Instances

Instances details
Eq NetworkId Source # 
Instance details

Defined in Cardano.Api.Typed

Show NetworkId Source # 
Instance details

Defined in Cardano.Api.Typed

Building transactions

Constructing and inspecting transactions

data TxBody era where Source #

Instances

Instances details
Eq (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (TxBody Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (TxBody Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (TxBody Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (TxBody Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (TxBody Shelley) Source #

HasTypeProxy (TxBody Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (TxBody Byron) Source #

data AsType (TxBody Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType (TxBody Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

newtype TxId Source #

Constructors

TxId (Hash StandardCrypto ()) 

Instances

Instances details
Eq TxId Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: TxId -> TxId -> Bool #

(/=) :: TxId -> TxId -> Bool #

Ord TxId Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

compare :: TxId -> TxId -> Ordering #

(<) :: TxId -> TxId -> Bool #

(<=) :: TxId -> TxId -> Bool #

(>) :: TxId -> TxId -> Bool #

(>=) :: TxId -> TxId -> Bool #

max :: TxId -> TxId -> TxId #

min :: TxId -> TxId -> TxId #

Show TxId Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> TxId -> ShowS #

show :: TxId -> String #

showList :: [TxId] -> ShowS #

IsString TxId Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromString :: String -> TxId #

SerialiseAsRawBytes TxId Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy TxId Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType TxId Source #

data AsType TxId Source # 
Instance details

Defined in Cardano.Api.Typed

data TxIn Source #

Constructors

TxIn TxId TxIx 

Instances

Instances details
Eq TxIn Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: TxIn -> TxIn -> Bool #

(/=) :: TxIn -> TxIn -> Bool #

Show TxIn Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> TxIn -> ShowS #

show :: TxIn -> String #

showList :: [TxIn] -> ShowS #

data TxOut era Source #

Constructors

TxOut (Address era) Lovelace 

Instances

Instances details
Eq (TxOut Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (TxOut Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (TxOut Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (TxOut Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

newtype TxIx Source #

Constructors

TxIx Word 

Instances

Instances details
Enum TxIx Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

succ :: TxIx -> TxIx #

pred :: TxIx -> TxIx #

toEnum :: Int -> TxIx #

fromEnum :: TxIx -> Int #

enumFrom :: TxIx -> [TxIx] #

enumFromThen :: TxIx -> TxIx -> [TxIx] #

enumFromTo :: TxIx -> TxIx -> [TxIx] #

enumFromThenTo :: TxIx -> TxIx -> TxIx -> [TxIx] #

Eq TxIx Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: TxIx -> TxIx -> Bool #

(/=) :: TxIx -> TxIx -> Bool #

Ord TxIx Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

compare :: TxIx -> TxIx -> Ordering #

(<) :: TxIx -> TxIx -> Bool #

(<=) :: TxIx -> TxIx -> Bool #

(>) :: TxIx -> TxIx -> Bool #

(>=) :: TxIx -> TxIx -> Bool #

max :: TxIx -> TxIx -> TxIx #

min :: TxIx -> TxIx -> TxIx #

Show TxIx Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> TxIx -> ShowS #

show :: TxIx -> String #

showList :: [TxIx] -> ShowS #

newtype SlotNo Source #

The 0-based index for the Ourboros time slot.

Constructors

SlotNo Word64 

Instances

Instances details
Bounded SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Enum SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Eq SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) :: SlotNo -> SlotNo -> Bool #

(/=) :: SlotNo -> SlotNo -> Bool #

Num SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Ord SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Show SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Generic SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep SlotNo :: Type -> Type #

Methods

from :: SlotNo -> Rep SlotNo x #

to :: Rep SlotNo x -> SlotNo #

NFData SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

rnf :: SlotNo -> () #

ToJSON SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

FromJSON SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

ToCBOR SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR :: SlotNo -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy SlotNo -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SlotNo] -> Size Source #

FromCBOR SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

NoThunks SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Serialise SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

Condense SlotNo 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

HasField "ttl" (TxBody era) SlotNo 
Instance details

Defined in Shelley.Spec.Ledger.TxBody

Methods

getField :: TxBody era -> SlotNo #

Embed (StakeCreds era) (Map (Credential 'Staking era) SlotNo) 
Instance details

Defined in Shelley.Spec.Ledger.TxBody

HasExp (StakeCreds era) (Map (Credential 'Staking era) SlotNo) 
Instance details

Defined in Shelley.Spec.Ledger.TxBody

Methods

toExp :: StakeCreds era -> Exp (Map (Credential 'Staking era) SlotNo) Source #

type Rep SlotNo 
Instance details

Defined in Cardano.Slotting.Slot

type Rep SlotNo = D1 ('MetaData "SlotNo" "Cardano.Slotting.Slot" "cardano-slotting-0.1.0.0-H21nBdelt3gCHGeqsQWafy" 'True) (C1 ('MetaCons "SlotNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSlotNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Signing transactions

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

data Tx era where Source #

Constructors

ShelleyTx :: Tx StandardShelley -> Tx Shelley 

Instances

Instances details
Eq (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: Tx Shelley -> Tx Shelley -> Bool #

(/=) :: Tx Shelley -> Tx Shelley -> Bool #

Eq (Tx Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: Tx Byron -> Tx Byron -> Bool #

(/=) :: Tx Byron -> Tx Byron -> Bool #

Show (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Tx Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> Tx Byron -> ShowS #

show :: Tx Byron -> String #

showList :: [Tx Byron] -> ShowS #

HasTextEnvelope (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (Tx Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (Tx Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Tx Shelley) Source #

HasTypeProxy (Tx Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Tx Byron) Source #

data AsType (Tx Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType (Tx Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Incremental signing and separate witnesses

data Witness era where Source #

Instances

Instances details
Eq (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (Witness Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Witness Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (Witness Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (Witness Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Witness Shelley) Source #

HasTypeProxy (Witness Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType (Witness Byron) Source #

data AsType (Witness Shelley) Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType (Witness Byron) Source # 
Instance details

Defined in Cardano.Api.Typed

data ShelleySigningKey Source #

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

Reading one of several key types

data FromSomeType (c :: Type -> Constraint) b where Source #

Constructors

FromSomeType :: c a => AsType a -> (a -> b) -> FromSomeType c b 

Transaction metadata

Embedding additional structured data within transactions.

newtype TxMetadata Source #

Bundled Patterns

pattern TxMetadata :: Map Word64 TxMetadataValue -> TxMetadata 

Instances

Instances details
Eq TxMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Show TxMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Semigroup TxMetadata Source #

Merge metadata maps. When there are clashing entries the left hand side takes precedence.

Instance details

Defined in Cardano.Api.Typed

Monoid TxMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR TxMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy TxMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType TxMetadata Source #

data AsType TxMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Protocol parameter updates

newtype UpdateProposal Source #

Instances

Instances details
Eq UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

Show UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

ToCBOR UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

FromCBOR UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType UpdateProposal Source #

data AsType UpdateProposal Source # 
Instance details

Defined in Cardano.Api.Typed

data ProtocolParametersUpdate Source #

protocolUpdateProtocolVersion :: ProtocolParametersUpdate -> Maybe (Natural, Natural) Source #

Protocol version, major and minor. Updating the major version is used to trigger hard forks.

protocolUpdateDecentralization :: ProtocolParametersUpdate -> Maybe Rational Source #

The decentralization parameter. This is fraction of slots that belong to the BFT overlay schedule, rather than the Praos schedule. So 1 means fully centralised, while 0 means fully decentralised.

This is the "d" parameter from the design document.

protocolUpdateExtraPraosEntropy :: ProtocolParametersUpdate -> Maybe (Maybe ByteString) Source #

Extra entropy for the Praos per-epoch nonce.

This can be used to add extra entropy during the decentralisation process. If the extra entropy can be demonstrated to be generated randomly then this method can be used to show that the initial federated operators did not subtly bias the initial schedule so that they retain undue influence after decentralisation.

protocolUpdateMaxBlockHeaderSize :: ProtocolParametersUpdate -> Maybe Natural Source #

The maximum permitted size of a block header.

This must be at least as big as the largest legitimate block headers but should not be too much larger, to help prevent DoS attacks.

Caution: setting this to be smaller than legitimate block headers is a sure way to brick the system!

protocolUpdateMaxBlockBodySize :: ProtocolParametersUpdate -> Maybe Natural Source #

The maximum permitted size of the block body (that is, the block payload, without the block header).

This should be picked with the Praos network delta security parameter in mind. Making this too large can severely weaken the Praos consensus properties.

Caution: setting this to be smaller than a transaction that can change the protocol parameters is a sure way to brick the system!

protocolUpdateMaxTxSize :: ProtocolParametersUpdate -> Maybe Natural Source #

The maximum permitted size of a transaction.

Typically this should not be too high a fraction of the block size, otherwise wastage from block fragmentation becomes a problem, and the current implementation does not use any sophisticated box packing algorithm.

protocolUpdateTxFeeFixed :: ProtocolParametersUpdate -> Maybe Natural Source #

The constant factor for the minimum fee calculation.

protocolUpdateTxFeePerByte :: ProtocolParametersUpdate -> Maybe Natural Source #

The linear factor for the minimum fee calculation.

protocolUpdateMinUTxOValue :: ProtocolParametersUpdate -> Maybe Lovelace Source #

The minimum permitted value for new UTxO entries, ie for transaction outputs.

protocolUpdateStakeAddressDeposit :: ProtocolParametersUpdate -> Maybe Lovelace Source #

The deposit required to register a stake address.

protocolUpdateStakePoolDeposit :: ProtocolParametersUpdate -> Maybe Lovelace Source #

The deposit required to register a stake pool.

protocolUpdateMinPoolCost :: ProtocolParametersUpdate -> Maybe Lovelace Source #

The minimum value that stake pools are permitted to declare for their cost parameter.

protocolUpdatePoolRetireMaxEpoch :: ProtocolParametersUpdate -> Maybe EpochNo Source #

The maximum number of epochs into the future that stake pools are permitted to schedule a retirement.

protocolUpdateStakePoolTargetNum :: ProtocolParametersUpdate -> Maybe Natural Source #

The equilibrium target number of stake pools.

This is the "k" incentives parameter from the design document.

protocolUpdatePoolPledgeInfluence :: ProtocolParametersUpdate -> Maybe Rational Source #

The influence of the pledge in stake pool rewards.

This is the "a_0" incentives parameter from the design document.

protocolUpdateMonetaryExpansion :: ProtocolParametersUpdate -> Maybe Rational Source #

The monetary expansion rate. This determines the fraction of the reserves that are added to the fee pot each epoch.

This is the "rho" incentives parameter from the design document.

protocolUpdateTreasuryCut :: ProtocolParametersUpdate -> Maybe Rational Source #

The fraction of the fee pot each epoch that goes to the treasury.

This is the "tau" incentives parameter from the design document.

newtype EpochNo Source #

An epoch, i.e. the number of the epoch.

Constructors

EpochNo 

Fields

Instances

Instances details
Enum EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Eq EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

(==) :: EpochNo -> EpochNo -> Bool #

(/=) :: EpochNo -> EpochNo -> Bool #

Num EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Ord EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Show EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Generic EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Associated Types

type Rep EpochNo :: Type -> Type #

Methods

from :: EpochNo -> Rep EpochNo x #

to :: Rep EpochNo x -> EpochNo #

ToJSON EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

FromJSON EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

ToCBOR EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Methods

toCBOR :: EpochNo -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy EpochNo -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [EpochNo] -> Size Source #

FromCBOR EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

NoThunks EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Serialise EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

Condense EpochNo 
Instance details

Defined in Ouroboros.Consensus.Util.Condense

type Rep EpochNo 
Instance details

Defined in Cardano.Slotting.Slot

type Rep EpochNo = D1 ('MetaData "EpochNo" "Cardano.Slotting.Slot" "cardano-slotting-0.1.0.0-H21nBdelt3gCHGeqsQWafy" 'True) (C1 ('MetaCons "EpochNo" 'PrefixI 'True) (S1 ('MetaSel ('Just "unEpochNo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

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 NetworkMagic :: Type -> Type #

NoThunks NetworkMagic 
Instance details

Defined in Ouroboros.Network.Magic

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-DgIBwCUrGXaLitNwqCfIcM" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

Scripts

Both PaymentCredentials and StakeCredentials can use scripts. Shelley supports multi-signatures via scripts.

newtype Script Source #

Constructors

Script (Script StandardShelley) 

Instances

Instances details
Eq Script Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: Script -> Script -> Bool #

(/=) :: Script -> Script -> Bool #

Ord Script Source # 
Instance details

Defined in Cardano.Api.Typed

Show Script Source # 
Instance details

Defined in Cardano.Api.Typed

ToCBOR Script Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

toCBOR :: Script -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy Script -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [Script] -> Size Source #

HasTextEnvelope Script Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR Script Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy Script Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType Script Source #

Eq (Hash Script) Source # 
Instance details

Defined in Cardano.Api.Typed

Ord (Hash Script) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Hash Script) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (Hash Script) Source # 
Instance details

Defined in Cardano.Api.Typed

newtype Hash Script Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType Script Source # 
Instance details

Defined in Cardano.Api.Typed

Certificates

newtype Certificate Source #

Instances

Instances details
Eq Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

Show Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

ToCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

FromCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType Certificate Source #

data AsType Certificate Source # 
Instance details

Defined in Cardano.Api.Typed

Operational certificates

data OperationalCertificate Source #

Constructors

OperationalCertificate !(OCert StandardCrypto) !(VerificationKey StakePoolKey) 

Instances

Instances details
Eq OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

Show OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

ToCBOR OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

FromCBOR OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType OperationalCertificate Source #

data AsType OperationalCertificate Source # 
Instance details

Defined in Cardano.Api.Typed

data OperationalCertificateIssueCounter Source #

Constructors

OperationalCertificateIssueCounter !Word64 !(VerificationKey StakePoolKey) 

Instances

Instances details
Eq OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

Show OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

ToCBOR OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

FromCBOR OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType OperationalCertificateIssueCounter Source # 
Instance details

Defined in Cardano.Api.Typed

data OperationalCertIssueError Source #

Constructors

OperationalCertKeyMismatch (VerificationKey StakePoolKey) (VerificationKey StakePoolKey)

The stake pool verification key expected for the OperationalCertificateIssueCounter does not match the signing key supplied for signing.

Order: pool vkey expected, pool skey supplied

Stake Pool

data StakePoolMetadata Source #

A representation of the required fields for off-chain stake pool metadata.

Constructors

StakePoolMetadata !Text !Text !Text !Text 

Instances

Instances details
Eq StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Show StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

FromJSON StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

HasTypeProxy StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType StakePoolMetadata Source #

Eq (Hash StakePoolMetadata) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Hash StakePoolMetadata) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (Hash StakePoolMetadata) Source # 
Instance details

Defined in Cardano.Api.Typed

newtype Hash StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType StakePoolMetadata Source # 
Instance details

Defined in Cardano.Api.Typed

stakePoolName :: StakePoolMetadata -> Text Source #

A name of up to 50 characters.

stakePoolDescription :: StakePoolMetadata -> Text Source #

A description of up to 255 characters.

stakePoolTicker :: StakePoolMetadata -> Text Source #

A ticker of 3-5 characters, for a compact display of stake pools in a wallet.

stakePoolHomepage :: StakePoolMetadata -> Text Source #

A URL to a homepage with additional information about the pool. n.b. the spec does not specify a character limit for this field.

data StakePoolRelay Source #

Constructors

StakePoolRelayIp (Maybe IPv4) (Maybe IPv6) (Maybe PortNumber)

One or both of IPv4 & IPv6

StakePoolRelayDnsARecord ByteString (Maybe PortNumber)

An DNS name pointing to a A or AAAA record.

StakePoolRelayDnsSrvRecord ByteString

A DNS name pointing to a SRV record.

Instances

Instances details
Eq StakePoolRelay Source # 
Instance details

Defined in Cardano.Api.Typed

Show StakePoolRelay Source # 
Instance details

Defined in Cardano.Api.Typed

Stake pool operator's keys

data StakePoolKey Source #

Instances

Instances details
Key StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data VerificationKey StakePoolKey

data SigningKey StakePoolKey

HasTypeProxy StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType StakePoolKey Source #

Eq (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: VerificationKey StakePoolKey -> VerificationKey StakePoolKey -> Bool #

(/=) :: VerificationKey StakePoolKey -> VerificationKey StakePoolKey -> Bool #

Ord (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> VerificationKey StakePoolKey -> ShowS #

show :: VerificationKey StakePoolKey -> String #

showList :: [VerificationKey StakePoolKey] -> ShowS #

Show (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> SigningKey StakePoolKey -> ShowS #

show :: SigningKey StakePoolKey -> String #

showList :: [SigningKey StakePoolKey] -> ShowS #

IsString (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromString :: String -> VerificationKey StakePoolKey #

IsString (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromString :: String -> SigningKey StakePoolKey #

ToJSON (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

ToCBOR (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

toCBOR :: VerificationKey StakePoolKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VerificationKey StakePoolKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VerificationKey StakePoolKey] -> Size Source #

ToCBOR (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

toCBOR :: SigningKey StakePoolKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (SigningKey StakePoolKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SigningKey StakePoolKey] -> Size Source #

FromCBOR (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromCBOR :: Decoder s (VerificationKey StakePoolKey) Source #

label :: Proxy (VerificationKey StakePoolKey) -> Text Source #

FromCBOR (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromCBOR :: Decoder s (SigningKey StakePoolKey) Source #

label :: Proxy (SigningKey StakePoolKey) -> Text Source #

HasTextEnvelope (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsBech32 (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsBech32 (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

bech32PrefixFor :: VerificationKey StakePoolKey -> Text

bech32PrefixesPermitted :: AsType (VerificationKey StakePoolKey) -> [Text]

SerialiseAsBech32 (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (Hash StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToRawBytes :: VerificationKey StakePoolKey -> ByteString Source #

deserialiseFromRawBytes :: AsType (VerificationKey StakePoolKey) -> ByteString -> Maybe (VerificationKey StakePoolKey) Source #

SerialiseAsRawBytes (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsCBOR (VerificationKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToCBOR :: VerificationKey StakePoolKey -> ByteString Source #

deserialiseFromCBOR :: AsType (VerificationKey StakePoolKey) -> ByteString -> Either DecoderError (VerificationKey StakePoolKey) Source #

SerialiseAsCBOR (SigningKey StakePoolKey) Source # 
Instance details

Defined in Cardano.Api.Typed

newtype Hash StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Typed

newtype VerificationKey StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Typed

newtype SigningKey StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType StakePoolKey Source # 
Instance details

Defined in Cardano.Api.Typed

KES keys

data KesKey Source #

Instances

Instances details
Key KesKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data VerificationKey KesKey

data SigningKey KesKey

HasTypeProxy KesKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType KesKey Source #

Eq (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: VerificationKey KesKey -> VerificationKey KesKey -> Bool #

(/=) :: VerificationKey KesKey -> VerificationKey KesKey -> Bool #

Ord (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> VerificationKey KesKey -> ShowS #

show :: VerificationKey KesKey -> String #

showList :: [VerificationKey KesKey] -> ShowS #

Show (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> SigningKey KesKey -> ShowS #

show :: SigningKey KesKey -> String #

showList :: [SigningKey KesKey] -> ShowS #

IsString (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromString :: String -> VerificationKey KesKey #

IsString (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromString :: String -> SigningKey KesKey #

ToCBOR (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

toCBOR :: VerificationKey KesKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VerificationKey KesKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VerificationKey KesKey] -> Size Source #

ToCBOR (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

toCBOR :: SigningKey KesKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (SigningKey KesKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SigningKey KesKey] -> Size Source #

FromCBOR (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromCBOR :: Decoder s (VerificationKey KesKey) Source #

label :: Proxy (VerificationKey KesKey) -> Text Source #

FromCBOR (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromCBOR :: Decoder s (SigningKey KesKey) Source #

label :: Proxy (SigningKey KesKey) -> Text Source #

HasTextEnvelope (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsBech32 (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

bech32PrefixFor :: VerificationKey KesKey -> Text

bech32PrefixesPermitted :: AsType (VerificationKey KesKey) -> [Text]

SerialiseAsBech32 (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

bech32PrefixFor :: SigningKey KesKey -> Text

bech32PrefixesPermitted :: AsType (SigningKey KesKey) -> [Text]

SerialiseAsRawBytes (Hash KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToRawBytes :: VerificationKey KesKey -> ByteString Source #

deserialiseFromRawBytes :: AsType (VerificationKey KesKey) -> ByteString -> Maybe (VerificationKey KesKey) Source #

SerialiseAsRawBytes (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToRawBytes :: SigningKey KesKey -> ByteString Source #

deserialiseFromRawBytes :: AsType (SigningKey KesKey) -> ByteString -> Maybe (SigningKey KesKey) Source #

SerialiseAsCBOR (VerificationKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToCBOR :: VerificationKey KesKey -> ByteString Source #

deserialiseFromCBOR :: AsType (VerificationKey KesKey) -> ByteString -> Either DecoderError (VerificationKey KesKey) Source #

SerialiseAsCBOR (SigningKey KesKey) Source # 
Instance details

Defined in Cardano.Api.Typed

newtype Hash KesKey Source # 
Instance details

Defined in Cardano.Api.Typed

newtype VerificationKey KesKey Source # 
Instance details

Defined in Cardano.Api.Typed

newtype SigningKey KesKey Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType KesKey Source # 
Instance details

Defined in Cardano.Api.Typed

VRF keys

data VrfKey Source #

Instances

Instances details
Key VrfKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data VerificationKey VrfKey

data SigningKey VrfKey

HasTypeProxy VrfKey Source # 
Instance details

Defined in Cardano.Api.Typed

Associated Types

data AsType VrfKey Source #

Eq (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Eq (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

(==) :: VerificationKey VrfKey -> VerificationKey VrfKey -> Bool #

(/=) :: VerificationKey VrfKey -> VerificationKey VrfKey -> Bool #

Ord (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Show (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> VerificationKey VrfKey -> ShowS #

show :: VerificationKey VrfKey -> String #

showList :: [VerificationKey VrfKey] -> ShowS #

Show (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

showsPrec :: Int -> SigningKey VrfKey -> ShowS #

show :: SigningKey VrfKey -> String #

showList :: [SigningKey VrfKey] -> ShowS #

IsString (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromString :: String -> VerificationKey VrfKey #

IsString (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromString :: String -> SigningKey VrfKey #

ToCBOR (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

toCBOR :: VerificationKey VrfKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (VerificationKey VrfKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [VerificationKey VrfKey] -> Size Source #

ToCBOR (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

toCBOR :: SigningKey VrfKey -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (SigningKey VrfKey) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [SigningKey VrfKey] -> Size Source #

FromCBOR (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromCBOR :: Decoder s (VerificationKey VrfKey) Source #

label :: Proxy (VerificationKey VrfKey) -> Text Source #

FromCBOR (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

fromCBOR :: Decoder s (SigningKey VrfKey) Source #

label :: Proxy (SigningKey VrfKey) -> Text Source #

HasTextEnvelope (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

HasTextEnvelope (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsBech32 (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

bech32PrefixFor :: VerificationKey VrfKey -> Text

bech32PrefixesPermitted :: AsType (VerificationKey VrfKey) -> [Text]

SerialiseAsBech32 (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

bech32PrefixFor :: SigningKey VrfKey -> Text

bech32PrefixesPermitted :: AsType (SigningKey VrfKey) -> [Text]

SerialiseAsRawBytes (Hash VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

SerialiseAsRawBytes (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToRawBytes :: VerificationKey VrfKey -> ByteString Source #

deserialiseFromRawBytes :: AsType (VerificationKey VrfKey) -> ByteString -> Maybe (VerificationKey VrfKey) Source #

SerialiseAsRawBytes (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToRawBytes :: SigningKey VrfKey -> ByteString Source #

deserialiseFromRawBytes :: AsType (SigningKey VrfKey) -> ByteString -> Maybe (SigningKey VrfKey) Source #

SerialiseAsCBOR (VerificationKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

Methods

serialiseToCBOR :: VerificationKey VrfKey -> ByteString Source #

deserialiseFromCBOR :: AsType (VerificationKey VrfKey) -> ByteString -> Either DecoderError (VerificationKey VrfKey) Source #

SerialiseAsCBOR (SigningKey VrfKey) Source # 
Instance details

Defined in Cardano.Api.Typed

newtype Hash VrfKey Source # 
Instance details

Defined in Cardano.Api.Typed

newtype VerificationKey VrfKey Source # 
Instance details

Defined in Cardano.Api.Typed

newtype SigningKey VrfKey Source # 
Instance details

Defined in Cardano.Api.Typed

data AsType VrfKey Source # 
Instance details

Defined in Cardano.Api.Typed

Low level protocol interaction with a Cardano node

data LocalNodeClientProtocols block Source #

Constructors

LocalNodeClientProtocols (Maybe (ChainSyncClient block (Point block) (Tip block) IO ())) (Maybe (LocalTxSubmissionClient (GenTx block) (ApplyTxErr block) IO ())) (Maybe (LocalStateQueryClient block (Point block) (Query block) IO ()))