-
Notifications
You must be signed in to change notification settings - Fork 721
/
Query.hs
261 lines (223 loc) · 10.1 KB
/
Query.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
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
-- | Convenience query functions
--
module Cardano.Api.Convenience.Query (
QueryConvenienceError(..),
determineEra,
determineEra_,
-- * Simplest query related
executeQueryCardanoMode,
queryStateForBalancedTx,
queryStateForBalancedTx_,
queryUtxo_,
queryProtocolParams_,
queryEraHistory_,
queryStakePools_,
querySystemStart_,
handleQueryConvenienceErrors_,
renderQueryConvenienceError,
) where
import Prelude
import qualified Control.Monad.Oops as OO
import Control.Monad.Trans.Class (lift)
import Control.Monad.Trans.Except (ExceptT (..), except, runExceptT)
import Control.Monad.Trans.Except.Extra (firstExceptT, hoistMaybe, left)
import Data.Bifunctor (first)
import Data.Function ((&))
import Data.Set (Set)
import qualified Data.Set as Set
import Data.Text (Text)
import Ouroboros.Consensus.HardFork.Combinator.AcrossEras (EraMismatch (..))
import Cardano.Api.Certificate
import Cardano.Api.Convenience.Constraints
import Cardano.Api.Environment
import Cardano.Api.Eras
import Cardano.Api.IPC
import Cardano.Api.IPC.Monad (LocalStateQueryExpr, executeLocalStateQueryExpr_,
queryExpr_)
import Cardano.Api.Modes
import Cardano.Api.NetworkId
import Cardano.Api.ProtocolParameters
import Cardano.Api.Query
import Cardano.Api.TxBody
import Cardano.Api.Utils
data QueryConvenienceError
= AcqFailure AcquiringFailure
| SockErr EnvSocketError
| QueryEraMismatch EraMismatch
| ByronEraNotSupported
| EraConsensusModeMismatch !AnyConsensusMode !AnyCardanoEra
| QueryConvenienceUnsupportedNodeToClientVersion !UnsupportedNtcVersionError
renderQueryConvenienceError :: QueryConvenienceError -> Text
renderQueryConvenienceError (AcqFailure e) =
"Acquiring failure: " <> textShow e
renderQueryConvenienceError (SockErr e) =
renderEnvSocketError e
renderQueryConvenienceError (QueryEraMismatch (EraMismatch ledgerEraName' otherEraName')) =
"The era of the node and the tx do not match. " <>
"The node is running in the " <> ledgerEraName' <>
" era, but the transaction is for the " <> otherEraName' <> " era."
renderQueryConvenienceError ByronEraNotSupported =
"Byron era not supported"
renderQueryConvenienceError (EraConsensusModeMismatch cMode anyCEra) =
"Consensus mode and era mismatch. Consensus mode: " <> textShow cMode <>
" Era: " <> textShow anyCEra
renderQueryConvenienceError (QueryConvenienceUnsupportedNodeToClientVersion
(UnsupportedNtcVersionError minNodeToClientVersion nodeToClientVersion)) =
"Unsupported Node to Client version: " <> textShow minNodeToClientVersion <> " " <> textShow nodeToClientVersion
handleQueryConvenienceErrors_ :: ()
=> Monad m
=> OO.CouldBeF e QueryConvenienceError
=> ExceptT (OO.Variant (EraMismatch : AcquireFailure : UnsupportedNtcVersionError : e)) m a
-> ExceptT (OO.Variant e) m a
handleQueryConvenienceErrors_ f = f
& OO.catch @EraMismatch (OO.throw . QueryEraMismatch)
& OO.catch @AcquireFailure (OO.throw . AcqFailure . toAcquiringFailure)
& OO.catch @UnsupportedNtcVersionError (OO.throw . QueryConvenienceUnsupportedNodeToClientVersion)
queryUtxo_ :: ()
=> OO.CouldBeF e UnsupportedNtcVersionError
=> OO.CouldBeF e EraMismatch
=> EraInMode era mode
-> ShelleyBasedEra era
-> [TxIn]
-> ExceptT (OO.Variant e) (LocalStateQueryExpr block point (QueryInMode mode) r IO) (UTxO era)
queryUtxo_ qeInMode qSbe allTxIns = do
let query = QueryInEra qeInMode $ QueryInShelleyBasedEra qSbe $
QueryUTxO (QueryUTxOByTxIn (Set.fromList allTxIns))
queryExpr_ query & OO.onLeft @EraMismatch OO.throw
queryProtocolParams_ :: ()
=> OO.CouldBeF e UnsupportedNtcVersionError
=> OO.CouldBeF e EraMismatch
=> EraInMode era mode
-> ShelleyBasedEra era
-> ExceptT (OO.Variant e) (LocalStateQueryExpr block point (QueryInMode mode) r IO) ProtocolParameters
queryProtocolParams_ qeInMode qSbe = do
let query = QueryInEra qeInMode $ QueryInShelleyBasedEra qSbe QueryProtocolParameters
queryExpr_ query & OO.onLeft @EraMismatch OO.throw
queryEraHistory_ :: ()
=> OO.CouldBeF e UnsupportedNtcVersionError
=> ExceptT (OO.Variant e) (LocalStateQueryExpr block point (QueryInMode CardanoMode) r IO) (EraHistory CardanoMode)
queryEraHistory_ = do
let query = QueryEraHistory CardanoModeIsMultiEra
queryExpr_ query
queryStakePools_ :: ()
=> OO.CouldBeF e UnsupportedNtcVersionError
=> OO.CouldBeF e QueryConvenienceError
=> EraInMode era mode
-> ShelleyBasedEra era
-> ExceptT (OO.Variant e) (LocalStateQueryExpr block point (QueryInMode mode) r IO) (Set PoolId)
queryStakePools_ qeInMode qSbe = do
let query = QueryInEra qeInMode . QueryInShelleyBasedEra qSbe $ QueryStakePools
queryExpr_ query & OO.onLeft @EraMismatch (OO.throw . QueryEraMismatch)
querySystemStart_ :: ()
=> OO.CouldBeF e UnsupportedNtcVersionError
=> ExceptT (OO.Variant e) (LocalStateQueryExpr block point (QueryInMode mode) r IO) SystemStart
querySystemStart_ = queryExpr_ QuerySystemStart
-- | A convenience function to query the relevant information, from
-- the local node, for Cardano.Api.Convenience.Construction.constructBalancedTx
queryStateForBalancedTx
:: CardanoEra era
-> NetworkId
-> [TxIn]
-> IO (Either QueryConvenienceError (UTxO era, ProtocolParameters, EraHistory CardanoMode, SystemStart, Set PoolId))
queryStateForBalancedTx era networkId allTxIns = OO.runOopsInEither @QueryConvenienceError $ do
queryStateForBalancedTx_ era networkId allTxIns
& OO.catch @EraMismatch (OO.throw . QueryEraMismatch)
& OO.catch @AcquireFailure (OO.throw . AcqFailure . toAcquiringFailure)
& OO.catch @UnsupportedNtcVersionError (OO.throw . QueryConvenienceUnsupportedNodeToClientVersion)
-- | A convenience function to query the relevant information, from
-- the local node, for Cardano.Api.Convenience.Construction.constructBalancedTx
queryStateForBalancedTx_ :: ()
=> OO.CouldBeF es QueryConvenienceError
=> OO.CouldBeF es AcquireFailure
=> OO.CouldBeF es UnsupportedNtcVersionError
=> OO.CouldBeF es EraMismatch
=> CardanoEra era
-> NetworkId
-> [TxIn]
-> ExceptT (OO.Variant es) IO (UTxO era, ProtocolParameters, EraHistory CardanoMode, SystemStart, Set PoolId)
queryStateForBalancedTx_ era networkId allTxIns = do
SocketPath sockPath <- lift readEnvSocketPath & OO.onLeft (OO.throw . SockErr)
let cModeParams = CardanoModeParams $ EpochSlots 21600
let localNodeConnInfo = LocalNodeConnectInfo cModeParams networkId sockPath
qSbe <- getSbe (cardanoEraStyle era) & OO.hoistEither
qeInMode <- toEraInMode era CardanoMode
& OO.hoistMaybe (EraConsensusModeMismatch (AnyConsensusMode CardanoMode) (getIsCardanoEraConstraint era $ AnyCardanoEra era))
-- Query execution
executeLocalStateQueryExpr_ localNodeConnInfo Nothing $ do
utxo <- queryUtxo_ qeInMode qSbe allTxIns
pparams <- queryProtocolParams_ qeInMode qSbe
eraHistory <- queryEraHistory_
systemStart <- querySystemStart_
stakePools <- queryStakePools_ qeInMode qSbe
pure (utxo, pparams, eraHistory, systemStart, stakePools)
-- | Query the node to determine which era it is in.
determineEra
:: ConsensusModeParams mode
-> LocalNodeConnectInfo mode
-> IO (Either AcquiringFailure AnyCardanoEra)
determineEra cModeParams localNodeConnInfo =
case consensusModeOnly cModeParams of
ByronMode -> return . Right $ AnyCardanoEra ByronEra
ShelleyMode -> return . Right $ AnyCardanoEra ShelleyEra
CardanoMode ->
queryNodeLocalState localNodeConnInfo Nothing
$ QueryCurrentEra CardanoModeIsMultiEra
-- | Query the node to determine which era it is in.
determineEra_
:: forall e mode. ()
=> e `OO.CouldBe` AcquireFailure
=> ConsensusModeParams mode
-> LocalNodeConnectInfo mode
-> ExceptT (OO.Variant e) IO AnyCardanoEra
determineEra_ cModeParams localNodeConnInfo =
case consensusModeOnly cModeParams of
ByronMode -> pure $ AnyCardanoEra ByronEra
ShelleyMode -> pure $ AnyCardanoEra ShelleyEra
CardanoMode ->
queryNodeLocalState_ localNodeConnInfo Nothing
$ QueryCurrentEra CardanoModeIsMultiEra
getSbe :: CardanoEraStyle era -> Either QueryConvenienceError (ShelleyBasedEra era)
getSbe LegacyByronEra = Left ByronEraNotSupported
getSbe (ShelleyBasedEra sbe) = return sbe
-- | Execute a query against the local node. The local
-- node must be in CardanoMode.
executeQueryCardanoMode
:: CardanoEra era
-> NetworkId
-> QueryInMode CardanoMode (Either EraMismatch result)
-> IO (Either QueryConvenienceError result)
executeQueryCardanoMode era nid q = runExceptT $ do
SocketPath sockPath <- firstExceptT SockErr . ExceptT $ readEnvSocketPath
let localConnectInfo =
LocalNodeConnectInfo
{ localConsensusModeParams = CardanoModeParams (EpochSlots 21600)
, localNodeNetworkId = nid
, localNodeSocketPath = sockPath
}
ExceptT $ executeQueryAnyMode era localConnectInfo q
-- | Execute a query against the local node in any mode.
executeQueryAnyMode
:: forall result era mode. CardanoEra era
-> LocalNodeConnectInfo mode
-> QueryInMode mode (Either EraMismatch result)
-> IO (Either QueryConvenienceError result)
executeQueryAnyMode era localNodeConnInfo q = runExceptT $ do
let cMode = consensusModeOnly $ localConsensusModeParams localNodeConnInfo
eraInMode <- toEraInMode era cMode
& hoistMaybe (EraConsensusModeMismatch (AnyConsensusMode CardanoMode) (getIsCardanoEraConstraint era $ AnyCardanoEra era))
case eraInMode of
ByronEraInByronMode -> left ByronEraNotSupported
_ -> execQuery
where
execQuery :: ExceptT QueryConvenienceError IO result
execQuery = do
r <- OO.runOopsInExceptT @QueryConvenienceError $ do
queryNodeLocalState_ localNodeConnInfo Nothing q
& OO.catch @AcquireFailure (OO.throw . AcqFailure . toAcquiringFailure)
except $ first QueryEraMismatch r