Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Client

Synopsis

data HydraEvent tx
- = ClientConnected
- | ClientDisconnected
- | Update (TimedServerOutput tx)
- | Tick UTCTime
data Client tx m = Client {
- sendInput :: ClientInput tx -> m ()
- sk :: SigningKey PaymentKey
- externalCommit :: UTxO -> m ()
}
type ClientCallback tx m = HydraEvent tx -> m ()
type ClientComponent tx m a = ClientCallback tx m -> (Client tx m -> m a) -> m a
withClient :: (ToJSON (ClientInput tx), FromJSON (TimedServerOutput tx)) => Options -> ClientComponent tx IO a
data ClientError = ClientJSONDecodeError String ByteString

Documentation

Constructors

ClientConnected
ClientDisconnected
Update (TimedServerOutput tx)
Tick UTCTime

Instances details

Generic (HydraEvent tx) Source #
Instance details Defined in Hydra.Client Associated Types type Rep (HydraEvent tx) :: Type -> Type Source # Methods from :: HydraEvent tx -> Rep (HydraEvent tx) x Source # to :: Rep (HydraEvent tx) x -> HydraEvent tx Source #
Show (TimedServerOutput tx) => Show (HydraEvent tx) Source #
Instance details Defined in Hydra.Client Methods showsPrec :: Int -> HydraEvent tx -> ShowS Source # show :: HydraEvent tx -> String Source # showList :: [HydraEvent tx] -> ShowS Source #
Eq (TimedServerOutput tx) => Eq (HydraEvent tx) Source #
Instance details Defined in Hydra.Client Methods (==) :: HydraEvent tx -> HydraEvent tx -> Bool Source # (/=) :: HydraEvent tx -> HydraEvent tx -> Bool Source #
type Rep (HydraEvent tx) Source #
Instance details Defined in Hydra.Client type Rep (HydraEvent tx) = D1 ('MetaData "HydraEvent" "Hydra.Client" "hydra-tui-0.16.0-JFj6a2OEHyL7Wdi6OlO2vT" 'False) ((C1 ('MetaCons "ClientConnected" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ClientDisconnected" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Update" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (TimedServerOutput tx))) :+: C1 ('MetaCons "Tick" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime))))

Handle to interact with Hydra node

Constructors

Client
Fields sendInput :: ClientInput tx -> m () Send some input to the server. sk :: SigningKey PaymentKey externalCommit :: UTxO -> m ()

Callback for receiving server outputs.

type ClientComponent tx m a = ClientCallback tx m -> (Client tx m -> m a) -> m a Source #

A type tying both receiving output and sending input into a Component.

withClient :: (ToJSON (ClientInput tx), FromJSON (TimedServerOutput tx)) => Options -> ClientComponent tx IO a Source #

Provide a component to interact with Hydra node.

Constructors

Instances details

Exception ClientError Source #
Instance details Defined in Hydra.Client Methods toException :: ClientError -> SomeException Source # fromException :: SomeException -> Maybe ClientError Source # displayException :: ClientError -> String Source #
Generic ClientError Source #
Instance details Defined in Hydra.Client Associated Types type Rep ClientError :: Type -> Type Source # Methods from :: ClientError -> Rep ClientError x Source # to :: Rep ClientError x -> ClientError Source #
Show ClientError Source #
Instance details Defined in Hydra.Client Methods showsPrec :: Int -> ClientError -> ShowS Source # show :: ClientError -> String Source # showList :: [ClientError] -> ShowS Source #
Eq ClientError Source #
Instance details Defined in Hydra.Client Methods (==) :: ClientError -> ClientError -> Bool Source # (/=) :: ClientError -> ClientError -> Bool Source #
type Rep ClientError Source #
Instance details Defined in Hydra.Client type Rep ClientError = D1 ('MetaData "ClientError" "Hydra.Client" "hydra-tui-0.16.0-JFj6a2OEHyL7Wdi6OlO2vT" 'False) (C1 ('MetaCons "ClientJSONDecodeError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))