Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Storage.LedgerDB

Synopsis

value openDB
value openDBInternal
value configLedgerDb
value currentPoint
value decorateReplayTracerWithGoal
value decorateReplayTracerWithStart
value getTipStatistics
value initialize
value openReadOnlyForker
value withTipForker
value defaultArgs
value defaultQueryBatchSize
value praosGetVolatileSuffix
value forkerCurrentPoint
value ledgerStateReadOnlyForker
value readOnlyForker
value validate
class CanUpgradeLedgerTables
data Decoders
data InitDB
data InitLog
data LedgerDB
type LedgerDB'
type LedgerDbCfg
data LedgerDbCfgF
data LedgerDbError
data LedgerDbPrune
type LedgerDbSerialiseConstraints
newtype ReplayGoal
newtype ReplayStart
type Sink
family SinkArgs
class StreamingBackend
data TestInternals
type TestInternals'
data TraceReplayEvent
data TraceReplayProgressEvent
data TraceReplayStartEvent
data WhereToTakeSnapshot
type Yield
family YieldArgs
newtype GetVolatileSuffix
data LedgerDbArgs
newtype LedgerDbBackendArgs
data QueryBatchSize
data AnnLedgerError
type AnnLedgerError'
data ExceededRollback
data Forker
type Forker'
newtype ForkerKey
data ForkerWasCommitted
data GetForkerError
newtype PushGoal
newtype PushStart
newtype Pushing
data RangeQuery
data RangeQueryPrevious
data ReadOnlyForker
type ReadOnlyForker'
type ResolveBlock
newtype Statistics
newtype SuccessForkerAction
data TraceForkerEvent
data TraceForkerEventWithKey
data TraceValidateEvent
data ValidateArgs
data ValidateResult
newtype FlavorImplSpecificTrace
data TraceEvent

Packageouroboros-consensus-4.2.1.0
Exports70
LicenceApache-2.0

valueopenDB

:: (IOLike m, LedgerSupportsProtocol blk, InspectLedger blk, HasCallStack, HasHardForkHistory blk)
=> Complete LedgerDbArgs m blk
-> StreamAPI m blk blk
-> Point blk
-> IsEBB
-> ResolveBlock m blk
-> GetVolatileSuffix m blk
-> WithTempRegistry st m (LedgerDB' m blk)

valueopenDBInternal

:: (IOLike m, LedgerSupportsProtocol blk, InspectLedger blk, HasCallStack)
=> Complete LedgerDbArgs m blk
-> InitDB db m blk
-> SnapshotManager m blk st
-> StreamAPI m blk blk
-> Point blk
-> IsEBB
-> m (LedgerDB' m blk, TestInternals' m blk)

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

valuedefaultArgs

:: Monad m
=> SomeBackendArgs m blk
-> Incomplete LedgerDbArgs m blk

valuedefaultQueryBatchSize :: QueryBatchSize -> Word64

valuepraosGetVolatileSuffix

:: IOLike m
=> SecurityParam
-> GetVolatileSuffix m blk

valueforkerCurrentPoint

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

valueledgerStateReadOnlyForker

:: IOLike m
=> ReadOnlyForker' m blk
-> ReadOnlyForker m LedgerState blk

valuereadOnlyForker :: Forker m l blk -> ReadOnlyForker m l blk

valuevalidate

:: (IOLike m, HasCallStack, ApplyBlock l blk)
=> ComputeLedgerEvents
-> ValidateArgs m l blk
-> m (ValidateResult l blk)

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-89mGcUlIDtl9Zis3MBCDdC" '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-89mGcUlIDtl9Zis3MBCDdC" '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

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))

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

Instances1SinkArgs

data SinkArgs m Mem
- SinkInMemory Int (TxIn blk -> Encoding) (TxOut blk -> Encoding) (SomeHasFS m) DiskSnapshot
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

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-89mGcUlIDtl9Zis3MBCDdC" '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-89mGcUlIDtl9Zis3MBCDdC" '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)

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

Instances1YieldArgs

data YieldArgs m Mem
- YieldInMemory (SomeHasFS m) DiskSnapshot (Decoders blk)
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

newtypenewtype GetVolatileSuffix (m :: Type -> Type) blk

Constructors

GetVolatileSuffix
- getVolatileSuffix :: forall s. Anchorable (WithOrigin SlotNo) s s => STM m (AnchoredSeq (WithOrigin SlotNo) s s -> AnchoredSeq (WithOrigin SlotNo) s s)

