Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Storage.LedgerDB.API

21 types
2 classes
8 values

Packageouroboros-consensus-4.2.1.0
Exports31
LicenceApache-2.0

valueconfigLedgerDb

:: ConsensusProtocol (BlockProtocol blk)
=> TopLevelConfig blk
-> ComputeLedgerEvents
-> LedgerDbCfg ExtLedgerState blk

valuecurrentPoint

:: (GetTip (l blk), HeaderHash (l blk) ~ HeaderHash blk, Functor (STM m))
=> LedgerDB m l blk
-> STM m (Point blk)

valuedecorateReplayTracerWithGoal

:: Monad m
=> Point blk
-> Tracer m (TraceReplayProgressEvent blk)
-> Tracer m (ReplayGoal blk -> TraceReplayProgressEvent blk)

valuedecorateReplayTracerWithStart

:: Monad m
=> Point blk
-> Tracer m (ReplayGoal blk -> TraceReplayProgressEvent blk)
-> Tracer m (ReplayStart blk -> ReplayGoal blk -> TraceReplayProgressEvent blk)

valuegetTipStatistics :: IOLike m => LedgerDB m l blk -> m Statistics

valueinitialize

:: (IOLike m, LedgerSupportsProtocol blk, InspectLedger blk, HasCallStack)
=> Tracer m (TraceReplayEvent blk)
-> Tracer m (TraceSnapshotEvent blk)
-> LedgerDbCfg ExtLedgerState blk
-> StreamAPI m blk blk
-> Point blk
-> IsEBB
-> InitDB db m blk
-> SnapshotManager m blk st
-> m (InitLog blk, db)

valueopenReadOnlyForker

:: MonadSTM m
=> LedgerDB m l blk
-> Target (Point blk)
-> m (Either GetForkerError (ReadOnlyForker m l blk))

valuewithTipForker

:: IOLike m
=> LedgerDB m l blk
-> Forker m l blk -> m a
-> m a

classclass CanUpgradeLedgerTables (l :: StateKind) blk where

Methods

upgradeTables :: l blk mk1 -> l blk mk2 -> LedgerTables blk ValuesMK -> LedgerTables blk ValuesMK

Instances3CanUpgradeLedgerTables

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

datadata Decoders blk

Constructors

Decoders (forall s. Decoder s (TxIn blk)) (forall s. Decoder s (TxOut blk))

datadata InitDB db (m :: Type -> Type) blk

Constructors

InitDB
- initFromGenesis :: !m db
- initFromSnapshot :: !DiskSnapshot -> m (Either (SnapshotFailure blk) (db, RealPoint blk))
- initReapplyBlock :: !LedgerDbCfg ExtLedgerState blk -> blk -> db -> m db
- currentTip :: !db -> LedgerState blk EmptyMK
- mkLedgerDb :: !db -> m (LedgerDB' m blk, TestInternals' m blk)

datadata InitLog blk

Constructors

