Safe Haskell	None
Language	Haskell2010

Cardano.Node.Types

Contents

Effects
Config types

Description

This module exports data types for logging, events and configuration

Synopsis

type ChainSyncHandle = Either (ChainSyncHandle Block) (ChainSyncHandle ChainSyncEvent)
data PABServerConfig = PABServerConfig {
- pscNodeServerConfig :: NodeServerConfig
- pscPassphrase :: Maybe Text
- pscNodeMode :: NodeMode
}
data NodeMode
- = MockNode
- | AlonzoNode
- | NoChainSyncEvents
_MockNode :: Prism' NodeMode ()
_AlonzoNode :: Prism' NodeMode ()

Effects

type ChainSyncHandle = Either (ChainSyncHandle Block) (ChainSyncHandle ChainSyncEvent) Source #

The types of handles varies based on the type of clients (mocked or real nodes) and we need a generic way of handling either type of response.

Config types

data PABServerConfig Source #

Node server configuration

Constructors

PABServerConfig
Fields pscNodeServerConfig :: NodeServerConfig Path to a JSON file containing the protocol parameters pscPassphrase :: Maybe Text Wallet passphrase pscNodeMode :: NodeMode Whether to connect to an Alonzo node or a mock node

Instances

Instances details

Eq PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods (==) :: PABServerConfig -> PABServerConfig -> Bool Source # (/=) :: PABServerConfig -> PABServerConfig -> Bool Source #
Show PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> PABServerConfig -> ShowS Source # show :: PABServerConfig -> String Source # showList :: [PABServerConfig] -> ShowS Source #
Generic PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Associated Types type Rep PABServerConfig :: Type -> Type Source # Methods from :: PABServerConfig -> Rep PABServerConfig x Source # to :: Rep PABServerConfig x -> PABServerConfig Source #
Default PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods def :: PABServerConfig
FromJSON PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser PABServerConfig parseJSONList :: Value -> Parser [PABServerConfig]
Pretty PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods pretty :: PABServerConfig -> Doc ann prettyList :: [PABServerConfig] -> Doc ann
ToJSON PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: PABServerConfig -> Value toEncoding :: PABServerConfig -> Encoding toJSONList :: [PABServerConfig] -> Value toEncodingList :: [PABServerConfig] -> Encoding
type Rep PABServerConfig Source #
Instance details Defined in Cardano.Node.Types type Rep PABServerConfig = D1 ('MetaData "PABServerConfig" "Cardano.Node.Types" "plutus-pab-1.2.0.0-LtxAAjtTYeqGloVmBPlsYv" 'False) (C1 ('MetaCons "PABServerConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pscNodeServerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeServerConfig) :: (S1 ('MetaSel ('Just "pscPassphrase") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "pscNodeMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 NodeMode))))

data NodeMode Source #

Which node we're connecting to

Constructors

MockNode	Connect to the PAB mock node.
AlonzoNode	Connect to an Alonzo node
NoChainSyncEvents	Do not connect to any node for chain sync events. Connect to Alonzo node for slot notifications.

Instances

Instances details

Eq NodeMode Source #
Instance details Defined in Cardano.Node.Types Methods (==) :: NodeMode -> NodeMode -> Bool Source # (/=) :: NodeMode -> NodeMode -> Bool Source #
Show NodeMode Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeMode -> ShowS Source # show :: NodeMode -> String Source # showList :: [NodeMode] -> ShowS Source #
Generic NodeMode Source #
Instance details Defined in Cardano.Node.Types Associated Types type Rep NodeMode :: Type -> Type Source # Methods from :: NodeMode -> Rep NodeMode x Source # to :: Rep NodeMode x -> NodeMode Source #
FromJSON NodeMode Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser NodeMode parseJSONList :: Value -> Parser [NodeMode]
ToJSON NodeMode Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: NodeMode -> Value toEncoding :: NodeMode -> Encoding toJSONList :: [NodeMode] -> Value toEncodingList :: [NodeMode] -> Encoding
type Rep NodeMode Source #
Instance details Defined in Cardano.Node.Types type Rep NodeMode = D1 ('MetaData "NodeMode" "Cardano.Node.Types" "plutus-pab-1.2.0.0-LtxAAjtTYeqGloVmBPlsYv" 'False) (C1 ('MetaCons "MockNode" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AlonzoNode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NoChainSyncEvents" 'PrefixI 'False) (U1 :: Type -> Type)))

_MockNode :: Prism' NodeMode () Source #

_AlonzoNode :: Prism' NodeMode () Source #