Safe Haskell | None |
---|---|
Language | Haskell2010 |
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
- module Cardano.API
- data Shelley
- class HasTypeProxy t where
- data AsType t
- proxyToAsType :: Proxy t -> AsType t
- data Address era where
- data NetworkId
- data TxBody era where
- ShelleyTxBody :: TxBody StandardShelley -> Maybe MetaData -> TxBody Shelley
- newtype TxId = TxId (Hash StandardCrypto ())
- data TxIn = TxIn TxId TxIx
- data TxOut era = TxOut (Address era) Lovelace
- newtype TxIx = TxIx Word
- newtype Lovelace = Lovelace Integer
- newtype SlotNo = SlotNo Word64
- data Tx era where
- ShelleyTx :: Tx StandardShelley -> Tx Shelley
- data Witness era where
- data ShelleyWitnessSigningKey
- = WitnessPaymentKey (SigningKey PaymentKey)
- | WitnessPaymentExtendedKey (SigningKey PaymentExtendedKey)
- | WitnessStakeKey (SigningKey StakeKey)
- | WitnessStakeExtendedKey (SigningKey StakeExtendedKey)
- | WitnessStakePoolKey (SigningKey StakePoolKey)
- | WitnessGenesisKey (SigningKey GenesisKey)
- | WitnessGenesisExtendedKey (SigningKey GenesisExtendedKey)
- | WitnessGenesisDelegateKey (SigningKey GenesisDelegateKey)
- | WitnessGenesisDelegateExtendedKey (SigningKey GenesisDelegateExtendedKey)
- data ShelleySigningKey
- getShelleyKeyWitnessVerificationKey :: ShelleySigningKey -> VKey Witness StandardCrypto
- makeShelleySignature :: SignableRepresentation tosign => tosign -> ShelleySigningKey -> SignedDSIGN StandardCrypto tosign
- toShelleySigningKey :: ShelleyWitnessSigningKey -> ShelleySigningKey
- data FromSomeType (c :: Type -> Constraint) b where
- FromSomeType :: c a => AsType a -> (a -> b) -> FromSomeType c b
- newtype TxMetadata where
- TxMetadataShelley MetaData
- pattern TxMetadata :: Map Word64 TxMetadataValue -> TxMetadata
- data TxMetadataValue
- toShelleyMetaData :: Map Word64 TxMetadataValue -> MetaData
- fromShelleyMetaData :: MetaData -> Map Word64 TxMetadataValue
- newtype UpdateProposal = UpdateProposal (Update StandardShelley)
- data ProtocolParametersUpdate = ProtocolParametersUpdate (Maybe (Natural, Natural)) (Maybe Rational) (Maybe (Maybe ByteString)) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Lovelace) (Maybe Lovelace) (Maybe Lovelace) (Maybe Lovelace) (Maybe EpochNo) (Maybe Natural) (Maybe Rational) (Maybe Rational) (Maybe Rational)
- protocolUpdateProtocolVersion :: ProtocolParametersUpdate -> Maybe (Natural, Natural)
- protocolUpdateDecentralization :: ProtocolParametersUpdate -> Maybe Rational
- protocolUpdateExtraPraosEntropy :: ProtocolParametersUpdate -> Maybe (Maybe ByteString)
- protocolUpdateMaxBlockHeaderSize :: ProtocolParametersUpdate -> Maybe Natural
- protocolUpdateMaxBlockBodySize :: ProtocolParametersUpdate -> Maybe Natural
- protocolUpdateMaxTxSize :: ProtocolParametersUpdate -> Maybe Natural
- protocolUpdateTxFeeFixed :: ProtocolParametersUpdate -> Maybe Natural
- protocolUpdateTxFeePerByte :: ProtocolParametersUpdate -> Maybe Natural
- protocolUpdateMinUTxOValue :: ProtocolParametersUpdate -> Maybe Lovelace
- protocolUpdateStakeAddressDeposit :: ProtocolParametersUpdate -> Maybe Lovelace
- protocolUpdateStakePoolDeposit :: ProtocolParametersUpdate -> Maybe Lovelace
- protocolUpdateMinPoolCost :: ProtocolParametersUpdate -> Maybe Lovelace
- protocolUpdatePoolRetireMaxEpoch :: ProtocolParametersUpdate -> Maybe EpochNo
- protocolUpdateStakePoolTargetNum :: ProtocolParametersUpdate -> Maybe Natural
- protocolUpdatePoolPledgeInfluence :: ProtocolParametersUpdate -> Maybe Rational
- protocolUpdateMonetaryExpansion :: ProtocolParametersUpdate -> Maybe Rational
- protocolUpdateTreasuryCut :: ProtocolParametersUpdate -> Maybe Rational
- newtype EpochNo = EpochNo {}
- newtype NetworkMagic = NetworkMagic {}
- toShelleyPParamsUpdate :: ProtocolParametersUpdate -> PParamsUpdate StandardShelley
- newtype Script = Script (Script StandardShelley)
- data MultiSigScript
- parseScript :: Value -> Parser MultiSigScript
- parseScriptAny :: Value -> Parser MultiSigScript
- parseScriptAll :: Value -> Parser MultiSigScript
- parseScriptAtLeast :: Value -> Parser MultiSigScript
- parseScriptSig :: Value -> Parser MultiSigScript
- newtype Certificate = Certificate (DCert StandardShelley)
- data OperationalCertificate = OperationalCertificate !(OCert StandardCrypto) !(VerificationKey StakePoolKey)
- data OperationalCertificateIssueCounter = OperationalCertificateIssueCounter !Word64 !(VerificationKey StakePoolKey)
- data OperationalCertIssueError = OperationalCertKeyMismatch (VerificationKey StakePoolKey) (VerificationKey StakePoolKey)
- data StakePoolMetadata = StakePoolMetadata !Text !Text !Text !Text
- stakePoolName :: StakePoolMetadata -> Text
- stakePoolDescription :: StakePoolMetadata -> Text
- stakePoolTicker :: StakePoolMetadata -> Text
- stakePoolHomepage :: StakePoolMetadata -> Text
- data StakePoolMetadataReference = StakePoolMetadataReference URI (Hash StakePoolMetadata)
- stakePoolMetadataURL :: StakePoolMetadataReference -> URI
- stakePoolMetadataHash :: StakePoolMetadataReference -> Hash StakePoolMetadata
- data StakePoolParameters = StakePoolParameters PoolId (Hash VrfKey) Lovelace Rational StakeAddress Lovelace [Hash StakeKey] [StakePoolRelay] (Maybe StakePoolMetadataReference)
- stakePoolId :: StakePoolParameters -> PoolId
- stakePoolVRF :: StakePoolParameters -> Hash VrfKey
- stakePoolCost :: StakePoolParameters -> Lovelace
- stakePoolMargin :: StakePoolParameters -> Rational
- stakePoolRewardAccount :: StakePoolParameters -> StakeAddress
- stakePoolPledge :: StakePoolParameters -> Lovelace
- stakePoolOwners :: StakePoolParameters -> [Hash StakeKey]
- stakePoolRelays :: StakePoolParameters -> [StakePoolRelay]
- stakePoolMetadata :: StakePoolParameters -> Maybe StakePoolMetadataReference
- data StakePoolRelay
- toShelleyPoolParams :: StakePoolParameters -> PoolParams StandardShelley
- data StakePoolKey
- type PoolId = Hash StakePoolKey
- data KesKey
- data VrfKey
- data LocalNodeConnectInfo mode block = LocalNodeConnectInfo FilePath NetworkId (NodeConsensusMode mode block)
- data ShelleyMode
- data CardanoMode
- data NodeConsensusMode mode block where
- data LocalNodeClientProtocols block = LocalNodeClientProtocols (Maybe (ChainSyncClient block (Point block) (Tip block) IO ())) (Maybe (LocalTxSubmissionClient (GenTx block) (ApplyTxErr block) IO ())) (Maybe (LocalStateQueryClient block (Point block) (Query block) IO ()))
- withNodeProtocolClient :: NodeConsensusMode mode block -> ((SerialiseNodeToClientConstraints block, SupportedNetworkProtocolVersion block) => ProtocolClient block (BlockProtocol block) -> a) -> a
Documentation
module Cardano.API
Era
A type used as a tag to distinguish the Shelley era.
Instances
class HasTypeProxy t where Source #
Associated Types
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
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
Building transactions
Constructing and inspecting transactions
data TxBody era where Source #
Constructors
ShelleyTxBody :: TxBody StandardShelley -> Maybe MetaData -> TxBody Shelley |
Instances
Constructors
TxId (Hash StandardCrypto ()) |
Instances
Eq TxId Source # | |
Ord TxId Source # | |
Show TxId Source # | |
IsString TxId Source # | |
Defined in Cardano.Api.Typed Methods fromString :: String -> TxId # | |
SerialiseAsRawBytes TxId Source # | |
Defined in Cardano.Api.Typed Methods serialiseToRawBytes :: TxId -> ByteString Source # deserialiseFromRawBytes :: AsType TxId -> ByteString -> Maybe TxId Source # | |
HasTypeProxy TxId Source # | |
data AsType TxId Source # | |
Defined in Cardano.Api.Typed |
Instances
Enum Lovelace Source # | |
Defined in Cardano.Api.Typed | |
Eq Lovelace Source # | |
Ord Lovelace Source # | |
Defined in Cardano.Api.Typed | |
Show Lovelace Source # | |
The 0-based index for the Ourboros time slot.
Instances
Bounded SlotNo | |
Enum SlotNo | |
Defined in Cardano.Slotting.Slot | |
Eq SlotNo | |
Num SlotNo | |
Ord SlotNo | |
Show SlotNo | |
Generic SlotNo | |
NFData SlotNo | |
Defined in Cardano.Slotting.Slot | |
ToJSON SlotNo | |
FromJSON SlotNo | |
ToCBOR SlotNo | |
FromCBOR SlotNo | |
NoThunks SlotNo | |
Serialise SlotNo | |
Condense SlotNo | |
HasField "ttl" (TxBody era) SlotNo | |
Defined in Shelley.Spec.Ledger.TxBody | |
Embed (StakeCreds era) (Map (Credential 'Staking era) SlotNo) | |
Defined in Shelley.Spec.Ledger.TxBody Methods toBase :: StakeCreds era -> Map (Credential 'Staking era) SlotNo Source # fromBase :: Map (Credential 'Staking era) SlotNo -> StakeCreds era Source # | |
HasExp (StakeCreds era) (Map (Credential 'Staking era) SlotNo) | |
Defined in Shelley.Spec.Ledger.TxBody Methods toExp :: StakeCreds era -> Exp (Map (Credential 'Staking era) SlotNo) Source # | |
type Rep SlotNo | |
Defined in Cardano.Slotting.Slot |
Signing transactions
Creating transaction witnesses one by one, or all in one go.
Constructors
ShelleyTx :: Tx StandardShelley -> Tx Shelley |
Instances
Incremental signing and separate witnesses
data Witness era where Source #
Constructors
Instances
data ShelleyWitnessSigningKey Source #
Constructors
WitnessPaymentKey (SigningKey PaymentKey) | |
WitnessPaymentExtendedKey (SigningKey PaymentExtendedKey) | |
WitnessStakeKey (SigningKey StakeKey) | |
WitnessStakeExtendedKey (SigningKey StakeExtendedKey) | |
WitnessStakePoolKey (SigningKey StakePoolKey) | |
WitnessGenesisKey (SigningKey GenesisKey) | |
WitnessGenesisExtendedKey (SigningKey GenesisExtendedKey) | |
WitnessGenesisDelegateKey (SigningKey GenesisDelegateKey) | |
WitnessGenesisDelegateExtendedKey (SigningKey GenesisDelegateExtendedKey) |
data ShelleySigningKey Source #
We support making key witnesses with both normal and extended signing keys.
makeShelleySignature :: SignableRepresentation tosign => tosign -> ShelleySigningKey -> SignedDSIGN StandardCrypto tosign Source #
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 #
Constructors
TxMetadataShelley MetaData |
Bundled Patterns
pattern TxMetadata :: Map Word64 TxMetadataValue -> TxMetadata |
Instances
data TxMetadataValue Source #
Constructors
TxMetaNumber Integer | |
TxMetaBytes ByteString | |
TxMetaText Text | |
TxMetaList [TxMetadataValue] | |
TxMetaMap [(TxMetadataValue, TxMetadataValue)] |
Instances
Eq TxMetadataValue Source # | |
Defined in Cardano.Api.Typed Methods (==) :: TxMetadataValue -> TxMetadataValue -> Bool # (/=) :: TxMetadataValue -> TxMetadataValue -> Bool # | |
Ord TxMetadataValue Source # | |
Defined in Cardano.Api.Typed Methods compare :: TxMetadataValue -> TxMetadataValue -> Ordering # (<) :: TxMetadataValue -> TxMetadataValue -> Bool # (<=) :: TxMetadataValue -> TxMetadataValue -> Bool # (>) :: TxMetadataValue -> TxMetadataValue -> Bool # (>=) :: TxMetadataValue -> TxMetadataValue -> Bool # max :: TxMetadataValue -> TxMetadataValue -> TxMetadataValue # min :: TxMetadataValue -> TxMetadataValue -> TxMetadataValue # | |
Show TxMetadataValue Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> TxMetadataValue -> ShowS # show :: TxMetadataValue -> String # showList :: [TxMetadataValue] -> ShowS # |
Protocol parameter updates
newtype UpdateProposal Source #
Constructors
UpdateProposal (Update StandardShelley) |
Instances
data ProtocolParametersUpdate Source #
Constructors
ProtocolParametersUpdate (Maybe (Natural, Natural)) (Maybe Rational) (Maybe (Maybe ByteString)) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Natural) (Maybe Lovelace) (Maybe Lovelace) (Maybe Lovelace) (Maybe Lovelace) (Maybe EpochNo) (Maybe Natural) (Maybe Rational) (Maybe Rational) (Maybe Rational) |
Instances
Eq ProtocolParametersUpdate Source # | |
Defined in Cardano.Api.Typed Methods (==) :: ProtocolParametersUpdate -> ProtocolParametersUpdate -> Bool # (/=) :: ProtocolParametersUpdate -> ProtocolParametersUpdate -> Bool # | |
Show ProtocolParametersUpdate Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> ProtocolParametersUpdate -> ShowS # show :: ProtocolParametersUpdate -> String # showList :: [ProtocolParametersUpdate] -> ShowS # | |
Semigroup ProtocolParametersUpdate Source # | |
Defined in Cardano.Api.Typed | |
Monoid ProtocolParametersUpdate Source # | |
Defined in Cardano.Api.Typed |
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.
An epoch, i.e. the number of the epoch.
Instances
Enum EpochNo | |
Eq EpochNo | |
Num EpochNo | |
Ord EpochNo | |
Defined in Cardano.Slotting.Slot | |
Show EpochNo | |
Generic EpochNo | |
ToJSON EpochNo | |
FromJSON EpochNo | |
ToCBOR EpochNo | |
FromCBOR EpochNo | |
NoThunks EpochNo | |
Serialise EpochNo | |
Condense EpochNo | |
type Rep EpochNo | |
Defined in Cardano.Slotting.Slot |
newtype NetworkMagic #
Constructors
NetworkMagic | |
Fields |
Instances
Eq NetworkMagic | |
Defined in Ouroboros.Network.Magic | |
Show NetworkMagic | |
Defined in Ouroboros.Network.Magic Methods showsPrec :: Int -> NetworkMagic -> ShowS # show :: NetworkMagic -> String # showList :: [NetworkMagic] -> ShowS # | |
Generic NetworkMagic | |
Defined in Ouroboros.Network.Magic Associated Types type Rep NetworkMagic :: Type -> Type # | |
NoThunks NetworkMagic | |
Defined in Ouroboros.Network.Magic | |
type Rep NetworkMagic | |
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 PaymentCredential
s and StakeCredential
s can use scripts.
Shelley supports multi-signatures via scripts.
Constructors
Script (Script StandardShelley) |
Instances
Eq Script Source # | |
Ord Script Source # | |
Show Script Source # | |
ToCBOR Script Source # | |
HasTextEnvelope Script Source # | |
Defined in Cardano.Api.Typed Methods textEnvelopeType :: AsType Script -> TextEnvelopeType Source # textEnvelopeDefaultDescr :: Script -> TextEnvelopeDescr Source # | |
SerialiseAsCBOR Script Source # | |
Defined in Cardano.Api.Typed Methods serialiseToCBOR :: Script -> ByteString Source # deserialiseFromCBOR :: AsType Script -> ByteString -> Either DecoderError Script Source # | |
HasTypeProxy Script Source # | |
Eq (Hash Script) Source # | |
Ord (Hash Script) Source # | |
Defined in Cardano.Api.Typed | |
Show (Hash Script) Source # | |
SerialiseAsRawBytes (Hash Script) Source # | |
Defined in Cardano.Api.Typed Methods serialiseToRawBytes :: Hash Script -> ByteString Source # deserialiseFromRawBytes :: AsType (Hash Script) -> ByteString -> Maybe (Hash Script) Source # | |
newtype Hash Script Source # | |
Defined in Cardano.Api.Typed | |
data AsType Script Source # | |
Defined in Cardano.Api.Typed |
data MultiSigScript Source #
Constructors
RequireSignature (Hash PaymentKey) | |
RequireAllOf [MultiSigScript] | |
RequireAnyOf [MultiSigScript] | |
RequireMOf Int [MultiSigScript] |
Instances
Eq MultiSigScript Source # | |
Defined in Cardano.Api.Typed Methods (==) :: MultiSigScript -> MultiSigScript -> Bool # (/=) :: MultiSigScript -> MultiSigScript -> Bool # | |
Show MultiSigScript Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> MultiSigScript -> ShowS # show :: MultiSigScript -> String # showList :: [MultiSigScript] -> ShowS # | |
ToJSON MultiSigScript Source # | |
Defined in Cardano.Api.Typed Methods toJSON :: MultiSigScript -> Value Source # toEncoding :: MultiSigScript -> Encoding Source # toJSONList :: [MultiSigScript] -> Value Source # toEncodingList :: [MultiSigScript] -> Encoding Source # | |
FromJSON MultiSigScript Source # | |
Defined in Cardano.Api.Typed Methods parseJSON :: Value -> Parser MultiSigScript Source # parseJSONList :: Value -> Parser [MultiSigScript] Source # |
parseScript :: Value -> Parser MultiSigScript Source #
Certificates
newtype Certificate Source #
Constructors
Certificate (DCert StandardShelley) |
Instances
Operational certificates
data OperationalCertificate Source #
Constructors
OperationalCertificate !(OCert StandardCrypto) !(VerificationKey StakePoolKey) |
Instances
data OperationalCertificateIssueCounter Source #
Constructors
OperationalCertificateIssueCounter !Word64 !(VerificationKey StakePoolKey) |
Instances
Eq OperationalCertificateIssueCounter Source # | |
Defined in Cardano.Api.Typed | |
Show OperationalCertificateIssueCounter Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> OperationalCertificateIssueCounter -> ShowS # | |
ToCBOR OperationalCertificateIssueCounter Source # | |
Defined in Cardano.Api.Typed Methods toCBOR :: OperationalCertificateIssueCounter -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy OperationalCertificateIssueCounter -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [OperationalCertificateIssueCounter] -> Size Source # | |
FromCBOR OperationalCertificateIssueCounter Source # | |
Defined in Cardano.Api.Typed | |
HasTextEnvelope OperationalCertificateIssueCounter Source # | |
SerialiseAsCBOR OperationalCertificateIssueCounter Source # | |
HasTypeProxy OperationalCertificateIssueCounter Source # | |
Defined in Cardano.Api.Typed Associated Types | |
data AsType OperationalCertificateIssueCounter Source # | |
data OperationalCertIssueError Source #
Constructors
OperationalCertKeyMismatch (VerificationKey StakePoolKey) (VerificationKey StakePoolKey) | The stake pool verification key expected for the
Order: pool vkey expected, pool skey supplied |
Instances
Show OperationalCertIssueError Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> OperationalCertIssueError -> ShowS # show :: OperationalCertIssueError -> String # showList :: [OperationalCertIssueError] -> ShowS # | |
Error OperationalCertIssueError Source # | |
Defined in Cardano.Api.Typed Methods displayError :: OperationalCertIssueError -> String Source # |
Stake Pool
data StakePoolMetadata Source #
A representation of the required fields for off-chain stake pool metadata.
Constructors
StakePoolMetadata !Text !Text !Text !Text |
Instances
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 StakePoolMetadataReference Source #
Constructors
StakePoolMetadataReference URI (Hash StakePoolMetadata) |
Instances
Eq StakePoolMetadataReference Source # | |
Defined in Cardano.Api.Typed Methods (==) :: StakePoolMetadataReference -> StakePoolMetadataReference -> Bool # (/=) :: StakePoolMetadataReference -> StakePoolMetadataReference -> Bool # | |
Show StakePoolMetadataReference Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> StakePoolMetadataReference -> ShowS # show :: StakePoolMetadataReference -> String # showList :: [StakePoolMetadataReference] -> ShowS # |
data StakePoolParameters Source #
Constructors
StakePoolParameters PoolId (Hash VrfKey) Lovelace Rational StakeAddress Lovelace [Hash StakeKey] [StakePoolRelay] (Maybe StakePoolMetadataReference) |
Instances
Eq StakePoolParameters Source # | |
Defined in Cardano.Api.Typed Methods (==) :: StakePoolParameters -> StakePoolParameters -> Bool # (/=) :: StakePoolParameters -> StakePoolParameters -> Bool # | |
Show StakePoolParameters Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> StakePoolParameters -> ShowS # show :: StakePoolParameters -> String # showList :: [StakePoolParameters] -> ShowS # |
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 |
StakePoolRelayDnsSrvRecord ByteString | A DNS name pointing to a |
Instances
Eq StakePoolRelay Source # | |
Defined in Cardano.Api.Typed Methods (==) :: StakePoolRelay -> StakePoolRelay -> Bool # (/=) :: StakePoolRelay -> StakePoolRelay -> Bool # | |
Show StakePoolRelay Source # | |
Defined in Cardano.Api.Typed Methods showsPrec :: Int -> StakePoolRelay -> ShowS # show :: StakePoolRelay -> String # showList :: [StakePoolRelay] -> ShowS # |
Stake pool operator's keys
data StakePoolKey Source #
Instances
type PoolId = Hash StakePoolKey Source #
KES keys
Instances
VRF keys
Instances
Low level protocol interaction with a Cardano node
data LocalNodeConnectInfo mode block Source #
Constructors
LocalNodeConnectInfo FilePath NetworkId (NodeConsensusMode mode block) |
data ShelleyMode Source #
Instances
Show (TxSubmitResultForMode ShelleyMode) Source # | |
Defined in Cardano.Api.TxSubmit Methods showsPrec :: Int -> TxSubmitResultForMode ShelleyMode -> ShowS # show :: TxSubmitResultForMode ShelleyMode -> String # showList :: [TxSubmitResultForMode ShelleyMode] -> ShowS # |
data CardanoMode Source #
Instances
Show (TxSubmitResultForMode CardanoMode) Source # | |
Defined in Cardano.Api.TxSubmit Methods showsPrec :: Int -> TxSubmitResultForMode CardanoMode -> ShowS # show :: TxSubmitResultForMode CardanoMode -> String # showList :: [TxSubmitResultForMode CardanoMode] -> ShowS # |
data NodeConsensusMode mode block where Source #
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 ())) |
withNodeProtocolClient :: NodeConsensusMode mode block -> ((SerialiseNodeToClientConstraints block, SupportedNetworkProtocolVersion block) => ProtocolClient block (BlockProtocol block) -> a) -> a Source #