Safe Haskell	None
Language	Haskell2010

Cardano.Node.Types

Contents

Logging types
Event types
Effects
State types
Lens functions
Config types
newtype wrappers

Description

This module exports data types for logging, events and configuration

Synopsis

data PABServerLogMsg
- = StartingSlotCoordination UTCTime Millisecond
- | NoRandomTxGeneration
- | StartingRandomTx
- | KeepingOldBlocks
- | RemovingOldBlocks
- | StartingPABServer Int
- | ProcessingChainEvent ChainEvent
- | BlockOperation BlockEvent
- | CreatingRandomTransaction
- | TxSendCalledWithoutMock
data BlockEvent
- = NewSlot
- | NewTransaction ( Tx BabbageEra )
type NodeServerEffects m = '[ ChainControlEffect , ChainEffect , State MockNodeServerChainState , LogMsg PABServerLogMsg , Reader ( Maybe TxSendHandle ), State AppState , LogMsg PABServerLogMsg , m]
type ChainSyncHandle = Either ( ChainSyncHandle Block) ( ChainSyncHandle ChainSyncEvent )
data AppState = AppState {
- _chainState :: MockNodeServerChainState
- _eventHistory :: [ LogMessage PABServerLogMsg ]
}
initialAppState :: MonadIO m => [Wallet] -> m AppState
initialChainState :: MonadIO m => InitialDistribution -> m MockNodeServerChainState
chainState :: Lens' AppState MockNodeServerChainState
eventHistory :: Lens' AppState [ LogMessage PABServerLogMsg ]
data PABServerConfig = PABServerConfig {
- pscBaseUrl :: BaseUrl
- pscInitialTxWallets :: [WalletNumber]
- pscSocketPath :: FilePath
- pscKeptBlocks :: Integer
- pscSlotConfig :: SlotConfig
- pscNetworkId :: NetworkIdWrapper
- pscProtocolParametersJsonPath :: Maybe FilePath
- pscPassphrase :: Maybe Text
- pscNodeMode :: NodeMode
}
data NodeMode
- = MockNode
- | AlonzoNode
- | NoChainSyncEvents
_MockNode :: Prism' NodeMode ()
_AlonzoNode :: Prism' NodeMode ()
newtype NodeUrl = NodeUrl BaseUrl

Logging types

data PABServerLogMsg Source #

Top-level logging data type for structural logging inside the PAB server.

Constructors

StartingSlotCoordination UTCTime Millisecond
NoRandomTxGeneration
StartingRandomTx
KeepingOldBlocks
RemovingOldBlocks
StartingPABServer Int
ProcessingChainEvent ChainEvent
BlockOperation BlockEvent
CreatingRandomTransaction
TxSendCalledWithoutMock

Instances

Instances details

Show PABServerLogMsg Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> PABServerLogMsg -> ShowS Source # show :: PABServerLogMsg -> String Source # showList :: [ PABServerLogMsg ] -> ShowS Source #
Generic PABServerLogMsg Source #
Instance details Defined in Cardano.Node.Types Associated Types type Rep PABServerLogMsg :: Type -> Type Source # Methods from :: PABServerLogMsg -> Rep PABServerLogMsg x Source # to :: Rep PABServerLogMsg x -> PABServerLogMsg Source #
ToJSON PABServerLogMsg Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: PABServerLogMsg -> Value Source # toEncoding :: PABServerLogMsg -> Encoding Source # toJSONList :: [ PABServerLogMsg ] -> Value Source # toEncodingList :: [ PABServerLogMsg ] -> Encoding Source #
FromJSON PABServerLogMsg Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser PABServerLogMsg Source # parseJSONList :: Value -> Parser [ PABServerLogMsg ] Source #
Pretty PABServerLogMsg Source #
Instance details Defined in Cardano.Node.Types Methods pretty :: PABServerLogMsg -> Doc ann Source # prettyList :: [ PABServerLogMsg ] -> Doc ann Source #
ToObject PABServerLogMsg Source #
Instance details Defined in Cardano.Node.Types Methods toObject :: TracingVerbosity -> PABServerLogMsg -> Object textTransformer :: PABServerLogMsg -> Object -> Text
type Rep PABServerLogMsg Source #
Instance details Defined in Cardano.Node.Types type Rep PABServerLogMsg = D1 (' MetaData "PABServerLogMsg" "Cardano.Node.Types" "plutus-pab-1.2.0.0-CtfsFiD4ohhEkbPm9mkCAB" ' False ) ((( C1 (' MetaCons "StartingSlotCoordination" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 UTCTime ) :*: S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 Millisecond )) :+: C1 (' MetaCons "NoRandomTxGeneration" ' PrefixI ' False ) ( U1 :: Type -> Type )) :+: ( C1 (' MetaCons "StartingRandomTx" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: ( C1 (' MetaCons "KeepingOldBlocks" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "RemovingOldBlocks" ' PrefixI ' False ) ( U1 :: Type -> Type )))) :+: (( C1 (' MetaCons "StartingPABServer" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 Int )) :+: C1 (' MetaCons "ProcessingChainEvent" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 ChainEvent ))) :+: ( C1 (' MetaCons "BlockOperation" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 BlockEvent )) :+: ( C1 (' MetaCons "CreatingRandomTransaction" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "TxSendCalledWithoutMock" ' PrefixI ' False ) ( U1 :: Type -> Type )))))

Event types

data BlockEvent Source #

Constructors

NewSlot
NewTransaction ( Tx BabbageEra )

Instances

Instances details

