Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Cardano.Block

Contents

Eras
Block
Headers
Generalised transactions
LedgerError
OtherEnvelopeError
TipInfo
Query
CodecConfig
BlockConfig
StorageConfig
ConsensusConfig
LedgerConfig
LedgerState
ChainDepState
EraMismatch

Synopsis

type CardanoEras c = ByronBlock ': CardanoShelleyEras c
type CardanoShelleyEras c = '[ShelleyBlock (TPraos c) (ShelleyEra c), ShelleyBlock (TPraos c) (AllegraEra c), ShelleyBlock (TPraos c) (MaryEra c), ShelleyBlock (TPraos c) (AlonzoEra c), ShelleyBlock (Praos c) (BabbageEra c), ShelleyBlock (Praos c) (ConwayEra c)]
module Ouroboros.Consensus.Shelley.Eras
type ShelleyBasedLedgerEras c = '[ShelleyEra c, AllegraEra c, MaryEra c, AlonzoEra c, BabbageEra c, ConwayEra c]
type CardanoBlock c = HardForkBlock (CardanoEras c)
data HardForkBlock (xs ∷ [Type]) where
- pattern BlockAllegra ∷ ShelleyBlock (TPraos c) (AllegraEra c) → CardanoBlock c
- pattern BlockAlonzo ∷ ShelleyBlock (TPraos c) (AlonzoEra c) → CardanoBlock c
- pattern BlockByron ∷ ByronBlock → CardanoBlock c
- pattern BlockMary ∷ ShelleyBlock (TPraos c) (MaryEra c) → CardanoBlock c
- pattern BlockShelley ∷ ShelleyBlock (TPraos c) (ShelleyEra c) → CardanoBlock c
- pattern BlockBabbage ∷ ShelleyBlock (Praos c) (BabbageEra c) → CardanoBlock c
- pattern BlockConway ∷ ShelleyBlock (Praos c) (ConwayEra c) → CardanoBlock c
type CardanoHeader c = Header (CardanoBlock c)
data family Header blk
type CardanoApplyTxErr c = HardForkApplyTxErr (CardanoEras c)
type CardanoGenTx c = GenTx (CardanoBlock c)
type CardanoGenTxId c = GenTxId (CardanoBlock c)
data family GenTx blk
data HardForkApplyTxErr (xs ∷ [Type]) where
- pattern ApplyTxErrAllegra ∷ ApplyTxErr (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoApplyTxErr c
- pattern ApplyTxErrAlonzo ∷ ApplyTxErr (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoApplyTxErr c
- pattern ApplyTxErrByron ∷ ApplyTxErr ByronBlock → CardanoApplyTxErr c
- pattern ApplyTxErrMary ∷ ApplyTxErr (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoApplyTxErr c
- pattern ApplyTxErrShelley ∷ ApplyTxErr (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoApplyTxErr c
- pattern ApplyTxErrWrongEra ∷ EraMismatch → CardanoApplyTxErr c
- pattern ApplyTxErrBabbage ∷ ApplyTxErr (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoApplyTxErr c
- pattern ApplyTxErrConway ∷ ApplyTxErr (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoApplyTxErr c
data family TxId tx
type CardanoLedgerError c = HardForkLedgerError (CardanoEras c)
data HardForkLedgerError (xs ∷ [Type]) where
- pattern LedgerErrorAllegra ∷ LedgerError (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoLedgerError c
- pattern LedgerErrorAlonzo ∷ LedgerError (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoLedgerError c
- pattern LedgerErrorByron ∷ LedgerError ByronBlock → CardanoLedgerError c
- pattern LedgerErrorMary ∷ LedgerError (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoLedgerError c
- pattern LedgerErrorShelley ∷ LedgerError (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoLedgerError c
- pattern LedgerErrorWrongEra ∷ EraMismatch → CardanoLedgerError c
- pattern LedgerErrorBabbage ∷ LedgerError (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoLedgerError c
- pattern LedgerErrorConway ∷ LedgerError (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoLedgerError c
type CardanoOtherHeaderEnvelopeError c = HardForkEnvelopeErr (CardanoEras c)
data HardForkEnvelopeErr (xs ∷ [Type]) where
- pattern OtherHeaderEnvelopeErrorAllegra ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoOtherHeaderEnvelopeError c
- pattern OtherHeaderEnvelopeErrorBabbage ∷ OtherHeaderEnvelopeError (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoOtherHeaderEnvelopeError c
- pattern OtherHeaderEnvelopeErrorConway ∷ OtherHeaderEnvelopeError (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoOtherHeaderEnvelopeError c
- pattern OtherHeaderEnvelopeErrorAlonzo ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoOtherHeaderEnvelopeError c
- pattern OtherHeaderEnvelopeErrorByron ∷ OtherHeaderEnvelopeError ByronBlock → CardanoOtherHeaderEnvelopeError c
- pattern OtherHeaderEnvelopeErrorMary ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoOtherHeaderEnvelopeError c
- pattern OtherHeaderEnvelopeErrorShelley ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoOtherHeaderEnvelopeError c
- pattern OtherHeaderEnvelopeErrorWrongEra ∷ EraMismatch → CardanoOtherHeaderEnvelopeError c
type CardanoTipInfo c = OneEraTipInfo (CardanoEras c)
data OneEraTipInfo (xs ∷ [Type]) where
- pattern TipInfoAllegra ∷ TipInfo (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoTipInfo c
- pattern TipInfoAlonzo ∷ TipInfo (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoTipInfo c
- pattern TipInfoByron ∷ TipInfo ByronBlock → CardanoTipInfo c
- pattern TipInfoBabbage ∷ TipInfo (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoTipInfo c
- pattern TipInfoConway ∷ TipInfo (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoTipInfo c
- pattern TipInfoMary ∷ TipInfo (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoTipInfo c
- pattern TipInfoShelley ∷ TipInfo (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoTipInfo c
data family BlockQuery blk ∷ Type → Type
type CardanoQuery c = BlockQuery (CardanoBlock c)
type CardanoQueryResult c = HardForkQueryResult (CardanoEras c)
data Either a b where
- pattern QueryResultSuccess ∷ result → CardanoQueryResult c result
- pattern QueryResultEraMismatch ∷ EraMismatch → CardanoQueryResult c result
type CardanoCodecConfig c = CodecConfig (CardanoBlock c)
data family CodecConfig blk
data family BlockConfig blk
type CardanoBlockConfig c = BlockConfig (CardanoBlock c)
type CardanoStorageConfig c = StorageConfig (CardanoBlock c)
data family StorageConfig blk
type CardanoConsensusConfig c = ConsensusConfig (HardForkProtocol (CardanoEras c))
data family ConsensusConfig p
type CardanoLedgerConfig c = HardForkLedgerConfig (CardanoEras c)
data HardForkLedgerConfig (xs ∷ [Type]) where
- pattern CardanoLedgerConfig ∷ PartialLedgerConfig ByronBlock → PartialLedgerConfig (ShelleyBlock (TPraos c) (ShelleyEra c)) → PartialLedgerConfig (ShelleyBlock (TPraos c) (AllegraEra c)) → PartialLedgerConfig (ShelleyBlock (TPraos c) (MaryEra c)) → PartialLedgerConfig (ShelleyBlock (TPraos c) (AlonzoEra c)) → PartialLedgerConfig (ShelleyBlock (Praos c) (BabbageEra c)) → PartialLedgerConfig (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoLedgerConfig c
type CardanoLedgerState c = LedgerState (CardanoBlock c)
data family LedgerState blk
type CardanoChainDepState c = HardForkChainDepState (CardanoEras c)
data HardForkState (f ∷ Type → Type) (xs ∷ [Type]) where
- pattern ChainDepStateAllegra ∷ ChainDepState (BlockProtocol (ShelleyBlock (TPraos c) (AllegraEra c))) → CardanoChainDepState c
- pattern ChainDepStateAlonzo ∷ ChainDepState (BlockProtocol (ShelleyBlock (TPraos c) (AlonzoEra c))) → CardanoChainDepState c
- pattern ChainDepStateBabbage ∷ ChainDepState (BlockProtocol (ShelleyBlock (Praos c) (BabbageEra c))) → CardanoChainDepState c
- pattern ChainDepStateConway ∷ ChainDepState (BlockProtocol (ShelleyBlock (Praos c) (ConwayEra c))) → CardanoChainDepState c
- pattern ChainDepStateByron ∷ ChainDepState (BlockProtocol ByronBlock) → CardanoChainDepState c
- pattern ChainDepStateMary ∷ ChainDepState (BlockProtocol (ShelleyBlock (TPraos c) (MaryEra c))) → CardanoChainDepState c
- pattern ChainDepStateShelley ∷ ChainDepState (BlockProtocol (ShelleyBlock (TPraos c) (ShelleyEra c))) → CardanoChainDepState c
data EraMismatch = EraMismatch {
- ledgerEraName ∷ !Text
- otherEraName ∷ !Text
}

Eras

type CardanoEras c = ByronBlock ': CardanoShelleyEras c Source #

The eras in the Cardano blockchain.

We parameterise over the crypto used in the post-Byron eras: c.

TODO: parameterise ByronBlock over crypto too

type CardanoShelleyEras c = '[ShelleyBlock (TPraos c) (ShelleyEra c), ShelleyBlock (TPraos c) (AllegraEra c), ShelleyBlock (TPraos c) (MaryEra c), ShelleyBlock (TPraos c) (AlonzoEra c), ShelleyBlock (Praos c) (BabbageEra c), ShelleyBlock (Praos c) (ConwayEra c)] Source #

module Ouroboros.Consensus.Shelley.Eras

type ShelleyBasedLedgerEras c = '[ShelleyEra c, AllegraEra c, MaryEra c, AlonzoEra c, BabbageEra c, ConwayEra c] Source #

Block

type CardanoBlock c = HardForkBlock (CardanoEras c) Source #

The Cardano block.

Thanks to the pattern synonyms, you can treat this as a sum type with constructors BlockByron, BlockShelley, etc.

f :: CardanoBlock c -> _
f (BlockByron   b) = _
f (BlockShelley s) = _
f (BlockAllegra a) = _
f (BlockMary    m) = _
f (BlockAlonzo  m) = _

data HardForkBlock (xs ∷ [Type]) where Source #

Bundled Patterns

pattern BlockAllegra ∷ ShelleyBlock (TPraos c) (AllegraEra c) → CardanoBlock c
pattern BlockAlonzo ∷ ShelleyBlock (TPraos c) (AlonzoEra c) → CardanoBlock c
pattern BlockByron ∷ ByronBlock → CardanoBlock c
pattern BlockMary ∷ ShelleyBlock (TPraos c) (MaryEra c) → CardanoBlock c
pattern BlockShelley ∷ ShelleyBlock (TPraos c) (ShelleyEra c) → CardanoBlock c
pattern BlockBabbage ∷ ShelleyBlock (Praos c) (BabbageEra c) → CardanoBlock c
pattern BlockConway ∷ ShelleyBlock (Praos c) (ConwayEra c) → CardanoBlock c

Instances

Instances details

SupportedNetworkProtocolVersion ByronBlockHFC Source #	Forward to the ByronBlock instance. Only supports `HardForkNodeToNodeDisabled`, which is compatible with nodes running with `ByronBlock`.
Instance details Defined in Ouroboros.Consensus.Cardano.ByronHFC Methods supportedNodeToNodeVersions ∷ Proxy ByronBlockHFC → Map NodeToNodeVersion (BlockNodeToNodeVersion ByronBlockHFC) Source # supportedNodeToClientVersions ∷ Proxy ByronBlockHFC → Map NodeToClientVersion (BlockNodeToClientVersion ByronBlockHFC) Source # latestReleasedNodeVersion ∷ Proxy ByronBlockHFC → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion) Source #
Typeable xs ⇒ ShowProxy (HardForkBlock xs ∷ Type)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods showProxy ∷ Proxy (HardForkBlock xs) → String Source #
CanHardFork xs ⇒ Show (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods showsPrec ∷ Int → HardForkBlock xs → ShowS # show ∷ HardForkBlock xs → String # showList ∷ [HardForkBlock xs] → ShowS #
CanHardFork xs ⇒ Show (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods showsPrec ∷ Int → LedgerState (HardForkBlock xs) → ShowS # show ∷ LedgerState (HardForkBlock xs) → String # showList ∷ [LedgerState (HardForkBlock xs)] → ShowS #
CanHardFork xs ⇒ Eq (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods (==) ∷ LedgerState (HardForkBlock xs) → LedgerState (HardForkBlock xs) → Bool # (/=) ∷ LedgerState (HardForkBlock xs) → LedgerState (HardForkBlock xs) → Bool #
CanHardFork xs ⇒ NoThunks (BlockConfig (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods noThunks ∷ Context → BlockConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → BlockConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (BlockConfig (HardForkBlock xs)) → String Source #
CanHardFork xs ⇒ NoThunks (CodecConfig (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods noThunks ∷ Context → CodecConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → CodecConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (CodecConfig (HardForkBlock xs)) → String Source #
CanHardFork xs ⇒ NoThunks (StorageConfig (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods noThunks ∷ Context → StorageConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → StorageConfig (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (StorageConfig (HardForkBlock xs)) → String Source #
CanHardFork xs ⇒ NoThunks (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods noThunks ∷ Context → LedgerState (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → LedgerState (HardForkBlock xs) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (LedgerState (HardForkBlock xs)) → String Source #
CardanoHardForkConstraints c ⇒ CondenseConstraints (CardanoBlock c) Source #
Instance details Defined in Ouroboros.Consensus.Cardano.Condense
CardanoHardForkConstraints c ⇒ SupportedNetworkProtocolVersion (CardanoBlock c) Source #
Instance details Defined in Ouroboros.Consensus.Cardano.Node Methods supportedNodeToNodeVersions ∷ Proxy (CardanoBlock c) → Map NodeToNodeVersion (BlockNodeToNodeVersion (CardanoBlock c)) Source # supportedNodeToClientVersions ∷ Proxy (CardanoBlock c) → Map NodeToClientVersion (BlockNodeToClientVersion (CardanoBlock c)) Source # latestReleasedNodeVersion ∷ Proxy (CardanoBlock c) → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion) Source #
(ShelleyCompatible proto era, LedgerSupportsProtocol (ShelleyBlock proto era), TxLimits (ShelleyBlock proto era)) ⇒ SupportedNetworkProtocolVersion (ShelleyBlockHFC proto era) Source #	Forward to the ShelleyBlock instance. Only supports `HardForkNodeToNodeDisabled`, which is compatible with nodes running with `ShelleyBlock`.
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC Methods supportedNodeToNodeVersions ∷ Proxy (ShelleyBlockHFC proto era) → Map NodeToNodeVersion (BlockNodeToNodeVersion (ShelleyBlockHFC proto era)) Source # supportedNodeToClientVersions ∷ Proxy (ShelleyBlockHFC proto era) → Map NodeToClientVersion (BlockNodeToClientVersion (ShelleyBlockHFC proto era)) Source # latestReleasedNodeVersion ∷ Proxy (ShelleyBlockHFC proto era) → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion) Source #
type HeaderHash (HardForkBlock xs ∷ Type)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics type HeaderHash (HardForkBlock xs ∷ Type) = OneEraHash xs
type Rep (Validated (GenTx (HardForkBlock xs)))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (Validated (GenTx (HardForkBlock xs))) = D1 ('MetaData "Validated" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'True) (C1 ('MetaCons "HardForkValidatedGenTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHardForkValidatedGenTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraValidatedGenTx xs))))
type Rep (GenTx (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (GenTx (HardForkBlock xs)) = D1 ('MetaData "GenTx" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'True) (C1 ('MetaCons "HardForkGenTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHardForkGenTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraGenTx xs))))
type Rep (TxId (GenTx (HardForkBlock xs)))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (TxId (GenTx (HardForkBlock xs))) = D1 ('MetaData "TxId" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'True) (C1 ('MetaCons "HardForkGenTxId" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHardForkGenTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraGenTxId xs))))
type Rep (Ticked (LedgerState (HardForkBlock xs)))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type Rep (Ticked (LedgerState (HardForkBlock xs))) = D1 ('MetaData "Ticked" "Ouroboros.Consensus.HardFork.Combinator.Ledger" "ouroboros-consensus-0.20.1.0-inplace" 'False) (C1 ('MetaCons "TickedHardForkLedgerState" 'PrefixI 'True) (S1 ('MetaSel ('Just "tickedHardForkLedgerStateTransition") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TransitionInfo) :*: S1 ('MetaSel ('Just "tickedHardForkLedgerStatePerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HardForkState (Ticked :.: LedgerState) xs))))
newtype BlockConfig (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics newtype BlockConfig (HardForkBlock xs) = HardForkBlockConfig { hardForkBlockConfigPerEra ∷ PerEraBlockConfig xs }
type BlockProtocol (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics type BlockProtocol (HardForkBlock xs) = HardForkProtocol xs
newtype CodecConfig (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics newtype CodecConfig (HardForkBlock xs) = HardForkCodecConfig { hardForkCodecConfigPerEra ∷ PerEraCodecConfig xs }
newtype Header (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Block newtype Header (HardForkBlock xs) = HardForkHeader { getHardForkHeader ∷ OneEraHeader xs }
newtype StorageConfig (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics newtype StorageConfig (HardForkBlock xs) = HardForkStorageConfig { hardForkStorageConfigPerEra ∷ PerEraStorageConfig xs }
type CannotForge (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Forging type CannotForge (HardForkBlock xs) = HardForkCannotForge xs
type ForgeStateInfo (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Forging type ForgeStateInfo (HardForkBlock xs) = HardForkForgeStateInfo xs
type ForgeStateUpdateError (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Forging type ForgeStateUpdateError (HardForkBlock xs) = HardForkForgeStateUpdateError xs
data NestedCtxt_ (HardForkBlock xs) a b
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Block data NestedCtxt_ (HardForkBlock xs) a b where NCZ ∷ ∀ x (a ∷ Type → Type) b (xs1 ∷ [Type]). !(NestedCtxt_ x a b) → NestedCtxt_ (HardForkBlock (x ': xs1)) a b NCS ∷ ∀ (xs1 ∷ [Type]) (a ∷ Type → Type) b x. !(NestedCtxt_ (HardForkBlock xs1) a b) → NestedCtxt_ (HardForkBlock (x ': xs1)) a b
type TentativeHeaderState (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Node.DiffusionPipelining type TentativeHeaderState (HardForkBlock xs) = OneEraTentativeHeaderState xs
type TentativeHeaderView (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Node.DiffusionPipelining type TentativeHeaderView (HardForkBlock xs) = OneEraTentativeHeaderView xs
type HardForkIndices (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type HardForkIndices (HardForkBlock xs) = xs
type OtherHeaderEnvelopeError (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type OtherHeaderEnvelopeError (HardForkBlock xs) = HardForkEnvelopeErr xs
type TipInfo (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Block type TipInfo (HardForkBlock xs) = OneEraTipInfo xs
newtype Validated (GenTx (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool newtype Validated (GenTx (HardForkBlock xs)) = HardForkValidatedGenTx { getHardForkValidatedGenTx ∷ OneEraValidatedGenTx xs }
type AuxLedgerEvent (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type AuxLedgerEvent (LedgerState (HardForkBlock xs)) = OneEraLedgerEvent xs
type LedgerCfg (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics type LedgerCfg (LedgerState (HardForkBlock xs)) = HardForkLedgerConfig xs
type LedgerErr (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type LedgerErr (LedgerState (HardForkBlock xs)) = HardForkLedgerError xs
newtype LedgerState (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics newtype LedgerState (HardForkBlock xs) = HardForkLedgerState { hardForkLedgerStatePerEra ∷ HardForkState LedgerState xs }
type LedgerUpdate (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type LedgerUpdate (HardForkBlock xs) = HardForkLedgerUpdate xs
type LedgerWarning (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type LedgerWarning (HardForkBlock xs) = HardForkLedgerWarning xs
data BlockQuery (HardForkBlock xs) a
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query data BlockQuery (HardForkBlock xs) a where QueryIfCurrent ∷ ∀ (xs ∷ [Type]) result. QueryIfCurrent xs result → BlockQuery (HardForkBlock xs) (Either (MismatchEraInfo xs) result) QueryAnytime ∷ ∀ (xs1 ∷ [Type]) a x. IsNonEmpty xs1 ⇒ QueryAnytime a → EraIndex (x ': xs1) → BlockQuery (HardForkBlock (x ': xs1)) a QueryHardFork ∷ ∀ (xs1 ∷ [Type]) x a. IsNonEmpty xs1 ⇒ QueryHardFork (x ': xs1) a → BlockQuery (HardForkBlock (x ': xs1)) a
type ApplyTxErr (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type ApplyTxErr (HardForkBlock xs) = HardForkApplyTxErr xs
newtype GenTx (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool newtype GenTx (HardForkBlock xs) = HardForkGenTx { getHardForkGenTx ∷ OneEraGenTx xs }
newtype TxId (GenTx (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool newtype TxId (GenTx (HardForkBlock xs)) = HardForkGenTxId { getHardForkGenTxId ∷ OneEraGenTxId xs }
type TxMeasure (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type TxMeasure (HardForkBlock xs) = HardForkTxMeasure xs
type BlockNodeToClientVersion (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common type BlockNodeToClientVersion (HardForkBlock xs) = HardForkNodeToClientVersion xs
type BlockNodeToNodeVersion (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.Common type BlockNodeToNodeVersion (HardForkBlock xs) = HardForkNodeToNodeVersion xs
data Ticked (LedgerState (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger data Ticked (LedgerState (HardForkBlock xs)) = TickedHardForkLedgerState { tickedHardForkLedgerStateTransition ∷ !TransitionInfo tickedHardForkLedgerStatePerEra ∷ !(HardForkState (Ticked :.: LedgerState) xs) }

Headers

type CardanoHeader c = Header (CardanoBlock c) Source #

The Cardano header.

data family Header blk Source #

Instances

Generalised transactions

type CardanoApplyTxErr c = HardForkApplyTxErr (CardanoEras c) Source #

An error resulting from applying a CardanoGenTx to the ledger.

Thanks to the pattern synonyms, you can treat this as a sum type with constructors ApplyTxByronErr, ApplyTxErrShelley, and ApplyTxErrWrongEra.

toText :: CardanoApplyTxErr c -> Text
toText (ApplyTxErrByron b) = byronApplyTxErrToText b
toText (ApplyTxErrShelley s) = shelleyApplyTxErrToText s
toText (ApplyTxErrAllegra a) = allegraApplyTxErrToText a
toText (ApplyTxErrMary m) = maryApplyTxErrToText m
toText (ApplyTxErrWrongEra eraMismatch) =
  "Transaction from the " <> otherEraName eraMismatch <>
  " era applied to a ledger from the " <>
  ledgerEraName eraMismatch <> " era"

type CardanoGenTx c = GenTx (CardanoBlock c) Source #

The Cardano transaction.

type CardanoGenTxId c = GenTxId (CardanoBlock c) Source #

The ID of a Cardano transaction.

data family GenTx blk Source #

Generalized transaction

The mempool (and, accordingly, blocks) consist of "generalized transactions"; this could be "proper" transactions (transferring funds) but also other kinds of things such as update proposals, delegations, etc.

Instances

Instances details

Inject GenTx
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Nary Methods inject ∷ ∀ x (xs ∷ [Type]). CanHardFork xs ⇒ Exactly xs Bound → Index xs x → GenTx x → GenTx (HardForkBlock xs) Source #
SerialiseNodeToClient ByronBlock (GenTx ByronBlock) Source #	No CBOR-in-CBOR, because we check for canonical encodings, which means we can use the recomputed encoding for the annotation.
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → GenTx ByronBlock → Encoding Source # decodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → ∀ s. Decoder s (GenTx ByronBlock) Source #
SerialiseNodeToClient ByronBlock (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → GenTxId ByronBlock → Encoding Source # decodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → ∀ s. Decoder s (GenTxId ByronBlock) Source #
SerialiseNodeToNode ByronBlock (GenTx ByronBlock) Source #	No CBOR-in-CBOR, because we check for canonical encodings, which means we can use the recomputed encoding for the annotation.
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → GenTx ByronBlock → Encoding Source # decodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → ∀ s. Decoder s (GenTx ByronBlock) Source #
SerialiseNodeToNode ByronBlock (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → GenTxId ByronBlock → Encoding Source # decodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → ∀ s. Decoder s (GenTxId ByronBlock) Source #
(Typeable era, Typeable proto) ⇒ ShowProxy (Validated (GenTx (ShelleyBlock proto era)) ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showProxy ∷ Proxy (Validated (GenTx (ShelleyBlock proto era))) → String Source #
ShowProxy (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods showProxy ∷ Proxy (GenTx ByronBlock) → String Source #
(Typeable era, Typeable proto) ⇒ ShowProxy (GenTx (ShelleyBlock proto era) ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showProxy ∷ Proxy (GenTx (ShelleyBlock proto era)) → String Source #
ShowProxy (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods showProxy ∷ Proxy (TxId (GenTx ByronBlock)) → String Source #
(Typeable era, Typeable proto) ⇒ ShowProxy (TxId (GenTx (ShelleyBlock proto era)) ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showProxy ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → String Source #
(ShelleyBasedEra era, TranslateEra era WrapTx) ⇒ TranslateEra era (GenTx :.: ShelleyBlock proto) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC Associated Types type TranslationError era (GenTx :.: ShelleyBlock proto) Source # Methods translateEra ∷ TranslationContext era → (GenTx :.: ShelleyBlock proto) (PreviousEra era) → Except (TranslationError era (GenTx :.: ShelleyBlock proto)) ((GenTx :.: ShelleyBlock proto) era) Source #
Generic (Validated (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Associated Types type Rep (Validated (GenTx ByronBlock)) ∷ Type → Type # Methods from ∷ Validated (GenTx ByronBlock) → Rep (Validated (GenTx ByronBlock)) x # to ∷ Rep (Validated (GenTx ByronBlock)) x → Validated (GenTx ByronBlock) #
Generic (Validated (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Associated Types type Rep (Validated (GenTx (ShelleyBlock proto era))) ∷ Type → Type # Methods from ∷ Validated (GenTx (ShelleyBlock proto era)) → Rep (Validated (GenTx (ShelleyBlock proto era))) x # to ∷ Rep (Validated (GenTx (ShelleyBlock proto era))) x → Validated (GenTx (ShelleyBlock proto era)) #
Generic (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Associated Types type Rep (GenTx ByronBlock) ∷ Type → Type # Methods from ∷ GenTx ByronBlock → Rep (GenTx ByronBlock) x # to ∷ Rep (GenTx ByronBlock) x → GenTx ByronBlock #
Generic (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Associated Types type Rep (GenTx (ShelleyBlock proto era)) ∷ Type → Type # Methods from ∷ GenTx (ShelleyBlock proto era) → Rep (GenTx (ShelleyBlock proto era)) x # to ∷ Rep (GenTx (ShelleyBlock proto era)) x → GenTx (ShelleyBlock proto era) #
Show (Validated (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods showsPrec ∷ Int → Validated (GenTx ByronBlock) → ShowS # show ∷ Validated (GenTx ByronBlock) → String # showList ∷ [Validated (GenTx ByronBlock)] → ShowS #
ShelleyBasedEra era ⇒ Show (Validated (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showsPrec ∷ Int → Validated (GenTx (ShelleyBlock proto era)) → ShowS # show ∷ Validated (GenTx (ShelleyBlock proto era)) → String # showList ∷ [Validated (GenTx (ShelleyBlock proto era))] → ShowS #
Show (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods showsPrec ∷ Int → GenTx ByronBlock → ShowS # show ∷ GenTx ByronBlock → String # showList ∷ [GenTx ByronBlock] → ShowS #
ShelleyBasedEra era ⇒ Show (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showsPrec ∷ Int → GenTx (ShelleyBlock proto era) → ShowS # show ∷ GenTx (ShelleyBlock proto era) → String # showList ∷ [GenTx (ShelleyBlock proto era)] → ShowS #
Show (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods showsPrec ∷ Int → GenTxId ByronBlock → ShowS # show ∷ GenTxId ByronBlock → String # showList ∷ [GenTxId ByronBlock] → ShowS #
Show (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showsPrec ∷ Int → GenTxId (ShelleyBlock proto era) → ShowS # show ∷ GenTxId (ShelleyBlock proto era) → String # showList ∷ [GenTxId (ShelleyBlock proto era)] → ShowS #
ShelleyCompatible proto era ⇒ FromCBOR (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods fromCBOR ∷ Decoder s (GenTx (ShelleyBlock proto era)) Source # label ∷ Proxy (GenTx (ShelleyBlock proto era)) → Text Source #
ShelleyCompatible proto era ⇒ ToCBOR (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods toCBOR ∷ GenTx (ShelleyBlock proto era) → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (GenTx (ShelleyBlock proto era)) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [GenTx (ShelleyBlock proto era)] → Size Source #
(Crypto (EraCrypto era), Typeable era, Typeable proto) ⇒ DecCBOR (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods decCBOR ∷ Decoder s (TxId (GenTx (ShelleyBlock proto era))) Source # dropCBOR ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → Decoder s () Source # label ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → Text Source #
(Crypto (EraCrypto era), Typeable era, Typeable proto) ⇒ EncCBOR (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods encCBOR ∷ TxId (GenTx (ShelleyBlock proto era)) → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (TxId (GenTx (ShelleyBlock proto era))) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [TxId (GenTx (ShelleyBlock proto era))] → Size Source #
Eq (Validated (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods (==) ∷ Validated (GenTx ByronBlock) → Validated (GenTx ByronBlock) → Bool # (/=) ∷ Validated (GenTx ByronBlock) → Validated (GenTx ByronBlock) → Bool #
ShelleyBasedEra era ⇒ Eq (Validated (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods (==) ∷ Validated (GenTx (ShelleyBlock proto era)) → Validated (GenTx (ShelleyBlock proto era)) → Bool # (/=) ∷ Validated (GenTx (ShelleyBlock proto era)) → Validated (GenTx (ShelleyBlock proto era)) → Bool #
Eq (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods (==) ∷ GenTx ByronBlock → GenTx ByronBlock → Bool # (/=) ∷ GenTx ByronBlock → GenTx ByronBlock → Bool #
ShelleyBasedEra era ⇒ Eq (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods (==) ∷ GenTx (ShelleyBlock proto era) → GenTx (ShelleyBlock proto era) → Bool # (/=) ∷ GenTx (ShelleyBlock proto era) → GenTx (ShelleyBlock proto era) → Bool #
Eq (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods (==) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (/=) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool #
Eq (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods (==) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (/=) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool #
Ord (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods compare ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Ordering # (<) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (<=) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (>) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (>=) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # max ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) # min ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) #
Ord (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods compare ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Ordering # (<) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (<=) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (>) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (>=) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # max ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) # min ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) #
NoThunks (Validated (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods noThunks ∷ Context → Validated (GenTx ByronBlock) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Validated (GenTx ByronBlock) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Validated (GenTx ByronBlock)) → String Source #
ShelleyBasedEra era ⇒ NoThunks (Validated (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods noThunks ∷ Context → Validated (GenTx (ShelleyBlock proto era)) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Validated (GenTx (ShelleyBlock proto era)) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Validated (GenTx (ShelleyBlock proto era))) → String Source #
NoThunks (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods noThunks ∷ Context → GenTx ByronBlock → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → GenTx ByronBlock → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (GenTx ByronBlock) → String Source #
ShelleyBasedEra era ⇒ NoThunks (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods noThunks ∷ Context → GenTx (ShelleyBlock proto era) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → GenTx (ShelleyBlock proto era) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (GenTx (ShelleyBlock proto era)) → String Source #
NoThunks (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods noThunks ∷ Context → TxId (GenTx ByronBlock) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → TxId (GenTx ByronBlock) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (TxId (GenTx ByronBlock)) → String Source #
NoThunks (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods noThunks ∷ Context → TxId (GenTx (ShelleyBlock proto era)) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → TxId (GenTx (ShelleyBlock proto era)) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → String Source #
ConvertRawTxId (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods toRawTxIdHash ∷ TxId (GenTx ByronBlock) → ShortByteString Source #
ShelleyBasedEra era ⇒ ConvertRawTxId (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods toRawTxIdHash ∷ TxId (GenTx (ShelleyBlock proto era)) → ShortByteString Source #
HasTxId (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods txId ∷ GenTx ByronBlock → TxId (GenTx ByronBlock) Source #
ShelleyBasedEra era ⇒ HasTxId (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods txId ∷ GenTx (ShelleyBlock proto era) → TxId (GenTx (ShelleyBlock proto era)) Source #
Condense (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods condense ∷ GenTx ByronBlock → String Source #
ShelleyBasedEra era ⇒ Condense (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods condense ∷ GenTx (ShelleyBlock proto era) → String Source #
Condense (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods condense ∷ GenTxId ByronBlock → String Source #
Condense (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods condense ∷ GenTxId (ShelleyBlock proto era) → String Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToClient (ShelleyBlock proto era) (GenTx (ShelleyBlock proto era)) Source #	Uses CBOR-in-CBOR in the `To/FromCBOR` instances to get the annotation.
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → GenTx (ShelleyBlock proto era) → Encoding Source # decodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → ∀ s. Decoder s (GenTx (ShelleyBlock proto era)) Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToClient (ShelleyBlock proto era) (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → GenTxId (ShelleyBlock proto era) → Encoding Source # decodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → ∀ s. Decoder s (GenTxId (ShelleyBlock proto era)) Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToNode (ShelleyBlock proto era) (GenTx (ShelleyBlock proto era)) Source #	The `To/FromCBOR` instances defined in `cardano-ledger` use CBOR-in-CBOR to get the annotation.
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → GenTx (ShelleyBlock proto era) → Encoding Source # decodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → ∀ s. Decoder s (GenTx (ShelleyBlock proto era)) Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToNode (ShelleyBlock proto era) (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → GenTxId (ShelleyBlock proto era) → Encoding Source # decodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → ∀ s. Decoder s (GenTxId (ShelleyBlock proto era)) Source #
data GenTx ByronBlock Source #	Generalized transactions in Byron This is effectively the same as `AMempoolPayload` but we cache the transaction ID (a hash).
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool data GenTx ByronBlock = ByronTx !TxId !(ATxAux ByteString) \| ByronDlg !CertificateId !(ACertificate ByteString) \| ByronUpdateProposal !UpId !(AProposal ByteString) \| ByronUpdateVote !VoteId !(AVote ByteString)
type TranslationError era (GenTx :.: ShelleyBlock proto) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC type TranslationError era (GenTx :.: ShelleyBlock proto) = TranslationError era WrapTx
type Rep (Validated (GenTx (HardForkBlock xs)))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (Validated (GenTx (HardForkBlock xs))) = D1 ('MetaData "Validated" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'True) (C1 ('MetaCons "HardForkValidatedGenTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHardForkValidatedGenTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraValidatedGenTx xs))))
type Rep (Validated (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool type Rep (Validated (GenTx ByronBlock)) = D1 ('MetaData "Validated" "Ouroboros.Consensus.Byron.Ledger.Mempool" "ouroboros-consensus-cardano-0.19.0.0-inplace" 'True) (C1 ('MetaCons "ValidatedByronTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "forgetValidatedByronTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (GenTx ByronBlock))))
type Rep (Validated (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool type Rep (Validated (GenTx (ShelleyBlock proto era))) = D1 ('MetaData "Validated" "Ouroboros.Consensus.Shelley.Ledger.Mempool" "ouroboros-consensus-cardano-0.19.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyValidatedTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (TxId (EraCrypto era))) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Validated (Tx era)))))
type Rep (GenTx (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (GenTx (HardForkBlock xs)) = D1 ('MetaData "GenTx" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'True) (C1 ('MetaCons "HardForkGenTx" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHardForkGenTx") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraGenTx xs))))
type Rep (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool type Rep (GenTx ByronBlock) = D1 ('MetaData "GenTx" "Ouroboros.Consensus.Byron.Ledger.Mempool" "ouroboros-consensus-cardano-0.19.0.0-inplace" 'False) ((C1 ('MetaCons "ByronTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TxId) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ATxAux ByteString))) :+: C1 ('MetaCons "ByronDlg" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CertificateId) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ACertificate ByteString)))) :+: (C1 ('MetaCons "ByronUpdateProposal" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UpId) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AProposal ByteString))) :+: C1 ('MetaCons "ByronUpdateVote" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VoteId) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AVote ByteString)))))
type Rep (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool type Rep (GenTx (ShelleyBlock proto era)) = D1 ('MetaData "GenTx" "Ouroboros.Consensus.Shelley.Ledger.Mempool" "ouroboros-consensus-cardano-0.19.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyTx" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (TxId (EraCrypto era))) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Tx era))))
type Rep (TxId (GenTx (HardForkBlock xs)))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (TxId (GenTx (HardForkBlock xs))) = D1 ('MetaData "TxId" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'True) (C1 ('MetaCons "HardForkGenTxId" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHardForkGenTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraGenTxId xs))))
newtype Validated (GenTx (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool newtype Validated (GenTx (HardForkBlock xs)) = HardForkValidatedGenTx { getHardForkValidatedGenTx ∷ OneEraValidatedGenTx xs }
newtype Validated (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool newtype Validated (GenTx ByronBlock) = ValidatedByronTx { forgetValidatedByronTx ∷ GenTx ByronBlock }
data Validated (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool data Validated (GenTx (ShelleyBlock proto era)) = ShelleyValidatedTx !(TxId (EraCrypto era)) !(Validated (Tx era))
newtype GenTx (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool newtype GenTx (HardForkBlock xs) = HardForkGenTx { getHardForkGenTx ∷ OneEraGenTx xs }
newtype TxId (GenTx (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool newtype TxId (GenTx (HardForkBlock xs)) = HardForkGenTxId { getHardForkGenTxId ∷ OneEraGenTxId xs }
data TxId (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool data TxId (GenTx ByronBlock) = ByronTxId !TxId \| ByronDlgId !CertificateId \| ByronUpdateProposalId !UpId \| ByronUpdateVoteId !VoteId
newtype TxId (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool newtype TxId (GenTx (ShelleyBlock proto era)) = ShelleyTxId (TxId (EraCrypto era))
data GenTx (ShelleyBlock proto era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool data GenTx (ShelleyBlock proto era) = ShelleyTx !(TxId (EraCrypto era)) !(Tx era)

data HardForkApplyTxErr (xs ∷ [Type]) where Source #

Bundled Patterns

pattern ApplyTxErrAllegra ∷ ApplyTxErr (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoApplyTxErr c
pattern ApplyTxErrAlonzo ∷ ApplyTxErr (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoApplyTxErr c
pattern ApplyTxErrByron ∷ ApplyTxErr ByronBlock → CardanoApplyTxErr c
pattern ApplyTxErrMary ∷ ApplyTxErr (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoApplyTxErr c
pattern ApplyTxErrShelley ∷ ApplyTxErr (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoApplyTxErr c
pattern ApplyTxErrWrongEra ∷ EraMismatch → CardanoApplyTxErr c
pattern ApplyTxErrBabbage ∷ ApplyTxErr (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoApplyTxErr c
pattern ApplyTxErrConway ∷ ApplyTxErr (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoApplyTxErr c

Instances

Instances details

Typeable xs ⇒ ShowProxy (HardForkApplyTxErr xs ∷ Type)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool Methods showProxy ∷ Proxy (HardForkApplyTxErr xs) → String Source #
Generic (HardForkApplyTxErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool Associated Types type Rep (HardForkApplyTxErr xs) ∷ Type → Type # Methods from ∷ HardForkApplyTxErr xs → Rep (HardForkApplyTxErr xs) x # to ∷ Rep (HardForkApplyTxErr xs) x → HardForkApplyTxErr xs #
CanHardFork xs ⇒ Show (HardForkApplyTxErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool Methods showsPrec ∷ Int → HardForkApplyTxErr xs → ShowS # show ∷ HardForkApplyTxErr xs → String # showList ∷ [HardForkApplyTxErr xs] → ShowS #
CanHardFork xs ⇒ Eq (HardForkApplyTxErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool Methods (==) ∷ HardForkApplyTxErr xs → HardForkApplyTxErr xs → Bool # (/=) ∷ HardForkApplyTxErr xs → HardForkApplyTxErr xs → Bool #
type Rep (HardForkApplyTxErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (HardForkApplyTxErr xs) = D1 ('MetaData "HardForkApplyTxErr" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'False) (C1 ('MetaCons "HardForkApplyTxErrFromEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (OneEraApplyTxErr xs))) :+: C1 ('MetaCons "HardForkApplyTxErrWrongEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (MismatchEraInfo xs))))

data family TxId tx Source #

A generalized transaction, GenTx, identifier.

Instances

Instances details

SerialiseNodeToClient ByronBlock (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → GenTxId ByronBlock → Encoding Source # decodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → ∀ s. Decoder s (GenTxId ByronBlock) Source #
SerialiseNodeToNode ByronBlock (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → GenTxId ByronBlock → Encoding Source # decodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → ∀ s. Decoder s (GenTxId ByronBlock) Source #
ShowProxy (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods showProxy ∷ Proxy (TxId (GenTx ByronBlock)) → String Source #
(Typeable era, Typeable proto) ⇒ ShowProxy (TxId (GenTx (ShelleyBlock proto era)) ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showProxy ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → String Source #
Show (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods showsPrec ∷ Int → GenTxId ByronBlock → ShowS # show ∷ GenTxId ByronBlock → String # showList ∷ [GenTxId ByronBlock] → ShowS #
Show (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods showsPrec ∷ Int → GenTxId (ShelleyBlock proto era) → ShowS # show ∷ GenTxId (ShelleyBlock proto era) → String # showList ∷ [GenTxId (ShelleyBlock proto era)] → ShowS #
(Crypto (EraCrypto era), Typeable era, Typeable proto) ⇒ DecCBOR (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods decCBOR ∷ Decoder s (TxId (GenTx (ShelleyBlock proto era))) Source # dropCBOR ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → Decoder s () Source # label ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → Text Source #
(Crypto (EraCrypto era), Typeable era, Typeable proto) ⇒ EncCBOR (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods encCBOR ∷ TxId (GenTx (ShelleyBlock proto era)) → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (TxId (GenTx (ShelleyBlock proto era))) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [TxId (GenTx (ShelleyBlock proto era))] → Size Source #
Eq (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods (==) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (/=) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool #
Eq (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods (==) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (/=) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool #
Ord (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods compare ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Ordering # (<) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (<=) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (>) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # (>=) ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → Bool # max ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) # min ∷ TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) → TxId (GenTx ByronBlock) #
Ord (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods compare ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Ordering # (<) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (<=) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (>) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # (>=) ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → Bool # max ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) # min ∷ TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) → TxId (GenTx (ShelleyBlock proto era)) #
NoThunks (TxId (GenTx ByronBlock)) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods noThunks ∷ Context → TxId (GenTx ByronBlock) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → TxId (GenTx ByronBlock) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (TxId (GenTx ByronBlock)) → String Source #
NoThunks (TxId (GenTx (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods noThunks ∷ Context → TxId (GenTx (ShelleyBlock proto era)) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → TxId (GenTx (ShelleyBlock proto era)) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (TxId (GenTx (ShelleyBlock proto era))) → String Source #
Condense (GenTxId ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool Methods condense ∷ GenTxId ByronBlock → String Source #
Condense (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool Methods condense ∷ GenTxId (ShelleyBlock proto era) → String Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToClient (ShelleyBlock proto era) (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → GenTxId (ShelleyBlock proto era) → Encoding Source # decodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → ∀ s. Decoder s (GenTxId (ShelleyBlock proto era)) Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToNode (ShelleyBlock proto era) (GenTxId (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → GenTxId (ShelleyBlock proto era) → Encoding Source # decodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → ∀ s. Decoder s (GenTxId (ShelleyBlock proto era)) Source #
type Rep (TxId (GenTx (HardForkBlock xs)))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool type Rep (TxId (GenTx (HardForkBlock xs))) = D1 ('MetaData "TxId" "Ouroboros.Consensus.HardFork.Combinator.Mempool" "ouroboros-consensus-0.20.1.0-inplace" 'True) (C1 ('MetaCons "HardForkGenTxId" 'PrefixI 'True) (S1 ('MetaSel ('Just "getHardForkGenTxId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraGenTxId xs))))
newtype TxId (GenTx (HardForkBlock xs))
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Mempool newtype TxId (GenTx (HardForkBlock xs)) = HardForkGenTxId { getHardForkGenTxId ∷ OneEraGenTxId xs }
data TxId (GenTx ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Mempool data TxId (GenTx ByronBlock) = ByronTxId !TxId \| ByronDlgId !CertificateId \| ByronUpdateProposalId !UpId \| ByronUpdateVoteId !VoteId
newtype TxId (GenTx (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Mempool newtype TxId (GenTx (ShelleyBlock proto era)) = ShelleyTxId (TxId (EraCrypto era))

LedgerError

type CardanoLedgerError c = HardForkLedgerError (CardanoEras c) Source #

An error resulting from applying a CardanoBlock to the ledger.

Thanks to the pattern synonyms, you can treat this as a sum type with constructors LedgerErrorByron, LedgerErrorShelley, and LedgerErrorWrongEra.

toText :: CardanoLedgerError c -> Text
toText (LedgerErrorByron b) = byronLedgerErrorToText b
toText (LedgerErrorShelley s) = shelleyLedgerErrorToText s
toText (LedgerErrorAllegra a) = allegraLedgerErrorToText a
toText (LedgerErrorMary m) = maryLedgerErrorToText m
toText (LedgerErrorWrongEra eraMismatch) =
  "Block from the " <> otherEraName eraMismatch <>
  " era applied to a ledger from the " <>
  ledgerEraName eraMismatch <> " era"

data HardForkLedgerError (xs ∷ [Type]) where Source #

Bundled Patterns

pattern LedgerErrorAllegra ∷ LedgerError (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoLedgerError c
pattern LedgerErrorAlonzo ∷ LedgerError (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoLedgerError c
pattern LedgerErrorByron ∷ LedgerError ByronBlock → CardanoLedgerError c
pattern LedgerErrorMary ∷ LedgerError (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoLedgerError c
pattern LedgerErrorShelley ∷ LedgerError (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoLedgerError c
pattern LedgerErrorWrongEra ∷ EraMismatch → CardanoLedgerError c
pattern LedgerErrorBabbage ∷ LedgerError (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoLedgerError c
pattern LedgerErrorConway ∷ LedgerError (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoLedgerError c

Instances

Instances details

Generic (HardForkLedgerError xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Associated Types type Rep (HardForkLedgerError xs) ∷ Type → Type # Methods from ∷ HardForkLedgerError xs → Rep (HardForkLedgerError xs) x # to ∷ Rep (HardForkLedgerError xs) x → HardForkLedgerError xs #
CanHardFork xs ⇒ Show (HardForkLedgerError xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods showsPrec ∷ Int → HardForkLedgerError xs → ShowS # show ∷ HardForkLedgerError xs → String # showList ∷ [HardForkLedgerError xs] → ShowS #
CanHardFork xs ⇒ Eq (HardForkLedgerError xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods (==) ∷ HardForkLedgerError xs → HardForkLedgerError xs → Bool # (/=) ∷ HardForkLedgerError xs → HardForkLedgerError xs → Bool #
CanHardFork xs ⇒ NoThunks (HardForkLedgerError xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods noThunks ∷ Context → HardForkLedgerError xs → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → HardForkLedgerError xs → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (HardForkLedgerError xs) → String Source #
type Rep (HardForkLedgerError xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type Rep (HardForkLedgerError xs) = D1 ('MetaData "HardForkLedgerError" "Ouroboros.Consensus.HardFork.Combinator.Ledger" "ouroboros-consensus-0.20.1.0-inplace" 'False) (C1 ('MetaCons "HardForkLedgerErrorFromEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraLedgerError xs))) :+: C1 ('MetaCons "HardForkLedgerErrorWrongEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MismatchEraInfo xs))))

OtherEnvelopeError

type CardanoOtherHeaderEnvelopeError c = HardForkEnvelopeErr (CardanoEras c) Source #

An error resulting from validating a CardanoHeader.

data HardForkEnvelopeErr (xs ∷ [Type]) where Source #

Bundled Patterns

pattern OtherHeaderEnvelopeErrorAllegra ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoOtherHeaderEnvelopeError c
pattern OtherHeaderEnvelopeErrorBabbage ∷ OtherHeaderEnvelopeError (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoOtherHeaderEnvelopeError c
pattern OtherHeaderEnvelopeErrorConway ∷ OtherHeaderEnvelopeError (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoOtherHeaderEnvelopeError c
pattern OtherHeaderEnvelopeErrorAlonzo ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoOtherHeaderEnvelopeError c
pattern OtherHeaderEnvelopeErrorByron ∷ OtherHeaderEnvelopeError ByronBlock → CardanoOtherHeaderEnvelopeError c
pattern OtherHeaderEnvelopeErrorMary ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoOtherHeaderEnvelopeError c
pattern OtherHeaderEnvelopeErrorShelley ∷ OtherHeaderEnvelopeError (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoOtherHeaderEnvelopeError c
pattern OtherHeaderEnvelopeErrorWrongEra ∷ EraMismatch → CardanoOtherHeaderEnvelopeError c

Instances

Instances details

Generic (HardForkEnvelopeErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Associated Types type Rep (HardForkEnvelopeErr xs) ∷ Type → Type # Methods from ∷ HardForkEnvelopeErr xs → Rep (HardForkEnvelopeErr xs) x # to ∷ Rep (HardForkEnvelopeErr xs) x → HardForkEnvelopeErr xs #
CanHardFork xs ⇒ Show (HardForkEnvelopeErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods showsPrec ∷ Int → HardForkEnvelopeErr xs → ShowS # show ∷ HardForkEnvelopeErr xs → String # showList ∷ [HardForkEnvelopeErr xs] → ShowS #
CanHardFork xs ⇒ Eq (HardForkEnvelopeErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods (==) ∷ HardForkEnvelopeErr xs → HardForkEnvelopeErr xs → Bool # (/=) ∷ HardForkEnvelopeErr xs → HardForkEnvelopeErr xs → Bool #
CanHardFork xs ⇒ NoThunks (HardForkEnvelopeErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger Methods noThunks ∷ Context → HardForkEnvelopeErr xs → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → HardForkEnvelopeErr xs → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (HardForkEnvelopeErr xs) → String Source #
type Rep (HardForkEnvelopeErr xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger type Rep (HardForkEnvelopeErr xs) = D1 ('MetaData "HardForkEnvelopeErr" "Ouroboros.Consensus.HardFork.Combinator.Ledger" "ouroboros-consensus-0.20.1.0-inplace" 'False) (C1 ('MetaCons "HardForkEnvelopeErrFromEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OneEraEnvelopeErr xs))) :+: C1 ('MetaCons "HardForkEnvelopeErrWrongEra" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MismatchEraInfo xs))))

TipInfo

type CardanoTipInfo c = OneEraTipInfo (CardanoEras c) Source #

The TipInfo of the Cardano chain.

data OneEraTipInfo (xs ∷ [Type]) where Source #

Bundled Patterns

pattern TipInfoAllegra ∷ TipInfo (ShelleyBlock (TPraos c) (AllegraEra c)) → CardanoTipInfo c
pattern TipInfoAlonzo ∷ TipInfo (ShelleyBlock (TPraos c) (AlonzoEra c)) → CardanoTipInfo c
pattern TipInfoByron ∷ TipInfo ByronBlock → CardanoTipInfo c
pattern TipInfoBabbage ∷ TipInfo (ShelleyBlock (Praos c) (BabbageEra c)) → CardanoTipInfo c
pattern TipInfoConway ∷ TipInfo (ShelleyBlock (Praos c) (ConwayEra c)) → CardanoTipInfo c
pattern TipInfoMary ∷ TipInfo (ShelleyBlock (TPraos c) (MaryEra c)) → CardanoTipInfo c
pattern TipInfoShelley ∷ TipInfo (ShelleyBlock (TPraos c) (ShelleyEra c)) → CardanoTipInfo c

Instances

Instances details

CanHardFork xs ⇒ Show (OneEraTipInfo xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.AcrossEras Methods showsPrec ∷ Int → OneEraTipInfo xs → ShowS # show ∷ OneEraTipInfo xs → String # showList ∷ [OneEraTipInfo xs] → ShowS #
CanHardFork xs ⇒ Eq (OneEraTipInfo xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.AcrossEras Methods (==) ∷ OneEraTipInfo xs → OneEraTipInfo xs → Bool # (/=) ∷ OneEraTipInfo xs → OneEraTipInfo xs → Bool #
CanHardFork xs ⇒ NoThunks (OneEraTipInfo xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.AcrossEras Methods noThunks ∷ Context → OneEraTipInfo xs → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → OneEraTipInfo xs → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (OneEraTipInfo xs) → String Source #

Query

data family BlockQuery blk ∷ Type → Type Source #

Different queries supported by the ledger, indexed by the result type.

Instances

Instances details

SerialiseResult ByronBlock (BlockQuery ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeResult ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → BlockQuery ByronBlock result → result → Encoding Source # decodeResult ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → BlockQuery ByronBlock result → ∀ s. Decoder s result Source #
SerialiseNodeToClient ByronBlock (SomeSecond BlockQuery ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → SomeSecond BlockQuery ByronBlock → Encoding Source # decodeNodeToClient ∷ CodecConfig ByronBlock → BlockNodeToClientVersion ByronBlock → ∀ s. Decoder s (SomeSecond BlockQuery ByronBlock) Source #
SameDepIndex (BlockQuery ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger Methods sameDepIndex ∷ BlockQuery ByronBlock a → BlockQuery ByronBlock b → Maybe (a :~: b) Source #
SameDepIndex (BlockQuery (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Query Methods sameDepIndex ∷ BlockQuery (ShelleyBlock proto era) a → BlockQuery (ShelleyBlock proto era) b → Maybe (a :~: b) Source #
ShowQuery (BlockQuery ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger Methods showResult ∷ BlockQuery ByronBlock result → result → String Source #
ShelleyCompatible proto era ⇒ ShowQuery (BlockQuery (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Query Methods showResult ∷ BlockQuery (ShelleyBlock proto era) result → result → String Source #
Show (BlockQuery ByronBlock result) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger Methods showsPrec ∷ Int → BlockQuery ByronBlock result → ShowS # show ∷ BlockQuery ByronBlock result → String # showList ∷ [BlockQuery ByronBlock result] → ShowS #
Show (BlockQuery (ShelleyBlock proto era) result) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Query Methods showsPrec ∷ Int → BlockQuery (ShelleyBlock proto era) result → ShowS # show ∷ BlockQuery (ShelleyBlock proto era) result → String # showList ∷ [BlockQuery (ShelleyBlock proto era) result] → ShowS #
Eq (BlockQuery ByronBlock result) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger Methods (==) ∷ BlockQuery ByronBlock result → BlockQuery ByronBlock result → Bool # (/=) ∷ BlockQuery ByronBlock result → BlockQuery ByronBlock result → Bool #
Eq (BlockQuery (ShelleyBlock proto era) result) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Query Methods (==) ∷ BlockQuery (ShelleyBlock proto era) result → BlockQuery (ShelleyBlock proto era) result → Bool # (/=) ∷ BlockQuery (ShelleyBlock proto era) result → BlockQuery (ShelleyBlock proto era) result → Bool #
ShelleyCompatible proto era ⇒ SerialiseResult (ShelleyBlock proto era) (BlockQuery (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeResult ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → BlockQuery (ShelleyBlock proto era) result → result → Encoding Source # decodeResult ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → BlockQuery (ShelleyBlock proto era) result → ∀ s. Decoder s result Source #
ShowProxy (BlockQuery ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger Methods showProxy ∷ Proxy (BlockQuery ByronBlock) → String Source #
(Typeable era, Typeable proto) ⇒ ShowProxy (BlockQuery (ShelleyBlock proto era) ∷ Type → Type) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Query Methods showProxy ∷ Proxy (BlockQuery (ShelleyBlock proto era)) → String Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToClient (ShelleyBlock proto era) (SomeSecond BlockQuery (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → SomeSecond BlockQuery (ShelleyBlock proto era) → Encoding Source # decodeNodeToClient ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToClientVersion (ShelleyBlock proto era) → ∀ s. Decoder s (SomeSecond BlockQuery (ShelleyBlock proto era)) Source #
Inject (SomeSecond BlockQuery)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Nary Methods inject ∷ ∀ x (xs ∷ [Type]). CanHardFork xs ⇒ Exactly xs Bound → Index xs x → SomeSecond BlockQuery x → SomeSecond BlockQuery (HardForkBlock xs) Source #
(∀ result. Show (BlockQuery blk result)) ⇒ Show (SomeSecond BlockQuery blk)
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods showsPrec ∷ Int → SomeSecond BlockQuery blk → ShowS # show ∷ SomeSecond BlockQuery blk → String # showList ∷ [SomeSecond BlockQuery blk] → ShowS #
SameDepIndex (BlockQuery blk) ⇒ Eq (SomeSecond BlockQuery blk)
Instance details Defined in Ouroboros.Consensus.Ledger.Query Methods (==) ∷ SomeSecond BlockQuery blk → SomeSecond BlockQuery blk → Bool # (/=) ∷ SomeSecond BlockQuery blk → SomeSecond BlockQuery blk → Bool #
data BlockQuery ByronBlock a Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Ledger data BlockQuery ByronBlock a where GetUpdateInterfaceState ∷ BlockQuery ByronBlock State
data BlockQuery (HardForkBlock xs) a
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Ledger.Query data BlockQuery (HardForkBlock xs) a where QueryIfCurrent ∷ ∀ (xs ∷ [Type]) result. QueryIfCurrent xs result → BlockQuery (HardForkBlock xs) (Either (MismatchEraInfo xs) result) QueryAnytime ∷ ∀ (xs1 ∷ [Type]) a x. IsNonEmpty xs1 ⇒ QueryAnytime a → EraIndex (x ': xs1) → BlockQuery (HardForkBlock (x ': xs1)) a QueryHardFork ∷ ∀ (xs1 ∷ [Type]) x a. IsNonEmpty xs1 ⇒ QueryHardFork (x ': xs1) a → BlockQuery (HardForkBlock (x ': xs1)) a
data BlockQuery (ShelleyBlock proto era) a Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Query data BlockQuery (ShelleyBlock proto era) a where GetLedgerTip ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (Point (ShelleyBlock proto era)) GetEpochNo ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) EpochNo GetNonMyopicMemberRewards ∷ ∀ era proto. Set (Either Coin (Credential 'Staking (EraCrypto era))) → BlockQuery (ShelleyBlock proto era) (NonMyopicMemberRewards (EraCrypto era)) GetCurrentPParams ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (PParams era) GetProposedPParamsUpdates ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (ProposedPPUpdates era) GetStakeDistribution ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (PoolDistr (EraCrypto era)) GetUTxOByAddress ∷ ∀ era proto. Set (Addr (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (UTxO era) GetUTxOWhole ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (UTxO era) DebugEpochState ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (EpochState era) GetCBOR ∷ ∀ proto era result. BlockQuery (ShelleyBlock proto era) result → BlockQuery (ShelleyBlock proto era) (Serialised result) GetFilteredDelegationsAndRewardAccounts ∷ ∀ era proto. Set (Credential 'Staking (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Delegations (EraCrypto era), RewardAccounts (EraCrypto era)) GetGenesisConfig ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (CompactGenesis (EraCrypto era)) DebugNewEpochState ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (NewEpochState era) DebugChainDepState ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (ChainDepState proto) GetRewardProvenance ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (RewardProvenance (EraCrypto era)) GetUTxOByTxIn ∷ ∀ era proto. Set (TxIn (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (UTxO era) GetStakePools ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (Set (KeyHash 'StakePool (EraCrypto era))) GetStakePoolParams ∷ ∀ era proto. Set (KeyHash 'StakePool (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Map (KeyHash 'StakePool (EraCrypto era)) (PoolParams (EraCrypto era))) GetRewardInfoPools ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (RewardParams, Map (KeyHash 'StakePool (EraCrypto era)) RewardInfoPool) GetPoolState ∷ ∀ era proto. Maybe (Set (KeyHash 'StakePool (EraCrypto era))) → BlockQuery (ShelleyBlock proto era) (PState era) GetStakeSnapshots ∷ ∀ era proto. Maybe (Set (KeyHash 'StakePool (EraCrypto era))) → BlockQuery (ShelleyBlock proto era) (StakeSnapshots (EraCrypto era)) GetPoolDistr ∷ ∀ era proto. Maybe (Set (KeyHash 'StakePool (EraCrypto era))) → BlockQuery (ShelleyBlock proto era) (PoolDistr (EraCrypto era)) GetStakeDelegDeposits ∷ ∀ era proto. Set (StakeCredential (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Map (StakeCredential (EraCrypto era)) Coin) GetConstitution ∷ ∀ era proto. ConwayEraGov era ⇒ BlockQuery (ShelleyBlock proto era) (Constitution era) GetGovState ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) (GovState era) GetDRepState ∷ ∀ era proto. ConwayEraGov era ⇒ Set (Credential 'DRepRole (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Map (Credential 'DRepRole (EraCrypto era)) (DRepState (EraCrypto era))) GetDRepStakeDistr ∷ ∀ era proto. ConwayEraGov era ⇒ Set (DRep (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Map (DRep (EraCrypto era)) Coin) GetCommitteeMembersState ∷ ∀ era proto. ConwayEraGov era ⇒ Set (Credential 'ColdCommitteeRole (EraCrypto era)) → Set (Credential 'HotCommitteeRole (EraCrypto era)) → Set MemberStatus → BlockQuery (ShelleyBlock proto era) (CommitteeMembersState (EraCrypto era)) GetFilteredVoteDelegatees ∷ ∀ era proto. ConwayEraGov era ⇒ Set (Credential 'Staking (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Map (Credential 'Staking (EraCrypto era)) (DRep (EraCrypto era))) GetAccountState ∷ ∀ proto era. BlockQuery (ShelleyBlock proto era) AccountState GetSPOStakeDistr ∷ ∀ era proto. ConwayEraGov era ⇒ Set (KeyHash 'StakePool (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Map (KeyHash 'StakePool (EraCrypto era)) Coin) GetProposals ∷ ∀ era proto. ConwayEraGov era ⇒ Set (GovActionId (EraCrypto era)) → BlockQuery (ShelleyBlock proto era) (Seq (GovActionState era)) GetRatifyState ∷ ∀ era proto. ConwayEraGov era ⇒ BlockQuery (ShelleyBlock proto era) (RatifyState era)

type CardanoQuery c = BlockQuery (CardanoBlock c) Source #

The Query of Cardano chain.

type CardanoQueryResult c = HardForkQueryResult (CardanoEras c) Source #

The result of a CardanoQuery

Thanks to the pattern synonyms, you can treat this as a sum type with constructors QueryResultSuccess and QueryResultEraMismatch.

data Either a b where #

The Either type represents values with two possibilities: a value of type Either a b is either Left a or Right b.

The Either type is sometimes used to represent a value which is either correct or an error; by convention, the Left constructor is used to hold an error value and the Right constructor is used to hold a correct value (mnemonic: "right" also means "correct").

Examples

Expand

The type Either String Int is the type of values which can be either a String or an Int. The Left constructor can be used only on Strings, and the Right constructor can be used only on Ints:

>>> let s = Left "foo" :: Either String Int
>>> s
Left "foo"
>>> let n = Right 3 :: Either String Int
>>> n
Right 3
>>> :type s
s :: Either String Int
>>> :type n
n :: Either String Int

The fmap from our Functor instance will ignore Left values, but will apply the supplied function to values contained in a Right:

>>> let s = Left "foo" :: Either String Int
>>> let n = Right 3 :: Either String Int
>>> fmap (*2) s
Left "foo"
>>> fmap (*2) n
Right 6

The Monad instance for Either allows us to chain together multiple actions which may fail, and fail overall if any of the individual steps failed. First we'll write a function that can either parse an Int from a Char, or fail.

>>> import Data.Char ( digitToInt, isDigit )
>>> :{
    let parseEither :: Char -> Either String Int
        parseEither c
          | isDigit c = Right (digitToInt c)
          | otherwise = Left "parse error"
>>> :}

The following should work, since both '1' and '2' can be parsed as Ints.

>>> :{
    let parseMultiple :: Either String Int
        parseMultiple = do
          x <- parseEither '1'
          y <- parseEither '2'
          return (x + y)
>>> :}

>>> parseMultiple
Right 3

But the following should fail overall, since the first operation where we attempt to parse 'm' as an Int will fail:

>>> :{
    let parseMultiple :: Either String Int
        parseMultiple = do
          x <- parseEither 'm'
          y <- parseEither '2'
          return (x + y)
>>> :}

>>> parseMultiple
Left "parse error"

Bundled Patterns

pattern QueryResultSuccess ∷ result → CardanoQueryResult c result
pattern QueryResultEraMismatch ∷ EraMismatch → CardanoQueryResult c result	A query from a different era than the ledger's era was sent.

Instances

Instances details

FromJSON2 Either
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON2 ∷ Maybe a → (Value → Parser a) → (Value → Parser [a]) → Maybe b → (Value → Parser b) → (Value → Parser [b]) → Value → Parser (Either a b) Source # liftParseJSONList2 ∷ Maybe a → (Value → Parser a) → (Value → Parser [a]) → Maybe b → (Value → Parser b) → (Value → Parser [b]) → Value → Parser [Either a b] Source # liftOmittedField2 ∷ Maybe a → Maybe b → Maybe (Either a b) Source #
ToJSON2 Either
Instance details Defined in Data.Aeson.Types.ToJSON Methods liftToJSON2 ∷ (a → Bool) → (a → Value) → ([a] → Value) → (b → Bool) → (b → Value) → ([b] → Value) → Either a b → Value Source # liftToJSONList2 ∷ (a → Bool) → (a → Value) → ([a] → Value) → (b → Bool) → (b → Value) → ([b] → Value) → [Either a b] → Value Source # liftToEncoding2 ∷ (a → Bool) → (a → Encoding) → ([a] → Encoding) → (b → Bool) → (b → Encoding) → ([b] → Encoding) → Either a b → Encoding Source # liftToEncodingList2 ∷ (a → Bool) → (a → Encoding) → ([a] → Encoding) → (b → Bool) → (b → Encoding) → ([b] → Encoding) → [Either a b] → Encoding Source # liftOmitField2 ∷ (a → Bool) → (b → Bool) → Either a b → Bool Source #
Bifunctor Either	Since: base-4.8.0.0
Instance details Defined in Data.Bifunctor Methods bimap ∷ (a → b) → (c → d) → Either a c → Either b d # first ∷ (a → b) → Either a c → Either b c # second ∷ (b → c) → Either a b → Either a c #
NFData2 Either	Since: deepseq-1.4.3.0
Instance details Defined in Control.DeepSeq Methods liftRnf2 ∷ (a → ()) → (b → ()) → Either a b → () #
Hashable2 Either
Instance details Defined in Data.Hashable.Class Methods liftHashWithSalt2 ∷ (Int → a → Int) → (Int → b → Int) → Int → Either a b → Int Source #
Validate Either
Instance details Defined in Data.Validation Methods _Validation ∷ Iso (Either e a) (Either g b) (Validation e a) (Validation g b) Source # _Either ∷ Iso (Either e a) (Either g b) (Either e a) (Either g b) Source #
Generic1 (Either a ∷ Type → Type)
Instance details Defined in GHC.Generics Associated Types type Rep1 (Either a) ∷ k → Type # Methods from1 ∷ ∀ (a0 ∷ k). Either a a0 → Rep1 (Either a) a0 # to1 ∷ ∀ (a0 ∷ k). Rep1 (Either a) a0 → Either a a0 #
MonadError e (Either e)
Instance details Defined in Control.Monad.Error.Class Methods throwError ∷ e → Either e a # catchError ∷ Either e a → (e → Either e a) → Either e a #
(Lift a, Lift b) ⇒ Lift (Either a b ∷ Type)
Instance details Defined in Language.Haskell.TH.Syntax Methods lift ∷ Quote m ⇒ Either a b → m Exp # liftTyped ∷ ∀ (m ∷ Type → Type). Quote m ⇒ Either a b → Code m (Either a b) #
FromJSON a ⇒ FromJSON1 (Either a)
Instance details Defined in Data.Aeson.Types.FromJSON Methods liftParseJSON ∷ Maybe a0 → (Value → Parser a0) → (Value → Parser [a0]) → Value → Parser (Either a a0) Source # liftParseJSONList ∷ Maybe a0 → (Value → Parser a0) → (Value → Parser [a0]) → Value → Parser [Either a a0] Source # liftOmittedField ∷ Maybe a0 → Maybe (Either a a0) Source #
ToJSON a ⇒ ToJSON1 (Either a)
Instance details Defined in Data.Aeson.Types.ToJSON Methods liftToJSON ∷ (a0 → Bool) → (a0 → Value) → ([a0] → Value) → Either a a0 → Value Source # liftToJSONList ∷ (a0 → Bool) → (a0 → Value) → ([a0] → Value) → [Either a a0] → Value Source # liftToEncoding ∷ (a0 → Bool) → (a0 → Encoding) → ([a0] → Encoding) → Either a a0 → Encoding Source # liftToEncodingList ∷ (a0 → Bool) → (a0 → Encoding) → ([a0] → Encoding) → [Either a a0] → Encoding Source # liftOmitField ∷ (a0 → Bool) → Either a a0 → Bool Source #
Foldable (Either a)	Since: base-4.7.0.0
Instance details Defined in Data.Foldable Methods fold ∷ Monoid m ⇒ Either a m → m # foldMap ∷ Monoid m ⇒ (a0 → m) → Either a a0 → m # foldMap' ∷ Monoid m ⇒ (a0 → m) → Either a a0 → m # foldr ∷ (a0 → b → b) → b → Either a a0 → b # foldr' ∷ (a0 → b → b) → b → Either a a0 → b # foldl ∷ (b → a0 → b) → b → Either a a0 → b # foldl' ∷ (b → a0 → b) → b → Either a a0 → b # foldr1 ∷ (a0 → a0 → a0) → Either a a0 → a0 # foldl1 ∷ (a0 → a0 → a0) → Either a a0 → a0 # toList ∷ Either a a0 → [a0] # null ∷ Either a a0 → Bool # length ∷ Either a a0 → Int # elem ∷ Eq a0 ⇒ a0 → Either a a0 → Bool # maximum ∷ Ord a0 ⇒ Either a a0 → a0 # minimum ∷ Ord a0 ⇒ Either a a0 → a0 # sum ∷ Num a0 ⇒ Either a a0 → a0 # product ∷ Num a0 ⇒ Either a a0 → a0 #
Traversable (Either a)	Since: base-4.7.0.0
Instance details Defined in Data.Traversable Methods traverse ∷ Applicative f ⇒ (a0 → f b) → Either a a0 → f (Either a b) # sequenceA ∷ Applicative f ⇒ Either a (f a0) → f (Either a a0) # mapM ∷ Monad m ⇒ (a0 → m b) → Either a a0 → m (Either a b) # sequence ∷ Monad m ⇒ Either a (m a0) → m (Either a a0) #
Applicative (Either e)	Since: base-3.0
Instance details Defined in Data.Either Methods pure ∷ a → Either e a # (<>) ∷ Either e (a → b) → Either e a → Either e b # liftA2 ∷ (a → b → c) → Either e a → Either e b → Either e c # (>) ∷ Either e a → Either e b → Either e b # (<*) ∷ Either e a → Either e b → Either e a #
Functor (Either a)	Since: base-3.0
Instance details Defined in Data.Either Methods fmap ∷ (a0 → b) → Either a a0 → Either a b # (<$) ∷ a0 → Either a b → Either a a0 #
Monad (Either e)	Since: base-4.4.0.0
Instance details Defined in Data.Either Methods (>>=) ∷ Either e a → (a → Either e b) → Either e b # (>>) ∷ Either e a → Either e b → Either e b # return ∷ a → Either e a #
MonadFailure (Either a)
Instance details Defined in Basement.Monad Associated Types type Failure (Either a) Source # Methods mFail ∷ Failure (Either a) → Either a () Source #
NFData a ⇒ NFData1 (

Inject Header
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Nary Methods inject ∷ ∀ x (xs ∷ [Type]). CanHardFork xs ⇒ Exactly xs Bound → Index xs x → Header x → Header (HardForkBlock xs) Source #
HasNestedContent Header ByronBlock Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Serialisation Methods unnest ∷ Header ByronBlock → DepPair (NestedCtxt Header ByronBlock) Source # nest ∷ DepPair (NestedCtxt Header ByronBlock) → Header ByronBlock Source #
ReconstructNestedCtxt Header ByronBlock Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods reconstructPrefixLen ∷ proxy (Header ByronBlock) → PrefixLen Source # reconstructNestedCtxt ∷ proxy (Header ByronBlock) → ShortByteString → SizeInBytes → SomeSecond (NestedCtxt Header) ByronBlock Source #
SerialiseNodeToNode ByronBlock (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → Header ByronBlock → Encoding Source # decodeNodeToNode ∷ CodecConfig ByronBlock → BlockNodeToNodeVersion ByronBlock → ∀ s. Decoder s (Header ByronBlock) Source #
HasHeader blk ⇒ StandardHash (Header blk ∷ Type)
Instance details Defined in Ouroboros.Consensus.Block.Abstract
ShowProxy (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block Methods showProxy ∷ Proxy (Header ByronBlock) → String Source #
(Typeable era, Typeable proto) ⇒ ShowProxy (Header (ShelleyBlock proto era) ∷ Type) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods showProxy ∷ Proxy (Header (ShelleyBlock proto era)) → String Source #
ShelleyBasedEra era ⇒ ReconstructNestedCtxt Header (ShelleyBlock proto era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods reconstructPrefixLen ∷ proxy (Header (ShelleyBlock proto era)) → PrefixLen Source # reconstructNestedCtxt ∷ proxy (Header (ShelleyBlock proto era)) → ShortByteString → SizeInBytes → SomeSecond (NestedCtxt Header) (ShelleyBlock proto era) Source #
Generic (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block Associated Types type Rep (Header ByronBlock) ∷ Type → Type # Methods from ∷ Header ByronBlock → Rep (Header ByronBlock) x # to ∷ Rep (Header ByronBlock) x → Header ByronBlock #
Generic (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Associated Types type Rep (Header (ShelleyBlock proto era)) ∷ Type → Type # Methods from ∷ Header (ShelleyBlock proto era) → Rep (Header (ShelleyBlock proto era)) x # to ∷ Rep (Header (ShelleyBlock proto era)) x → Header (ShelleyBlock proto era) #
Show (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block Methods showsPrec ∷ Int → Header ByronBlock → ShowS # show ∷ Header ByronBlock → String # showList ∷ [Header ByronBlock] → ShowS #
ShelleyCompatible proto era ⇒ Show (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods showsPrec ∷ Int → Header (ShelleyBlock proto era) → ShowS # show ∷ Header (ShelleyBlock proto era) → String # showList ∷ [Header (ShelleyBlock proto era)] → ShowS #
ShelleyCompatible proto era ⇒ DecCBOR (Annotator (Header (ShelleyBlock proto era))) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods decCBOR ∷ Decoder s (Annotator (Header (ShelleyBlock proto era))) Source # dropCBOR ∷ Proxy (Annotator (Header (ShelleyBlock proto era))) → Decoder s () Source # label ∷ Proxy (Annotator (Header (ShelleyBlock proto era))) → Text Source #
ShelleyCompatible proto era ⇒ EncCBOR (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods encCBOR ∷ Header (ShelleyBlock proto era) → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Header (ShelleyBlock proto era)) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Header (ShelleyBlock proto era)] → Size Source #
Eq (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block Methods (==) ∷ Header ByronBlock → Header ByronBlock → Bool # (/=) ∷ Header ByronBlock → Header ByronBlock → Bool #
ShelleyCompatible proto era ⇒ Eq (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods (==) ∷ Header (ShelleyBlock proto era) → Header (ShelleyBlock proto era) → Bool # (/=) ∷ Header (ShelleyBlock proto era) → Header (ShelleyBlock proto era) → Bool #
NoThunks (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block Methods noThunks ∷ Context → Header ByronBlock → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Header ByronBlock → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Header ByronBlock) → String Source #
ShelleyCompatible proto era ⇒ NoThunks (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods noThunks ∷ Context → Header (ShelleyBlock proto era) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Header (ShelleyBlock proto era) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Header (ShelleyBlock proto era)) → String Source #
SignedHeader (ShelleyProtocolHeader proto) ⇒ SignedHeader (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Protocol Methods headerSigned ∷ Header (ShelleyBlock proto era) → Signed (Header (ShelleyBlock proto era)) Source #
Condense (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block Methods condense ∷ Header ByronBlock → String Source #
ShelleyCompatible proto era ⇒ Condense (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods condense ∷ Header (ShelleyBlock proto era) → String Source #
HasHeader (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block Methods getHeaderFields ∷ Header ByronBlock → HeaderFields (Header ByronBlock) Source #
ShelleyCompatible proto era ⇒ HasHeader (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block Methods getHeaderFields ∷ Header (ShelleyBlock proto era) → HeaderFields (Header (ShelleyBlock proto era)) Source #
DecodeDiskDep (NestedCtxt Header) ByronBlock Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods decodeDiskDep ∷ CodecConfig ByronBlock → NestedCtxt Header ByronBlock a → ∀ s. Decoder s (ByteString → a) Source #
DecodeDiskDepIx (NestedCtxt Header) ByronBlock Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods decodeDiskDepIx ∷ CodecConfig ByronBlock → Decoder s (SomeSecond (NestedCtxt Header) ByronBlock) Source #
EncodeDiskDep (NestedCtxt Header) ByronBlock Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeDiskDep ∷ CodecConfig ByronBlock → NestedCtxt Header ByronBlock a → a → Encoding Source #
EncodeDiskDepIx (NestedCtxt Header) ByronBlock Source #
Instance details Defined in Ouroboros.Consensus.Byron.Node.Serialisation Methods encodeDiskDepIx ∷ CodecConfig ByronBlock → SomeSecond (NestedCtxt Header) ByronBlock → Encoding Source #
ShelleyCompatible proto era ⇒ DecodeDiskDep (NestedCtxt Header) (ShelleyBlock proto era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods decodeDiskDep ∷ CodecConfig (ShelleyBlock proto era) → NestedCtxt Header (ShelleyBlock proto era) a → ∀ s. Decoder s (ByteString → a) Source #
ShelleyBasedEra era ⇒ DecodeDiskDepIx (NestedCtxt Header) (ShelleyBlock proto era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods decodeDiskDepIx ∷ CodecConfig (ShelleyBlock proto era) → Decoder s (SomeSecond (NestedCtxt Header) (ShelleyBlock proto era)) Source #
ShelleyCompatible proto era ⇒ EncodeDiskDep (NestedCtxt Header) (ShelleyBlock proto era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeDiskDep ∷ CodecConfig (ShelleyBlock proto era) → NestedCtxt Header (ShelleyBlock proto era) a → a → Encoding Source #
ShelleyBasedEra era ⇒ EncodeDiskDepIx (NestedCtxt Header) (ShelleyBlock proto era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeDiskDepIx ∷ CodecConfig (ShelleyBlock proto era) → SomeSecond (NestedCtxt Header) (ShelleyBlock proto era) → Encoding Source #
ShelleyCompatible proto era ⇒ SerialiseNodeToNode (ShelleyBlock proto era) (Header (ShelleyBlock proto era)) Source #	CBOR-in-CBOR to be compatible with the wrapped (`Serialised`) variant.
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → Header (ShelleyBlock proto era) → Encoding Source # decodeNodeToNode ∷ CodecConfig (ShelleyBlock proto era) → BlockNodeToNodeVersion (ShelleyBlock proto era) → ∀ s. Decoder s (Header (ShelleyBlock proto era)) Source #
ShelleyCompatible proto era ⇒ EncodeDisk (ShelleyBlock proto era) (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods encodeDisk ∷ CodecConfig (ShelleyBlock proto era) → Header (ShelleyBlock proto era) → Encoding Source #
ShelleyCompatible proto era ⇒ DecodeDisk (ShelleyBlock proto era) (ByteString → Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Node.Serialisation Methods decodeDisk ∷ CodecConfig (ShelleyBlock proto era) → ∀ s. Decoder s (ByteString → Header (ShelleyBlock proto era)) Source #
data Header ByronBlock Source #	Byron header See `ByronBlock` for comments on why we cache certain values.
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block data Header ByronBlock = ByronHeader { byronHeaderRaw ∷ !(ABlockOrBoundaryHdr ByteString) byronHeaderSlotNo ∷ !SlotNo byronHeaderHash ∷ !ByronHash byronHeaderBlockSizeHint ∷ !SizeInBytes }
type HeaderHash (Header blk ∷ Type)
Instance details Defined in Ouroboros.Consensus.Block.Abstract type HeaderHash (Header blk ∷ Type) = HeaderHash blk
type Rep (Header ByronBlock) Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Block type Rep (Header ByronBlock) = D1 ('MetaData "Header" "Ouroboros.Consensus.Byron.Ledger.Block" "ouroboros-consensus-cardano-0.19.0.0-inplace" 'False) (C1 ('MetaCons "ByronHeader" 'PrefixI 'True) ((S1 ('MetaSel ('Just "byronHeaderRaw") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ABlockOrBoundaryHdr ByteString)) :: S1 ('MetaSel ('Just "byronHeaderSlotNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo)) :: (S1 ('MetaSel ('Just "byronHeaderHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ByronHash) :*: S1 ('MetaSel ('Just "byronHeaderBlockSizeHint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SizeInBytes))))
type Rep (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block type Rep (Header (ShelleyBlock proto era)) = D1 ('MetaData "Header" "Ouroboros.Consensus.Shelley.Ledger.Block" "ouroboros-consensus-cardano-0.19.0.0-inplace" 'False) (C1 ('MetaCons "ShelleyHeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "shelleyHeaderRaw") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ShelleyProtocolHeader proto)) :*: S1 ('MetaSel ('Just "shelleyHeaderHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ShelleyHash (ProtoCrypto proto)))))
type BlockProtocol (Header blk)
Instance details Defined in Ouroboros.Consensus.Block.Abstract type BlockProtocol (Header blk) = BlockProtocol blk
newtype Header (DisableDiffusionPipelining blk)
Instance details Defined in Ouroboros.Consensus.Block.SupportsDiffusionPipelining newtype Header (DisableDiffusionPipelining blk) = DisableDiffusionPipeliningHeader (Header blk)
newtype Header (SelectViewDiffusionPipelining blk)
Instance details Defined in Ouroboros.Consensus.Block.SupportsDiffusionPipelining newtype Header (SelectViewDiffusionPipelining blk) = SelectViewDiffusionPipeliningHeader (Header blk)
newtype Header (HardForkBlock xs)
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Block newtype Header (HardForkBlock xs) = HardForkHeader { getHardForkHeader ∷ OneEraHeader xs }
type Signed (Header (ShelleyBlock proto era)) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Protocol type Signed (Header (ShelleyBlock proto era)) = Signed (ShelleyProtocolHeader proto)
data Header (ShelleyBlock proto era) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.Ledger.Block data Header (ShelleyBlock proto era) = ShelleyHeader { shelleyHeaderRaw ∷ !(ShelleyProtocolHeader proto) shelleyHeaderHash ∷ !(ShelleyHash (ProtoCrypto proto)) }