ouroboros-consensus

Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Storage.LedgerDB.V2.Backend

Contents

Backend API
Existentials
Tracing

Description

Common interface for LedgerDB V2 backends

Synopsis

class NoThunks (Resources m backend) ⇒ Backend (m ∷ Type → Type) backend blk where
- data Args (m ∷ Type → Type) backend
- data Resources (m ∷ Type → Type) backend
- data Trace backend
- mkResources ∷ Proxy blk → Tracer m LedgerDBV2Trace → Args m backend → SomeHasFS m → WithTempRegistry fState m (Resources m backend)
- releaseResources ∷ Proxy blk → Resources m backend → m ()
- createAndPopulateStateRefFromGenesis ∷ Tracer m LedgerDBV2Trace → Resources m backend → ExtLedgerState blk ValuesMK → m (StateRef m ExtLedgerState blk)
- openStateRefFromSnapshot ∷ Tracer m LedgerDBV2Trace → CodecConfig blk → SomeHasFS m → Resources m backend → DiskSnapshot → ExceptT (SnapshotFailure blk) m (StateRef m ExtLedgerState blk, RealPoint blk)
- snapshotManager ∷ Proxy blk → Resources m backend → CodecConfig blk → Tracer m (TraceSnapshotEvent blk) → SomeHasFS m → SnapshotManager m blk (StateRef m ExtLedgerState blk)
data SomeBackendTrace where
- SomeBackendTrace ∷ ∀ backend. (Show (Trace backend), Typeable backend) ⇒ Trace backend → SomeBackendTrace
data SomeBackendArgs (m ∷ Type → Type) blk where
- SomeBackendArgs ∷ ∀ (m ∷ Type → Type) backend blk. Backend m backend blk ⇒ Args m backend → SomeBackendArgs m blk
data SomeResources (m ∷ Type → Type) blk where
- SomeResources ∷ ∀ (m ∷ Type → Type) backend blk. Backend m backend blk ⇒ Resources m backend → SomeResources m blk
data LedgerDBV2Trace

Backend API

class NoThunks (Resources m backend) ⇒ Backend (m ∷ Type → Type) backend blk where Source #

Operations needed to open and operate a LedgerDB V2

Associated Types

data Args (m ∷ Type → Type) backend Source #

The Arguments that will be used initially to create the Resources.

data Resources (m ∷ Type → Type) backend Source #

The Resources that will be stored in the LedgerDB environment and given to the handle operations.

data Trace backend Source #

A trace dependent on the particular backend.

Methods

mkResources ∷ Proxy blk → Tracer m LedgerDBV2Trace → Args m backend → SomeHasFS m → WithTempRegistry fState m (Resources m backend) Source #

Transform Args into Resources, with some context made up of LedgerDbArgs.

releaseResources ∷ Proxy blk → Resources m backend → m () Source #

Release the acquired resources.

createAndPopulateStateRefFromGenesis ∷ Tracer m LedgerDBV2Trace → Resources m backend → ExtLedgerState blk ValuesMK → m (StateRef m ExtLedgerState blk) Source #

Create a new handle from the given Genesis state.

openStateRefFromSnapshot ∷ Tracer m LedgerDBV2Trace → CodecConfig blk → SomeHasFS m → Resources m backend → DiskSnapshot → ExceptT (SnapshotFailure blk) m (StateRef m ExtLedgerState blk, RealPoint blk) Source #

Create a new handle from a snapshot.

snapshotManager ∷ Proxy blk → Resources m backend → CodecConfig blk → Tracer m (TraceSnapshotEvent blk) → SomeHasFS m → SnapshotManager m blk (StateRef m ExtLedgerState blk) Source #

Instantiate the SnapshotManager for this backend.

Instances

Instances details

(IOLike m, LedgerDbSerialiseConstraints blk, LedgerSupportsProtocol blk, CanUpgradeLedgerTables LedgerState blk) ⇒ Backend m Mem blk Source #

Instance details

Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory

Associated Types

data Args m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory data Args m Mem = InMemArgs
newtype Resources m Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory newtype Resources m Mem = Resources (SomeHasFS m)
newtype Trace Mem
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.InMemory newtype Trace Mem = NoTrace Void

Methods

mkResources ∷ Proxy blk → Tracer m LedgerDBV2Trace → Args m Mem → SomeHasFS m → WithTempRegistry fState m (Resources m Mem) Source #

releaseResources ∷ Proxy blk → Resources m Mem → m () Source #

createAndPopulateStateRefFromGenesis ∷ Tracer m LedgerDBV2Trace → Resources m Mem → ExtLedgerState blk ValuesMK → m (StateRef m ExtLedgerState blk) Source #

openStateRefFromSnapshot ∷ Tracer m LedgerDBV2Trace → CodecConfig blk → SomeHasFS m → Resources m Mem → DiskSnapshot → ExceptT (SnapshotFailure blk) m (StateRef m ExtLedgerState blk, RealPoint blk) Source #

snapshotManager ∷ Proxy blk → Resources m Mem → CodecConfig blk → Tracer m (TraceSnapshotEvent blk) → SomeHasFS m → SnapshotManager m blk (StateRef m ExtLedgerState blk) Source #

Existentials

data SomeBackendTrace where Source #

Constructors

SomeBackendTrace ∷ ∀ backend. (Show (Trace backend), Typeable backend) ⇒ Trace backend → SomeBackendTrace

Instances

Instances details

Show SomeBackendTrace Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.Backend Methods showsPrec ∷ Int → SomeBackendTrace → ShowS # show ∷ SomeBackendTrace → String # showList ∷ [SomeBackendTrace] → ShowS #

data SomeBackendArgs (m ∷ Type → Type) blk where Source #

Constructors

SomeBackendArgs ∷ ∀ (m ∷ Type → Type) backend blk. Backend m backend blk ⇒ Args m backend → SomeBackendArgs m blk

data SomeResources (m ∷ Type → Type) blk where Source #

Constructors

SomeResources ∷ ∀ (m ∷ Type → Type) backend blk. Backend m backend blk ⇒ Resources m backend → SomeResources m blk

Instances

Instances details

NoThunks (SomeResources m blk) Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.Backend Methods noThunks ∷ Context → SomeResources m blk → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → SomeResources m blk → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (SomeResources m blk) → String Source #

Tracing

data LedgerDBV2Trace Source #

Constructors

TraceLedgerTablesHandleCreate EnclosingTimed	Created a new `LedgerTablesHandle`, potentially by duplicating an existing one.
TraceLedgerTablesHandleClose EnclosingTimed	Closed a `LedgerTablesHandle`.
TraceLedgerTablesHandleRead EnclosingTimed
TraceLedgerTablesHandleDuplicate EnclosingTimed
TraceLedgerTablesHandleCreateFirst EnclosingTimed
TraceLedgerTablesHandlePush EnclosingTimed
BackendTrace SomeBackendTrace

Instances

Instances details

Show SomeBackendTrace ⇒ Show LedgerDBV2Trace Source #
Instance details Defined in Ouroboros.Consensus.Storage.LedgerDB.V2.Backend Methods showsPrec ∷ Int → LedgerDBV2Trace → ShowS # show ∷ LedgerDBV2Trace → String # showList ∷ [LedgerDBV2Trace] → ShowS #