Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Ledger.Basics

6 types
3 classes
7 values

Packageouroboros-consensus-4.2.1.0
Exports19
LicenceApache-2.0

valueapplyChainTick

:: IsLedger l blk
=> ComputeLedgerEvents
-> LedgerCfg l blk
-> SlotNo
-> l blk EmptyMK
-> Ticked l blk DiffMK

valuecastLedgerResult

:: AuxLedgerEvent l ~ AuxLedgerEvent l'
=> LedgerResult l a
-> LedgerResult l' a

valueembedLedgerResult

:: AuxLedgerEvent l -> AuxLedgerEvent l'
-> LedgerResult l a
-> LedgerResult l' a

valuegetTipHash :: GetTip l => l mk -> ChainHash l

valuegetTipM :: (GetTipSTM m l, MonadSTM m) => l -> m (Point l)

valuegetTipSlot :: GetTip l => l mk -> WithOrigin SlotNo

valuepureLedgerResult :: a -> LedgerResult l a

familytype family AuxLedgerEvent blk

Instances2AuxLedgerEvent

type AuxLedgerEvent (HardForkBlock xs) = OneEraLedgerEvent xsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
type AuxLedgerEvent (DualBlock m a) = AuxLedgerEvent mDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

datadata ComputeLedgerEvents

ComputeLedgerEvents OmitLedgerEvents

Instances5Eq, Show, Generic, NoThunks, Rep

Eq ComputeLedgerEventsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
Show ComputeLedgerEventsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
Generic ComputeLedgerEventsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
NoThunks ComputeLedgerEventsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
type Rep ComputeLedgerEvents = D1 ('MetaData "ComputeLedgerEvents" "Ouroboros.Consensus.Ledger.Basics" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ComputeLedgerEvents" 'PrefixI 'False) U1 :+: C1 ('MetaCons "OmitLedgerEvents" 'PrefixI 'False) U1)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics

classclass GetTip (l :: LedgerStateKind) where

Methods

getTip :: l mk -> Point l

Instances6GetTip

