Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Client

Synopsis

Documentation

Constructors

ClientConnected
ClientDisconnected
Update (AllPossibleAPIMessages 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 #
IsChainState 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 #
IsChainState 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.20.0-1niWKpadJVK6QwtZePrL7" '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 (AllPossibleAPIMessages tx))) :+: C1 ('MetaCons "Tick" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime))))

All possible messages that expect to receive from the hydra-node.

Constructors

ApiTimedServerOutput (TimedServerOutput tx)
ApiClientMessage (ClientMessage tx)
ApiGreetings (Greetings tx)
ApiInvalidInput InvalidInput

Instances details

IsChainState tx => FromJSON (AllPossibleAPIMessages tx) Source #
Instance details Defined in Hydra.Client Methods parseJSON :: Value -> Parser (AllPossibleAPIMessages tx) parseJSONList :: Value -> Parser [AllPossibleAPIMessages tx] omittedField :: Maybe (AllPossibleAPIMessages tx)
IsChainState tx => Show (AllPossibleAPIMessages tx) Source #
Instance details Defined in Hydra.Client Methods showsPrec :: Int -> AllPossibleAPIMessages tx -> ShowS Source # show :: AllPossibleAPIMessages tx -> String Source # showList :: [AllPossibleAPIMessages tx] -> ShowS Source #
IsChainState tx => Eq (AllPossibleAPIMessages tx) Source #
Instance details Defined in Hydra.Client Methods (==) :: AllPossibleAPIMessages tx -> AllPossibleAPIMessages tx -> Bool Source # (/=) :: AllPossibleAPIMessages tx -> AllPossibleAPIMessages tx -> Bool Source #

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 () recoverCommit :: TxId -> 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 :: forall tx a. IsChainState 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.20.0-1niWKpadJVK6QwtZePrL7" '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)))