Safe Haskell	Safe-Inferred
Language	Haskell2010

Marconi.Cardano.Indexers.ExtLedgerStateCoordinator

Contents

Types
Constructors
Utils
For testing

Description

A coordinator that also maintains the ExtLedgerState.

It takes an input computes the ExtLedgerState out of it (in a preprocessor, we don't want to pass the ledger state if it isn't needed)
volatile ExtLedgerStates are stored in memory (in a preprocessor as well).
Compute the output from there
pass the output to the underlying coordinator
saves the last known stable ledger state systematically on close

Synopsis

type ExtLedgerState = ExtLedgerState (HardForkBlock (CardanoEras StandardCrypto))
data ExtLedgerStateEvent = ExtLedgerStateEvent {
- extLedgerState :: ExtLedgerState
- blockNo :: BlockNo
}
type ExtLedgerConfig = ExtLedgerCfg (HardForkBlock (CardanoEras StandardCrypto))
newtype ExtLedgerStateCoordinator output input = ExtLedgerStateCoordinator (Coordinator output)
data ExtLedgerStateWorkerConfig output input = ExtLedgerStateWorkerConfig {
- workerEventExtractor :: input -> BlockEvent
- workerDistanceExtractor :: input -> Word64
- workerNodeConfigPath :: FilePath
- workerSnapshotInterval :: Word64
- workerSecurityParam :: SecurityParam
- workerOutputBuilder :: ExtLedgerStateEvent -> ExtLedgerStateEvent -> input -> Maybe output
}
data EpochMetadata
mkExtLedgerStateCoordinator :: (MonadIO m, MonadError IndexerError m, Point output ~ ChainPoint) => [Worker output ChainPoint] -> m (ExtLedgerStateCoordinator output input)
extLedgerStateWorker :: forall m output input. (MonadIO m, MonadError IndexerError m, Point output ~ ChainPoint, Point input ~ ChainPoint) => ExtLedgerStateWorkerConfig output input -> Trace IO Text -> [Worker output ChainPoint] -> FilePath -> m (WorkerIndexer IO input output (WithTrace IO (ExtLedgerStateCoordinator output)))
buildExtLedgerStateEventIndexer :: (MonadIO m, MonadError IndexerError m) => CodecConfig (HardForkBlock (CardanoEras StandardCrypto)) -> FilePath -> m (FileIndexer EpochMetadata ExtLedgerStateEvent)
getEpochNo :: ExtLedgerState (CardanoBlock StandardCrypto) -> Maybe EpochNo
newEpochPreprocessor :: Monad m => (a -> EpochNo) -> Preprocessor m ChainPoint a a
readGenesisFile :: (MonadIO m, MonadError IndexerError m) => FilePath -> m GenesisConfig
deserialiseLedgerState :: CodecConfig -> EpochMetadata -> ByteString -> Either Text (Maybe ExtLedgerStateEvent)
deserialiseMetadata :: [Text] -> Maybe EpochMetadata

Types

type ExtLedgerState = ExtLedgerState (HardForkBlock (CardanoEras StandardCrypto)) #

data ExtLedgerStateEvent #

Base event used to store the ExtLedgerState

Constructors

ExtLedgerStateEvent
Fields extLedgerState :: ExtLedgerState blockNo :: BlockNo

Instances

Instances details

Show ExtLedgerStateEvent #
Instance details Defined in Marconi.Cardano.Indexers.ExtLedgerStateCoordinator Methods showsPrec :: Int -> ExtLedgerStateEvent -> ShowS Source # show :: ExtLedgerStateEvent -> String Source # showList :: [ExtLedgerStateEvent] -> ShowS Source #
type Point ExtLedgerStateEvent #
Instance details Defined in Marconi.Cardano.Indexers.ExtLedgerStateCoordinator type Point ExtLedgerStateEvent = ChainPoint

type ExtLedgerConfig = ExtLedgerCfg (HardForkBlock (CardanoEras StandardCrypto)) #

newtype ExtLedgerStateCoordinator output input #

Constructors

ExtLedgerStateCoordinator (Coordinator output)

Instances

Instances details