Instances1NoThunks

NoThunks (GetVolatileSuffix m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Args

datadata LedgerDbArgs (f :: Type -> Type) (m :: Type -> Type) blk

Constructors

LedgerDbArgs
- lgrSnapshotPolicyArgs :: SnapshotPolicyArgs
- lgrGenesis :: HKD f (m (ExtLedgerState blk ValuesMK))
- lgrHasFS :: HKD f (SomeHasFS m)
- lgrConfig :: LedgerDbCfgF f ExtLedgerState blk
- lgrTracer :: !Tracer m (TraceEvent blk)
- lgrBackendArgs :: LedgerDbBackendArgs m blk
- lgrQueryBatchSize :: QueryBatchSize

newtypenewtype LedgerDbBackendArgs (m :: Type -> Type) blk

Constructors

LedgerDbBackendArgsV2 (SomeBackendArgs m blk)

datadata QueryBatchSize

Constructors

Instances5Eq, Show, Generic, NoThunks, Rep

Eq QueryBatchSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Args
Show QueryBatchSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Args
Generic QueryBatchSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Args
NoThunks QueryBatchSizeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Args
type Rep QueryBatchSize = D1 ('MetaData "QueryBatchSize" "Ouroboros.Consensus.Storage.LedgerDB.Args" "ouroboros-consensus-4.2.1.0-89mGcUlIDtl9Zis3MBCDdC" 'False) (C1 ('MetaCons "DefaultQueryBatchSize" 'PrefixI 'False) U1 :+: C1 ('MetaCons "RequestedQueryBatchSize" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Args

datadata AnnLedgerError (l :: StateKind) blk

Constructors

AnnLedgerError
- annLedgerBaseRef :: Point blk
- annLedgerErrRef :: RealPoint blk
- annLedgerErr :: LedgerErr l blk

typetype AnnLedgerError' blk = AnnLedgerError ExtLedgerState blk

datadata ExceededRollback

Constructors

ExceededRollback
- rollbackMaximum :: Word64
- rollbackRequested :: Word64

Instances2Eq, Show

Eq ExceededRollbackDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Show ExceededRollbackDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

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

Constructors

Forker
- forkerClose :: !m ()
- forkerReadTables :: !LedgerTables blk KeysMK -> m (LedgerTables blk ValuesMK)
- forkerRangeReadTables :: !RangeQueryPrevious blk -> m (LedgerTables blk ValuesMK, Maybe (TxIn blk))
- forkerGetLedgerState :: !STM m (l blk EmptyMK)
- forkerReadStatistics :: !m Statistics
- forkerPush :: !l blk DiffMK -> m ()
- forkerCommit :: !STM m (m ())

Instances5GetTipSTM, Generic, NoThunks, Rep, HeaderHash

(GetTip (l blk), MonadSTM m) => GetTipSTM m (Forker m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Generic (Forker m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
(Typeable l, Typeable m, Typeable blk) => NoThunks (Forker m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
type Rep (Forker m l blk) = D1 ('MetaData "Forker" "Ouroboros.Consensus.Storage.LedgerDB.Forker" "ouroboros-consensus-4.2.1.0-89mGcUlIDtl9Zis3MBCDdC" 'False) (C1 ('MetaCons "Forker" 'PrefixI 'True) ((S1 ('MetaSel ('Just "forkerClose") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (m ())) :*: (S1 ('MetaSel ('Just "forkerReadTables") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (LedgerTables blk KeysMK -> m (LedgerTables blk ValuesMK))) :*: S1 ('MetaSel ('Just "forkerRangeReadTables") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (RangeQueryPrevious blk -> m (LedgerTables blk ValuesMK, Maybe (TxIn blk)))))) :*: ((S1 ('MetaSel ('Just "forkerGetLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (STM m (l blk EmptyMK))) :*: S1 ('MetaSel ('Just "forkerReadStatistics") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (m Statistics))) :*: (S1 ('MetaSel ('Just "forkerPush") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (l blk DiffMK -> m ())) :*: S1 ('MetaSel ('Just "forkerCommit") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (STM m (m ())))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
type HeaderHash (Forker m l blk) = HeaderHash (l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

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

newtypenewtype ForkerKey

Constructors

ForkerKey Word16

Instances6Enum, Eq, Num, Ord, Show, NoThunks

Enum ForkerKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Eq ForkerKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Num ForkerKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Ord ForkerKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Show ForkerKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
NoThunks ForkerKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

datadata ForkerWasCommitted

ForkerWasCommitted ForkerWasUncommitted

Instances2Eq, Show

Eq ForkerWasCommittedDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Show ForkerWasCommittedDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

datadata GetForkerError

Constructors

PointNotOnChain
PointTooOld !(Maybe ExceededRollback)

Instances2Eq, Show

Eq GetForkerErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Show GetForkerErrorDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

newtypenewtype PushGoal blk

Constructors

PushGoal
- unPushGoal :: RealPoint blk

Instances2Eq, Show

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

newtypenewtype PushStart blk

Constructors

PushStart
- unPushStart :: RealPoint blk

Instances2Eq, Show

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

newtypenewtype Pushing blk

Constructors

Pushing
- unPushing :: RealPoint blk

Instances2Eq, Show

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

datadata RangeQuery l

Constructors

RangeQuery
- rqPrev :: !RangeQueryPrevious l
- rqCount :: !Int

datadata RangeQueryPrevious l

Constructors

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

Constructors

ReadOnlyForker
- roforkerClose :: !m ()
- roforkerReadTables :: !LedgerTables blk KeysMK -> m (LedgerTables blk ValuesMK)
- roforkerRangeReadTables :: !RangeQueryPrevious blk -> m (LedgerTables blk ValuesMK, Maybe (TxIn blk))
- roforkerGetLedgerState :: !STM m (l blk EmptyMK)
- roforkerReadStatistics :: !m Statistics

Instances4Generic, NoThunks, Rep, HeaderHash

Generic (ReadOnlyForker m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
NoThunks (ReadOnlyForker m l blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
type Rep (ReadOnlyForker m l blk) = D1 ('MetaData "ReadOnlyForker" "Ouroboros.Consensus.Storage.LedgerDB.Forker" "ouroboros-consensus-4.2.1.0-89mGcUlIDtl9Zis3MBCDdC" 'False) (C1 ('MetaCons "ReadOnlyForker" 'PrefixI 'True) ((S1 ('MetaSel ('Just "roforkerClose") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (m ())) :*: S1 ('MetaSel ('Just "roforkerReadTables") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (LedgerTables blk KeysMK -> m (LedgerTables blk ValuesMK)))) :*: (S1 ('MetaSel ('Just "roforkerRangeReadTables") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (RangeQueryPrevious blk -> m (LedgerTables blk ValuesMK, Maybe (TxIn blk)))) :*: (S1 ('MetaSel ('Just "roforkerGetLedgerState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (STM m (l blk EmptyMK))) :*: S1 ('MetaSel ('Just "roforkerReadStatistics") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (m Statistics))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
type HeaderHash (ReadOnlyForker m l) = HeaderHash lDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

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

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

newtypenewtype Statistics

Constructors

Statistics
- ledgerTableSize :: Int

newtypenewtype SuccessForkerAction (m :: Type -> Type) (l :: StateKind) blk

Constructors

MkSuccessForkerAction
- applySuccessForkerAction :: Forker m l blk -> m ()

datadata TraceForkerEvent

Constructors

Instances2Eq, Show

Eq TraceForkerEventDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Show TraceForkerEventDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

datadata TraceForkerEventWithKey

Constructors

TraceForkerEventWithKey ForkerKey TraceForkerEvent

Instances2Eq, Show

Eq TraceForkerEventWithKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Show TraceForkerEventWithKeyDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker

datadata TraceValidateEvent blk

Constructors

StartedPushingBlockToTheLedgerDb !(PushStart blk) (PushGoal blk) !(Pushing blk)

Instances4Eq, Show, Generic, Rep

StandardHash blk => Eq (TraceValidateEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
StandardHash blk => Show (TraceValidateEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
Generic (TraceValidateEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker
type Rep (TraceValidateEvent blk) = D1 ('MetaData "TraceValidateEvent" "Ouroboros.Consensus.Storage.LedgerDB.Forker" "ouroboros-consensus-4.2.1.0-89mGcUlIDtl9Zis3MBCDdC" 'False) (C1 ('MetaCons "StartedPushingBlockToTheLedgerDb" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PushStart blk)) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (PushGoal blk)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Pushing blk)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.LedgerDB.Forker