Safe Haskell	Safe-Inferred
Language	Haskell2010

Marconi.Cardano.Indexers.SnapshotBlockEvent

Contents

Block ranges
For testing

Synopsis

snapshotBlockEventWorker :: forall input m n. (MonadIO m, MonadError IndexerError m, MonadIO n) => StandardWorkerConfig n input SnapshotBlockEvent -> SnapshotWorkerConfig input -> FilePath -> m (WorkerIndexer n input SnapshotBlockEvent (WithTrace n (FileIndexer SnapshotMetadata)))
newtype SnapshotBlockEvent = SnapshotBlockEvent {
- getBlockEvent :: BlockEvent
}
data SnapshotWorkerConfig input = SnapshotWorkerConfig {
- currentBlockNo :: input -> BlockNo
- blockRange :: BlockRange
- nodeConfig :: FilePath
}
data SnapshotMetadata = SnapshotMetadata {
- snapshotMetadataBlockNo :: Maybe BlockNo
- snapshotMetadataChainpoint :: ChainPoint
}
getConfigCodec :: (MonadIO m, MonadError IndexerError m) => FilePath -> m CodecConfig
data BlockRange
mkBlockRange :: Word64 -> Word64 -> Either String BlockRange
blockRangeFst :: Lens' BlockRange Word64
blockRangeSnd :: Lens' BlockRange Word64
type CodecConfig = CodecConfig (HardForkBlock (CardanoEras StandardCrypto))
type BlockNodeToClientVersion = BlockNodeToClientVersion (CardanoBlock StandardCrypto)
deserialiseSnapshotBlockEvent :: CodecConfig -> BlockNodeToClientVersion -> SnapshotMetadata -> ByteString -> Either Text (Maybe SnapshotBlockEvent)
deserialiseMetadata :: [Text] -> Maybe SnapshotMetadata
blockNodeToNodeVersionM :: Maybe (HardForkNodeToClientVersion (ByronBlock ': CardanoShelleyEras StandardCrypto))

Documentation

snapshotBlockEventWorker :: forall input m n. (MonadIO m, MonadError IndexerError m, MonadIO n) => StandardWorkerConfig n input SnapshotBlockEvent -> SnapshotWorkerConfig input -> FilePath -> m (WorkerIndexer n input SnapshotBlockEvent (WithTrace n (FileIndexer SnapshotMetadata))) #

Builds the worker on top of the BlockEvent indexer. This is where the events are preprocessed by filtering out any blocks which are not in the given BlockRange.

newtype SnapshotBlockEvent #

Constructors

SnapshotBlockEvent
Fields getBlockEvent :: BlockEvent

Instances

Instances details

type Point SnapshotBlockEvent #
Instance details Defined in Marconi.Cardano.Indexers.SnapshotBlockEvent type Point SnapshotBlockEvent = ChainPoint

data SnapshotWorkerConfig input #

Type which contains the data needed to configure the snapshot indexer workers for BlockEvents and ExtLedgerState events.

Constructors

SnapshotWorkerConfig
Fields currentBlockNo :: input -> BlockNo retrieves the current block number from the indexer's input blockRange :: BlockRange sub-chain to index, passed by the user on the CL nodeConfig :: FilePath configuration of the Cardano node, passed by the user on the CL

data SnapshotMetadata #

A representation of the names provided for the snapshot files. This is used by the file indexer when parsing and unparsing the file names.

Constructors

SnapshotMetadata
Fields snapshotMetadataBlockNo :: Maybe BlockNo the block which was serialized snapshotMetadataChainpoint :: ChainPoint the chain point which was serialized

Instances

Instances details

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

getConfigCodec :: (MonadIO m, MonadError IndexerError m) => FilePath -> m CodecConfig #

Block ranges

data BlockRange #

A range of block number

Instances

Instances details

FromJSON BlockRange #
Instance details Defined in Marconi.Cardano.Indexers.SnapshotBlockEvent Methods parseJSON :: Value -> Parser BlockRange parseJSONList :: Value -> Parser [BlockRange]
ToJSON BlockRange #
Instance details Defined in Marconi.Cardano.Indexers.SnapshotBlockEvent Methods toJSON :: BlockRange -> Value toEncoding :: BlockRange -> Encoding toJSONList :: [BlockRange] -> Value toEncodingList :: [BlockRange] -> Encoding
Generic BlockRange #
Instance details Defined in Marconi.Cardano.Indexers.SnapshotBlockEvent Associated Types type Rep BlockRange :: Type -> Type Source # Methods from :: BlockRange -> Rep BlockRange x Source # to :: Rep BlockRange x -> BlockRange Source #
Show BlockRange #
Instance details Defined in Marconi.Cardano.Indexers.SnapshotBlockEvent Methods showsPrec :: Int -> BlockRange -> ShowS Source # show :: BlockRange -> String Source # showList :: [BlockRange] -> ShowS Source #
type Rep BlockRange #
Instance details Defined in Marconi.Cardano.Indexers.SnapshotBlockEvent type Rep BlockRange = D1 ('MetaData "BlockRange" "Marconi.Cardano.Indexers.SnapshotBlockEvent" "marconi-cardano-indexers-1.2.0.0-inplace" 'False) (C1 ('MetaCons "BlockRange" 'PrefixI 'True) (S1 ('MetaSel ('Just "_blockRangeFst") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :*: S1 ('MetaSel ('Just "_blockRangeSnd") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)))

mkBlockRange :: Word64 -> Word64 -> Either String BlockRange #

Smart constructor for BlockRange that ensures that the lower bound is lower than the upper bound.

blockRangeFst :: Lens' BlockRange Word64 #

blockRangeSnd :: Lens' BlockRange Word64 #

For testing

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

type BlockNodeToClientVersion = BlockNodeToClientVersion (CardanoBlock StandardCrypto) #

deserialiseSnapshotBlockEvent :: CodecConfig -> BlockNodeToClientVersion -> SnapshotMetadata -> ByteString -> Either Text (Maybe SnapshotBlockEvent) #

deserialiseMetadata :: [Text] -> Maybe SnapshotMetadata #

blockNodeToNodeVersionM :: Maybe (HardForkNodeToClientVersion (ByronBlock ': CardanoShelleyEras StandardCrypto)) #