InitFromGenesis
InitFromSnapshot DiskSnapshot (RealPoint blk)
InitFailure DiskSnapshot (SnapshotFailure blk) (InitLog blk)

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (InitLog blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
StandardHash blk => Show (InitLog blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
Generic (InitLog blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
type Rep (InitLog blk) = D1 ('MetaData "InitLog" "Ouroboros.Consensus.Storage.LedgerDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "InitFromGenesis" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "InitFromSnapshot" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk))) :+: C1 ('MetaCons "InitFailure" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SnapshotFailure blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (InitLog blk))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

datadata LedgerDB (m :: Type -> Type) (l :: StateKind) blk

Constructors

LedgerDB
- getVolatileTip :: STM m (l blk EmptyMK)
- getImmutableTip :: STM m (l blk EmptyMK)
- getPastLedgerState :: Point blk -> STM m (Maybe (l blk EmptyMK))
- getHeaderStateHistory :: l ~ ExtLedgerState => STM m (HeaderStateHistory blk)
- openForkerAtTarget :: Target (Point blk) -> m (Either GetForkerError (Forker m l blk))
- validateFork :: (TraceValidateEvent blk -> m ()) -> BlockCache blk -> Word64 -> NonEmpty (Header blk) -> SuccessForkerAction m l blk -> m (ValidateResult l blk)
- getPrevApplied :: STM m (Set (RealPoint blk))
- garbageCollect :: SlotNo -> m ()
- tryTakeSnapshot :: m ()
- snapshotRequestQueue :: SnapshotRequestQueue m
- closeDB :: m ()

Instances2NoThunks, HeaderHash

NoThunks (LedgerDB m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
type HeaderHash (LedgerDB m l blk) = HeaderHash blkDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

typetype LedgerDB' (m :: Type -> Type) blk = LedgerDB m ExtLedgerState blk

typetype LedgerDbCfg (l :: StateKind) = Complete LedgerDbCfgF l

datadata LedgerDbCfgF (f :: Type -> Type) (l :: StateKind) blk

Constructors

LedgerDbCfg
- ledgerDbCfgSecParam :: !HKD f SecurityParam
- ledgerDbCfg :: !HKD f (LedgerCfg l blk)
- ledgerDbCfgComputeLedgerEvents :: !ComputeLedgerEvents

Instances3NoThunks, Generic, Rep

NoThunks (LedgerCfg l blk) => NoThunks (LedgerDbCfg l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
Generic (LedgerDbCfgF f l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
type Rep (LedgerDbCfgF f l blk) = D1 ('MetaData "LedgerDbCfgF" "Ouroboros.Consensus.Storage.LedgerDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "LedgerDbCfg" 'PrefixI 'True) (S1 ('MetaSel ('Just "ledgerDbCfgSecParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HKD f SecurityParam)) :*: (S1 ('MetaSel ('Just "ledgerDbCfg") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (HKD f (LedgerCfg l blk))) :*: S1 ('MetaSel ('Just "ledgerDbCfgComputeLedgerEvents") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ComputeLedgerEvents))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

datadata LedgerDbError

Constructors

ClosedDBError PrettyCallStack

Instances2Show, Exception

Show LedgerDbErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
Exception LedgerDbErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

datadata LedgerDbPrune

Constructors

LedgerDbPruneAll
LedgerDbPruneBeforeSlot SlotNo

Instances1Show

Show LedgerDbPruneDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

type

type LedgerDbSerialiseConstraints blk = (Serialise (HeaderHash blk), EncodeDisk blk (LedgerState blk EmptyMK), DecodeDisk blk (LedgerState blk EmptyMK), EncodeDisk blk (AnnTip blk), DecodeDisk blk (AnnTip blk), EncodeDisk blk (ChainDepState (BlockProtocol blk)), DecodeDisk blk (ChainDepState (BlockProtocol blk)), IndexedMemPack LedgerState blk (TxOut blk), MemPack (TxIn blk), SerializeTablesWithHint LedgerState blk)

newtypenewtype ReplayGoal blk

Constructors

ReplayGoal (Point blk)

Instances2Eq, Show

StandardHash blk => Eq (ReplayGoal blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
StandardHash blk => Show (ReplayGoal blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

newtypenewtype ReplayStart blk

Constructors

ReplayStart (Point blk)

Instances2Eq, Show

StandardHash blk => Eq (ReplayStart blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
StandardHash blk => Show (ReplayStart blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

type

type Sink (m :: Type -> Type) (l :: Type -> (Type -> Type -> Type) -> Type) blk = l blk EmptyMK -> Stream (Of (TxIn blk, TxOut blk)) (ExceptT DeserialiseFailure m) (Stream (Of ByteString) m (Maybe CRC)) -> ExceptT DeserialiseFailure m (Stream (Of ByteString) m (Maybe CRC, Maybe CRC))

classclass StreamingBackend (m :: Type -> Type) backend (l :: Type -> (Type -> Type -> Type) -> Type) blk where

Associated types

data family YieldArgs (m :: Type -> Type) backend (l :: Type -> (Type -> Type -> Type) -> Type) blk
data family SinkArgs (m :: Type -> Type) backend (l :: Type -> (Type -> Type -> Type) -> Type) blk

Methods

yield :: Proxy backend -> YieldArgs m backend l blk -> Yield m l blk
releaseYieldArgs :: YieldArgs m backend l blk -> m ()
sink :: Proxy backend -> SinkArgs m backend l blk -> Sink m l blk
releaseSinkArgs :: SinkArgs m backend l blk -> m ()

Instances1StreamingBackend

IOLike m => StreamingBackend m Mem l blkDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

datadata TestInternals (m :: Type -> Type) (l :: Type -> (Type -> Type -> Type) -> Type) blk

Constructors

TestInternals
- wipeLedgerDB :: m ()
- takeSnapshotNOW :: WhereToTakeSnapshot -> Maybe String -> m ()
- push :: l blk DiffMK -> m ()
- reapplyThenPushNOW :: blk -> m ()
- truncateSnapshots :: m ()
- closeLedgerDB :: m ()
- getNumLedgerTablesHandles :: m Word64

Instances1NoThunks

NoThunks (TestInternals m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

typetype TestInternals' (m :: Type -> Type) blk = TestInternals m ExtLedgerState blk

datadata TraceReplayEvent blk

Constructors

TraceReplayStartEvent (TraceReplayStartEvent blk)
TraceReplayProgressEvent (TraceReplayProgressEvent blk)

Instances2Eq, Show

(StandardHash blk, InspectLedger blk) => Eq (TraceReplayEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
(StandardHash blk, InspectLedger blk) => Show (TraceReplayEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

datadata TraceReplayProgressEvent blk

Constructors

ReplayedBlock (RealPoint blk) [LedgerEvent blk] (ReplayStart blk) (ReplayGoal blk)

Instances4Eq, Show, Generic, Rep

(InspectLedger blk, StandardHash blk) => Eq (TraceReplayProgressEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
(InspectLedger blk, StandardHash blk) => Show (TraceReplayProgressEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
Generic (TraceReplayProgressEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
type Rep (TraceReplayProgressEvent blk) = D1 ('MetaData "TraceReplayProgressEvent" "Ouroboros.Consensus.Storage.LedgerDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ReplayedBlock" 'PrefixI 'False) ((S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (RealPoint blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [LedgerEvent blk])) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayStart blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayGoal blk)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

datadata TraceReplayStartEvent blk

Constructors

ReplayFromGenesis
ReplayFromSnapshot DiskSnapshot (ReplayStart blk)

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (TraceReplayStartEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
StandardHash blk => Show (TraceReplayStartEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
Generic (TraceReplayStartEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API
type Rep (TraceReplayStartEvent blk) = D1 ('MetaData "TraceReplayStartEvent" "Ouroboros.Consensus.Storage.LedgerDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ReplayFromGenesis" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ReplayFromSnapshot" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DiskSnapshot) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ReplayStart blk))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

datadata WhereToTakeSnapshot

TakeAtImmutableTip TakeAtVolatileTip

Instances1Eq

Eq WhereToTakeSnapshotDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.API

type

type Yield (m :: Type -> Type) (l :: Type -> (Type -> Type -> Type) -> Type) blk = l blk EmptyMK -> (Stream (Of (TxIn blk, TxOut blk)) (ExceptT DeserialiseFailure m) (Stream (Of ByteString) m (Maybe CRC)) -> ExceptT DeserialiseFailure m (Stream (Of ByteString) m (Maybe CRC, Maybe CRC))) -> ExceptT DeserialiseFailure m (Maybe CRC, Maybe CRC)

typetype ResolveBlock (m :: Type -> Type) blk = RealPoint blk -> m blk