-
Notifications
You must be signed in to change notification settings - Fork 740
/
check_weight.rs
948 lines (856 loc) · 28.3 KB
/
check_weight.rs
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
// This file is part of Substrate.
// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::{limits::BlockWeights, Config, Pallet, LOG_TARGET};
use codec::{Decode, Encode};
use frame_support::{
dispatch::{DispatchInfo, PostDispatchInfo},
pallet_prelude::TransactionSource,
traits::Get,
};
use scale_info::TypeInfo;
use sp_runtime::{
traits::{
DispatchInfoOf, Dispatchable, PostDispatchInfoOf, TransactionExtension, ValidateResult,
},
transaction_validity::{InvalidTransaction, TransactionValidityError, ValidTransaction},
DispatchResult,
};
use sp_weights::Weight;
/// Block resource (weight) limit check.
///
/// # Transaction Validity
///
/// This extension does not influence any fields of `TransactionValidity` in case the
/// transaction is valid.
#[derive(Encode, Decode, Clone, Eq, PartialEq, Default, TypeInfo)]
#[scale_info(skip_type_params(T))]
pub struct CheckWeight<T: Config + Send + Sync>(core::marker::PhantomData<T>);
impl<T: Config + Send + Sync> CheckWeight<T>
where
T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,
{
/// Checks if the current extrinsic does not exceed the maximum weight a single extrinsic
/// with given `DispatchClass` can have.
fn check_extrinsic_weight(
info: &DispatchInfoOf<T::RuntimeCall>,
) -> Result<(), TransactionValidityError> {
let max = T::BlockWeights::get().get(info.class).max_extrinsic;
match max {
Some(max) if info.total_weight().any_gt(max) => {
log::debug!(
target: LOG_TARGET,
"Extrinsic {} is greater than the max extrinsic {}",
info.total_weight(),
max,
);
Err(InvalidTransaction::ExhaustsResources.into())
},
_ => Ok(()),
}
}
/// Checks if the current extrinsic can fit into the block with respect to block length limits.
///
/// Upon successes, it returns the new block length as a `Result`.
fn check_block_length(
info: &DispatchInfoOf<T::RuntimeCall>,
len: usize,
) -> Result<u32, TransactionValidityError> {
let length_limit = T::BlockLength::get();
let current_len = Pallet::<T>::all_extrinsics_len();
let added_len = len as u32;
let next_len = current_len.saturating_add(added_len);
if next_len > *length_limit.max.get(info.class) {
log::debug!(
target: LOG_TARGET,
"Exceeded block length limit: {} > {}",
next_len,
length_limit.max.get(info.class),
);
Err(InvalidTransaction::ExhaustsResources.into())
} else {
Ok(next_len)
}
}
/// Creates new `TransactionExtension` to check weight of the extrinsic.
pub fn new() -> Self {
Self(Default::default())
}
/// Do the validate checks. This can be applied to both signed and unsigned.
///
/// It only checks that the block weight and length limit will not exceed.
///
/// Returns the transaction validity and the next block length, to be used in `prepare`.
pub fn do_validate(
info: &DispatchInfoOf<T::RuntimeCall>,
len: usize,
) -> Result<(ValidTransaction, u32), TransactionValidityError> {
// If they return `Ok`, then it is below the limit.
let next_len = Self::check_block_length(info, len)?;
// during validation we skip block limit check. Since the `validate_transaction`
// call runs on an empty block anyway, by this we prevent `on_initialize` weight
// consumption from causing false negatives.
Self::check_extrinsic_weight(info)?;
Ok((Default::default(), next_len))
}
/// Do the pre-dispatch checks. This can be applied to both signed and unsigned.
///
/// It checks and notes the new weight and length.
pub fn do_prepare(
info: &DispatchInfoOf<T::RuntimeCall>,
len: usize,
next_len: u32,
) -> Result<(), TransactionValidityError> {
let all_weight = Pallet::<T>::block_weight();
let maximum_weight = T::BlockWeights::get();
let next_weight =
calculate_consumed_weight::<T::RuntimeCall>(&maximum_weight, all_weight, info, len)?;
// Extrinsic weight already checked in `validate`.
crate::AllExtrinsicsLen::<T>::put(next_len);
crate::BlockWeight::<T>::put(next_weight);
Ok(())
}
pub fn do_post_dispatch(
info: &DispatchInfoOf<T::RuntimeCall>,
post_info: &PostDispatchInfoOf<T::RuntimeCall>,
) -> Result<(), TransactionValidityError> {
let unspent = post_info.calc_unspent(info);
if unspent.any_gt(Weight::zero()) {
crate::BlockWeight::<T>::mutate(|current_weight| {
current_weight.reduce(unspent, info.class);
})
}
log::trace!(
target: LOG_TARGET,
"Used block weight: {:?}",
crate::BlockWeight::<T>::get(),
);
log::trace!(
target: LOG_TARGET,
"Used block length: {:?}",
Pallet::<T>::all_extrinsics_len(),
);
Ok(())
}
}
/// Checks if the current extrinsic can fit into the block with respect to block weight limits.
///
/// Upon successes, it returns the new block weight as a `Result`.
pub fn calculate_consumed_weight<Call>(
maximum_weight: &BlockWeights,
mut all_weight: crate::ConsumedWeight,
info: &DispatchInfoOf<Call>,
len: usize,
) -> Result<crate::ConsumedWeight, TransactionValidityError>
where
Call: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,
{
// Also Consider extrinsic length as proof weight.
let extrinsic_weight = info
.total_weight()
.saturating_add(maximum_weight.get(info.class).base_extrinsic)
.saturating_add(Weight::from_parts(0, len as u64));
let limit_per_class = maximum_weight.get(info.class);
// add the weight. If class is unlimited, use saturating add instead of checked one.
if limit_per_class.max_total.is_none() && limit_per_class.reserved.is_none() {
all_weight.accrue(extrinsic_weight, info.class)
} else {
all_weight.checked_accrue(extrinsic_weight, info.class).map_err(|_| {
log::debug!(
target: LOG_TARGET,
"All weight checked add overflow.",
);
InvalidTransaction::ExhaustsResources
})?;
}
let per_class = *all_weight.get(info.class);
// Check if we don't exceed per-class allowance
match limit_per_class.max_total {
Some(max) if per_class.any_gt(max) => {
log::debug!(
target: LOG_TARGET,
"Exceeded the per-class allowance.",
);
return Err(InvalidTransaction::ExhaustsResources.into());
},
// There is no `max_total` limit (`None`),
// or we are below the limit.
_ => {},
}
// In cases total block weight is exceeded, we need to fall back
// to `reserved` pool if there is any.
if all_weight.total().any_gt(maximum_weight.max_block) {
match limit_per_class.reserved {
// We are over the limit in reserved pool.
Some(reserved) if per_class.any_gt(reserved) => {
log::debug!(
target: LOG_TARGET,
"Total block weight is exceeded.",
);
return Err(InvalidTransaction::ExhaustsResources.into());
},
// There is either no limit in reserved pool (`None`),
// or we are below the limit.
_ => {},
}
}
Ok(all_weight)
}
impl<T: Config + Send + Sync> TransactionExtension<T::RuntimeCall> for CheckWeight<T>
where
T::RuntimeCall: Dispatchable<Info = DispatchInfo, PostInfo = PostDispatchInfo>,
{
const IDENTIFIER: &'static str = "CheckWeight";
type Implicit = ();
type Pre = ();
type Val = u32; /* next block length */
fn weight(&self, _: &T::RuntimeCall) -> Weight {
<T::ExtensionsWeightInfo as super::WeightInfo>::check_weight()
}
fn validate(
&self,
origin: T::RuntimeOrigin,
_call: &T::RuntimeCall,
info: &DispatchInfoOf<T::RuntimeCall>,
len: usize,
_self_implicit: Self::Implicit,
_inherited_implication: &impl Encode,
_source: TransactionSource,
) -> ValidateResult<Self::Val, T::RuntimeCall> {
let (validity, next_len) = Self::do_validate(info, len)?;
Ok((validity, next_len, origin))
}
fn prepare(
self,
val: Self::Val,
_origin: &T::RuntimeOrigin,
_call: &T::RuntimeCall,
info: &DispatchInfoOf<T::RuntimeCall>,
len: usize,
) -> Result<Self::Pre, TransactionValidityError> {
Self::do_prepare(info, len, val)
}
fn post_dispatch_details(
_pre: Self::Pre,
info: &DispatchInfoOf<T::RuntimeCall>,
post_info: &PostDispatchInfoOf<T::RuntimeCall>,
_len: usize,
_result: &DispatchResult,
) -> Result<Weight, TransactionValidityError> {
Self::do_post_dispatch(info, post_info)?;
Ok(Weight::zero())
}
fn bare_validate(
_call: &T::RuntimeCall,
info: &DispatchInfoOf<T::RuntimeCall>,
len: usize,
) -> frame_support::pallet_prelude::TransactionValidity {
Ok(Self::do_validate(info, len)?.0)
}
fn bare_validate_and_prepare(
_call: &T::RuntimeCall,
info: &DispatchInfoOf<T::RuntimeCall>,
len: usize,
) -> Result<(), TransactionValidityError> {
let (_, next_len) = Self::do_validate(info, len)?;
Self::do_prepare(info, len, next_len)
}
fn bare_post_dispatch(
info: &DispatchInfoOf<T::RuntimeCall>,
post_info: &mut PostDispatchInfoOf<T::RuntimeCall>,
_len: usize,
_result: &DispatchResult,
) -> Result<(), TransactionValidityError> {
Self::do_post_dispatch(info, post_info)
}
}
impl<T: Config + Send + Sync> core::fmt::Debug for CheckWeight<T> {
#[cfg(feature = "std")]
fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
write!(f, "CheckWeight")
}
#[cfg(not(feature = "std"))]
fn fmt(&self, _: &mut core::fmt::Formatter) -> core::fmt::Result {
Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{
mock::{new_test_ext, System, Test, CALL},
AllExtrinsicsLen, BlockWeight, DispatchClass,
};
use core::marker::PhantomData;
use frame_support::{assert_err, assert_ok, dispatch::Pays, weights::Weight};
use sp_runtime::traits::DispatchTransaction;
fn block_weights() -> crate::limits::BlockWeights {
<Test as crate::Config>::BlockWeights::get()
}
fn normal_weight_limit() -> Weight {
block_weights()
.get(DispatchClass::Normal)
.max_total
.unwrap_or_else(|| block_weights().max_block)
}
fn block_weight_limit() -> Weight {
block_weights().max_block
}
fn normal_length_limit() -> u32 {
*<Test as Config>::BlockLength::get().max.get(DispatchClass::Normal)
}
#[test]
fn mandatory_extrinsic_doesnt_care_about_limits() {
fn check(call: impl FnOnce(&DispatchInfo, usize)) {
new_test_ext().execute_with(|| {
let max = DispatchInfo {
call_weight: Weight::MAX,
class: DispatchClass::Mandatory,
..Default::default()
};
let len = 0_usize;
call(&max, len);
});
}
check(|max, len| {
let next_len = CheckWeight::<Test>::check_block_length(max, len).unwrap();
assert_ok!(CheckWeight::<Test>::do_prepare(max, len, next_len));
assert_eq!(System::block_weight().total(), Weight::MAX);
assert!(System::block_weight().total().ref_time() > block_weight_limit().ref_time());
});
check(|max, len| {
assert_ok!(CheckWeight::<Test>::do_validate(max, len));
});
}
#[test]
fn normal_extrinsic_limited_by_maximum_extrinsic_weight() {
new_test_ext().execute_with(|| {
let max = DispatchInfo {
call_weight: block_weights().get(DispatchClass::Normal).max_extrinsic.unwrap() +
Weight::from_parts(1, 0),
class: DispatchClass::Normal,
..Default::default()
};
let len = 0_usize;
assert_err!(
CheckWeight::<Test>::do_validate(&max, len),
InvalidTransaction::ExhaustsResources
);
});
}
#[test]
fn operational_extrinsic_limited_by_operational_space_limit() {
new_test_ext().execute_with(|| {
let weights = block_weights();
let operational_limit = weights
.get(DispatchClass::Operational)
.max_total
.unwrap_or_else(|| weights.max_block);
let base_weight = weights.get(DispatchClass::Operational).base_extrinsic;
let call_weight = operational_limit - base_weight;
let okay = DispatchInfo {
call_weight,
class: DispatchClass::Operational,
..Default::default()
};
let max = DispatchInfo {
call_weight: call_weight + Weight::from_parts(1, 0),
class: DispatchClass::Operational,
..Default::default()
};
let len = 0_usize;
assert_eq!(CheckWeight::<Test>::do_validate(&okay, len), Ok(Default::default()));
assert_err!(
CheckWeight::<Test>::do_validate(&max, len),
InvalidTransaction::ExhaustsResources
);
});
}
#[test]
fn register_extra_weight_unchecked_doesnt_care_about_limits() {
new_test_ext().execute_with(|| {
System::register_extra_weight_unchecked(Weight::MAX, DispatchClass::Normal);
assert_eq!(System::block_weight().total(), Weight::MAX);
assert!(System::block_weight().total().ref_time() > block_weight_limit().ref_time());
});
}
#[test]
fn full_block_with_normal_and_operational() {
new_test_ext().execute_with(|| {
// Max block is 1024
// Max normal is 768 (75%)
// 10 is taken for block execution weight
// So normal extrinsic can be 758 weight (-5 for base extrinsic weight)
// And Operational can be 246 to produce a full block (-10 for base)
let max_normal =
DispatchInfo { call_weight: Weight::from_parts(753, 0), ..Default::default() };
let rest_operational = DispatchInfo {
call_weight: Weight::from_parts(246, 0),
class: DispatchClass::Operational,
..Default::default()
};
let len = 0_usize;
let next_len = CheckWeight::<Test>::check_block_length(&max_normal, len).unwrap();
assert_ok!(CheckWeight::<Test>::do_prepare(&max_normal, len, next_len));
assert_eq!(System::block_weight().total(), Weight::from_parts(768, 0));
let next_len = CheckWeight::<Test>::check_block_length(&rest_operational, len).unwrap();
assert_ok!(CheckWeight::<Test>::do_prepare(&rest_operational, len, next_len));
assert_eq!(block_weight_limit(), Weight::from_parts(1024, u64::MAX));
assert_eq!(System::block_weight().total(), block_weight_limit().set_proof_size(0));
// Checking single extrinsic should not take current block weight into account.
assert_eq!(CheckWeight::<Test>::check_extrinsic_weight(&rest_operational), Ok(()));
});
}
#[test]
fn dispatch_order_does_not_effect_weight_logic() {
new_test_ext().execute_with(|| {
// We switch the order of `full_block_with_normal_and_operational`
let max_normal =
DispatchInfo { call_weight: Weight::from_parts(753, 0), ..Default::default() };
let rest_operational = DispatchInfo {
call_weight: Weight::from_parts(246, 0),
class: DispatchClass::Operational,
..Default::default()
};
let len = 0_usize;
let next_len = CheckWeight::<Test>::check_block_length(&rest_operational, len).unwrap();
assert_ok!(CheckWeight::<Test>::do_prepare(&rest_operational, len, next_len));
// Extra 20 here from block execution + base extrinsic weight
assert_eq!(System::block_weight().total(), Weight::from_parts(266, 0));
let next_len = CheckWeight::<Test>::check_block_length(&max_normal, len).unwrap();
assert_ok!(CheckWeight::<Test>::do_prepare(&max_normal, len, next_len));
assert_eq!(block_weight_limit(), Weight::from_parts(1024, u64::MAX));
assert_eq!(System::block_weight().total(), block_weight_limit().set_proof_size(0));
});
}
#[test]
fn operational_works_on_full_block() {
new_test_ext().execute_with(|| {
// An on_initialize takes up the whole block! (Every time!)
System::register_extra_weight_unchecked(Weight::MAX, DispatchClass::Mandatory);
let dispatch_normal = DispatchInfo {
call_weight: Weight::from_parts(251, 0),
class: DispatchClass::Normal,
..Default::default()
};
let dispatch_operational = DispatchInfo {
call_weight: Weight::from_parts(246, 0),
class: DispatchClass::Operational,
..Default::default()
};
let len = 0_usize;
let next_len = CheckWeight::<Test>::check_block_length(&dispatch_normal, len).unwrap();
assert_err!(
CheckWeight::<Test>::do_prepare(&dispatch_normal, len, next_len),
InvalidTransaction::ExhaustsResources
);
let next_len =
CheckWeight::<Test>::check_block_length(&dispatch_operational, len).unwrap();
// Thank goodness we can still do an operational transaction to possibly save the
// blockchain.
assert_ok!(CheckWeight::<Test>::do_prepare(&dispatch_operational, len, next_len));
// Not too much though
assert_err!(
CheckWeight::<Test>::do_prepare(&dispatch_operational, len, next_len),
InvalidTransaction::ExhaustsResources
);
// Even with full block, validity of single transaction should be correct.
assert_eq!(CheckWeight::<Test>::check_extrinsic_weight(&dispatch_operational), Ok(()));
});
}
#[test]
fn signed_ext_check_weight_works_operational_tx() {
new_test_ext().execute_with(|| {
let normal =
DispatchInfo { call_weight: Weight::from_parts(100, 0), ..Default::default() };
let op = DispatchInfo {
call_weight: Weight::from_parts(100, 0),
extension_weight: Weight::zero(),
class: DispatchClass::Operational,
pays_fee: Pays::Yes,
};
let len = 0_usize;
let normal_limit = normal_weight_limit();
// given almost full block
BlockWeight::<Test>::mutate(|current_weight| {
current_weight.set(normal_limit, DispatchClass::Normal)
});
// will not fit.
assert_eq!(
CheckWeight::<Test>(PhantomData)
.validate_and_prepare(Some(1).into(), CALL, &normal, len, 0)
.unwrap_err(),
InvalidTransaction::ExhaustsResources.into()
);
// will fit.
assert_ok!(CheckWeight::<Test>(PhantomData).validate_and_prepare(
Some(1).into(),
CALL,
&op,
len,
0,
));
// likewise for length limit.
let len = 100_usize;
AllExtrinsicsLen::<Test>::put(normal_length_limit());
assert_eq!(
CheckWeight::<Test>(PhantomData)
.validate_and_prepare(Some(1).into(), CALL, &normal, len, 0)
.unwrap_err(),
InvalidTransaction::ExhaustsResources.into()
);
assert_ok!(CheckWeight::<Test>(PhantomData).validate_and_prepare(
Some(1).into(),
CALL,
&op,
len,
0,
));
})
}
#[test]
fn signed_ext_check_weight_block_size_works() {
new_test_ext().execute_with(|| {
let normal = DispatchInfo::default();
let normal_limit = normal_weight_limit().ref_time() as usize;
let reset_check_weight = |tx, s, f| {
AllExtrinsicsLen::<Test>::put(0);
let r = CheckWeight::<Test>(PhantomData).validate_and_prepare(
Some(1).into(),
CALL,
tx,
s,
0,
);
if f {
assert!(r.is_err())
} else {
assert!(r.is_ok())
}
};
reset_check_weight(&normal, normal_limit - 1, false);
reset_check_weight(&normal, normal_limit, false);
reset_check_weight(&normal, normal_limit + 1, true);
// Operational ones don't have this limit.
let op = DispatchInfo {
call_weight: Weight::zero(),
extension_weight: Weight::zero(),
class: DispatchClass::Operational,
pays_fee: Pays::Yes,
};
reset_check_weight(&op, normal_limit, false);
reset_check_weight(&op, normal_limit + 100, false);
reset_check_weight(&op, 1024, false);
reset_check_weight(&op, 1025, true);
})
}
#[test]
fn signed_ext_check_weight_works_normal_tx() {
new_test_ext().execute_with(|| {
let normal_limit = normal_weight_limit();
let small =
DispatchInfo { call_weight: Weight::from_parts(100, 0), ..Default::default() };
let base_extrinsic = block_weights().get(DispatchClass::Normal).base_extrinsic;
let medium =
DispatchInfo { call_weight: normal_limit - base_extrinsic, ..Default::default() };
let big = DispatchInfo {
call_weight: normal_limit - base_extrinsic + Weight::from_parts(1, 0),
..Default::default()
};
let len = 0_usize;
let reset_check_weight = |i, f, s| {
BlockWeight::<Test>::mutate(|current_weight| {
current_weight.set(s, DispatchClass::Normal)
});
let r = CheckWeight::<Test>(PhantomData).validate_and_prepare(
Some(1).into(),
CALL,
i,
len,
0,
);
if f {
assert!(r.is_err())
} else {
assert!(r.is_ok())
}
};
reset_check_weight(&small, false, Weight::zero());
reset_check_weight(&medium, false, Weight::zero());
reset_check_weight(&big, true, Weight::from_parts(1, 0));
})
}
#[test]
fn signed_ext_check_weight_refund_works() {
new_test_ext().execute_with(|| {
// This is half of the max block weight
let info =
DispatchInfo { call_weight: Weight::from_parts(512, 0), ..Default::default() };
let post_info = PostDispatchInfo {
actual_weight: Some(Weight::from_parts(128, 0)),
pays_fee: Default::default(),
};
let len = 0_usize;
let base_extrinsic = block_weights().get(DispatchClass::Normal).base_extrinsic;
// We allow 75% for normal transaction, so we put 25% - extrinsic base weight
BlockWeight::<Test>::mutate(|current_weight| {
current_weight.set(Weight::zero(), DispatchClass::Mandatory);
current_weight
.set(Weight::from_parts(256, 0) - base_extrinsic, DispatchClass::Normal);
});
let pre = CheckWeight::<Test>(PhantomData)
.validate_and_prepare(Some(1).into(), CALL, &info, len, 0)
.unwrap()
.0;
assert_eq!(
BlockWeight::<Test>::get().total(),
info.total_weight() + Weight::from_parts(256, 0)
);
assert_ok!(CheckWeight::<Test>::post_dispatch_details(
pre,
&info,
&post_info,
len,
&Ok(())
));
assert_eq!(
BlockWeight::<Test>::get().total(),
post_info.actual_weight.unwrap() + Weight::from_parts(256, 0)
);
})
}
#[test]
fn signed_ext_check_weight_actual_weight_higher_than_max_is_capped() {
new_test_ext().execute_with(|| {
let info =
DispatchInfo { call_weight: Weight::from_parts(512, 0), ..Default::default() };
let post_info = PostDispatchInfo {
actual_weight: Some(Weight::from_parts(700, 0)),
pays_fee: Default::default(),
};
let len = 0_usize;
BlockWeight::<Test>::mutate(|current_weight| {
current_weight.set(Weight::zero(), DispatchClass::Mandatory);
current_weight.set(Weight::from_parts(128, 0), DispatchClass::Normal);
});
let pre = CheckWeight::<Test>(PhantomData)
.validate_and_prepare(Some(1).into(), CALL, &info, len, 0)
.unwrap()
.0;
assert_eq!(
BlockWeight::<Test>::get().total(),
info.total_weight() +
Weight::from_parts(128, 0) +
block_weights().get(DispatchClass::Normal).base_extrinsic,
);
assert_ok!(CheckWeight::<Test>::post_dispatch_details(
pre,
&info,
&post_info,
len,
&Ok(())
));
assert_eq!(
BlockWeight::<Test>::get().total(),
info.total_weight() +
Weight::from_parts(128, 0) +
block_weights().get(DispatchClass::Normal).base_extrinsic,
);
})
}
#[test]
fn zero_weight_extrinsic_still_has_base_weight() {
new_test_ext().execute_with(|| {
let weights = block_weights();
let free = DispatchInfo { call_weight: Weight::zero(), ..Default::default() };
let len = 0_usize;
// Initial weight from `weights.base_block`
assert_eq!(System::block_weight().total(), weights.base_block);
assert_ok!(CheckWeight::<Test>(PhantomData).validate_and_prepare(
Some(1).into(),
CALL,
&free,
len,
0,
));
assert_eq!(
System::block_weight().total(),
weights.get(DispatchClass::Normal).base_extrinsic + weights.base_block
);
})
}
#[test]
fn normal_and_mandatory_tracked_separately() {
new_test_ext().execute_with(|| {
// Max block is 1024
// Max normal is 768 (75%)
// Max mandatory is unlimited
let max_normal =
DispatchInfo { call_weight: Weight::from_parts(753, 0), ..Default::default() };
let mandatory = DispatchInfo {
call_weight: Weight::from_parts(1019, 0),
class: DispatchClass::Mandatory,
..Default::default()
};
let len = 0_usize;
let next_len = CheckWeight::<Test>::check_block_length(&max_normal, len).unwrap();
assert_ok!(CheckWeight::<Test>::do_prepare(&max_normal, len, next_len));
assert_eq!(System::block_weight().total(), Weight::from_parts(768, 0));
let next_len = CheckWeight::<Test>::check_block_length(&mandatory, len).unwrap();
assert_ok!(CheckWeight::<Test>::do_prepare(&mandatory, len, next_len));
assert_eq!(block_weight_limit(), Weight::from_parts(1024, u64::MAX));
assert_eq!(System::block_weight().total(), Weight::from_parts(1024 + 768, 0));
assert_eq!(CheckWeight::<Test>::check_extrinsic_weight(&mandatory), Ok(()));
});
}
#[test]
fn no_max_total_should_still_be_limited_by_max_block() {
// given
let maximum_weight = BlockWeights::builder()
.base_block(Weight::zero())
.for_class(DispatchClass::non_mandatory(), |w| {
w.base_extrinsic = Weight::zero();
w.max_total = Some(Weight::from_parts(20, u64::MAX));
})
.for_class(DispatchClass::Mandatory, |w| {
w.base_extrinsic = Weight::zero();
w.reserved = Some(Weight::from_parts(5, u64::MAX));
w.max_total = None;
})
.build_or_panic();
let all_weight = crate::ConsumedWeight::new(|class| match class {
DispatchClass::Normal => Weight::from_parts(10, 0),
DispatchClass::Operational => Weight::from_parts(10, 0),
DispatchClass::Mandatory => Weight::zero(),
});
assert_eq!(maximum_weight.max_block, all_weight.total().set_proof_size(u64::MAX));
// fits into reserved
let mandatory1 = DispatchInfo {
call_weight: Weight::from_parts(5, 0),
class: DispatchClass::Mandatory,
..Default::default()
};
// does not fit into reserved and the block is full.
let mandatory2 = DispatchInfo {
call_weight: Weight::from_parts(6, 0),
class: DispatchClass::Mandatory,
..Default::default()
};
// when
assert_ok!(calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight.clone(),
&mandatory1,
0
));
assert_err!(
calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight,
&mandatory2,
0
),
InvalidTransaction::ExhaustsResources
);
}
#[test]
fn proof_size_includes_length() {
let maximum_weight = BlockWeights::builder()
.base_block(Weight::zero())
.for_class(DispatchClass::non_mandatory(), |w| {
w.base_extrinsic = Weight::zero();
w.max_total = Some(Weight::from_parts(20, 1000));
})
.for_class(DispatchClass::Mandatory, |w| {
w.base_extrinsic = Weight::zero();
w.max_total = Some(Weight::from_parts(20, 1000));
})
.build_or_panic();
let all_weight = crate::ConsumedWeight::new(|class| match class {
DispatchClass::Normal => Weight::from_parts(5, 0),
DispatchClass::Operational => Weight::from_parts(5, 0),
DispatchClass::Mandatory => Weight::from_parts(0, 0),
});
let normal = DispatchInfo {
call_weight: Weight::from_parts(5, 0),
class: DispatchClass::Normal,
..Default::default()
};
let mandatory = DispatchInfo {
call_weight: Weight::from_parts(5, 0),
class: DispatchClass::Mandatory,
..Default::default()
};
// Using 0 length extrinsics.
let consumed = calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight.clone(),
&normal,
0,
)
.unwrap();
assert_eq!(consumed.total().saturating_sub(all_weight.total()), normal.total_weight());
let consumed = calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight.clone(),
&mandatory,
0,
)
.unwrap();
assert_eq!(consumed.total().saturating_sub(all_weight.total()), mandatory.total_weight());
// Using non zero length extrinsics.
let consumed = calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight.clone(),
&normal,
100,
)
.unwrap();
// Must account for the len in the proof size
assert_eq!(
consumed.total().saturating_sub(all_weight.total()),
normal.total_weight().add_proof_size(100)
);
let consumed = calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight.clone(),
&mandatory,
100,
)
.unwrap();
// Must account for the len in the proof size
assert_eq!(
consumed.total().saturating_sub(all_weight.total()),
mandatory.total_weight().add_proof_size(100)
);
// Using oversized zero length extrinsics.
let consumed = calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight.clone(),
&normal,
2000,
);
// errors out
assert_eq!(consumed, Err(InvalidTransaction::ExhaustsResources.into()));
// Using oversized zero length extrinsics.
let consumed = calculate_consumed_weight::<<Test as Config>::RuntimeCall>(
&maximum_weight,
all_weight.clone(),
&mandatory,
2000,
);
// errors out
assert_eq!(consumed, Err(InvalidTransaction::ExhaustsResources.into()));
}
}