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 = DirectBackend {
- options :: DirectOptions
}
type BlockType = BlockInMode
data DirectConnectException = DirectConnectException {
- ioException :: IOException
- nodeSocket :: SocketPath
- networkId :: NetworkId
}
newtype IntersectionNotFoundException = IntersectionNotFound {
- requestedPoint :: ChainPoint
}
data EraNotSupportedException
- = EraNotSupportedAnymore {
  - otherEraName :: Text
  }
- | EraNotSupportedYet {
  - otherEraName :: Text
  }
withDirectChain :: DirectBackend -> Tracer IO CardanoChainLog -> CardanoChainConfig -> ChainContext -> TinyWallet IO -> ChainStateHistory Tx -> ChainComponent Tx IO a
chainSyncClient :: forall m. (MonadSTM m, MonadThrow m) => ChainSyncHandler m -> TinyWallet m -> ChainPoint -> ChainSyncClient BlockType ChainPoint ChainTip m ()
txSubmissionClient :: forall m. (MonadSTM m, MonadDelay m) => Tracer m CardanoChainLog -> 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 #
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-api-0.14.0.0-FzoRUEZPHbuD5ACTMdXOlT" 'True) (C1 ('MetaCons "NetworkMagic" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNetworkMagic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word32)))

newtype DirectBackend Source #

Constructors

DirectBackend
Fields options :: DirectOptions

Instances

Instances details

ChainBackend DirectBackend Source #

Instance details

Defined in Hydra.Chain.Direct

Methods

queryGenesisParameters :: (MonadIO m, MonadThrow m) => DirectBackend -> m (GenesisParameters ShelleyEra) Source #

queryScriptRegistry :: (MonadIO m, MonadThrow m) => DirectBackend -> [TxId] -> m ScriptRegistry Source #

queryNetworkId :: (MonadIO m, MonadThrow m) => DirectBackend -> m NetworkId Source #

queryTip :: (MonadIO m, MonadThrow m) => DirectBackend -> m ChainPoint Source #

queryUTxO :: (MonadIO m, MonadThrow m) => DirectBackend -> [Address ShelleyAddr] -> m UTxO Source #

queryEraHistory :: (MonadIO m, MonadThrow m) => DirectBackend -> QueryPoint -> m EraHistory Source #

querySystemStart :: (MonadIO m, MonadThrow m) => DirectBackend -> QueryPoint -> m SystemStart Source #

queryProtocolParameters :: (MonadIO m, MonadThrow m) => DirectBackend -> QueryPoint -> m (PParams LedgerEra) Source #

queryStakePools :: (MonadIO m, MonadThrow m) => DirectBackend -> QueryPoint -> m (Set PoolId) Source #

queryUTxOFor :: (MonadIO m, MonadThrow m) => DirectBackend -> QueryPoint -> VerificationKey PaymentKey -> m UTxO Source #

submitTransaction :: (MonadIO m, MonadThrow m) => DirectBackend -> Tx -> m () Source #

awaitTransaction :: (MonadIO m, MonadThrow m) => DirectBackend -> Tx -> m UTxO Source #

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 point of intersection is unknown to the local node. This may happen if users shut down their node quickly after starting them and hold on a not-so-stable point of the chain. When they turn the node back on, that point may no longer exist on the network if a fork with deeper roots has been adopted in the meantime.

Constructors

IntersectionNotFound
Fields requestedPoint :: 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 #

withDirectChain Source #

Arguments

:: DirectBackend
-> 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 -> ChainPoint -> ChainSyncClient BlockType ChainPoint ChainTip m () Source #

txSubmissionClient :: forall m. (MonadSTM m, MonadDelay m) => Tracer m CardanoChainLog -> TQueue m (Tx, TMVar m (Maybe (PostTxError Tx))) -> LocalTxSubmissionClient TxInMode TxValidationErrorInCardanoMode m () Source #