(MonadIO m, MonadError IndexerError m, Point output ~ ChainPoint) => IsIndex m output (ExtLedgerStateCoordinator output) #
Instance details Defined in Marconi.Cardano.Indexers.ExtLedgerStateCoordinator Methods index :: Timed (Point output) (Maybe output) -> ExtLedgerStateCoordinator output output -> m (ExtLedgerStateCoordinator output output) Source # indexAll :: (Eq (Point output), Traversable f) => f (Timed (Point output) (Maybe output)) -> ExtLedgerStateCoordinator output output -> m (ExtLedgerStateCoordinator output output) Source # indexAllDescending :: (Eq (Point output), Traversable f) => f (Timed (Point output) (Maybe output)) -> ExtLedgerStateCoordinator output output -> m (ExtLedgerStateCoordinator output output) Source # rollback :: Point output -> ExtLedgerStateCoordinator output output -> m (ExtLedgerStateCoordinator output output) Source # setLastStablePoint :: Point output -> ExtLedgerStateCoordinator output output -> m (ExtLedgerStateCoordinator output output) Source #
(MonadIO m, MonadError IndexerError m, Point event ~ Point output, Point output ~ ChainPoint, Ord (Point output)) => IsSync m event (ExtLedgerStateCoordinator output) #
Instance details Defined in Marconi.Cardano.Indexers.ExtLedgerStateCoordinator Methods lastStablePoint :: ExtLedgerStateCoordinator output event -> m (Point event) Source # lastSyncPoint :: ExtLedgerStateCoordinator output event -> m (Point event) Source #
(MonadIO m, MonadError IndexerError m) => Closeable m (ExtLedgerStateCoordinator output) #
Instance details Defined in Marconi.Cardano.Indexers.ExtLedgerStateCoordinator Methods close :: ExtLedgerStateCoordinator output event -> m () Source #

data ExtLedgerStateWorkerConfig output input #

Configuration of the worker

Constructors

ExtLedgerStateWorkerConfig

Fields

workerEventExtractor :: input -> BlockEvent
Get the blockEvent (required to compute the ledger state) from the event
workerDistanceExtractor :: input -> Word64
Get the distance to the tip
workerNodeConfigPath :: FilePath
Location of the node config, used to initialise the ledger state
workerSnapshotInterval :: Word64
Number of blocks before two snapshots of the ledger state
workerSecurityParam :: SecurityParam
Number of volatile blocks
workerOutputBuilder :: ExtLedgerStateEvent -> ExtLedgerStateEvent -> input -> Maybe output
How to create an output from the previous ledger state, the current one and the current input

data EpochMetadata #

Metadata used to create ExtLedgerStateEventIndexer filenames

Instances

Instances details

Show EpochMetadata #
Instance details Defined in Marconi.Cardano.Indexers.ExtLedgerStateCoordinator Methods showsPrec :: Int -> EpochMetadata -> ShowS Source # show :: EpochMetadata -> String Source # showList :: [EpochMetadata] -> ShowS Source #

Constructors

mkExtLedgerStateCoordinator :: (MonadIO m, MonadError IndexerError m, Point output ~ ChainPoint) => [Worker output ChainPoint] -> m (ExtLedgerStateCoordinator output input) #

Create a naked coordinator. | You would usually prefer to use a worker, as it will maintain the | ledger state before sending it to the coordinator.

extLedgerStateWorker :: forall m output input. (MonadIO m, MonadError IndexerError m, Point output ~ ChainPoint, Point input ~ ChainPoint) => ExtLedgerStateWorkerConfig output input -> Trace IO Text -> [Worker output ChainPoint] -> FilePath -> m (WorkerIndexer IO input output (WithTrace IO (ExtLedgerStateCoordinator output))) #

Create a worker for the extLedgerState coordinator

buildExtLedgerStateEventIndexer :: (MonadIO m, MonadError IndexerError m) => CodecConfig (HardForkBlock (CardanoEras StandardCrypto)) -> FilePath -> m (FileIndexer EpochMetadata ExtLedgerStateEvent) #

File Indexer to save the ExtLedgerState

Utils

getEpochNo :: ExtLedgerState (CardanoBlock StandardCrypto) -> Maybe EpochNo #

newEpochPreprocessor :: Monad m => (a -> EpochNo) -> Preprocessor m ChainPoint a a #

A preprocessor that filters in events when they are the first of their epoch

readGenesisFile :: (MonadIO m, MonadError IndexerError m) => FilePath -> m GenesisConfig #

For testing

deserialiseLedgerState :: CodecConfig -> EpochMetadata -> ByteString -> Either Text (Maybe ExtLedgerStateEvent) #

deserialiseMetadata :: [Text] -> Maybe EpochMetadata #