Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Chain.Blockfrost

Contents

Helpers

Synopsis

newtype BlockfrostBackend a = BlockfrostBackend (ReaderT BlockfrostEnv IO a)
data BlockfrostEnv = BlockfrostEnv {
- project :: Project
- genesisVar :: TVar IO (Maybe Genesis)
}
newBlockfrostEnv :: BlockfrostOptions -> IO BlockfrostEnv
runBlockfrostBackend :: BlockfrostOptions -> BlockfrostBackend a -> IO a
runBlockfrostBackendWith :: BlockfrostEnv -> BlockfrostBackend a -> IO a
memoizeIO :: TVar IO (Maybe a) -> IO a -> IO a
cachedGenesis :: BlockfrostBackend Genesis
runQuery :: BlockfrostClientT IO a -> BlockfrostBackend a
withNetworkId :: (NetworkId -> BlockfrostClientT IO a) -> BlockfrostBackend a
withBlockfrostChain :: BlockfrostEnv -> Tracer IO CardanoChainLog -> CardanoChainConfig -> ChainContext -> TinyWallet IO -> ChainStateHistory Tx -> ChainComponent Tx IO a
newtype BlockfrostConnectException = BlockfrostConnectException {
- ioException :: IOException
}
blockfrostChain :: (MonadIO m, MonadFail m, MonadCatch m, MonadAsync m, MonadDelay m, MonadLabelledSTM m, MonadMask m) => Tracer m CardanoChainLog -> TQueue m (Tx, TMVar m (Maybe (PostTxError Tx))) -> Project -> m Genesis -> NonEmpty ChainPoint -> ChainSyncHandler m -> TinyWallet m -> m ()
blockfrostChainFollow :: forall m. (MonadIO m, MonadFail m, MonadCatch m, MonadDelay m, MonadLabelledSTM m, MonadMask m) => Tracer m CardanoChainLog -> Project -> m Genesis -> NonEmpty ChainPoint -> ChainSyncHandler m -> TinyWallet m -> m ()
processBlock :: (MonadIO m, MonadThrow m) => Tracer m CardanoChainLog -> Project -> ChainSyncHandler m -> TinyWallet m -> Block -> m ()
blockfrostSubmissionClient :: forall m. MonadSTM m => Tracer m CardanoChainLog -> (Tx -> m (Either Text TxHash)) -> TQueue m (Tx, TMVar m (Maybe (PostTxError Tx))) -> m ()
submitViaBlockfrost :: MonadIO m => Project -> Tx -> m (Either Text TxHash)
toChainPoint :: Block -> ChainPoint
maxBlockBatch :: Int
retryOnBlockfrostError :: (MonadIO m, MonadMask m) => Tracer m CardanoChainLog -> RetryPolicyM m -> (RetryStatus -> m a) -> m a
toTx :: MonadThrow m => TransactionCBOR -> m Tx

Documentation

newtype BlockfrostBackend a Source #

Constructors

BlockfrostBackend (ReaderT BlockfrostEnv IO a)

Instances

Instances details

MonadIO BlockfrostBackend Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods liftIO :: IO a -> BlockfrostBackend a Source #
Applicative BlockfrostBackend Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods pure :: a -> BlockfrostBackend a Source # (<>) :: BlockfrostBackend (a -> b) -> BlockfrostBackend a -> BlockfrostBackend b Source # liftA2 :: (a -> b -> c) -> BlockfrostBackend a -> BlockfrostBackend b -> BlockfrostBackend c Source # (>) :: BlockfrostBackend a -> BlockfrostBackend b -> BlockfrostBackend b Source # (<*) :: BlockfrostBackend a -> BlockfrostBackend b -> BlockfrostBackend a Source #
Functor BlockfrostBackend Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods fmap :: (a -> b) -> BlockfrostBackend a -> BlockfrostBackend b Source # (<$) :: a -> BlockfrostBackend b -> BlockfrostBackend a Source #
Monad BlockfrostBackend Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods (>>=) :: BlockfrostBackend a -> (a -> BlockfrostBackend b) -> BlockfrostBackend b Source # (>>) :: BlockfrostBackend a -> BlockfrostBackend b -> BlockfrostBackend b Source # return :: a -> BlockfrostBackend a Source #
ChainBackend BlockfrostBackend Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods queryGenesisParameters :: BlockfrostBackend (GenesisParameters ShelleyEra) Source # queryScriptRegistry :: [TxId] -> BlockfrostBackend ScriptRegistry Source # queryNetworkId :: BlockfrostBackend NetworkId Source # queryTip :: BlockfrostBackend ChainPoint Source # queryUTxO :: [Address ShelleyAddr] -> BlockfrostBackend UTxO Source # queryUTxOByTxIn :: [TxIn] -> BlockfrostBackend UTxO Source # queryEraHistory :: QueryPoint -> BlockfrostBackend EraHistory Source # querySystemStart :: QueryPoint -> BlockfrostBackend SystemStart Source # queryProtocolParameters :: QueryPoint -> BlockfrostBackend (PParams LedgerEra) Source # queryStakePools :: QueryPoint -> BlockfrostBackend (Set PoolId) Source # queryUTxOFor :: QueryPoint -> VerificationKey PaymentKey -> BlockfrostBackend UTxO Source # submitTransaction :: Tx -> BlockfrostBackend () Source # awaitTransaction :: Tx -> VerificationKey PaymentKey -> BlockfrostBackend UTxO Source # getBlockTime :: BlockfrostBackend NominalDiffTime Source #
MonadCatch BlockfrostBackend Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods catch :: Exception e => BlockfrostBackend a -> (e -> BlockfrostBackend a) -> BlockfrostBackend a catchJust :: Exception e => (e -> Maybe b) -> BlockfrostBackend a -> (b -> BlockfrostBackend a) -> BlockfrostBackend a try :: Exception e => BlockfrostBackend a -> BlockfrostBackend (Either e a) tryJust :: Exception e => (e -> Maybe b) -> BlockfrostBackend a -> BlockfrostBackend (Either b a) handle :: Exception e => (e -> BlockfrostBackend a) -> BlockfrostBackend a -> BlockfrostBackend a handleJust :: Exception e => (e -> Maybe b) -> (b -> BlockfrostBackend a) -> BlockfrostBackend a -> BlockfrostBackend a onException :: BlockfrostBackend a -> BlockfrostBackend b -> BlockfrostBackend a bracketOnError :: BlockfrostBackend a -> (a -> BlockfrostBackend b) -> (a -> BlockfrostBackend c) -> BlockfrostBackend c generalBracket :: BlockfrostBackend a -> (a -> ExitCase b -> BlockfrostBackend c) -> (a -> BlockfrostBackend b) -> BlockfrostBackend (b, c)
MonadThrow BlockfrostBackend Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods throwIO :: Exception e => e -> BlockfrostBackend a bracket :: BlockfrostBackend a -> (a -> BlockfrostBackend b) -> (a -> BlockfrostBackend c) -> BlockfrostBackend c bracket_ :: BlockfrostBackend a -> BlockfrostBackend b -> BlockfrostBackend c -> BlockfrostBackend c finally :: BlockfrostBackend a -> BlockfrostBackend b -> BlockfrostBackend a

