-
Notifications
You must be signed in to change notification settings - Fork 213
/
App.hs
311 lines (282 loc) · 14.1 KB
/
App.hs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DerivingStrategies #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE PartialTypeSignatures #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeOperators #-}
{-# OPTIONS_GHC -fno-warn-partial-type-signatures #-}
module Plutus.PAB.App(
App,
runApp,
AppEnv(..),
StorageBackend(..),
-- * App actions
migrate,
dbConnect,
handleContractDefinition
) where
import Cardano.Api.NetworkId.Extra (NetworkIdWrapper (NetworkIdWrapper))
import Cardano.Api.ProtocolParameters ()
import Cardano.Api.Shelley (ProtocolParameters)
import Cardano.BM.Trace (Trace, logDebug)
import Cardano.ChainIndex.Types qualified as ChainIndex
import Cardano.Node.Client (handleNodeClientClient)
import Cardano.Node.Types (ChainSyncHandle, NodeMode (AlonzoNode, MockNode),
PABServerConfig (PABServerConfig, pscBaseUrl, pscNetworkId, pscNodeMode, pscProtocolParametersJsonPath, pscSlotConfig, pscSocketPath))
import Cardano.Protocol.Socket.Mock.Client qualified as MockClient
import Cardano.Wallet.LocalClient qualified as LocalWalletClient
import Cardano.Wallet.Mock.Client qualified as WalletMockClient
import Cardano.Wallet.RemoteClient qualified as RemoteWalletClient
import Cardano.Wallet.Types qualified as Wallet
import Control.Concurrent.STM qualified as STM
import Control.Lens (preview)
import Control.Monad.Freer (Eff, LastMember, Member, interpret, reinterpret, reinterpret2, reinterpretN, type (~>))
import Control.Monad.Freer.Error (Error, handleError, throwError)
import Control.Monad.Freer.Extras.Beam (handleBeam)
import Control.Monad.Freer.Extras.Log (LogMsg, mapLog)
import Control.Monad.Freer.Reader (Reader, ask, runReader)
import Control.Monad.IO.Class (MonadIO (liftIO))
import Data.Aeson (FromJSON, ToJSON, eitherDecode)
import Data.ByteString.Lazy qualified as BSL
import Data.Coerce (coerce)
import Data.Default (def)
import Data.Text (Text, pack, unpack)
import Data.Typeable (Typeable)
import Database.Beam.Migrate.Simple (autoMigrate)
import Database.Beam.Sqlite qualified as Sqlite
import Database.Beam.Sqlite.Migrate qualified as Sqlite
import Database.SQLite.Simple (open)
import Database.SQLite.Simple qualified as Sqlite
import Network.HTTP.Client (managerModifyRequest, newManager, setRequestIgnoreStatus)
import Network.HTTP.Client.TLS (tlsManagerSettings)
import Plutus.ChainIndex.Client qualified as ChainIndex
import Plutus.PAB.Core (EffectHandlers (EffectHandlers), PABAction)
import Plutus.PAB.Core qualified as Core
import Plutus.PAB.Core.ContractInstance.BlockchainEnv qualified as BlockchainEnv
import Plutus.PAB.Core.ContractInstance.STM as Instances (InstancesState, emptyInstancesState)
import Plutus.PAB.Db.Beam.ContractStore qualified as BeamEff
import Plutus.PAB.Db.Memory.ContractStore (InMemInstances, initialInMemInstances)
import Plutus.PAB.Db.Memory.ContractStore qualified as InMem
import Plutus.PAB.Db.Schema (checkedSqliteDb)
import Plutus.PAB.Effects.Contract (ContractDefinition (AddDefinition, GetDefinitions))
import Plutus.PAB.Effects.Contract.Builtin (Builtin, BuiltinHandler (BuiltinHandler, contractHandler),
HasDefinitions (getDefinitions))
import Plutus.PAB.Monitoring.Monitoring (convertLog, handleLogMsgTrace)
import Plutus.PAB.Monitoring.PABLogMsg (PABLogMsg (SMultiAgent), PABMultiAgentMsg (BeamLogItem, UserLog, WalletClient),
WalletClientMsg)
import Plutus.PAB.Timeout (Timeout (Timeout))
import Plutus.PAB.Types (Config (Config), DbConfig (DbConfig, dbConfigFile),
DevelopmentOptions (DevelopmentOptions, pabResumeFrom, pabRollbackHistory),
PABError (BeamEffectError, ChainIndexError, NodeClientError, RemoteWalletWithMockNodeError, WalletClientError, WalletError),
WebserverConfig (WebserverConfig), chainIndexConfig, dbConfig, developmentOptions,
endpointTimeout, nodeServerConfig, pabWebserverConfig, walletServerConfig)
import Servant.Client (ClientEnv, ClientError, mkClientEnv)
import Wallet.Effects (WalletEffect)
import Wallet.Emulator.Wallet (Wallet)
import Wallet.Error (WalletAPIError)
import Wallet.Types (ContractInstanceId)
------------------------------------------------------------
-- | Application environment with a contract type `a`.
data AppEnv a =
AppEnv
{ dbConnection :: Sqlite.Connection
, walletClientEnv :: Maybe ClientEnv -- ^ No 'ClientEnv' when in the remote client setting.
, nodeClientEnv :: ClientEnv
, chainIndexEnv :: ClientEnv
, txSendHandle :: MockClient.TxSendHandle
, chainSyncHandle :: ChainSyncHandle
, appConfig :: Config
, appTrace :: Trace IO (PABLogMsg (Builtin a))
, appInMemContractStore :: InMemInstances (Builtin a)
, protocolParameters :: ProtocolParameters
}
appEffectHandlers
:: forall a.
( FromJSON a
, ToJSON a
, HasDefinitions a
, Typeable a
)
=> StorageBackend
-> Config
-> Trace IO (PABLogMsg (Builtin a))
-> BuiltinHandler a
-> EffectHandlers (Builtin a) (AppEnv a)
appEffectHandlers storageBackend config trace BuiltinHandler{contractHandler} =
EffectHandlers
{ initialiseEnvironment = do
env <- liftIO $ mkEnv trace config
let Config { nodeServerConfig = PABServerConfig{pscSocketPath, pscSlotConfig, pscNodeMode, pscNetworkId = NetworkIdWrapper networkId}
, developmentOptions = DevelopmentOptions{pabRollbackHistory, pabResumeFrom} } = config
instancesState <- liftIO $ STM.atomically Instances.emptyInstancesState
blockchainEnv <- liftIO $ BlockchainEnv.startNodeClient pscSocketPath pscNodeMode pabRollbackHistory pscSlotConfig networkId pabResumeFrom instancesState
pure (instancesState, blockchainEnv, env)
, handleLogMessages =
interpret (handleLogMsgTrace trace)
. reinterpret (mapLog SMultiAgent)
, handleContractEffect =
interpret (handleLogMsgTrace trace)
. reinterpret contractHandler
, handleContractStoreEffect =
case storageBackend of
InMemoryBackend ->
interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. interpret (Core.handleMappedReader @(AppEnv a) appInMemContractStore)
. reinterpret2 InMem.handleContractStore
BeamSqliteBackend ->
interpret (handleLogMsgTrace trace)
. reinterpret (mapLog @_ @(PABLogMsg (Builtin a)) SMultiAgent)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. interpret (Core.handleMappedReader @(AppEnv a) dbConnection)
. flip handleError (throwError . BeamEffectError)
. interpret (handleBeam (convertLog (SMultiAgent . BeamLogItem) trace))
. reinterpretN @'[_, _, _, _, _] BeamEff.handleContractStore
, handleContractDefinitionEffect =
interpret (handleLogMsgTrace trace)
. reinterpret (mapLog @_ @(PABLogMsg (Builtin a)) SMultiAgent)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. interpret (Core.handleMappedReader @(AppEnv a) dbConnection)
. flip handleError (throwError . BeamEffectError)
. interpret (handleBeam (convertLog (SMultiAgent . BeamLogItem) trace))
. reinterpretN @'[_, _, _, _, _] handleContractDefinition
, handleServicesEffects = \wallet cidM -> do
-- handle 'NodeClientEffect'
flip handleError (throwError . NodeClientError)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. reinterpret (Core.handleMappedReader @(AppEnv a) @ChainSyncHandle chainSyncHandle)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. reinterpret (Core.handleMappedReader @(AppEnv a) @MockClient.TxSendHandle txSendHandle)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. reinterpret (Core.handleMappedReader @(AppEnv a) @ClientEnv nodeClientEnv)
. reinterpretN @'[_, _, _, _] (handleNodeClientClient @IO $ pscSlotConfig $ nodeServerConfig config)
-- handle 'ChainIndexEffect'
. flip handleError (throwError . ChainIndexError)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. reinterpret (Core.handleMappedReader @(AppEnv a) @ClientEnv chainIndexEnv)
. reinterpret2 (ChainIndex.handleChainIndexClient @IO)
-- handle 'WalletEffect'
. flip handleError (throwError . WalletClientError)
. flip handleError (throwError . WalletError)
. interpret (mapLog @_ @(PABMultiAgentMsg (Builtin a)) WalletClient)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. reinterpret (Core.handleMappedReader @(AppEnv a) @(Maybe ClientEnv) walletClientEnv)
. interpret (Core.handleUserEnvReader @(Builtin a) @(AppEnv a))
. reinterpret (Core.handleMappedReader @(AppEnv a) @ProtocolParameters protocolParameters)
. interpret (Core.handleInstancesStateReader @(Builtin a) @(AppEnv a))
. reinterpretN @'[_, _, _, _, _, _] (handleWalletEffect (nodeServerConfig config) cidM wallet)
, onStartup = pure ()
, onShutdown = pure ()
}
handleWalletEffect
:: forall effs.
( LastMember IO effs
, Member (Error ClientError) effs
, Member (Error WalletAPIError) effs
, Member (Error PABError) effs
, Member (Reader (Maybe ClientEnv)) effs
, Member (Reader ProtocolParameters) effs
, Member (LogMsg WalletClientMsg) effs
, Member (Reader InstancesState) effs
)
=> PABServerConfig
-> Maybe ContractInstanceId
-> Wallet
-> WalletEffect
~> Eff effs
handleWalletEffect PABServerConfig { pscNodeMode = MockNode } _ w eff = do
clientEnvM <- ask @(Maybe ClientEnv)
case clientEnvM of
Nothing -> throwError RemoteWalletWithMockNodeError
Just clientEnv ->
runReader clientEnv $ WalletMockClient.handleWalletClient @IO w eff
handleWalletEffect nodeCfg@PABServerConfig { pscNodeMode = AlonzoNode } cidM w eff = do
clientEnvM <- ask @(Maybe ClientEnv)
case clientEnvM of
Nothing -> RemoteWalletClient.handleWalletClient nodeCfg cidM eff
Just clientEnv ->
runReader clientEnv $ LocalWalletClient.handleWalletClient @IO nodeCfg w eff
runApp ::
forall a b.
( FromJSON a
, ToJSON a
, HasDefinitions a
, Typeable a
)
=> StorageBackend
-> Trace IO (PABLogMsg (Builtin a)) -- ^ Top-level tracer
-> BuiltinHandler a
-> Config -- ^ Client configuration
-> App a b -- ^ Action
-> IO (Either PABError b)
runApp
storageBackend
trace
contractHandler
config@Config{pabWebserverConfig=WebserverConfig{endpointTimeout}} =
Core.runPAB (Timeout endpointTimeout) (appEffectHandlers storageBackend config trace contractHandler)
type App a b = PABAction (Builtin a) (AppEnv a) b
data StorageBackend = BeamSqliteBackend | InMemoryBackend
deriving (Eq, Ord, Show)
mkEnv :: Trace IO (PABLogMsg (Builtin a)) -> Config -> IO (AppEnv a)
mkEnv appTrace appConfig@Config { dbConfig
, nodeServerConfig = PABServerConfig{pscBaseUrl, pscSocketPath, pscSlotConfig, pscProtocolParametersJsonPath}
, walletServerConfig
, chainIndexConfig
} = do
walletClientEnv <- maybe (pure Nothing) (fmap Just . clientEnv) $ preview Wallet._LocalWalletConfig walletServerConfig
nodeClientEnv <- clientEnv pscBaseUrl
chainIndexEnv <- clientEnv (ChainIndex.ciBaseUrl chainIndexConfig)
dbConnection <- dbConnect appTrace dbConfig
txSendHandle <- liftIO $ MockClient.runTxSender pscSocketPath
-- This is for access to the slot number in the interpreter
chainSyncHandle <- Left <$> (liftIO $ MockClient.runChainSync' pscSocketPath pscSlotConfig)
appInMemContractStore <- liftIO initialInMemInstances
protocolParameters <- maybe (pure def) readPP pscProtocolParametersJsonPath
pure AppEnv {..}
where
clientEnv baseUrl = mkClientEnv <$> liftIO mkManager <*> pure (coerce baseUrl)
mkManager =
newManager $
tlsManagerSettings {managerModifyRequest = pure . setRequestIgnoreStatus}
readPP path = do
bs <- BSL.readFile path
case eitherDecode bs of
Left err -> error $ "Error reading protocol parameters JSON file: "
++ show pscProtocolParametersJsonPath ++ " (" ++ err ++ ")"
Right params -> pure params
logDebugString :: Trace IO (PABLogMsg t) -> Text -> IO ()
logDebugString trace = logDebug trace . SMultiAgent . UserLog
-- | Initialize/update the database to hold our effects.
migrate :: Trace IO (PABLogMsg (Builtin a)) -> DbConfig -> IO ()
migrate trace config = do
connection <- dbConnect trace config
logDebugString trace "Running beam migration"
runBeamMigration trace connection
runBeamMigration
:: Trace IO (PABLogMsg (Builtin a))
-> Sqlite.Connection
-> IO ()
runBeamMigration trace conn = Sqlite.runBeamSqliteDebug (logDebugString trace . pack) conn $ do
autoMigrate Sqlite.migrationBackend checkedSqliteDb
-- | Connect to the database.
dbConnect :: Trace IO (PABLogMsg (Builtin a)) -> DbConfig -> IO Sqlite.Connection
dbConnect trace DbConfig {dbConfigFile} = do
logDebugString trace $ "Connecting to DB: " <> dbConfigFile
open (unpack dbConfigFile)
handleContractDefinition ::
forall a effs. HasDefinitions a
=> ContractDefinition (Builtin a)
~> Eff effs
handleContractDefinition = \case
AddDefinition _ -> pure ()
GetDefinitions -> pure getDefinitions