CanHardFork xs => GetTip (LedgerState (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
IsLedger LedgerState blk => GetTip (ExtLedgerState blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Extended
Bridge m a => GetTip (LedgerState (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
CanHardFork xs => GetTip (Ticked LedgerState (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
IsLedger LedgerState blk => GetTip (Ticked ExtLedgerState blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Extended
Bridge m a => GetTip (Ticked LedgerState (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

classclass GetTipSTM (m :: Type -> Type) l where

Methods

getTipSTM :: l -> STM m (Point l)

Instances1GetTipSTM

(GetTip (l blk), MonadSTM m) => GetTipSTM m (Forker m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

class

class (forall (mk :: MapKind). EqMK mk => Eq (l blk mk), forall (mk :: MapKind). NoThunksMK mk => NoThunks (l blk mk), forall (mk :: MapKind). ShowMK mk => Show (l blk mk), NoThunks (LedgerCfg l blk), Show (LedgerErr l blk), Eq (LedgerErr l blk), NoThunks (LedgerErr l blk), GetTip (l blk), GetTip (Ticked l blk)) => IsLedger (l :: StateKind) blk where

Associated types

type family LedgerErr (l :: StateKind) blk

Methods

applyChainTickLedgerResult :: ComputeLedgerEvents -> LedgerCfg l blk -> SlotNo -> l blk EmptyMK -> LedgerResult blk (Ticked l blk DiffMK)

Instances3IsLedger

LedgerSupportsProtocol blk => IsLedger ExtLedgerState blkDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Extended
CanHardFork xs => IsLedger LedgerState (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
Bridge m a => IsLedger LedgerState (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

familytype family LedgerCfg (l :: StateKind) blk

Instances3LedgerCfg

type LedgerCfg LedgerState (HardForkBlock xs) = HardForkLedgerConfig xsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
type LedgerCfg LedgerState (DualBlock m a) = DualLedgerConfig m aDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
type LedgerCfg ExtLedgerState blk = ExtLedgerCfg blkDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Extended

typetype LedgerConfig blk = LedgerCfg LedgerState blk

typetype LedgerError blk = LedgerErr LedgerState blk

datadata LedgerResult blk a

Constructors

LedgerResult
- lrEvents :: [AuxLedgerEvent blk]
- lrResult :: !a

Instances3Functor, Foldable, Traversable

Functor (LedgerResult blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
Foldable (LedgerResult blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
Traversable (LedgerResult blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics

data familydata family LedgerState blk (mk :: MapKind)

Instances39ApplyBlock, CanUpgradeLedgerTables, IsLedger, SerializeTablesWithHint, IndexedMemPack, CanStowLedgerTables, …

(CanHardFork xs, HasCanonicalTxIn xs, HasHardForkTxOut xs) => HasLedgerTables LedgerState (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
(CanHardFork xs, HasCanonicalTxIn xs, HasHardForkTxOut xs) => ApplyBlock LedgerState (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
(CanHardFork xs, HasHardForkTxOut xs) => CanUpgradeLedgerTables LedgerState (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
CanHardFork xs => IsLedger LedgerState (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
(Bridge m a, HasLedgerTables LedgerState m) => HasLedgerTables LedgerState (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
Bridge m a => ApplyBlock LedgerState (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
CanUpgradeLedgerTables LedgerState (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
Bridge m a => IsLedger LedgerState (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
(Ord (TxIn m), MemPack (TxIn m), MemPack (TxOut m)) => SerializeTablesWithHint LedgerState (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
(txout ~ TxOut m, IndexedMemPack LedgerState m txout) => IndexedMemPack LedgerState (DualBlock m a) txoutDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
CanHardFork xs => GetTip (LedgerState (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
Bridge m a => GetTip (LedgerState (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
CanStowLedgerTables (LedgerState m) => CanStowLedgerTables (LedgerState (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
All (Compose CanStowLedgerTables LedgerState) xs => CanStowLedgerTables (LedgerState (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
SerialiseHFC xs => EncodeDisk (HardForkBlock xs) (LedgerState (HardForkBlock xs) EmptyMK)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
SerialiseHFC xs => DecodeDisk (HardForkBlock xs) (LedgerState (HardForkBlock xs) EmptyMK)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk · orphan
(Bridge m a, EqMK mk) => Eq (LedgerState (DualBlock m a) mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
(EqMK mk, CanHardFork xs) => Eq (LedgerState (HardForkBlock xs) mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
(Bridge m a, ShowMK mk) => Show (LedgerState (DualBlock m a) mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
(ShowMK mk, CanHardFork xs) => Show (LedgerState (HardForkBlock xs) mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
NoThunks (LedgerState (DualBlock m a) mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
(NoThunksMK mk, CanHardFork xs) => NoThunks (LedgerState (HardForkBlock xs) mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
StandardHash blk => StandardHash (LedgerState blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
(CanHardFork xs, HasCanonicalTxIn xs, HasHardForkTxOut xs) => HasLedgerTables (Ticked LedgerState) (HardForkBlock xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
(Bridge m a, HasLedgerTables (Ticked LedgerState) m) => HasLedgerTables (Ticked LedgerState) (DualBlock m a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
CanHardFork xs => GetTip (Ticked LedgerState (HardForkBlock xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
Bridge m a => GetTip (Ticked LedgerState (DualBlock m a))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
NoThunks (Ticked LedgerState (DualBlock m a) mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
Inject (Flip LedgerState mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Embed.Nary
Isomorphic (Flip LedgerState mk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Embed.Unary
type HeaderHash (LedgerState blk) = HeaderHash blkDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Basics
data Ticked LedgerState (HardForkBlock xs)
- TickedHardForkLedgerStatetickedHardForkLedgerStateTransition :: !TransitionInfotickedHardForkLedgerStatePerEra :: !HardForkState (FlipTickedLedgerState mk) xs
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
data Ticked LedgerState (DualBlock m a)
- TickedDualLedgerStatetickedDualLedgerStateMain :: Ticked LedgerState m mktickedDualLedgerStateAux :: Ticked LedgerState a ValuesMKtickedDualLedgerStateBridge :: BridgeLedger m atickedDualLedgerStateAuxOrig :: LedgerState a ValuesMK
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
data LedgerState (HardForkBlock xs)
- HardForkLedgerStatehardForkLedgerStatePerEra :: HardForkState (Flip LedgerState mk) xs
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
data LedgerState (DualBlock m a)
- DualLedgerStatedualLedgerStateMain :: LedgerState m mkdualLedgerStateAux :: LedgerState a ValuesMKdualLedgerStateBridge :: BridgeLedger m a
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
type LedgerCfg LedgerState (HardForkBlock xs) = HardForkLedgerConfig xsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
type LedgerCfg LedgerState (DualBlock m a) = DualLedgerConfig m aDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual
type LedgerErr LedgerState (HardForkBlock xs) = HardForkLedgerError xsDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Ledger · orphan
type LedgerErr LedgerState (DualBlock m a) = DualLedgerError m aDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Ledger.Dual

typetype TickedLedgerState blk = Ticked LedgerState blk

datadata VoidLedgerEvent