| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
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
- module Cardano.Api
- data SomeByronSigningKey
- data family Hash keyrole ∷ Type
- data Address addrtype where
- ByronAddress ∷ Address → Address ByronAddr
- data NetworkId
- data TxBody era where
- ByronTxBody ∷ Annotated Tx ByteString → TxBody ByronEra
- newtype TxId = TxId (Hash StandardCrypto EraIndependentTxBody)
- data TxIn = TxIn TxId TxIx
- data TxOut ctx era = TxOut (AddressInEra era) (TxOutValue era) (TxOutDatum ctx era) (ReferenceScript era)
- newtype TxIx = TxIx Word
- newtype Lovelace = Lovelace Integer
- data Tx era where
- ByronTx ∷ ATxAux ByteString → Tx ByronEra
- data KeyWitness era where
- ByronKeyWitness ∷ TxInWitness → KeyWitness ByronEra
- data WitnessNetworkIdOrByronAddress
- class Show e ⇒ Error e where
- displayError ∷ e → String
- data FileError e
- data LocalNodeConnectInfo mode = LocalNodeConnectInfo (ConsensusModeParams mode) NetworkId FilePath
- data ByronMode
- data ConsensusMode mode where
- data LocalNodeClientProtocols block point tip slot tx txid txerr query m = LocalNodeClientProtocols (LocalChainSyncClient block point tip m) (Maybe (LocalTxSubmissionClient tx txerr m ())) (Maybe (LocalStateQueryClient block point query m ())) (Maybe (LocalTxMonitorClient txid tx slot m ()))
- newtype ChainSyncClient header point tip (m ∷ Type → Type) a = ChainSyncClient {
- runChainSyncClient ∷ m (ClientStIdle header point tip m a)
- newtype LocalTxSubmissionClient tx reject (m ∷ Type → Type) a = LocalTxSubmissionClient (m (LocalTxClientStIdle tx reject m a))
- newtype LocalStateQueryClient block point (query ∷ Type → Type) (m ∷ Type → Type) a = LocalStateQueryClient {
- runLocalStateQueryClient ∷ m (ClientStIdle block point query m a)
- newtype NetworkMagic = NetworkMagic {}
- newtype ByronUpdateProposal = ByronUpdateProposal {
- unByronUpdateProposal ∷ AProposal ByteString
- data ByronProtocolParametersUpdate = ByronProtocolParametersUpdate {
- bPpuScriptVersion ∷ !(Maybe Word16)
- bPpuSlotDuration ∷ !(Maybe Natural)
- bPpuMaxBlockSize ∷ !(Maybe Natural)
- bPpuMaxHeaderSize ∷ !(Maybe Natural)
- bPpuMaxTxSize ∷ !(Maybe Natural)
- bPpuMaxProposalSize ∷ !(Maybe Natural)
- bPpuMpcThd ∷ !(Maybe LovelacePortion)
- bPpuHeavyDelThd ∷ !(Maybe LovelacePortion)
- bPpuUpdateVoteThd ∷ !(Maybe LovelacePortion)
- bPpuUpdateProposalThd ∷ !(Maybe LovelacePortion)
- bPpuUpdateProposalTTL ∷ !(Maybe SlotNumber)
- bPpuSoftforkRule ∷ !(Maybe SoftforkRule)
- bPpuTxFeePolicy ∷ !(Maybe TxFeePolicy)
- bPpuUnlockStakeEpoch ∷ !(Maybe EpochNumber)
- makeByronUpdateProposal ∷ NetworkId → ProtocolVersion → SoftwareVersion → SystemTag → InstallerHash → SomeByronSigningKey → ByronProtocolParametersUpdate → ByronUpdateProposal
- toByronLedgerUpdateProposal ∷ ByronUpdateProposal → GenTx ByronBlock
- makeProtocolParametersUpdate ∷ ByronProtocolParametersUpdate → ProtocolParametersUpdate
- newtype ByronVote = ByronVote {
- unByronVote ∷ AVote ByteString
- makeByronVote ∷ NetworkId → SomeByronSigningKey → ByronUpdateProposal → Bool → ByronVote
- toByronLedgertoByronVote ∷ ByronVote → GenTx ByronBlock
- fromByronTxIn ∷ TxIn → TxIn
- toByronLovelace ∷ Lovelace → Maybe Lovelace
- toByronNetworkMagic ∷ NetworkId → NetworkMagic
- toByronProtocolMagicId ∷ NetworkId → ProtocolMagicId
- toByronRequiresNetworkMagic ∷ NetworkId → RequiresNetworkMagic
Documentation
module Cardano.Api
Cryptographic key interface
data SomeByronSigningKey Source #
Constructors
| AByronSigningKeyLegacy (SigningKey ByronKeyLegacy) | |
| AByronSigningKey (SigningKey ByronKey) |
Hashes
data family Hash keyrole ∷ Type Source #
Instances
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
Building transactions
Constructing and inspecting transactions
data TxBody era where Source #
Constructors
| ByronTxBody ∷ Annotated Tx ByteString → TxBody ByronEra |
Instances
| Show (TxBody era) Source # | |
| HasTypeProxy era ⇒ HasTypeProxy (TxBody era) Source # | |
| IsCardanoEra era ⇒ SerialiseAsCBOR (TxBody era) Source # | |
Defined in Cardano.Api.TxBody Methods serialiseToCBOR ∷ TxBody era → ByteString Source # deserialiseFromCBOR ∷ AsType (TxBody era) → ByteString → Either DecoderError (TxBody era) Source # | |
| IsCardanoEra era ⇒ HasTextEnvelope (TxBody era) Source # | |
Defined in Cardano.Api.TxBody Methods textEnvelopeType ∷ AsType (TxBody era) → TextEnvelopeType Source # textEnvelopeDefaultDescr ∷ TxBody era → TextEnvelopeDescr Source # | |
| Eq (TxBody era) Source # | |
| data AsType (TxBody era) Source # | |
Defined in Cardano.Api.TxBody | |
Constructors
| TxId (Hash StandardCrypto EraIndependentTxBody) |
Instances
| FromJSON TxId Source # | |
Defined in Cardano.Api.TxIn | |
| FromJSONKey TxId Source # | |
Defined in Cardano.Api.TxIn | |
| ToJSON TxId Source # | |
Defined in Cardano.Api.TxIn Methods toEncoding ∷ TxId → Encoding # toJSONList ∷ [TxId] → Value # toEncodingList ∷ [TxId] → Encoding # | |
| ToJSONKey TxId Source # | |
Defined in Cardano.Api.TxIn | |
| IsString TxId Source # | |
Defined in Cardano.Api.TxIn Methods fromString ∷ String → TxId Source # | |
| Show TxId Source # | |
| HasTypeProxy TxId Source # | |
| SerialiseAsRawBytes TxId Source # | |
Defined in Cardano.Api.TxIn | |
| Eq TxId Source # | |
| Ord TxId Source # | |
| data AsType TxId Source # | |
Defined in Cardano.Api.TxIn | |
Instances
| FromJSON TxIn Source # | |
Defined in Cardano.Api.TxIn | |
| FromJSONKey TxIn Source # | |
Defined in Cardano.Api.TxIn | |
| ToJSON TxIn Source # | |
Defined in Cardano.Api.TxIn Methods toEncoding ∷ TxIn → Encoding # toJSONList ∷ [TxIn] → Value # toEncodingList ∷ [TxIn] → Encoding # | |
| ToJSONKey TxIn Source # | |
Defined in Cardano.Api.TxIn | |
| Show TxIn Source # | |
| Eq TxIn Source # | |
| Ord TxIn Source # | |
Constructors
| TxOut (AddressInEra era) (TxOutValue era) (TxOutDatum ctx era) (ReferenceScript era) |
Instances
| EraCast (TxOut ctx) Source # | |
Defined in Cardano.Api.TxBody Methods eraCast ∷ (IsCardanoEra fromEra, IsCardanoEra toEra) ⇒ CardanoEra toEra → TxOut ctx fromEra → Either EraCastError (TxOut ctx toEra) Source # | |
| IsShelleyBasedEra era ⇒ FromJSON (TxOut CtxTx era) Source # | |
Defined in Cardano.Api.TxBody | |
| IsShelleyBasedEra era ⇒ FromJSON (TxOut CtxUTxO era) Source # | |
Defined in Cardano.Api.TxBody | |
| IsCardanoEra era ⇒ ToJSON (TxOut ctx era) Source # | |
Defined in Cardano.Api.TxBody Methods toJSON ∷ TxOut ctx era → Value # toEncoding ∷ TxOut ctx era → Encoding # toJSONList ∷ [TxOut ctx era] → Value # toEncodingList ∷ [TxOut ctx era] → Encoding # | |
| Show (TxOut ctx era) Source # | |
| Eq (TxOut ctx era) Source # | |
Instances
| FromJSON TxIx Source # | |
Defined in Cardano.Api.TxIn | |
| ToJSON TxIx Source # | |
Defined in Cardano.Api.TxIn Methods toEncoding ∷ TxIx → Encoding # toJSONList ∷ [TxIx] → Value # toEncodingList ∷ [TxIx] → Encoding # | |
| Enum TxIx Source # | |
Defined in Cardano.Api.TxIn | |
| Show TxIx Source # | |
| Eq TxIx Source # | |
| Ord TxIx Source # | |
Instances
Signing transactions
Creating transaction witnesses one by one, or all in one go.
Constructors
| ByronTx ∷ ATxAux ByteString → Tx ByronEra |
Instances
| Show (InAnyCardanoEra Tx) Source # | |
Defined in Cardano.Api.Tx | |
| Show (Tx era) Source # | |
| HasTypeProxy era ⇒ HasTypeProxy (Tx era) Source # | |
| IsCardanoEra era ⇒ SerialiseAsCBOR (Tx era) Source # | |
Defined in Cardano.Api.Tx Methods serialiseToCBOR ∷ Tx era → ByteString Source # deserialiseFromCBOR ∷ AsType (Tx era) → ByteString → Either DecoderError (Tx era) Source # | |
| IsCardanoEra era ⇒ HasTextEnvelope (Tx era) Source # | |
Defined in Cardano.Api.Tx Methods textEnvelopeType ∷ AsType (Tx era) → TextEnvelopeType Source # textEnvelopeDefaultDescr ∷ Tx era → TextEnvelopeDescr Source # | |
| Eq (InAnyCardanoEra Tx) Source # | |
Defined in Cardano.Api.Tx Methods (==) ∷ InAnyCardanoEra Tx → InAnyCardanoEra Tx → Bool Source # (/=) ∷ InAnyCardanoEra Tx → InAnyCardanoEra Tx → Bool Source # | |
| Eq (Tx era) Source # | |
| data AsType (Tx era) Source # | |
Defined in Cardano.Api.Tx | |
Incremental signing and separate witnesses
data KeyWitness era where Source #
Constructors
| ByronKeyWitness ∷ TxInWitness → KeyWitness ByronEra |
Instances
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 !(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
Constructors
| FileError FilePath e | |
| FileErrorTempFile | |
| FileIOError FilePath IOException | |
Low level protocol interaction with a Cardano node
data LocalNodeConnectInfo mode Source #
Constructors
| LocalNodeConnectInfo (ConsensusModeParams mode) NetworkId FilePath |
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.
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.
Constructors
| ByronMode ∷ ConsensusMode ByronMode |
Instances
| Show (ConsensusMode mode) Source # | |
Defined in Cardano.Api.Modes | |
data LocalNodeClientProtocols block point tip slot tx txid 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 ())) (Maybe (LocalTxMonitorClient txid tx slot m ())) |
Chain sync protocol
newtype ChainSyncClient header point tip (m ∷ Type → Type) a #
Constructors
| ChainSyncClient | |
Fields
| |
Local tx submission
newtype LocalTxSubmissionClient tx reject (m ∷ Type → Type) a #
Constructors
| LocalTxSubmissionClient (m (LocalTxClientStIdle tx reject m a)) |
Local state query
newtype LocalStateQueryClient block point (query ∷ Type → Type) (m ∷ Type → Type) a #
Constructors
| LocalStateQueryClient | |
Fields
| |
Address
newtype NetworkMagic #
Constructors
| NetworkMagic | |
Fields | |
Instances
| Generic NetworkMagic | |
Defined in Ouroboros.Network.Magic Methods from ∷ NetworkMagic → Rep NetworkMagic x Source # to ∷ Rep NetworkMagic x → NetworkMagic Source # | |
| Show NetworkMagic | |
Defined in Ouroboros.Network.Magic | |
| Eq NetworkMagic | |
Defined in Ouroboros.Network.Magic Methods (==) ∷ NetworkMagic → NetworkMagic → Bool Source # (/=) ∷ NetworkMagic → NetworkMagic → Bool Source # | |
| NoThunks NetworkMagic | |
Defined in Ouroboros.Network.Magic Methods noThunks ∷ Context → NetworkMagic → IO (Maybe ThunkInfo) wNoThunks ∷ Context → NetworkMagic → IO (Maybe ThunkInfo) | |
| type Rep NetworkMagic | |
Defined in Ouroboros.Network.Magic type Rep NetworkMagic = D1 ('MetaData "NetworkMagic" "Ouroboros.Network.Magic" "ouroboros-network-api-0.1.0.0-f4cf9f0dbeeecfd1786121d607cf281b32f27fbab6212805d213af94979e6631" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32))) | |
Update Proposal
newtype ByronUpdateProposal Source #
Byron era update proposal
Constructors
| ByronUpdateProposal | |
Fields
| |
Instances
| Show ByronUpdateProposal Source # | |
Defined in Cardano.Api.SpecialByron | |
| HasTypeProxy ByronUpdateProposal Source # | |
Defined in Cardano.Api.SpecialByron Associated Types data AsType ByronUpdateProposal Source # | |
| SerialiseAsRawBytes ByronUpdateProposal Source # | |
| Eq ByronUpdateProposal Source # | |
Defined in Cardano.Api.SpecialByron Methods (==) ∷ ByronUpdateProposal → ByronUpdateProposal → Bool Source # (/=) ∷ ByronUpdateProposal → ByronUpdateProposal → Bool Source # | |
| data AsType ByronUpdateProposal Source # | |
Defined in Cardano.Api.SpecialByron | |
data ByronProtocolParametersUpdate Source #
Constructors
| ByronProtocolParametersUpdate | |
Fields
| |
Instances
makeByronUpdateProposal ∷ NetworkId → ProtocolVersion → SoftwareVersion → SystemTag → InstallerHash → SomeByronSigningKey → ByronProtocolParametersUpdate → ByronUpdateProposal Source #
toByronLedgerUpdateProposal ∷ ByronUpdateProposal → GenTx ByronBlock Source #
makeProtocolParametersUpdate ∷ ByronProtocolParametersUpdate → ProtocolParametersUpdate Source #
Vote
Byron era votes
Constructors
| ByronVote | |
Fields
| |
toByronLedgertoByronVote ∷ ByronVote → GenTx ByronBlock Source #
Conversions
fromByronTxIn ∷ TxIn → TxIn Source #
toByronLovelace ∷ Lovelace → Maybe Lovelace Source #
toByronNetworkMagic ∷ NetworkId → NetworkMagic Source #
toByronProtocolMagicId ∷ NetworkId → ProtocolMagicId Source #
toByronRequiresNetworkMagic ∷ NetworkId → RequiresNetworkMagic Source #