Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Tools.DBImmutaliser.Run

Contents

Setup
Immutalise

Synopsis

data Opts = Opts {
- dbDirs ∷ DBDirs FilePath
- configFile ∷ FilePath
}
run ∷ Opts → IO ()
data DBDirs a = DBDirs {
- immDBDir ∷ a
- volDBDir ∷ a
}
withDBs ∷ ∀ m blk a. (IOLike m, ConvertRawHash blk, LedgerSupportsProtocol blk, ImmutableDbSerialiseConstraints blk, VolatileDbSerialiseConstraints blk, NodeInitStorage blk) ⇒ TopLevelConfig blk → ResourceRegistry m → DBDirs (SomeHasFS m) → (ImmutableDB m blk → VolatileDB m blk → m a) → m a
data TraceImmutalisationEvent blk
- = TraceStartImmutalisation (WithOrigin (Tip blk)) MaxSlotNo
- | TraceNoVolatileCandidate
- | TraceFoundCandidate (HeaderHash blk) Int (SelectView (BlockProtocol blk))
- | TraceCopiedtoImmutableDB (WithOrigin (Tip blk))
immutalise ∷ ∀ m blk. (IOLike m, BlockSupportsProtocol blk) ⇒ BlockConfig blk → Tracer m (TraceImmutalisationEvent blk) → ImmutableDB m blk → VolatileDB m blk → m ()

Documentation

data Opts Source #

Constructors

Opts
Fields dbDirs ∷ DBDirs FilePath configFile ∷ FilePath

run ∷ Opts → IO () Source #

Setup

data DBDirs a Source #

Constructors

DBDirs
Fields immDBDir ∷ a volDBDir ∷ a

Instances

Instances details

Foldable DBDirs Source #
Instance details Defined in Cardano.Tools.DBImmutaliser.Run Methods fold ∷ Monoid m ⇒ DBDirs m → m # foldMap ∷ Monoid m ⇒ (a → m) → DBDirs a → m # foldMap' ∷ Monoid m ⇒ (a → m) → DBDirs a → m # foldr ∷ (a → b → b) → b → DBDirs a → b # foldr' ∷ (a → b → b) → b → DBDirs a → b # foldl ∷ (b → a → b) → b → DBDirs a → b # foldl' ∷ (b → a → b) → b → DBDirs a → b # foldr1 ∷ (a → a → a) → DBDirs a → a # foldl1 ∷ (a → a → a) → DBDirs a → a # toList ∷ DBDirs a → [a] # null ∷ DBDirs a → Bool # length ∷ DBDirs a → Int # elem ∷ Eq a ⇒ a → DBDirs a → Bool # maximum ∷ Ord a ⇒ DBDirs a → a # minimum ∷ Ord a ⇒ DBDirs a → a # sum ∷ Num a ⇒ DBDirs a → a # product ∷ Num a ⇒ DBDirs a → a #
Traversable DBDirs Source #
Instance details Defined in Cardano.Tools.DBImmutaliser.Run Methods traverse ∷ Applicative f ⇒ (a → f b) → DBDirs a → f (DBDirs b) # sequenceA ∷ Applicative f ⇒ DBDirs (f a) → f (DBDirs a) # mapM ∷ Monad m ⇒ (a → m b) → DBDirs a → m (DBDirs b) # sequence ∷ Monad m ⇒ DBDirs (m a) → m (DBDirs a) #
Functor DBDirs Source #
Instance details Defined in Cardano.Tools.DBImmutaliser.Run Methods fmap ∷ (a → b) → DBDirs a → DBDirs b # (<$) ∷ a → DBDirs b → DBDirs a #

withDBs ∷ ∀ m blk a. (IOLike m, ConvertRawHash blk, LedgerSupportsProtocol blk, ImmutableDbSerialiseConstraints blk, VolatileDbSerialiseConstraints blk, NodeInitStorage blk) ⇒ TopLevelConfig blk → ResourceRegistry m → DBDirs (SomeHasFS m) → (ImmutableDB m blk → VolatileDB m blk → m a) → m a Source #

Immutalise

data TraceImmutalisationEvent blk Source #

Constructors

TraceStartImmutalisation
Fields (WithOrigin (Tip blk)) Tip of the ImmutableDB. MaxSlotNo `MaxSlotNo` of the VolatileDB.
TraceNoVolatileCandidate	No blocks in the VolatileDB extend the immutable tip.
TraceFoundCandidate	Found a volatile candidate extending the immutable tip.
Fields (HeaderHash blk) Hash of the candidate tip. Int Blocks to be added to the ImmutableDB. (SelectView (BlockProtocol blk)) `SelectView` of the candidate tip.
TraceCopiedtoImmutableDB
Fields (WithOrigin (Tip blk)) New tip of the ImmutableDB.

Instances

Instances details

(ConsensusProtocol (BlockProtocol blk), StandardHash blk) ⇒ Show (TraceImmutalisationEvent blk) Source #
Instance details Defined in Cardano.Tools.DBImmutaliser.Run Methods showsPrec ∷ Int → TraceImmutalisationEvent blk → ShowS # show ∷ TraceImmutalisationEvent blk → String # showList ∷ [TraceImmutalisationEvent blk] → ShowS #

immutalise ∷ ∀ m blk. (IOLike m, BlockSupportsProtocol blk) ⇒ BlockConfig blk → Tracer m (TraceImmutalisationEvent blk) → ImmutableDB m blk → VolatileDB m blk → m () Source #

Copy a specific chain from the given VolatileDB to the ImmutableDB, such that other tools that only work with an ImmutableDB can process the corresponding blocks.

This function requires exclusive access to the databases.

Currently, this will pick the best (according to the SelectView) chain extending the immutable tip, and it will _not_ do any kind of validation.

Future work might include customizing this behavior, like:

picking the best _valid_ chain (requires reading a ledger snapshot and/or replaying)
picking a chain that contains particular points (user input)