Show BlockEvent Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> BlockEvent -> ShowS Source # show :: BlockEvent -> String Source # showList :: [ BlockEvent ] -> ShowS Source #
Generic BlockEvent Source #
Instance details Defined in Cardano.Node.Types Associated Types type Rep BlockEvent :: Type -> Type Source # Methods from :: BlockEvent -> Rep BlockEvent x Source # to :: Rep BlockEvent x -> BlockEvent Source #
ToJSON BlockEvent Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: BlockEvent -> Value Source # toEncoding :: BlockEvent -> Encoding Source # toJSONList :: [ BlockEvent ] -> Value Source # toEncodingList :: [ BlockEvent ] -> Encoding Source #
FromJSON BlockEvent Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser BlockEvent Source # parseJSONList :: Value -> Parser [ BlockEvent ] Source #
Pretty BlockEvent Source #
Instance details Defined in Cardano.Node.Types Methods pretty :: BlockEvent -> Doc ann Source # prettyList :: [ BlockEvent ] -> Doc ann Source #
type Rep BlockEvent Source #
Instance details Defined in Cardano.Node.Types type Rep BlockEvent = D1 (' MetaData "BlockEvent" "Cardano.Node.Types" "plutus-pab-1.2.0.0-CtfsFiD4ohhEkbPm9mkCAB" ' False ) ( C1 (' MetaCons "NewSlot" ' PrefixI ' False ) ( U1 :: Type -> Type ) :+: C1 (' MetaCons "NewTransaction" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 ( Tx BabbageEra ))))

Effects

type NodeServerEffects m = '[ ChainControlEffect , ChainEffect , State MockNodeServerChainState , LogMsg PABServerLogMsg , Reader ( Maybe TxSendHandle ), State AppState , LogMsg PABServerLogMsg , m] Source #

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.

State types

data AppState Source #

Application State

Constructors

AppState
Fields _chainState :: MockNodeServerChainState blockchain state _eventHistory :: [ LogMessage PABServerLogMsg ] history of all log messages

Instances

Instances details

Show AppState Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> AppState -> ShowS Source # show :: AppState -> String Source # showList :: [ AppState ] -> ShowS Source #

initialAppState :: MonadIO m => [Wallet] -> m AppState Source #

AppState with an initial transaction that pays some Ada to the wallets.

initialChainState :: MonadIO m => InitialDistribution -> m MockNodeServerChainState Source #

ChainState with initial values

Lens functions

chainState :: Lens' AppState MockNodeServerChainState Source #

eventHistory :: Lens' AppState [ LogMessage PABServerLogMsg ] Source #

Config types

data PABServerConfig Source #

Node server configuration

Constructors

PABServerConfig

Fields

pscBaseUrl :: BaseUrl

base url of the service
pscInitialTxWallets :: [WalletNumber]

The wallets that receive money from the initial transaction.
pscSocketPath :: FilePath

Path to the socket used to communicate with the server.
pscKeptBlocks :: Integer

The number of blocks to keep for replaying to a newly connected clients
pscSlotConfig :: SlotConfig

Beginning of slot 0.
pscNetworkId :: NetworkIdWrapper

NetworkId that's used with the CardanoAPI.
pscProtocolParametersJsonPath :: Maybe FilePath

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 #
ToJSON PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: PABServerConfig -> Value Source # toEncoding :: PABServerConfig -> Encoding Source # toJSONList :: [ PABServerConfig ] -> Value Source # toEncodingList :: [ PABServerConfig ] -> Encoding Source #
FromJSON PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser PABServerConfig Source # parseJSONList :: Value -> Parser [ PABServerConfig ] Source #
Default PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods def :: PABServerConfig Source #
Pretty PABServerConfig Source #
Instance details Defined in Cardano.Node.Types Methods pretty :: PABServerConfig -> Doc ann Source # prettyList :: [ PABServerConfig ] -> Doc ann Source #
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-CtfsFiD4ohhEkbPm9mkCAB" ' False ) ( C1 (' MetaCons "PABServerConfig" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "pscBaseUrl") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 BaseUrl ) :: S1 (' MetaSel (' Just "pscInitialTxWallets") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 [WalletNumber])) :: ( S1 (' MetaSel (' Just "pscSocketPath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 FilePath ) :: S1 (' MetaSel (' Just "pscKeptBlocks") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 Integer ))) :: (( S1 (' MetaSel (' Just "pscSlotConfig") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 SlotConfig ) :: S1 (' MetaSel (' Just "pscNetworkId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 NetworkIdWrapper )) :: ( S1 (' MetaSel (' Just "pscProtocolParametersJsonPath") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedStrict ) ( Rec0 ( Maybe FilePath )) :: ( 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 #
ToJSON NodeMode Source #
Instance details Defined in Cardano.Node.Types Methods toJSON :: NodeMode -> Value Source # toEncoding :: NodeMode -> Encoding Source # toJSONList :: [ NodeMode ] -> Value Source # toEncodingList :: [ NodeMode ] -> Encoding Source #
FromJSON NodeMode Source #
Instance details Defined in Cardano.Node.Types Methods parseJSON :: Value -> Parser NodeMode Source # parseJSONList :: Value -> Parser [ NodeMode ] Source #
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-CtfsFiD4ohhEkbPm9mkCAB" ' 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 #

newtype wrappers

newtype NodeUrl Source #

Constructors

NodeUrl BaseUrl

Instances

Instances details

Eq NodeUrl Source #
Instance details Defined in Cardano.Node.Types Methods (==) :: NodeUrl -> NodeUrl -> Bool Source # (/=) :: NodeUrl -> NodeUrl -> Bool Source #
Show NodeUrl Source #
Instance details Defined in Cardano.Node.Types Methods showsPrec :: Int -> NodeUrl -> ShowS Source # show :: NodeUrl -> String Source # showList :: [ NodeUrl ] -> ShowS Source #