Safe Haskell	None
Language	Haskell2010

Cardano.Streaming

Contents

Stream blocks and ledger states

Synopsis

withChainSyncEventStream :: FilePath -> NetworkId -> [ ChainPoint ] -> ( Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r -> IO b) -> IO b
data ChainSyncEvent a
- = RollForward a ChainTip
- | RollBackward ChainPoint ChainTip
data ChainSyncEventException = NoIntersectionFound
mkConnectInfo :: Env -> FilePath -> LocalNodeConnectInfo CardanoMode
mkLocalNodeConnectInfo :: NetworkId -> FilePath -> LocalNodeConnectInfo CardanoMode
blocks :: LocalNodeConnectInfo CardanoMode -> ChainPoint -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r
blocksPipelined :: Word32 -> LocalNodeConnectInfo CardanoMode -> ChainPoint -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r
ledgerStates :: FilePath -> FilePath -> ValidationMode -> Stream ( Of LedgerState ) IO r
ledgerStatesPipelined :: Word32 -> FilePath -> FilePath -> ValidationMode -> Stream ( Of LedgerState ) IO r
foldLedgerState :: Env -> LedgerStateHistory -> ValidationMode -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r -> Stream ( Of LedgerState ) IO r
foldLedgerStateEvents :: Env -> LedgerStateHistory -> ValidationMode -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r -> Stream ( Of ( BlockInMode CardanoMode , LedgerStateEvents)) IO r
getEnvAndInitialLedgerStateHistory :: FilePath -> IO ( Env , LedgerStateHistory)
ignoreRollbacks :: Monad m => Stream ( Of ( ChainSyncEvent a)) m r -> Stream ( Of a) m r

Documentation

withChainSyncEventStream Source #

Arguments

:: FilePath	Path to the node socket
-> NetworkId
-> [ ChainPoint ]	The point on the chain to start streaming from
-> ( Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r -> IO b)	The stream consumer
-> IO b

withChainSyncEventStream uses the chain-sync mini-protocol to connect to a locally running node and fetch blocks from the given starting point.

data ChainSyncEvent a Source #

Constructors

RollForward a ChainTip
RollBackward ChainPoint ChainTip

Instances

Instances details

Functor ChainSyncEvent Source #
Instance details Defined in Cardano.Streaming.Helpers Methods fmap :: (a -> b) -> ChainSyncEvent a -> ChainSyncEvent b Source # (<$) :: a -> ChainSyncEvent b -> ChainSyncEvent a Source #
Show a => Show ( ChainSyncEvent a) Source #
Instance details Defined in Cardano.Streaming.Helpers Methods showsPrec :: Int -> ChainSyncEvent a -> ShowS Source # show :: ChainSyncEvent a -> String Source # showList :: [ ChainSyncEvent a] -> ShowS Source #
Generic ( ChainSyncEvent a) Source #
Instance details Defined in Cardano.Streaming.Helpers Associated Types type Rep ( ChainSyncEvent a) :: Type -> Type Source # Methods from :: ChainSyncEvent a -> Rep ( ChainSyncEvent a) x Source # to :: Rep ( ChainSyncEvent a) x -> ChainSyncEvent a Source #
type Rep ( ChainSyncEvent a) Source #
Instance details Defined in Cardano.Streaming.Helpers type Rep ( ChainSyncEvent a) = D1 (' MetaData "ChainSyncEvent" "Cardano.Streaming.Helpers" "cardano-streaming-1.2.0.0-3K1SjQkdiXnGaRr9D4cHjb" ' False ) ( C1 (' MetaCons "RollForward" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 a) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ChainTip )) :+: C1 (' MetaCons "RollBackward" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ChainPoint ) :: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ChainTip )))

data ChainSyncEventException Source #

Constructors

NoIntersectionFound

Instances

Instances details

Show ChainSyncEventException Source #
Instance details Defined in Cardano.Streaming.Helpers Methods showsPrec :: Int -> ChainSyncEventException -> ShowS Source # show :: ChainSyncEventException -> String Source # showList :: [ ChainSyncEventException ] -> ShowS Source #
Exception ChainSyncEventException Source #
Instance details Defined in Cardano.Streaming.Helpers Methods toException :: ChainSyncEventException -> SomeException Source # fromException :: SomeException -> Maybe ChainSyncEventException Source # displayException :: ChainSyncEventException -> String Source #

mkConnectInfo :: Env -> FilePath -> LocalNodeConnectInfo CardanoMode Source #

Derive LocalNodeConnectInfo from Env.

mkLocalNodeConnectInfo :: NetworkId -> FilePath -> LocalNodeConnectInfo CardanoMode Source #

Stream blocks and ledger states

blocks :: LocalNodeConnectInfo CardanoMode -> ChainPoint -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r Source #

Create stream of ChainSyncEvent (BlockInMode CardanoMode) from a node at socketPath with networkId starting at point .

blocksPipelined :: Word32 -> LocalNodeConnectInfo CardanoMode -> ChainPoint -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r Source #

ledgerStates :: FilePath -> FilePath -> ValidationMode -> Stream ( Of LedgerState ) IO r Source #

Get a stream of permanent ledger states

ledgerStatesPipelined :: Word32 -> FilePath -> FilePath -> ValidationMode -> Stream ( Of LedgerState ) IO r Source #

Get a stream of ledger states over a pipelined chain sync

foldLedgerState :: Env -> LedgerStateHistory -> ValidationMode -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r -> Stream ( Of LedgerState ) IO r Source #

Fold a stream of blocks into a stream of ledger states. This is implemented in a similar way as foldBlocks in cardano-api:Cardano.Api.LedgerState, the difference being that this keeps waiting for more blocks when chainsync server and client are fully synchronized.

foldLedgerStateEvents :: Env -> LedgerStateHistory -> ValidationMode -> Stream ( Of ( ChainSyncEvent ( BlockInMode CardanoMode ))) IO r -> Stream ( Of ( BlockInMode CardanoMode , LedgerStateEvents)) IO r Source #

Like foldLedgerState , but also produces blocks and LedgerEvent s.

getEnvAndInitialLedgerStateHistory :: FilePath -> IO ( Env , LedgerStateHistory) Source #

ignoreRollbacks :: Monad m => Stream ( Of ( ChainSyncEvent a)) m r -> Stream ( Of a) m r Source #

Ignore rollback events in the chainsync event stream. Useful for monitor which blocks has been seen by the node, regardless whether they are permanent.