data BlockfrostEnv Source #

Constructors

BlockfrostEnv
Fields project :: Project genesisVar :: TVar IO (Maybe Genesis)

newBlockfrostEnv :: BlockfrostOptions -> IO BlockfrostEnv Source #

runBlockfrostBackend :: BlockfrostOptions -> BlockfrostBackend a -> IO a Source #

runBlockfrostBackendWith :: BlockfrostEnv -> BlockfrostBackend a -> IO a Source #

memoizeIO :: TVar IO (Maybe a) -> IO a -> IO a Source #

Return the cached value or run the action once and store its result. Concurrent callers may run the action more than once (last write wins), which is safe for immutable values.

cachedGenesis :: BlockfrostBackend Genesis Source #

runQuery :: BlockfrostClientT IO a -> BlockfrostBackend a Source #

Run a Blockfrost client action with the backend's project.

withNetworkId :: (NetworkId -> BlockfrostClientT IO a) -> BlockfrostBackend a Source #

Run a Blockfrost client action that needs the (cached) network id.

withBlockfrostChain Source #

Arguments

:: BlockfrostEnv
-> Tracer IO CardanoChainLog
-> CardanoChainConfig
-> ChainContext
-> TinyWallet IO
-> ChainStateHistory Tx	Chain state loaded from persistence.
-> ChainComponent Tx IO a

newtype BlockfrostConnectException Source #

Constructors

BlockfrostConnectException
Fields ioException :: IOException

Instances

Instances details

Exception BlockfrostConnectException Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods toException :: BlockfrostConnectException -> SomeException Source # fromException :: SomeException -> Maybe BlockfrostConnectException Source # displayException :: BlockfrostConnectException -> String Source #
Show BlockfrostConnectException Source #
Instance details Defined in Hydra.Chain.Blockfrost Methods showsPrec :: Int -> BlockfrostConnectException -> ShowS Source # show :: BlockfrostConnectException -> String Source # showList :: [BlockfrostConnectException] -> ShowS Source #

blockfrostChain :: (MonadIO m, MonadFail m, MonadCatch m, MonadAsync m, MonadDelay m, MonadLabelledSTM m, MonadMask m) => Tracer m CardanoChainLog -> TQueue m (Tx, TMVar m (Maybe (PostTxError Tx))) -> Project -> m Genesis -> NonEmpty ChainPoint -> ChainSyncHandler m -> TinyWallet m -> m () Source #

blockfrostChainFollow :: forall m. (MonadIO m, MonadFail m, MonadCatch m, MonadDelay m, MonadLabelledSTM m, MonadMask m) => Tracer m CardanoChainLog -> Project -> m Genesis -> NonEmpty ChainPoint -> ChainSyncHandler m -> TinyWallet m -> m () Source #

processBlock :: (MonadIO m, MonadThrow m) => Tracer m CardanoChainLog -> Project -> ChainSyncHandler m -> TinyWallet m -> Block -> m () Source #

blockfrostSubmissionClient Source #

Arguments

:: forall m. MonadSTM m
=> Tracer m CardanoChainLog
-> (Tx -> m (Either Text TxHash))	How to submit a transaction, yielding a rendered failure reason or the transaction hash. Must not throw.
-> TQueue m (Tx, TMVar m (Maybe (PostTxError Tx)))
-> m ()

submitViaBlockfrost :: MonadIO m => Project -> Tx -> m (Either Text TxHash) Source #

Submit a transaction via Blockfrost, rendering both transport and API level failures into a reason.

toChainPoint :: Block -> ChainPoint Source #

maxBlockBatch :: Int Source #

Maximum number of blocks fetched per poll iteration (the Blockfrost page size limit).

retryOnBlockfrostError :: (MonadIO m, MonadMask m) => Tracer m CardanoChainLog -> RetryPolicyM m -> (RetryStatus -> m a) -> m a Source #

Helpers

toTx :: MonadThrow m => TransactionCBOR -> m Tx Source #