Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Chain.Direct

Description

Chain component implementation which uses directly the Node-to-Client protocols to submit "hand-rolled" transactions.

Synopsis

newtype NetworkMagic = NetworkMagic Word32
newtype DirectBackend a = DirectBackend (ReaderT DirectOptions IO a)
type BlockType = BlockInMode
data DirectConnectException = DirectConnectException {
- ioException :: IOException
- nodeSocket :: SocketPath
- networkId :: NetworkId
}
newtype IntersectionNotFoundException = IntersectionNotFound {
- requestedPoints :: NonEmpty ChainPoint
}
data EraNotSupportedException
- = EraNotSupportedAnymore {
  - otherEraName :: Text
  }
- | EraNotSupportedYet {
  - otherEraName :: Text
  }
runDirectBackend :: DirectOptions -> DirectBackend a -> IO a
withDirectChain :: DirectOptions -> Tracer IO CardanoChainLog -> CardanoChainConfig -> ChainContext -> TinyWallet IO -> ChainStateHistory Tx -> ChainComponent Tx IO a
chainSyncClient :: forall m. (MonadSTM m, MonadThrow m) => ChainSyncHandler m -> TinyWallet m -> NonEmpty ChainPoint -> ChainSyncClient BlockType ChainPoint ChainTip m ()
withNodeConn :: (LocalNodeConnectInfo -> IO a) -> DirectBackend a
txSubmissionClient :: forall m. (MonadSTM m, MonadDelay m) => Tracer m CardanoChainLog -> m NominalDiffTime -> TQueue m (Tx, TMVar m (Maybe (PostTxError Tx))) -> LocalTxSubmissionClient TxInMode TxValidationErrorInCardanoMode m ()

Documentation

newtype NetworkMagic #

Constructors

NetworkMagic Word32

Instances

Instances details

Generic NetworkMagic
Instance details Defined in Ouroboros.Network.Magic Associated Types type Rep NetworkMagic :: Type -> Type Source # Methods from :: NetworkMagic -> Rep NetworkMagic x Source # to :: Rep NetworkMagic x -> NetworkMagic Source #
Show NetworkMagic
Instance details Defined in Ouroboros.Network.Magic Methods showsPrec :: Int -> NetworkMagic -> ShowS Source # show :: NetworkMagic -> String Source # showList :: [NetworkMagic] -> ShowS Source #
NFData NetworkMagic
Instance details Defined in Ouroboros.Network.Magic Methods rnf :: NetworkMagic -> () Source #
Eq NetworkMagic
Instance details Defined in Ouroboros.Network.Magic Methods (==) :: NetworkMagic -> NetworkMagic -> Bool Source # (/=) :: NetworkMagic -> NetworkMagic -> Bool Source #
NoThunks NetworkMagic
Instance details Defined in Ouroboros.Network.Magic Methods noThunks :: Context -> NetworkMagic -> IO (Maybe ThunkInfo) wNoThunks :: Context -> NetworkMagic -> IO (Maybe ThunkInfo) showTypeOf :: Proxy NetworkMagic -> String
type Rep NetworkMagic
Instance details Defined in Ouroboros.Network.Magic type Rep NetworkMagic = D1 ('MetaData "NetworkMagic" "Ouroboros.Network.Magic" "ouroboros-network-1.1.0.0-DJAedeKuhUG7XDERoyiXES-api" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

newtype DirectBackend a Source #

Constructors

DirectBackend (ReaderT DirectOptions IO a)

Instances

Instances details

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

type BlockType = BlockInMode Source #

The block type used in the node-to-client protocols.

data DirectConnectException Source #

Constructors

DirectConnectException
Fields ioException :: IOException nodeSocket :: SocketPath networkId :: NetworkId

Instances

Instances details

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

newtype IntersectionNotFoundException Source #

Thrown when the user-provided custom points of intersection are unknown to the local node. This may happen if users shut down their node quickly after starting them and hold on not-so-stable points of the chain. When they turn the node back on, those points may no longer exist on the network if a fork with deeper roots has been adopted in the meantime.

Constructors

IntersectionNotFound
Fields requestedPoints :: NonEmpty ChainPoint

Instances

Instances details

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

data EraNotSupportedException Source #

Constructors

EraNotSupportedAnymore
Fields otherEraName :: Text
EraNotSupportedYet
Fields otherEraName :: Text

Instances

Instances details

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

runDirectBackend :: DirectOptions -> DirectBackend a -> IO a Source #

withDirectChain Source #

Arguments

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

chainSyncClient :: forall m. (MonadSTM m, MonadThrow m) => ChainSyncHandler m -> TinyWallet m -> NonEmpty ChainPoint -> ChainSyncClient BlockType ChainPoint ChainTip m () Source #

withNodeConn :: (LocalNodeConnectInfo -> IO a) -> DirectBackend a Source #

txSubmissionClient Source #

Arguments

:: forall m. (MonadSTM m, MonadDelay m)
=> Tracer m CardanoChainLog
-> m NominalDiffTime	Action returning the chain's average block time (seconds), used to size the delay before reporting `PostTxError` so the observing side has a chance to process a competing transaction.
-> TQueue m (Tx, TMVar m (Maybe (PostTxError Tx)))
-> LocalTxSubmissionClient TxInMode TxValidationErrorInCardanoMode m ()