-
Notifications
You must be signed in to change notification settings - Fork 210
/
TransactionSpec.hs
1556 lines (1412 loc) · 59.1 KB
/
TransactionSpec.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
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{-# LANGUAGE AllowAmbiguousTypes #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE NumericUnderscores #-}
{-# LANGUAGE OverloadedLabels #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE TypeApplications #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE UndecidableInstances #-}
{-# LANGUAGE ViewPatterns #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
module Cardano.Wallet.Shelley.TransactionSpec
( spec
) where
import Prelude
import Cardano.Address.Derivation
( XPrv, xprvFromBytes, xprvToBytes )
import Cardano.Address.Script
( KeyHash (..)
, KeyRole (Delegation, Payment)
, Script
, foldScript
, serializeScript
)
import Cardano.Api
( AnyCardanoEra (..)
, CardanoEra (..)
, CardanoEraStyle (..)
, InAnyCardanoEra (..)
, IsCardanoEra (..)
, IsShelleyBasedEra (..)
, ShelleyBasedEra (..)
, cardanoEraStyle
)
import Cardano.Wallet
( ErrSelectAssets (..)
, ErrUpdateSealedTx (..)
, FeeEstimation (..)
, estimateFee
)
import Cardano.Wallet.Byron.Compatibility
( maryTokenBundleMaxSize )
import Cardano.Wallet.Gen
( genScript )
import Cardano.Wallet.Primitive.AddressDerivation
( DerivationIndex (..)
, Passphrase (..)
, PassphraseMaxLength (..)
, PassphraseMinLength (..)
, PassphraseScheme (..)
, hex
, preparePassphrase
)
import Cardano.Wallet.Primitive.AddressDerivation.Byron
( ByronKey )
import Cardano.Wallet.Primitive.AddressDerivation.Icarus
( IcarusKey )
import Cardano.Wallet.Primitive.AddressDerivation.Shelley
( ShelleyKey )
import Cardano.Wallet.Primitive.CoinSelection
( SelectionError (..), SelectionOf (..), selectionDelta )
import Cardano.Wallet.Primitive.CoinSelection.Balance
( UnableToConstructChangeError (..), emptySkeleton )
import Cardano.Wallet.Primitive.Types
( ExecutionUnitPrices (..)
, ExecutionUnits (..)
, FeePolicy (..)
, ProtocolParameters (..)
, TokenBundleMaxSize (..)
, TxParameters (..)
)
import Cardano.Wallet.Primitive.Types.Address
( Address (..) )
import Cardano.Wallet.Primitive.Types.Coin
( Coin (..) )
import Cardano.Wallet.Primitive.Types.Coin.Gen
( genCoinPositive, shrinkCoinPositive )
import Cardano.Wallet.Primitive.Types.Hash
( Hash (..) )
import Cardano.Wallet.Primitive.Types.RewardAccount
( RewardAccount (..) )
import Cardano.Wallet.Primitive.Types.TokenBundle
( AssetId, TokenBundle, tokenName )
import Cardano.Wallet.Primitive.Types.TokenBundle.Gen
( genFixedSizeTokenBundle
, genTokenBundleSmallRange
, shrinkTokenBundleSmallRange
)
import Cardano.Wallet.Primitive.Types.TokenPolicy
( TokenName (UnsafeTokenName), TokenPolicyId, unTokenName )
import Cardano.Wallet.Primitive.Types.TokenPolicy.Gen
( genTokenPolicyId, shrinkTokenPolicyId )
import Cardano.Wallet.Primitive.Types.Tx
( SealedTx (..)
, TxConstraints (..)
, TxIn (..)
, TxMetadata (..)
, TxMetadataValue (..)
, TxOut (..)
, TxSize (..)
, cardanoTx
, sealedTxFromBytes
, sealedTxFromBytes'
, sealedTxFromCardano'
, serialisedTx
, txMetadataIsNull
, txOutCoin
)
import Cardano.Wallet.Primitive.Types.UTxO
( UTxO (..) )
import Cardano.Wallet.Shelley.Compatibility
( AnyShelleyBasedEra (..)
, computeTokenBundleSerializedLengthBytes
, getShelleyBasedEra
, shelleyToCardanoEra
, toCardanoLovelace
)
import Cardano.Wallet.Shelley.Transaction
( TxSkeleton (..)
, TxUpdate (..)
, TxWitnessTag (..)
, TxWitnessTagFor
, estimateTxCost
, estimateTxSize
, mkShelleyWitness
, mkTxSkeleton
, mkUnsignedTx
, newTransactionLayer
, noTxUpdate
, txConstraints
, updateSealedTx
, _decodeSealedTx
, _estimateMaxNumberOfInputs
, _maxScriptExecutionCost
)
import Cardano.Wallet.Transaction
( TransactionCtx (..)
, TransactionLayer (..)
, Withdrawal (..)
, defaultTransactionCtx
)
import Cardano.Wallet.Unsafe
( unsafeFromHex )
import Control.Monad
( forM_, replicateM )
import Control.Monad.Trans.Except
( except, runExceptT )
import Data.ByteString
( ByteString )
import Data.Either
( isRight )
import Data.Function
( on, (&) )
import Data.Generics.Internal.VL.Lens
( view )
import Data.List.NonEmpty
( NonEmpty (..) )
import Data.Maybe
( fromJust )
import Data.Proxy
( Proxy (..) )
import Data.Quantity
( Quantity (..) )
import Data.Semigroup
( Sum (Sum), getSum, mtimesDefault )
import Data.Set
( Set )
import Data.Typeable
( Typeable, typeRep )
import Data.Word
( Word16, Word64, Word8 )
import Fmt
( (+||), (||+) )
import Ouroboros.Network.Block
( SlotNo (..) )
import System.Directory
( listDirectory )
import System.FilePath
( (</>) )
import Test.Hspec
( Spec
, SpecWith
, before_
, describe
, expectationFailure
, it
, pendingWith
, runIO
, shouldBe
, shouldSatisfy
, xdescribe
)
import Test.Hspec.Core.Spec
( SpecM )
import Test.Hspec.QuickCheck
( prop )
import Test.QuickCheck
( Arbitrary (..)
, Blind (..)
, NonEmptyList (..)
, Property
, arbitraryPrintableChar
, checkCoverage
, choose
, classify
, conjoin
, counterexample
, cover
, elements
, frequency
, oneof
, property
, scale
, suchThatMap
, vector
, vectorOf
, withMaxSuccess
, within
, (.||.)
, (=/=)
, (===)
, (==>)
)
import Test.QuickCheck.Extra
( chooseNatural )
import Test.QuickCheck.Gen
( Gen (..), listOf1 )
import Test.QuickCheck.Random
( mkQCGen )
import Test.Utils.Paths
( getTestData )
import Test.Utils.Pretty
( Pretty (..), (====) )
import qualified Cardano.Api as Cardano
import qualified Cardano.Api.Shelley as Cardano
import qualified Cardano.Ledger.Alonzo.TxWitness as Alonzo
import qualified Cardano.Wallet.Primitive.CoinSelection.Balance as Balance
import qualified Cardano.Wallet.Primitive.Types.Coin as Coin
import qualified Cardano.Wallet.Primitive.Types.TokenBundle as TokenBundle
import qualified Cardano.Wallet.Primitive.Types.TokenMap as TokenMap
import qualified Data.ByteArray as BA
import qualified Data.ByteString as BS
import qualified Data.ByteString.Char8 as B8
import qualified Data.Foldable as F
import qualified Data.List.NonEmpty as NE
import qualified Data.Map.Strict as Map
import qualified Data.Set as Set
import qualified Data.Text as T
import qualified Data.Text.Encoding as T
spec :: Spec
spec = do
decodeSealedTxSpec
estimateMaxInputsSpec
feeCalculationSpec
feeEstimationRegressionSpec
forAllEras binaryCalculationsSpec
transactionConstraintsSpec
updateSealedTxSpec
forAllEras :: (AnyCardanoEra -> Spec) -> Spec
forAllEras eraSpec = do
eraSpec (AnyCardanoEra ByronEra)
forAllShelleyBasedEras eraSpec
forAllShelleyBasedEras :: (AnyCardanoEra -> Spec) -> Spec
forAllShelleyBasedEras eraSpec = do
eraSpec (AnyCardanoEra ShelleyEra)
eraSpec (AnyCardanoEra AllegraEra)
eraSpec (AnyCardanoEra MaryEra)
eraSpec (AnyCardanoEra AlonzoEra)
allEras :: [(Int, AnyCardanoEra)]
allEras =
[ (1, AnyCardanoEra ByronEra)
, (2, AnyCardanoEra ShelleyEra)
, (3, AnyCardanoEra AllegraEra)
, (4, AnyCardanoEra MaryEra)
, (5, AnyCardanoEra AlonzoEra)
]
eraNum :: AnyCardanoEra -> Int
eraNum e = fst $ head $ filter ((== e) . snd) allEras
shelleyEraNum :: AnyShelleyBasedEra -> Int
shelleyEraNum = eraNum . shelleyToCardanoEra
pendingOnAlonzo :: String -> ShelleyBasedEra era -> SpecWith a -> SpecWith a
pendingOnAlonzo msg era = before_ $ case era of
Cardano.ShelleyBasedEraAlonzo -> pendingWith ("AlonzoEra: " ++ msg)
_ -> pure ()
instance Arbitrary AnyCardanoEra where
arbitrary = frequency $ zip [1..] $ map (pure . snd) allEras
-- Shrink by choosing a *later* era
shrink e = map snd $ filter ((> eraNum e) . fst) allEras
instance Arbitrary AnyShelleyBasedEra where
arbitrary = suchThatMap (getShelleyBasedEra <$> arbitrary) id
-- shrink = _fixme
decodeSealedTxSpec :: Spec
decodeSealedTxSpec = describe "SealedTx serialisation/deserialisation" $ do
it "tx with withdrawal" $ do
let bytes = unsafeFromHex "84a70081825820410a9cd4af08b3abe25c2d3b87af4c23d0bb2fb7577b639d5cfbdfe13a4a696c0c0d80018182583901059f0c7b9899793d2c9afaeff4fd09bedd9df3b8cb1b9c301ab8e0f7fb3c13a29d3798f1b77b47f2ddb31c19326b87ed6f71fb9a27133ad51b000001001d19d714021a000220ec03198d0f05a1581de1fb3c13a29d3798f1b77b47f2ddb31c19326b87ed6f71fb9a27133ad51b000000e8d4a510000e80a0f5f6"
let sealedTx = sealedTxFromBytes bytes
sealedTx `shouldSatisfy` isRight
prop "roundtrip for Shelley witnesses" prop_sealedTxShelleyRoundtrip
xdescribe "Not implemented yet" $ do -- TODO: [ADP-919]
prop "roundtrip for Byron witnesses" prop_sealedTxByronRoundtrip
-- Note:
--
-- In the tests below, the expected numbers of inputs are highly sensitive
-- to the size distribution of token bundles within generated transaction
-- outputs.
--
-- If these tests fail unexpectedly, it's a good idea to check whether or
-- not the distribution of generated token bundles has changed.
--
estimateMaxInputsSpec :: Spec
estimateMaxInputsSpec = do
estimateMaxInputsTests @ShelleyKey
[(1,115),(5,109),(10,104),(20,93),(50,54)]
estimateMaxInputsTests @ByronKey
[(1,73),(5,69),(10,65),(20,57),(50,29)]
estimateMaxInputsTests @IcarusKey
[(1,73),(5,69),(10,65),(20,57),(50,29)]
feeCalculationSpec :: Spec
feeCalculationSpec = describe "fee calculations" $ do
it "withdrawals incur fees" $ property $ \wdrl ->
let
costWith =
minFee $ defaultTransactionCtx
{ txWithdrawal = WithdrawalSelf dummyAcct dummyPath wdrl }
costWithout =
minFee defaultTransactionCtx
marginalCost :: Integer
marginalCost = costWith - costWithout
in
(if wdrl == Coin 0
then property $ marginalCost == 0
else property $ marginalCost > 0
) & classify (wdrl == Coin 0) "null withdrawal"
& counterexample ("marginal cost: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "metadata incurs fees" $ property $ \md ->
let
costWith =
minFee $ defaultTransactionCtx { txMetadata = Just md }
costWithout =
minFee defaultTransactionCtx
marginalCost :: Integer
marginalCost = costWith - costWithout
in
property (marginalCost > 0)
& classify (txMetadataIsNull md) "null metadata"
& counterexample ("cost of metadata: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "minting incurs fees" $ property $ \assets ->
let
costWith =
minFeeSkeleton $ emptyTxSkeleton
{ txAssetsToMintOrBurn = Set.fromList assets }
costWithout =
minFeeSkeleton emptyTxSkeleton
marginalCost :: Integer
marginalCost = costWith - costWithout
in
(if null assets
then property $ marginalCost == 0
else property $ marginalCost > 0
)
& classify (null assets) "null minting assets"
& counterexample ("marginal cost: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "scripts incur fees" $ property $ \scripts ->
let
costWith =
minFeeSkeleton $ emptyTxSkeleton { txScripts = scripts }
costWithout =
minFeeSkeleton emptyTxSkeleton
marginalCost :: Integer
marginalCost = costWith - costWithout
in
(if null scripts
then property $ marginalCost == 0
else property $ marginalCost > 0
)
& classify (null scripts) "null scripts"
& counterexample ("marginal cost: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "increasing mint increases tx size at least proportianally to asset names"
$ property $ \mints ->
let
assetNameLength = BS.length . unTokenName . tokenName
lengthAssetNames = fromIntegral . getSum $
F.foldMap (Sum . assetNameLength) mints
sizeWith =
estimateTxSize' $ emptyTxSkeleton
{ txAssetsToMintOrBurn = Set.fromList mints }
sizeWithout =
estimateTxSize' emptyTxSkeleton
marginalSize :: Integer
marginalSize = sizeWith - sizeWithout
in
-- Larger asset names means more bytes in the tx which should
-- mean a more expensive tx. Adding the mints should increase
-- the marginal size at least as much as the size of the asset
-- names.
property (marginalSize >= lengthAssetNames)
& classify (null mints) "null minting assets"
& counterexample
("asset names length: " <> show lengthAssetNames)
& counterexample ("marginal size: " <> show marginalSize)
& counterexample ("size with: " <> show sizeWith)
& counterexample ("size without: " <> show sizeWithout)
it "increasing scripts increases fee at least proportionate to size of CBOR script"
$ property $ \scripts ->
let
-- Number of signatures required in the script
numWitnesses = sum $ (foldScript (const (+ 1)) 0) <$> scripts
sizeWitness = 1 -- small array
+ 34 -- vkey
+ 66 -- signature
-- Total size (in bytes) of the scripts when serialized
scriptLengths = fromIntegral . getSum $
F.foldMap (Sum . BS.length . serializeScript ) scripts
sizeWith =
estimateTxSize' $ emptyTxSkeleton { txScripts = scripts }
sizeWithout =
estimateTxSize' emptyTxSkeleton
marginalSize :: Integer
marginalSize = sizeWith - sizeWithout
in
-- The entire script must be serialized when it is included in
-- the transaction. Ensure that the marginal size increases at
-- least as much as the size of the CBOR serialized scripts.
--
-- Additionally, each 'required signature' in the script means
-- the tx will need to be witnessed by those vkeys (in the worst
-- case).
property
(marginalSize >= scriptLengths + numWitnesses * sizeWitness)
& classify (null scripts) "no scripts"
& classify (scriptLengths == 0) "zero script lengths"
& classify (numWitnesses == 0) "no witnesses"
& counterexample ("script lengths: " <> show scriptLengths)
& counterexample
("witness size: " <> show (numWitnesses * sizeWitness))
& counterexample ("marginal size: " <> show marginalSize)
& counterexample ("size with: " <> show sizeWith)
& counterexample ("size without: " <> show sizeWithout)
describe "calculate fee execution costs" $ do
let ppWithPrices :: ProtocolParameters
ppWithPrices = dummyProtocolParameters
{ executionUnitPrices = Just (ExecutionUnitPrices 1 1)
, txParameters = dummyTxParameters
{ getMaxExecutionUnits = ExecutionUnits 10000000 10000000000
}
}
txs <- readTestTransactions
forM_ txs $ \(filepath, tx) -> do
let rdmrs = replicate (sealedNumberOfRedeemers tx) (error "Redeemer")
if (null rdmrs) then do
it ("without redeemers: " <> filepath) $
_maxScriptExecutionCost ppWithPrices rdmrs
`shouldBe` (Coin 0)
else do
it ("with redeemers: " <> filepath) $
_maxScriptExecutionCost ppWithPrices rdmrs
`shouldSatisfy` (> (Coin 0))
describe "fee calculations" $ do
it "withdrawals incur fees" $ property $ \wdrl ->
let
costWith =
minFee $ defaultTransactionCtx
{ txWithdrawal = WithdrawalSelf dummyAcct dummyPath wdrl }
costWithout =
minFee defaultTransactionCtx
marginalCost :: Integer
marginalCost = costWith - costWithout
in
(if wdrl == Coin 0
then property $ marginalCost == 0
else property $ marginalCost > 0
) & classify (wdrl == Coin 0) "null withdrawal"
& counterexample ("marginal cost: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "metadata incurs fees" $ property $ \md ->
let
costWith =
minFee $ defaultTransactionCtx { txMetadata = Just md }
costWithout =
minFee defaultTransactionCtx
marginalCost :: Integer
marginalCost = costWith - costWithout
in
property (marginalCost > 0)
& classify (txMetadataIsNull md) "null metadata"
& counterexample ("cost of metadata: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "minting incurs fees" $ property $ \assets ->
let
costWith =
minFeeSkeleton $ emptyTxSkeleton
{ txAssetsToMintOrBurn = Set.fromList assets }
costWithout =
minFeeSkeleton emptyTxSkeleton
marginalCost :: Integer
marginalCost = costWith - costWithout
in
(if null assets
then property $ marginalCost == 0
else property $ marginalCost > 0
)
& classify (null assets) "null minting assets"
& counterexample ("marginal cost: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "scripts incur fees" $ property $ \scripts ->
let
costWith =
minFeeSkeleton $ emptyTxSkeleton { txScripts = scripts }
costWithout =
minFeeSkeleton emptyTxSkeleton
marginalCost :: Integer
marginalCost = costWith - costWithout
in
(if null scripts
then property $ marginalCost == 0
else property $ marginalCost > 0
)
& classify (null scripts) "null scripts"
& counterexample ("marginal cost: " <> show marginalCost)
& counterexample ("cost with: " <> show costWith)
& counterexample ("cost without: " <> show costWithout)
it "increasing mint increases tx size at least proportianally to asset names"
$ property $ \mints ->
let
assetNameLength = BS.length . unTokenName . tokenName
lengthAssetNames = fromIntegral . getSum $
F.foldMap (Sum . assetNameLength) mints
sizeWith =
estimateTxSize' $ emptyTxSkeleton
{ txAssetsToMintOrBurn = Set.fromList mints }
sizeWithout =
estimateTxSize' emptyTxSkeleton
marginalSize :: Integer
marginalSize = sizeWith - sizeWithout
in
-- Larger asset names means more bytes in the tx which should
-- mean a more expensive tx. Adding the mints should increase
-- the marginal size at least as much as the size of the asset
-- names.
property (marginalSize >= lengthAssetNames)
& classify (null mints) "null minting assets"
& counterexample
("asset names length: " <> show lengthAssetNames)
& counterexample ("marginal size: " <> show marginalSize)
& counterexample ("size with: " <> show sizeWith)
& counterexample ("size without: " <> show sizeWithout)
it "increasing scripts increases fee at least proportionate to size of CBOR script"
$ property $ \scripts ->
let
-- Number of signatures required in the script
numWitnesses = sum $ (foldScript (const (+ 1)) 0) <$> scripts
sizeWitness = 1 -- small array
+ 34 -- vkey
+ 66 -- signature
-- Total size (in bytes) of the scripts when serialized
scriptLengths = fromIntegral . getSum $
F.foldMap (Sum . BS.length . serializeScript ) scripts
sizeWith =
estimateTxSize' $ emptyTxSkeleton { txScripts = scripts }
sizeWithout =
estimateTxSize' emptyTxSkeleton
marginalSize :: Integer
marginalSize = sizeWith - sizeWithout
in
-- The entire script must be serialized when it is included in
-- the transaction. Ensure that the marginal size increases at
-- least as much as the size of the CBOR serialized scripts.
--
-- Additionally, each 'required signature' in the script means
-- the tx will need to be witnessed by those vkeys (in the worst
-- case).
property
(marginalSize >= scriptLengths + numWitnesses * sizeWitness)
& classify (null scripts) "no scripts"
& classify (scriptLengths == 0) "zero script lengths"
& classify (numWitnesses == 0) "no witnesses"
& counterexample ("script lengths: " <> show scriptLengths)
& counterexample
("witness size: " <> show (numWitnesses * sizeWitness))
& counterexample ("marginal size: " <> show marginalSize)
& counterexample ("size with: " <> show sizeWith)
& counterexample ("size without: " <> show sizeWithout)
where
pp :: ProtocolParameters
pp = dummyProtocolParameters
{ txParameters = dummyTxParameters
{ getFeePolicy = fp
}
}
fp = LinearFee (Quantity 100_000) (Quantity 100)
minFee :: TransactionCtx -> Integer
minFee ctx = Coin.toInteger $ calcMinimumCost testTxLayer pp ctx sel
where sel = emptySkeleton
minFeeSkeleton :: TxSkeleton -> Integer
minFeeSkeleton = Coin.toInteger . estimateTxCost pp
estimateTxSize' :: TxSkeleton -> Integer
estimateTxSize' = fromIntegral . unTxSize . estimateTxSize
(dummyAcct, dummyPath) =
(RewardAccount mempty, DerivationIndex 0 :| [])
feeEstimationRegressionSpec :: Spec
feeEstimationRegressionSpec = describe "Regression tests" $ do
it "#1740 Fee estimation at the boundaries" $ do
let requiredCost = 166029
let runSelection = except $ Left
$ ErrSelectAssetsSelectionError
$ SelectionBalanceError
$ Balance.UnableToConstructChange
$ Balance.UnableToConstructChangeError
{ requiredCost = Coin.fromWord64 requiredCost
, shortfall = Coin 100000
}
result <- runExceptT (estimateFee runSelection)
result `shouldBe`
Right (FeeEstimation requiredCost requiredCost)
binaryCalculationsSpec :: AnyCardanoEra -> Spec
binaryCalculationsSpec (AnyCardanoEra era) =
case cardanoEraStyle era of
LegacyByronEra -> pure ()
ShelleyBasedEra shelleyEra ->
-- TODO: [ADP-919] tests for byron witnesses
pendingOnAlonzo "Golden transactions not yet updated" shelleyEra $
before_ (pendingWith ("Will return with signTx PR")) $
binaryCalculationsSpec' shelleyEra
binaryCalculationsSpec' :: IsShelleyBasedEra era => ShelleyBasedEra era -> Spec
binaryCalculationsSpec' era = describe ("calculateBinary - "+||era||+"") $ do
describe "Byron witnesses - mainnet" $ do
let net = Cardano.Mainnet
it "1 input, 2 outputs" $ do
let pairs = [dummyWit 0]
let amtInp = 10000000
let amtFee = 129700
let amtOut = 2000000
let amtChange = amtInp - amtOut - amtFee
let utxo = UTxO $ Map.fromList
[ ( TxIn dummyTxId 0
, TxOut (dummyAddress 0) (coinToBundle amtInp)
)
]
let outs =
[ TxOut (dummyAddress 1) (coinToBundle amtOut)
]
let chgs =
[ TxOut (dummyAddress 2) (coinToBundle amtChange)
]
calculateBinary net utxo outs chgs pairs `shouldBe`
"83a40081825820000000000000000000000000000000000000000000000000\
\00000000000000000001828258390101010101010101010101010101010101\
\01010101010101010101010101010101010101010101010101010101010101\
\0101010101010101011a001e84808258390102020202020202020202020202\
\02020202020202020202020202020202020202020202020202020202020202\
\0202020202020202020202021a0078175c021a0001faa403191e46a1028184\
\58200100000000000000000000000000000000000000000000000000000000\
\0000005840d7af60ae33d2af351411c1445c79590526990bfa73cbb3732b54\
\ef322daa142e6884023410f8be3c16e9bd52076f2bb36bf38dfe034a9f0465\
\8e9f56197ab80f582000000000000000000000000000000000000000000000\
\0000000000000000000041a0f6"
it "2 inputs, 3 outputs" $ do
let pairs = [dummyWit 0, dummyWit 1]
let amtInp = 10000000
let amtFee = 135200
let amtOut = 6000000
let amtChange = 2*amtInp - 2*amtOut - amtFee
let utxo = UTxO $ Map.fromList
[ ( TxIn dummyTxId 0
, TxOut (dummyAddress 0) (coinToBundle amtInp)
)
, ( TxIn dummyTxId 1
, TxOut (dummyAddress 1) (coinToBundle amtInp)
)
]
let outs =
[ TxOut (dummyAddress 2) (coinToBundle amtOut)
, TxOut (dummyAddress 3) (coinToBundle amtOut)
]
let chgs =
[ TxOut (dummyAddress 4) (coinToBundle amtChange)
]
calculateBinary net utxo outs chgs pairs `shouldBe`
"83a40082825820000000000000000000000000000000000000000000000000\
\00000000000000000082582000000000000000000000000000000000000000\
\00000000000000000000000000010183825839010202020202020202020202\
\02020202020202020202020202020202020202020202020202020202020202\
\02020202020202020202020202021a005b8d80825839010303030303030303\
\03030303030303030303030303030303030303030303030303030303030303\
\03030303030303030303030303030303031a005b8d80825839010404040404\
\04040404040404040404040404040404040404040404040404040404040404\
\04040404040404040404040404040404040404041a007801e0021a00021020\
\03191e46a10282845820010000000000000000000000000000000000000000\
\00000000000000000000005840e8e769ecd0f3c538f0a5a574a1c881775f08\
\6d6f4c845b81be9b78955728bffa7efa54297c6a5d73337bd6280205b1759c\
\13f79d4c93f29871fc51b78aeba80e58200000000000000000000000000000\
\00000000000000000000000000000000000041a0845820130ae82201d7072e\
\6fbfc0a1884fb54636554d14945b799125cf7ce38d477f5158405835ff78c6\
\fc5e4466a179ca659fa85c99b8a3fba083f3f3f42ba360d479c64ef169914b\
\52ade49b19a7208fd63a6e67a19c406b4826608fdc5307025506c307582001\
\01010101010101010101010101010101010101010101010101010101010101\
\41a0f6"
describe "Byron witnesses - testnet" $ do
let net = Cardano.Testnet (Cardano.NetworkMagic 0)
it "1 input, 2 outputs" $ do
let pairs = [dummyWit 0]
let amtInp = 10000000
let amtFee = 129700
let amtOut = 2000000
let amtChange = amtInp - amtOut - amtFee
let utxo = UTxO $ Map.fromList
[ ( TxIn dummyTxId 0
, TxOut (dummyAddress 0) (coinToBundle amtInp)
)
]
let outs =
[ TxOut (dummyAddress 1) (coinToBundle amtOut)
]
let chgs =
[ TxOut (dummyAddress 2) (coinToBundle amtChange)
]
calculateBinary net utxo outs chgs pairs `shouldBe`
"83a40081825820000000000000000000000000000000000000000000000000\
\00000000000000000001828258390101010101010101010101010101010101\
\01010101010101010101010101010101010101010101010101010101010101\
\0101010101010101011a001e84808258390102020202020202020202020202\
\02020202020202020202020202020202020202020202020202020202020202\
\0202020202020202020202021a0078175c021a0001faa403191e46a1028184\
\58200100000000000000000000000000000000000000000000000000000000\
\0000005840d7af60ae33d2af351411c1445c79590526990bfa73cbb3732b54\
\ef322daa142e6884023410f8be3c16e9bd52076f2bb36bf38dfe034a9f0465\
\8e9f56197ab80f582000000000000000000000000000000000000000000000\
\0000000000000000000044a1024100f6"
it "2 inputs, 3 outputs" $ do
let pairs = [dummyWit 0, dummyWit 1]
let amtInp = 10000000
let amtFee = 135200
let amtOut = 6000000
let amtChange = 2*amtInp - 2*amtOut - amtFee
let utxo = UTxO $ Map.fromList
[ ( TxIn dummyTxId 0
, TxOut (dummyAddress 0) (coinToBundle amtInp)
)
, ( TxIn dummyTxId 1
, TxOut (dummyAddress 1) (coinToBundle amtInp)
)
]
let outs =
[ TxOut (dummyAddress 2) (coinToBundle amtOut)
, TxOut (dummyAddress 3) (coinToBundle amtOut)
]
let chgs =
[ TxOut (dummyAddress 4) (coinToBundle amtChange)
]
calculateBinary net utxo outs chgs pairs `shouldBe`
"83a40082825820000000000000000000000000000000000000000000000000\
\00000000000000000082582000000000000000000000000000000000000000\
\00000000000000000000000000010183825839010202020202020202020202\
\02020202020202020202020202020202020202020202020202020202020202\
\02020202020202020202020202021a005b8d80825839010303030303030303\
\03030303030303030303030303030303030303030303030303030303030303\
\03030303030303030303030303030303031a005b8d80825839010404040404\
\04040404040404040404040404040404040404040404040404040404040404\
\04040404040404040404040404040404040404041a007801e0021a00021020\
\03191e46a10282845820130ae82201d7072e6fbfc0a1884fb54636554d1494\
\5b799125cf7ce38d477f5158405835ff78c6fc5e4466a179ca659fa85c99b8\
\a3fba083f3f3f42ba360d479c64ef169914b52ade49b19a7208fd63a6e67a1\
\9c406b4826608fdc5307025506c30758200101010101010101010101010101\
\01010101010101010101010101010101010144a10241008458200100000000\
\0000000000000000000000000000000000000000000000000000005840e8e7\
\69ecd0f3c538f0a5a574a1c881775f086d6f4c845b81be9b78955728bffa7e\
\fa54297c6a5d73337bd6280205b1759c13f79d4c93f29871fc51b78aeba80e\
\58200000000000000000000000000000000000000000000000000000000000\
\00000044a1024100f6"
where
slotNo = SlotNo 7750
md = Nothing
calculateBinary _net utxo outs chgs pairs =
hex (Cardano.serialiseToCBOR ledgerTx)
where
ledgerTx = Cardano.makeSignedTransaction addrWits unsigned
mkByronWitness' _unsignedTx (_, (TxOut _addr _)) =
error "mkByronWitness'" -- TODO: [ADP-919]
addrWits = zipWith (mkByronWitness' unsigned) inps pairs
fee = toCardanoLovelace $ selectionDelta txOutCoin cs
Right unsigned = mkUnsignedTx era slotNo cs md mempty [] fee
cs = Selection
{ inputs = NE.fromList inps
, collateral = []
, extraCoinSource = Coin 0
, extraCoinSink = Coin 0
, outputs = outs
, change = chgs
, assetsToMint = mempty
, assetsToBurn = mempty
}
inps = Map.toList $ unUTxO utxo
transactionConstraintsSpec :: Spec
transactionConstraintsSpec = describe "Transaction constraints" $ do
it "cost of empty transaction" $
property prop_txConstraints_txBaseCost
it "size of empty transaction" $
property prop_txConstraints_txBaseSize
it "cost of non-empty transaction" $
property prop_txConstraints_txCost
it "size of non-empty transaction" $
property prop_txConstraints_txSize
it "maximum size of output" $
property prop_txConstraints_txOutputMaximumSize
newtype GivenNumOutputs = GivenNumOutputs Int deriving Num
newtype ExpectedNumInputs = ExpectedNumInputs Int deriving Num
-- | Set of tests related to `estimateMaxNumberOfInputs` from the transaction
-- layer.
estimateMaxInputsTests
:: forall k. (TxWitnessTagFor k, Typeable k)
=> [(GivenNumOutputs, ExpectedNumInputs)]
-> SpecWith ()
estimateMaxInputsTests cases = do
let k = show $ typeRep (Proxy @k)
describe ("estimateMaxNumberOfInputs for "<>k) $ do
forM_ cases $ \(GivenNumOutputs nOuts, ExpectedNumInputs nInps) -> do
let (o,i) = (show nOuts, show nInps)
it ("order of magnitude, nOuts = " <> o <> " => nInps = " <> i) $ do
-- NOTE: These tests broke in the GHC 8.6 -> 8.10 bump,
-- presumably due to some change in the arbitrary generation.
-- It would be better if they weren't so fragile.
--
-- They also broke when bumping to lts-18.4.
let outs = [ generatePure r arbitrary | r <- [ 1 .. nOuts ] ]
length outs `shouldBe` nOuts
_estimateMaxNumberOfInputs @k (Quantity 16384) defaultTransactionCtx outs
`shouldBe` nInps
prop "more outputs ==> less inputs"
(prop_moreOutputsMeansLessInputs @k)
prop "bigger size ==> more inputs"
(prop_biggerMaxSizeMeansMoreInputs @k)
--------------------------------------------------------------------------------
-- Roundtrip tests for SealedTx
prop_sealedTxShelleyRoundtrip
:: AnyShelleyBasedEra
-> AnyCardanoEra
-> Pretty DecodeSetup
-> Property
prop_sealedTxShelleyRoundtrip txEra@(AnyShelleyBasedEra era) currentEra (Pretty tc) = conjoin
[ txBytes ==== serialisedTx sealedTxC
, either (\e -> counterexample (show e) False) (compareOnCBOR tx) sealedTxB
]
.||. encodingFromTheFuture txEra currentEra
where
tx = makeShelleyTx era tc
txBytes = Cardano.serialiseToCBOR tx
sealedTxC = sealedTxFromCardano' tx
sealedTxB = sealedTxFromBytes' currentEra txBytes
makeShelleyTx :: IsShelleyBasedEra era => ShelleyBasedEra era -> DecodeSetup -> Cardano.Tx era
makeShelleyTx era testCase = Cardano.makeSignedTransaction addrWits unsigned
where
DecodeSetup utxo outs md slotNo pairs _netwk = testCase
inps = Map.toList $ unUTxO utxo
fee = toCardanoLovelace $ selectionDelta txOutCoin cs
Right unsigned = mkUnsignedTx era slotNo cs md mempty [] fee
addrWits = map (mkShelleyWitness unsigned) pairs
cs = Selection
{ inputs = NE.fromList inps
, collateral = []
, extraCoinSource = Coin 0
, extraCoinSink = Coin 0
, outputs = []
, change = outs
-- TODO: [ADP-346]
, assetsToMint = TokenMap.empty
, assetsToBurn = TokenMap.empty
}
prop_sealedTxByronRoundtrip
:: AnyShelleyBasedEra
-> AnyCardanoEra
-> Pretty (ForByron DecodeSetup)
-> Property
prop_sealedTxByronRoundtrip txEra@(AnyShelleyBasedEra era) currentEra (Pretty tc) = conjoin
[ txBytes ==== serialisedTx sealedTxC
, either (\e -> counterexample (show e) False) (compareOnCBOR tx) sealedTxB
]
.||. encodingFromTheFuture txEra currentEra
where
tx = makeByronTx era tc
txBytes = Cardano.serialiseToCBOR tx
sealedTxC = sealedTxFromCardano' tx
sealedTxB = sealedTxFromBytes' currentEra txBytes
makeByronTx :: IsShelleyBasedEra era => ShelleyBasedEra era -> ForByron DecodeSetup -> Cardano.Tx era
makeByronTx era testCase = Cardano.makeSignedTransaction byronWits unsigned
where
ForByron (DecodeSetup utxo outs _ slotNo pairs _ntwrk) = testCase
inps = Map.toList $ unUTxO utxo
fee = toCardanoLovelace $ selectionDelta txOutCoin cs
Right unsigned = mkUnsignedTx era slotNo cs Nothing mempty [] fee
-- byronWits = map (mkByronWitness unsigned ntwrk Nothing) pairs
byronWits = map (error "makeByronTx: broken") pairs -- TODO: [ADP-919]
cs = Selection
{ inputs = NE.fromList inps
, collateral = []
, extraCoinSource = Coin 0
, extraCoinSink = Coin 0
, outputs = []
, change = outs
-- TODO: [ADP-346]
, assetsToMint = TokenMap.empty
, assetsToBurn = TokenMap.empty
}
encodingFromTheFuture :: AnyShelleyBasedEra -> AnyCardanoEra -> Bool
encodingFromTheFuture tx current = shelleyEraNum tx > eraNum current
compareOnCBOR :: IsCardanoEra era => Cardano.Tx era -> SealedTx -> Property
compareOnCBOR b sealed = case cardanoTx sealed of
InAnyCardanoEra _ a ->