-
Notifications
You must be signed in to change notification settings - Fork 213
/
api-bench.hs
592 lines (532 loc) · 18.3 KB
/
api-bench.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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{- |
Copyright: © 2023–2023 IOHK
This benchmark measures the running time of various functions from
the main module "Cardano.Wallet". The benchmark loads wallet states
from database files inside a given directory. These wallets are not
actively synchronized to the blockchain.
This benchmark design is useful for the following tasks:
* Compare the performance for wallet states with different ``shapes'',
e.g. wallets with many addresses and few UTxO, or vice-versa.
* Detect performance regressions or improvements as the codebase changes.
* Develop performance improvements, by enabling speedy testing of
hypotheses on the code. (In order to keep recompilation times
short, the benchmark exercises the "Cardano.Wallet" module,
but not the full HTTP endpoints.)
This benchmark is not so useful for the following tasks:
* Accurately measure the absolute running time for wallets of
realistic sizes. (Unless we generate a corresponding wallet state file.)
* Accurately measure the absolute running time of all HTTP API endpoints,
as this is at odds with the goal of allowing speedy hypothesis testing.
(We want the "Cardano.Wallet" module to faithfully represent the API
and expect that only a small cost of serializing/deserializing to/from JSON
is incurred comparing to the HTTP API.)
-}
module Main where
import Prelude
import Cardano.BM.Data.Severity
( Severity (..)
)
import Cardano.BM.Extra
( trMessageText
)
import Cardano.BM.Trace
( Trace
)
import Cardano.Wallet
( WalletLayer (..)
, readWalletMeta
)
import Cardano.Wallet.Address.Derivation
( DelegationAddress (..)
, Depth (..)
, delegationAddressS
)
import Cardano.Wallet.Address.Derivation.Shared
( SharedKey
)
import Cardano.Wallet.Address.Derivation.Shelley
( ShelleyKey
)
import Cardano.Wallet.Address.Discovery.Random
( RndState (..)
)
import Cardano.Wallet.Address.Discovery.Sequential
( SeqState (..)
)
import Cardano.Wallet.Address.Discovery.Shared
( SharedState (..)
)
import Cardano.Wallet.BenchShared
( Time
, bench
, initBenchmarkLogging
, runBenchmarks
)
import Cardano.Wallet.DB.Layer
( PersistAddressBook
)
import Cardano.Wallet.DummyTarget.Primitive.Types
( dummyNetworkLayer
, dummyNodeProtocolParameters
, dummyProtocolParameters
, dummySlottingParameters
, dummyTimeInterpreter
)
import Cardano.Wallet.Flavor
( KeyFlavor
, KeyOf
, WalletFlavor (..)
, keyFlavor
)
import Cardano.Wallet.Network
( NetworkLayer (..)
)
import Cardano.Wallet.Primitive.Model
( totalUTxO
)
import Cardano.Wallet.Primitive.NetworkId
( HasSNetworkId (..)
, NetworkDiscriminant (..)
, NetworkId (..)
, SNetworkId (..)
, networkIdVal
, withSNetworkId
)
import Cardano.Wallet.Primitive.Slotting
( TimeInterpreter
, hoistTimeInterpreter
)
import Cardano.Wallet.Primitive.Types
( SortOrder (..)
, WalletId
, WalletMetadata (..)
)
import Cardano.Wallet.Primitive.Types.Coin
( Coin (..)
)
import Cardano.Wallet.Primitive.Types.UTxOStatistics
( HistogramBar (..)
, UTxOStatistics (..)
)
import Cardano.Wallet.Shelley.Transaction
( newTransactionLayer
)
import Cardano.Wallet.Unsafe
( unsafeRunExceptT
)
import Control.Monad
( forM
)
import Control.Monad.IO.Class
( liftIO
)
import Data.Aeson
( ToJSON (..)
, genericToJSON
, (.=)
)
import Data.Quantity
( Quantity (..)
)
import Data.Text
( Text
)
import Fmt
( Buildable
, Builder
, blockListF'
, build
, genericF
, nameF
, pretty
)
import GHC.Generics
( Generic
)
import Main.Utf8
( withUtf8
)
import Numeric.Natural
( Natural
)
import Say
( sayErr
)
import qualified Cardano.Api as C
import qualified Cardano.Api as Cardano
import qualified Cardano.Wallet as W
import qualified Cardano.Wallet.DB as DB
import qualified Cardano.Wallet.DB.Layer as DB
import qualified Cardano.Wallet.DB.Layer as Sqlite
import qualified Cardano.Wallet.Primitive.Types.UTxOStatistics as UTxOStatistics
import qualified Cardano.Wallet.Read as Read
import qualified Cardano.Wallet.Transaction as Tx
import qualified Data.Aeson as Aeson
import qualified Data.Map.Strict as Map
import qualified Data.Text as T
import qualified Internal.Cardano.Write.Tx as Write
( MaybeInRecentEra (InRecentEraBabbage)
)
import qualified System.Environment as Sys
import qualified System.Exit as Sys
{-------------------------------------------------------------------------------
Main function
-------------------------------------------------------------------------------}
main :: IO ()
main = withUtf8 $ do
Sys.getArgs >>= \case
[] -> do
sayErr "expected 1 argument: directory with wallet database files"
Sys.exitFailure
(dir: _) -> benchmarkApi dir
benchmarkApi :: FilePath -> IO ()
benchmarkApi dir = do
(_, tr) <- initBenchmarkLogging "wallet" Notice
withSNetworkId (NTestnet 0) $ \networkId ->
runBenchmarks
[ benchmarkWallets "sequential"
dir tr networkId benchmarksSeq
, benchmarkWallets "shared"
dir tr networkId benchmarksShared
, benchmarkWallets "random"
dir tr networkId benchmarksRnd
]
{-------------------------------------------------------------------------------
Wallet API benchmarks
-------------------------------------------------------------------------------}
data WalletOverview = WalletOverview
{ utxo :: UTxOStatistics
, addresses :: Word
, transactions :: Word
} deriving (Show, Generic)
instance Buildable WalletOverview where
build WalletOverview{utxo,addresses,transactions} =
blockListF' "" id
[ nameF "number of addresses" (build addresses)
, nameF "number of transactions" (build transactions)
, build utxo
]
instance ToJSON WalletOverview where
toJSON WalletOverview{utxo,addresses,transactions} = Aeson.object
[ "utxo" .= jsonFromUTxOStatistics utxo
, "addresses" .= addresses
, "transactions" .= transactions
]
jsonFromUTxOStatistics :: UTxOStatistics -> Aeson.Value
jsonFromUTxOStatistics UTxOStatistics{histogram,allStakes,boundType} =
Aeson.object
[ "total" .=
(Quantity (fromIntegral allStakes) :: Quantity "lovelace" Natural)
, "scale" .= genericToJSON Aeson.defaultOptions boundType
, "distribution" .=
Map.fromList (map (\(HistogramBar k v)-> (k,v)) histogram)
]
{-------------------------------------------------------------------------------
Wallet API benchmarks
SeqState
-------------------------------------------------------------------------------}
data BenchSeqResults = BenchSeqResults
{ benchName :: Text
, walletOverview :: WalletOverview
, readWalletTime :: Time
, getWalletUtxoSnapshotTime :: Time
, listAddressesTime :: Time
, listAssetsTime :: Time
, listTransactionsTime :: Time
, listTransactionsLimitedTime :: Time
, createMigrationPlanTime :: Time
, delegationFeeTime :: Time
} deriving (Show, Generic)
instance Buildable BenchSeqResults where
build = genericF
instance ToJSON BenchSeqResults where
toJSON = genericToJSON Aeson.defaultOptions
benchmarksSeq
:: forall n s .
( s ~ SeqState n ShelleyKey
, HasSNetworkId n
, DelegationAddress ShelleyKey 'CredFromKeyK
)
=> BenchmarkConfig n s
-> IO BenchSeqResults
benchmarksSeq BenchmarkConfig{benchmarkName,ctx} = do
((cp, pending), readWalletTime) <- bench "readWallet" $ do
(cp, _, pending) <- W.readWallet ctx
pure (cp, pending)
(utxo, _) <- bench "utxo statistics" $
pure $ UTxOStatistics.compute (totalUTxO pending cp)
(_, getWalletUtxoSnapshotTime) <- bench "getWalletUtxoSnapshot"
$ length
<$> W.getWalletUtxoSnapshot ctx
(addresses, listAddressesTime) <- bench "listAddresses"
$ fromIntegral . length
<$> W.listAddresses ctx (const pure)
(_, listAssetsTime) <- bench "listAssets"
$ length
<$> W.listAssets @s ctx
(transactions, listTransactionsTime) <- bench "listTransactions"
$ fmap (fromIntegral . length)
$ unsafeRunExceptT
$ W.listTransactions ctx
Nothing Nothing Nothing Descending Nothing Nothing
(_, listTransactionsLimitedTime) <- bench "listTransactions (max_count=50)"
$ unsafeRunExceptT
$ W.listTransactions ctx
Nothing Nothing Nothing Descending (Just 50) Nothing
(_, createMigrationPlanTime) <- bench "createMigrationPlan"
$ W.createMigrationPlan ctx Tx.NoWithdrawal
(_, delegationFeeTime) <- bench "delegationFee" $ do
W.delegationFee
(W.dbLayer_ ctx) (W.networkLayer_ ctx)
(W.defaultChangeAddressGen (delegationAddressS @n))
pure BenchSeqResults
{ benchName = benchmarkName
, walletOverview = WalletOverview{utxo,addresses,transactions}
, readWalletTime
, getWalletUtxoSnapshotTime
, listAddressesTime
, listAssetsTime
, listTransactionsTime
, listTransactionsLimitedTime
, createMigrationPlanTime
, delegationFeeTime
}
{-------------------------------------------------------------------------------
Wallet API benchmarks
SharedState
-------------------------------------------------------------------------------}
data BenchSharedResults = BenchSharedResults
{ benchName :: Text
, walletOverview :: WalletOverview
, readWalletTime :: Time
, getWalletUtxoSnapshotTime :: Time
, listAddressesTime :: Time
, listAssetsTime :: Time
, listTransactionsTime :: Time
, listTransactionsLimitedTime :: Time
} deriving (Show, Generic)
instance Buildable BenchSharedResults where
build = genericF
instance ToJSON BenchSharedResults where
toJSON = genericToJSON Aeson.defaultOptions
benchmarksShared
:: forall n s
. ( s ~ SharedState n SharedKey
, HasSNetworkId n
)
=> BenchmarkConfig n s
-> IO BenchSharedResults
benchmarksShared BenchmarkConfig{benchmarkName,ctx} = do
((cp, pending), readWalletTime) <- bench "readWallet" $ do
(cp, _, pending) <- W.readWallet ctx
pure (cp, pending)
(utxo, _) <- bench "utxo statistics" $
pure $ UTxOStatistics.compute (totalUTxO pending cp)
(_, getWalletUtxoSnapshotTime) <- bench "getWalletUtxoSnapshot"
$ length
<$> W.getWalletUtxoSnapshot ctx
(addresses, listAddressesTime) <- bench "listAddresses"
$ fromIntegral . length
<$> W.listAddresses ctx (const pure)
(_, listAssetsTime) <- bench "listAssets"
$ length
<$> W.listAssets @s ctx
(transactions, listTransactionsTime) <- bench "listTransactions"
$ fmap (fromIntegral . length)
$ unsafeRunExceptT
$ W.listTransactions ctx
Nothing Nothing Nothing Descending Nothing Nothing
(_, listTransactionsLimitedTime) <- bench "listTransactions (max_count=50)"
$ unsafeRunExceptT
$ W.listTransactions ctx
Nothing Nothing Nothing Descending (Just 50) Nothing
pure BenchSharedResults
{ benchName = benchmarkName
, walletOverview = WalletOverview{utxo,addresses,transactions}
, readWalletTime
, getWalletUtxoSnapshotTime
, listAddressesTime
, listAssetsTime
, listTransactionsTime
, listTransactionsLimitedTime
}
{-------------------------------------------------------------------------------
Wallet API benchmarks
RndState
-------------------------------------------------------------------------------}
data BenchRndResults = BenchRndResults
{ benchName :: Text
, walletOverview :: WalletOverview
, readWalletTime :: Time
, getWalletUtxoSnapshotTime :: Time
, listAddressesTime :: Time
, listAssetsTime :: Time
, listTransactionsTime :: Time
, listTransactionsLimitedTime :: Time
, createMigrationPlanTime :: Time
} deriving (Show, Generic)
instance Buildable BenchRndResults where
build = genericF
instance ToJSON BenchRndResults where
toJSON = genericToJSON Aeson.defaultOptions
benchmarksRnd
:: forall n s
. s ~ RndState n
=> BenchmarkConfig n s
-> IO BenchRndResults
benchmarksRnd BenchmarkConfig{benchmarkName,ctx} = do
((cp, pending), readWalletTime) <- bench "readWallet" $ do
(cp, _, pending) <- W.readWallet ctx
pure (cp, pending)
(utxo, _) <- bench "utxo statistics" $
pure $ UTxOStatistics.compute (totalUTxO pending cp)
(_, getWalletUtxoSnapshotTime) <- bench "getWalletUtxoSnapshot"
$ length
<$> W.getWalletUtxoSnapshot ctx
(addresses, listAddressesTime) <- bench "listAddresses"
$ fromIntegral . length
<$> W.listAddresses ctx (const pure)
(_, listAssetsTime) <- bench "listAssets"
$ length
<$> W.listAssets @s ctx
(transactions, listTransactionsTime) <- bench "listTransactions"
$ fmap (fromIntegral . length)
$ unsafeRunExceptT
$ W.listTransactions ctx
Nothing Nothing Nothing Descending Nothing Nothing
(_, listTransactionsLimitedTime) <- bench "listTransactions (max_count=50)"
$ unsafeRunExceptT
$ W.listTransactions ctx
Nothing Nothing Nothing Descending (Just 50) Nothing
(_, createMigrationPlanTime) <- bench "createMigrationPlan"
$ W.createMigrationPlan ctx Tx.NoWithdrawal
pure BenchRndResults
{ benchName = benchmarkName
, walletOverview = WalletOverview{utxo,addresses,transactions}
, readWalletTime
, getWalletUtxoSnapshotTime
, listAddressesTime
, listAssetsTime
, listTransactionsTime
, listTransactionsLimitedTime
, createMigrationPlanTime
}
{-------------------------------------------------------------------------------
Benchmark Harness
-------------------------------------------------------------------------------}
newtype SomeBenchmarkResults = SomeBenchmarkResults Builder
instance Buildable SomeBenchmarkResults where
build (SomeBenchmarkResults x) = x
data BenchmarkConfig (n :: NetworkDiscriminant) s =
BenchmarkConfig
{ benchmarkName :: Text
, networkId :: SNetworkId n
, ctx :: WalletLayer IO s
, wid :: WalletId
}
-- | Run benchmarks on all wallet databases in a given directory.
benchmarkWallets
:: forall n s results
. ( PersistAddressBook s
, KeyFlavor (KeyOf s)
, Buildable results
, ToJSON results
, WalletFlavor s
)
=> Text
-- ^ Benchmark name (used for naming resulting files)
-> FilePath
-- ^ Directory from which to load database files
-> Trace IO Text
-- ^ For wallet tracing
-> SNetworkId n
-> ( BenchmarkConfig n s -> IO results )
-- ^ Benchmark to run
-> IO [SomeBenchmarkResults]
benchmarkWallets benchName dir walletTr networkId action = do
withWalletsFromDirectory dir walletTr networkId
$ \ctx@(WalletLayer{dbLayer_=DB.DBLayer{atomically,walletState}}) wid
-> do
WalletMetadata{name} <- atomically $ readWalletMeta walletState
let config = BenchmarkConfig
{ benchmarkName = benchName <> " " <> pretty name
, networkId = networkId
, ctx
, wid
}
sayErr $ "*** " <> benchmarkName config
results <- action config
saveBenchmarkPoints (benchmarkName config) results
pure $ SomeBenchmarkResults (build results)
where
saveBenchmarkPoints :: ToJSON a => Text -> a -> IO ()
saveBenchmarkPoints benchname =
Aeson.encodeFile (T.unpack benchname <> ".json")
mockNetworkLayer :: NetworkLayer IO Read.ConsensusBlock
mockNetworkLayer = dummyNetworkLayer
{ timeInterpreter = hoistTimeInterpreter liftIO mockTimeInterpreter
, currentSlottingParameters = pure dummySlottingParameters
, currentProtocolParameters = pure dummyProtocolParameters
, currentProtocolParametersInRecentEras = pure
$ Write.InRecentEraBabbage $
either (error . show) id $
C.toLedgerPParams
C.ShelleyBasedEraBabbage
dummyNodeProtocolParameters
, currentNodeEra = pure $ Cardano.anyCardanoEra Cardano.BabbageEra
, currentNodeTip = pure Read.BlockTip
{ Read.slotNo = Read.SlotNo 123456789
, Read.blockNo = Read.BlockNo 12345
, Read.headerHash = mockHash
}
}
mockHash :: Read.RawHeaderHash
mockHash = Read.mockRawHeaderHash 0
mockTimeInterpreter :: TimeInterpreter IO
mockTimeInterpreter = dummyTimeInterpreter
withWalletsFromDirectory
:: forall n s k a
. ( PersistAddressBook s
, WalletFlavor s
, k ~ KeyOf s
, KeyFlavor k
)
=> FilePath
-- ^ Directory of database files
-> Trace IO Text
-> SNetworkId n
-> (WalletLayer IO s -> WalletId -> IO a)
-> IO [a]
withWalletsFromDirectory dir tr networkId action = do
DB.DBFactory{listDatabases,withDatabaseLoad}
<- DB.newDBFactory (walletFlavor @s)
tr' migrationDefaultValues ti (Just dir)
wids <- listDatabases
forM wids $ \wid ->
withDatabaseLoad wid $
flip action wid . mkMockWalletLayer
where
mkMockWalletLayer =
WalletLayer (trMessageText tr) genesis mockNetworkLayer tl
genesis = error "not implemented: genesis data"
ti = mockTimeInterpreter
tl = newTransactionLayer
(keyFlavor @k) (networkIdVal networkId)
tr' = trMessageText tr
migrationDefaultValues = Sqlite.DefaultFieldValues
{ Sqlite.defaultActiveSlotCoefficient = 1
, Sqlite.defaultDesiredNumberOfPool = 0
, Sqlite.defaultMinimumUTxOValue = Coin 1000
, Sqlite.defaultHardforkEpoch = Nothing
, Sqlite.defaultKeyDeposit = Coin 0
}