-
Notifications
You must be signed in to change notification settings - Fork 769
/
Copy pathmod.rs
1462 lines (1267 loc) · 44.2 KB
/
mod.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
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
// Copyright (C) Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! This pallet allows to assign permanent (long-lived) or temporary
//! (short-lived) parachain slots to paras, leveraging the existing
//! parachain slot lease mechanism. Temporary slots are given turns
//! in a fair (though best-effort) manner.
//! The dispatchables must be called from the configured origin
//! (typically `Sudo` or a governance origin).
//! This pallet should not be used on a production relay chain,
//! only on a test relay chain (e.g. Rococo).
pub mod benchmarking;
pub mod migration;
use crate::{
slots::{self, Pallet as Slots, WeightInfo as SlotsWeightInfo},
traits::{LeaseError, Leaser, Registrar},
};
use alloc::vec::Vec;
use codec::{Decode, Encode, MaxEncodedLen};
use frame_support::{pallet_prelude::*, traits::Currency};
use frame_system::pallet_prelude::*;
pub use pallet::*;
use polkadot_primitives::Id as ParaId;
use polkadot_runtime_parachains::{
configuration,
paras::{self},
};
use scale_info::TypeInfo;
use sp_runtime::traits::{One, Saturating, Zero};
const LOG_TARGET: &str = "runtime::assigned_slots";
/// Lease period an assigned slot should start from (current, or next one).
#[derive(Encode, Decode, Clone, Copy, Eq, PartialEq, RuntimeDebug, TypeInfo)]
pub enum SlotLeasePeriodStart {
Current,
Next,
}
/// Information about a temporary parachain slot.
#[derive(Encode, Decode, Clone, PartialEq, Eq, Default, MaxEncodedLen, RuntimeDebug, TypeInfo)]
pub struct ParachainTemporarySlot<AccountId, LeasePeriod> {
/// Manager account of the para.
pub manager: AccountId,
/// Lease period the parachain slot should ideally start from,
/// As slot are allocated in a best-effort manner, this could be later,
/// but not earlier than the specified period.
pub period_begin: LeasePeriod,
/// Number of lease period the slot lease will last.
/// This is set to the value configured in `TemporarySlotLeasePeriodLength`.
pub period_count: LeasePeriod,
/// Last lease period this slot had a turn in (incl. current).
/// This is set to the beginning period of a slot.
pub last_lease: Option<LeasePeriod>,
/// Number of leases this temporary slot had (incl. current).
pub lease_count: u32,
}
pub trait WeightInfo {
fn assign_perm_parachain_slot() -> Weight;
fn assign_temp_parachain_slot() -> Weight;
fn unassign_parachain_slot() -> Weight;
fn set_max_permanent_slots() -> Weight;
fn set_max_temporary_slots() -> Weight;
}
pub struct TestWeightInfo;
impl WeightInfo for TestWeightInfo {
fn assign_perm_parachain_slot() -> Weight {
Weight::zero()
}
fn assign_temp_parachain_slot() -> Weight {
Weight::zero()
}
fn unassign_parachain_slot() -> Weight {
Weight::zero()
}
fn set_max_permanent_slots() -> Weight {
Weight::zero()
}
fn set_max_temporary_slots() -> Weight {
Weight::zero()
}
}
type BalanceOf<T> = <<<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::Currency as Currency<
<T as frame_system::Config>::AccountId,
>>::Balance;
type LeasePeriodOf<T> = <<T as Config>::Leaser as Leaser<BlockNumberFor<T>>>::LeasePeriod;
#[frame_support::pallet]
pub mod pallet {
use super::*;
/// The in-code storage version.
const STORAGE_VERSION: StorageVersion = StorageVersion::new(1);
#[pallet::pallet]
#[pallet::storage_version(STORAGE_VERSION)]
pub struct Pallet<T>(_);
#[pallet::config]
#[pallet::disable_frame_system_supertrait_check]
pub trait Config: configuration::Config + paras::Config + slots::Config {
/// The overarching event type.
type RuntimeEvent: From<Event<Self>> + IsType<<Self as frame_system::Config>::RuntimeEvent>;
/// Origin for assigning slots.
type AssignSlotOrigin: EnsureOrigin<<Self as frame_system::Config>::RuntimeOrigin>;
/// The type representing the leasing system.
type Leaser: Leaser<
BlockNumberFor<Self>,
AccountId = Self::AccountId,
LeasePeriod = BlockNumberFor<Self>,
>;
/// The number of lease periods a permanent parachain slot lasts.
#[pallet::constant]
type PermanentSlotLeasePeriodLength: Get<u32>;
/// The number of lease periods a temporary parachain slot lasts.
#[pallet::constant]
type TemporarySlotLeasePeriodLength: Get<u32>;
/// The max number of temporary slots to be scheduled per lease periods.
#[pallet::constant]
type MaxTemporarySlotPerLeasePeriod: Get<u32>;
/// Weight Information for the Extrinsics in the Pallet
type WeightInfo: WeightInfo;
}
/// Assigned permanent slots, with their start lease period, and duration.
#[pallet::storage]
pub type PermanentSlots<T: Config> =
StorageMap<_, Twox64Concat, ParaId, (LeasePeriodOf<T>, LeasePeriodOf<T>), OptionQuery>;
/// Number of assigned (and active) permanent slots.
#[pallet::storage]
pub type PermanentSlotCount<T: Config> = StorageValue<_, u32, ValueQuery>;
/// Assigned temporary slots.
#[pallet::storage]
pub type TemporarySlots<T: Config> = StorageMap<
_,
Twox64Concat,
ParaId,
ParachainTemporarySlot<T::AccountId, LeasePeriodOf<T>>,
OptionQuery,
>;
/// Number of assigned temporary slots.
#[pallet::storage]
pub type TemporarySlotCount<T: Config> = StorageValue<_, u32, ValueQuery>;
/// Number of active temporary slots in current slot lease period.
#[pallet::storage]
pub type ActiveTemporarySlotCount<T: Config> = StorageValue<_, u32, ValueQuery>;
/// The max number of temporary slots that can be assigned.
#[pallet::storage]
pub type MaxTemporarySlots<T: Config> = StorageValue<_, u32, ValueQuery>;
/// The max number of permanent slots that can be assigned.
#[pallet::storage]
pub type MaxPermanentSlots<T: Config> = StorageValue<_, u32, ValueQuery>;
#[pallet::genesis_config]
#[derive(frame_support::DefaultNoBound)]
pub struct GenesisConfig<T: Config> {
pub max_temporary_slots: u32,
pub max_permanent_slots: u32,
#[serde(skip)]
pub _config: PhantomData<T>,
}
#[pallet::genesis_build]
impl<T: Config> BuildGenesisConfig for GenesisConfig<T> {
fn build(&self) {
MaxPermanentSlots::<T>::put(&self.max_permanent_slots);
MaxTemporarySlots::<T>::put(&self.max_temporary_slots);
}
}
#[pallet::event]
#[pallet::generate_deposit(pub(super) fn deposit_event)]
pub enum Event<T: Config> {
/// A parachain was assigned a permanent parachain slot
PermanentSlotAssigned(ParaId),
/// A parachain was assigned a temporary parachain slot
TemporarySlotAssigned(ParaId),
/// The maximum number of permanent slots has been changed
MaxPermanentSlotsChanged { slots: u32 },
/// The maximum number of temporary slots has been changed
MaxTemporarySlotsChanged { slots: u32 },
}
#[pallet::error]
pub enum Error<T> {
/// The specified parachain is not registered.
ParaDoesntExist,
/// Not a parathread (on-demand parachain).
NotParathread,
/// Cannot upgrade on-demand parachain to lease holding
/// parachain.
CannotUpgrade,
/// Cannot downgrade lease holding parachain to
/// on-demand.
CannotDowngrade,
/// Permanent or Temporary slot already assigned.
SlotAlreadyAssigned,
/// Permanent or Temporary slot has not been assigned.
SlotNotAssigned,
/// An ongoing lease already exists.
OngoingLeaseExists,
// The maximum number of permanent slots exceeded
MaxPermanentSlotsExceeded,
// The maximum number of temporary slots exceeded
MaxTemporarySlotsExceeded,
}
#[pallet::hooks]
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
fn on_initialize(n: BlockNumberFor<T>) -> Weight {
if let Some((lease_period, first_block)) = Self::lease_period_index(n) {
// If we're beginning a new lease period then handle that.
if first_block {
return Self::manage_lease_period_start(lease_period)
}
}
// We didn't return early above, so we didn't do anything.
Weight::zero()
}
}
#[pallet::call]
impl<T: Config> Pallet<T> {
/// Assign a permanent parachain slot and immediately create a lease for it.
#[pallet::call_index(0)]
#[pallet::weight((<T as Config>::WeightInfo::assign_perm_parachain_slot(), DispatchClass::Operational))]
pub fn assign_perm_parachain_slot(origin: OriginFor<T>, id: ParaId) -> DispatchResult {
T::AssignSlotOrigin::ensure_origin(origin)?;
let manager = T::Registrar::manager_of(id).ok_or(Error::<T>::ParaDoesntExist)?;
ensure!(T::Registrar::is_parathread(id), Error::<T>::NotParathread);
ensure!(
!Self::has_permanent_slot(id) && !Self::has_temporary_slot(id),
Error::<T>::SlotAlreadyAssigned
);
let current_lease_period: BlockNumberFor<T> = Self::current_lease_period_index();
ensure!(
!T::Leaser::already_leased(
id,
current_lease_period,
// Check current lease & next one
current_lease_period.saturating_add(
BlockNumberFor::<T>::from(2u32)
.saturating_mul(T::PermanentSlotLeasePeriodLength::get().into())
)
),
Error::<T>::OngoingLeaseExists
);
ensure!(
PermanentSlotCount::<T>::get() < MaxPermanentSlots::<T>::get(),
Error::<T>::MaxPermanentSlotsExceeded
);
// Permanent slot assignment fails if a lease cannot be created
Self::configure_slot_lease(
id,
manager,
current_lease_period,
T::PermanentSlotLeasePeriodLength::get().into(),
)
.map_err(|_| Error::<T>::CannotUpgrade)?;
PermanentSlots::<T>::insert(
id,
(
current_lease_period,
LeasePeriodOf::<T>::from(T::PermanentSlotLeasePeriodLength::get()),
),
);
PermanentSlotCount::<T>::mutate(|count| count.saturating_inc());
Self::deposit_event(Event::<T>::PermanentSlotAssigned(id));
Ok(())
}
/// Assign a temporary parachain slot. The function tries to create a lease for it
/// immediately if `SlotLeasePeriodStart::Current` is specified, and if the number
/// of currently active temporary slots is below `MaxTemporarySlotPerLeasePeriod`.
#[pallet::call_index(1)]
#[pallet::weight((<T as Config>::WeightInfo::assign_temp_parachain_slot(), DispatchClass::Operational))]
pub fn assign_temp_parachain_slot(
origin: OriginFor<T>,
id: ParaId,
lease_period_start: SlotLeasePeriodStart,
) -> DispatchResult {
T::AssignSlotOrigin::ensure_origin(origin)?;
let manager = T::Registrar::manager_of(id).ok_or(Error::<T>::ParaDoesntExist)?;
ensure!(T::Registrar::is_parathread(id), Error::<T>::NotParathread);
ensure!(
!Self::has_permanent_slot(id) && !Self::has_temporary_slot(id),
Error::<T>::SlotAlreadyAssigned
);
let current_lease_period: BlockNumberFor<T> = Self::current_lease_period_index();
ensure!(
!T::Leaser::already_leased(
id,
current_lease_period,
// Check current lease & next one
current_lease_period.saturating_add(
BlockNumberFor::<T>::from(2u32)
.saturating_mul(T::TemporarySlotLeasePeriodLength::get().into())
)
),
Error::<T>::OngoingLeaseExists
);
ensure!(
TemporarySlotCount::<T>::get() < MaxTemporarySlots::<T>::get(),
Error::<T>::MaxTemporarySlotsExceeded
);
let mut temp_slot = ParachainTemporarySlot {
manager: manager.clone(),
period_begin: match lease_period_start {
SlotLeasePeriodStart::Current => current_lease_period,
SlotLeasePeriodStart::Next => current_lease_period + One::one(),
},
period_count: T::TemporarySlotLeasePeriodLength::get().into(),
last_lease: None,
lease_count: 0,
};
if lease_period_start == SlotLeasePeriodStart::Current &&
ActiveTemporarySlotCount::<T>::get() < T::MaxTemporarySlotPerLeasePeriod::get()
{
// Try to allocate slot directly
match Self::configure_slot_lease(
id,
manager,
temp_slot.period_begin,
temp_slot.period_count,
) {
Ok(_) => {
ActiveTemporarySlotCount::<T>::mutate(|count| count.saturating_inc());
temp_slot.last_lease = Some(temp_slot.period_begin);
temp_slot.lease_count += 1;
},
Err(err) => {
// Treat failed lease creation as warning .. slot will be allocated a lease
// in a subsequent lease period by the `allocate_temporary_slot_leases`
// function.
log::warn!(
target: LOG_TARGET,
"Failed to allocate a temp slot for para {:?} at period {:?}: {:?}",
id,
current_lease_period,
err
);
},
}
}
TemporarySlots::<T>::insert(id, temp_slot);
TemporarySlotCount::<T>::mutate(|count| count.saturating_inc());
Self::deposit_event(Event::<T>::TemporarySlotAssigned(id));
Ok(())
}
/// Unassign a permanent or temporary parachain slot
#[pallet::call_index(2)]
#[pallet::weight((<T as Config>::WeightInfo::unassign_parachain_slot(), DispatchClass::Operational))]
pub fn unassign_parachain_slot(origin: OriginFor<T>, id: ParaId) -> DispatchResult {
T::AssignSlotOrigin::ensure_origin(origin.clone())?;
ensure!(
Self::has_permanent_slot(id) || Self::has_temporary_slot(id),
Error::<T>::SlotNotAssigned
);
// Check & cache para status before we clear the lease
let is_parachain = Self::is_parachain(id);
// Remove perm or temp slot
Self::clear_slot_leases(origin.clone(), id)?;
if PermanentSlots::<T>::contains_key(id) {
PermanentSlots::<T>::remove(id);
PermanentSlotCount::<T>::mutate(|count| *count = count.saturating_sub(One::one()));
} else if TemporarySlots::<T>::contains_key(id) {
TemporarySlots::<T>::remove(id);
TemporarySlotCount::<T>::mutate(|count| *count = count.saturating_sub(One::one()));
if is_parachain {
ActiveTemporarySlotCount::<T>::mutate(|active_count| {
*active_count = active_count.saturating_sub(One::one())
});
}
}
// Force downgrade to on-demand parachain (if needed) before end of lease period
if is_parachain {
if let Err(err) = polkadot_runtime_parachains::schedule_parachain_downgrade::<T>(id)
{
// Treat failed downgrade as warning .. slot lease has been cleared,
// so the parachain will be downgraded anyway by the slots pallet
// at the end of the lease period .
log::warn!(
target: LOG_TARGET,
"Failed to downgrade parachain {:?} at period {:?}: {:?}",
id,
Self::current_lease_period_index(),
err
);
}
}
Ok(())
}
/// Sets the storage value [`MaxPermanentSlots`].
#[pallet::call_index(3)]
#[pallet::weight((<T as Config>::WeightInfo::set_max_permanent_slots(), DispatchClass::Operational))]
pub fn set_max_permanent_slots(origin: OriginFor<T>, slots: u32) -> DispatchResult {
ensure_root(origin)?;
MaxPermanentSlots::<T>::put(slots);
Self::deposit_event(Event::<T>::MaxPermanentSlotsChanged { slots });
Ok(())
}
/// Sets the storage value [`MaxTemporarySlots`].
#[pallet::call_index(4)]
#[pallet::weight((<T as Config>::WeightInfo::set_max_temporary_slots(), DispatchClass::Operational))]
pub fn set_max_temporary_slots(origin: OriginFor<T>, slots: u32) -> DispatchResult {
ensure_root(origin)?;
MaxTemporarySlots::<T>::put(slots);
Self::deposit_event(Event::<T>::MaxTemporarySlotsChanged { slots });
Ok(())
}
}
}
impl<T: Config> Pallet<T> {
/// Allocate temporary slot leases up to `MaxTemporarySlotPerLeasePeriod` per lease period.
/// Beyond the already active temporary slot leases, this function will activate more leases
/// in the following order of preference:
/// - Assigned slots that didn't have a turn yet, though their `period_begin` has passed.
/// - Assigned slots that already had one (or more) turn(s): they will be considered for the
/// current slot lease if they weren't active in the preceding one, and will be ranked by
/// total number of lease (lower first), and then when they last a turn (older ones first).
/// If any remaining ex-aequo, we just take the para ID in ascending order as discriminator.
///
/// Assigned slots with a `period_begin` bigger than current lease period are not considered
/// (yet).
///
/// The function will call out to `Leaser::lease_out` to create the appropriate slot leases.
fn allocate_temporary_slot_leases(lease_period_index: LeasePeriodOf<T>) -> DispatchResult {
let mut active_temp_slots = 0u32;
let mut pending_temp_slots = Vec::new();
TemporarySlots::<T>::iter().for_each(|(para, slot)| {
match slot.last_lease {
Some(last_lease)
if last_lease <= lease_period_index &&
lease_period_index <
(last_lease.saturating_add(slot.period_count)) =>
{
// Active slot lease
active_temp_slots += 1;
}
Some(last_lease)
// Slot w/ past lease, only consider it every other slot lease period (times period_count)
if last_lease.saturating_add(slot.period_count.saturating_mul(2u32.into())) <= lease_period_index => {
pending_temp_slots.push((para, slot));
},
None if slot.period_begin <= lease_period_index => {
// Slot hasn't had a lease yet
pending_temp_slots.insert(0, (para, slot));
},
_ => {
// Slot not being considered for this lease period (will be for a subsequent one)
},
}
});
let mut newly_created_lease = 0u32;
if active_temp_slots < T::MaxTemporarySlotPerLeasePeriod::get() &&
!pending_temp_slots.is_empty()
{
// Sort by lease_count, favoring slots that had no or less turns first
// (then by last_lease index, and then Para ID)
pending_temp_slots.sort_by(|a, b| {
a.1.lease_count
.cmp(&b.1.lease_count)
.then_with(|| a.1.last_lease.cmp(&b.1.last_lease))
.then_with(|| a.0.cmp(&b.0))
});
let slots_to_be_upgraded = pending_temp_slots.iter().take(
(T::MaxTemporarySlotPerLeasePeriod::get().saturating_sub(active_temp_slots))
as usize,
);
for (id, temp_slot) in slots_to_be_upgraded {
TemporarySlots::<T>::try_mutate::<_, _, Error<T>, _>(id, |s| {
// Configure temp slot lease
Self::configure_slot_lease(
*id,
temp_slot.manager.clone(),
lease_period_index,
temp_slot.period_count,
)
.map_err(|_| Error::<T>::CannotUpgrade)?;
// Update temp slot lease info in storage
*s = Some(ParachainTemporarySlot {
manager: temp_slot.manager.clone(),
period_begin: temp_slot.period_begin,
period_count: temp_slot.period_count,
last_lease: Some(lease_period_index),
lease_count: temp_slot.lease_count + 1,
});
newly_created_lease += 1;
Ok(())
})?;
}
}
ActiveTemporarySlotCount::<T>::set(active_temp_slots + newly_created_lease);
Ok(())
}
/// Clear out all slot leases for both permanent & temporary slots.
/// The function merely calls out to `Slots::clear_all_leases`.
fn clear_slot_leases(origin: OriginFor<T>, id: ParaId) -> DispatchResult {
Slots::<T>::clear_all_leases(origin, id)
}
/// Create a parachain slot lease based on given params.
/// The function merely calls out to `Leaser::lease_out`.
fn configure_slot_lease(
para: ParaId,
manager: T::AccountId,
lease_period: LeasePeriodOf<T>,
lease_duration: LeasePeriodOf<T>,
) -> Result<(), LeaseError> {
T::Leaser::lease_out(para, &manager, BalanceOf::<T>::zero(), lease_period, lease_duration)
}
/// Returns whether a para has been assigned a permanent slot.
fn has_permanent_slot(id: ParaId) -> bool {
PermanentSlots::<T>::contains_key(id)
}
/// Returns whether a para has been assigned temporary slot.
fn has_temporary_slot(id: ParaId) -> bool {
TemporarySlots::<T>::contains_key(id)
}
/// Returns whether a para is currently a lease holding parachain.
fn is_parachain(id: ParaId) -> bool {
T::Registrar::is_parachain(id)
}
/// Returns current lease period index.
fn current_lease_period_index() -> LeasePeriodOf<T> {
T::Leaser::lease_period_index(frame_system::Pallet::<T>::block_number())
.and_then(|x| Some(x.0))
.unwrap()
}
/// Returns lease period index for block
fn lease_period_index(block: BlockNumberFor<T>) -> Option<(LeasePeriodOf<T>, bool)> {
T::Leaser::lease_period_index(block)
}
/// Handles start of a lease period.
fn manage_lease_period_start(lease_period_index: LeasePeriodOf<T>) -> Weight {
// Note: leases that have ended in previous lease period, should have been cleaned in slots
// pallet.
if let Err(err) = Self::allocate_temporary_slot_leases(lease_period_index) {
log::error!(
target: LOG_TARGET,
"Allocating slots failed for lease period {:?}, with: {:?}",
lease_period_index,
err
);
}
<T as slots::Config>::WeightInfo::force_lease() *
(T::MaxTemporarySlotPerLeasePeriod::get() as u64)
}
}
/// tests for this pallet
#[cfg(test)]
mod tests {
use super::*;
use crate::{assigned_slots, mock::TestRegistrar, slots};
use frame_support::{assert_noop, assert_ok, derive_impl, parameter_types};
use frame_system::EnsureRoot;
use pallet_balances;
use polkadot_primitives::BlockNumber;
use polkadot_primitives_test_helpers::{dummy_head_data, dummy_validation_code};
use polkadot_runtime_parachains::{
configuration as parachains_configuration, paras as parachains_paras,
shared as parachains_shared,
};
use sp_core::H256;
use sp_runtime::{
traits::{BlakeTwo256, IdentityLookup},
transaction_validity::TransactionPriority,
BuildStorage,
DispatchError::BadOrigin,
};
type UncheckedExtrinsic = frame_system::mocking::MockUncheckedExtrinsic<Test>;
type Block = frame_system::mocking::MockBlockU32<Test>;
frame_support::construct_runtime!(
pub enum Test
{
System: frame_system,
Balances: pallet_balances,
Configuration: parachains_configuration,
ParasShared: parachains_shared,
Parachains: parachains_paras,
Slots: slots,
AssignedSlots: assigned_slots,
}
);
impl<C> frame_system::offchain::CreateTransactionBase<C> for Test
where
RuntimeCall: From<C>,
{
type Extrinsic = UncheckedExtrinsic;
type RuntimeCall = RuntimeCall;
}
impl<C> frame_system::offchain::CreateInherent<C> for Test
where
RuntimeCall: From<C>,
{
fn create_inherent(call: Self::RuntimeCall) -> Self::Extrinsic {
UncheckedExtrinsic::new_bare(call)
}
}
#[derive_impl(frame_system::config_preludes::TestDefaultConfig)]
impl frame_system::Config for Test {
type BaseCallFilter = frame_support::traits::Everything;
type BlockWeights = ();
type BlockLength = ();
type RuntimeOrigin = RuntimeOrigin;
type RuntimeCall = RuntimeCall;
type Nonce = u64;
type Hash = H256;
type Hashing = BlakeTwo256;
type AccountId = u64;
type Lookup = IdentityLookup<Self::AccountId>;
type Block = Block;
type RuntimeEvent = RuntimeEvent;
type DbWeight = ();
type Version = ();
type PalletInfo = PalletInfo;
type AccountData = pallet_balances::AccountData<u64>;
type OnNewAccount = ();
type OnKilledAccount = ();
type SystemWeightInfo = ();
type SS58Prefix = ();
type OnSetCode = ();
type MaxConsumers = frame_support::traits::ConstU32<16>;
}
#[derive_impl(pallet_balances::config_preludes::TestDefaultConfig)]
impl pallet_balances::Config for Test {
type AccountStore = System;
}
impl parachains_configuration::Config for Test {
type WeightInfo = parachains_configuration::TestWeightInfo;
}
parameter_types! {
pub const ParasUnsignedPriority: TransactionPriority = TransactionPriority::max_value();
}
impl parachains_paras::Config for Test {
type RuntimeEvent = RuntimeEvent;
type WeightInfo = parachains_paras::TestWeightInfo;
type UnsignedPriority = ParasUnsignedPriority;
type QueueFootprinter = ();
type NextSessionRotation = crate::mock::TestNextSessionRotation;
type OnNewHead = ();
type AssignCoretime = ();
}
impl parachains_shared::Config for Test {
type DisabledValidators = ();
}
parameter_types! {
pub const LeasePeriod: BlockNumber = 3;
pub static LeaseOffset: BlockNumber = 0;
pub const ParaDeposit: u64 = 1;
}
impl slots::Config for Test {
type RuntimeEvent = RuntimeEvent;
type Currency = Balances;
type Registrar = TestRegistrar<Test>;
type LeasePeriod = LeasePeriod;
type LeaseOffset = LeaseOffset;
type ForceOrigin = EnsureRoot<Self::AccountId>;
type WeightInfo = crate::slots::TestWeightInfo;
}
parameter_types! {
pub const PermanentSlotLeasePeriodLength: u32 = 3;
pub const TemporarySlotLeasePeriodLength: u32 = 2;
pub const MaxTemporarySlotPerLeasePeriod: u32 = 2;
}
impl assigned_slots::Config for Test {
type RuntimeEvent = RuntimeEvent;
type AssignSlotOrigin = EnsureRoot<Self::AccountId>;
type Leaser = Slots;
type PermanentSlotLeasePeriodLength = PermanentSlotLeasePeriodLength;
type TemporarySlotLeasePeriodLength = TemporarySlotLeasePeriodLength;
type MaxTemporarySlotPerLeasePeriod = MaxTemporarySlotPerLeasePeriod;
type WeightInfo = crate::assigned_slots::TestWeightInfo;
}
// This function basically just builds a genesis storage key/value store according to
// our desired mock up.
pub fn new_test_ext() -> sp_io::TestExternalities {
let mut t = frame_system::GenesisConfig::<Test>::default().build_storage().unwrap();
pallet_balances::GenesisConfig::<Test> {
balances: vec![(1, 10), (2, 20), (3, 30), (4, 40), (5, 50), (6, 60)],
}
.assimilate_storage(&mut t)
.unwrap();
crate::assigned_slots::GenesisConfig::<Test> {
max_temporary_slots: 6,
max_permanent_slots: 2,
_config: Default::default(),
}
.assimilate_storage(&mut t)
.unwrap();
t.into()
}
fn run_to_block(n: BlockNumber) {
while System::block_number() < n {
let mut block = System::block_number();
// on_finalize hooks
AssignedSlots::on_finalize(block);
Slots::on_finalize(block);
Parachains::on_finalize(block);
ParasShared::on_finalize(block);
Configuration::on_finalize(block);
Balances::on_finalize(block);
System::on_finalize(block);
// Set next block
System::set_block_number(block + 1);
block = System::block_number();
// on_initialize hooks
System::on_initialize(block);
Balances::on_initialize(block);
Configuration::on_initialize(block);
ParasShared::on_initialize(block);
Parachains::on_initialize(block);
Slots::on_initialize(block);
AssignedSlots::on_initialize(block);
}
}
#[test]
fn basic_setup_works() {
new_test_ext().execute_with(|| {
run_to_block(1);
assert_eq!(AssignedSlots::current_lease_period_index(), 0);
assert_eq!(Slots::deposit_held(1.into(), &1), 0);
run_to_block(3);
assert_eq!(AssignedSlots::current_lease_period_index(), 1);
});
}
#[test]
fn assign_perm_slot_fails_for_unknown_para() {
new_test_ext().execute_with(|| {
run_to_block(1);
assert_noop!(
AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(1_u32),
),
Error::<Test>::ParaDoesntExist
);
});
}
#[test]
fn assign_perm_slot_fails_for_invalid_origin() {
new_test_ext().execute_with(|| {
run_to_block(1);
assert_noop!(
AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::signed(1),
ParaId::from(1_u32),
),
BadOrigin
);
});
}
#[test]
fn assign_perm_slot_fails_when_not_parathread() {
new_test_ext().execute_with(|| {
run_to_block(1);
assert_ok!(TestRegistrar::<Test>::register(
1,
ParaId::from(1_u32),
dummy_head_data(),
dummy_validation_code(),
));
assert_ok!(TestRegistrar::<Test>::make_parachain(ParaId::from(1_u32)));
assert_noop!(
AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(1_u32),
),
Error::<Test>::NotParathread
);
});
}
#[test]
fn assign_perm_slot_fails_when_existing_lease() {
new_test_ext().execute_with(|| {
run_to_block(1);
assert_ok!(TestRegistrar::<Test>::register(
1,
ParaId::from(1_u32),
dummy_head_data(),
dummy_validation_code(),
));
// Register lease in current lease period
assert_ok!(Slots::lease_out(ParaId::from(1_u32), &1, 1, 1, 1));
// Try to assign a perm slot in current period fails
assert_noop!(
AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(1_u32),
),
Error::<Test>::OngoingLeaseExists
);
// Cleanup
assert_ok!(Slots::clear_all_leases(RuntimeOrigin::root(), 1.into()));
// Register lease for next lease period
assert_ok!(Slots::lease_out(ParaId::from(1_u32), &1, 1, 2, 1));
// Should be detected and also fail
assert_noop!(
AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(1_u32),
),
Error::<Test>::OngoingLeaseExists
);
});
}
#[test]
fn assign_perm_slot_fails_when_max_perm_slots_exceeded() {
new_test_ext().execute_with(|| {
run_to_block(1);
assert_ok!(TestRegistrar::<Test>::register(
1,
ParaId::from(1_u32),
dummy_head_data(),
dummy_validation_code(),
));
assert_ok!(TestRegistrar::<Test>::register(
2,
ParaId::from(2_u32),
dummy_head_data(),
dummy_validation_code(),
));
assert_ok!(TestRegistrar::<Test>::register(
3,
ParaId::from(3_u32),
dummy_head_data(),
dummy_validation_code(),
));
assert_ok!(AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(1_u32),
));
assert_ok!(AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(2_u32),
));
assert_eq!(assigned_slots::PermanentSlotCount::<Test>::get(), 2);
assert_noop!(
AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(3_u32),
),
Error::<Test>::MaxPermanentSlotsExceeded
);
});
}
#[test]
fn assign_perm_slot_succeeds_for_parathread() {
new_test_ext().execute_with(|| {
let mut block = 1;
run_to_block(block);
assert_ok!(TestRegistrar::<Test>::register(
1,
ParaId::from(1_u32),
dummy_head_data(),
dummy_validation_code(),
));
assert_eq!(assigned_slots::PermanentSlotCount::<Test>::get(), 0);
assert_eq!(assigned_slots::PermanentSlots::<Test>::get(ParaId::from(1_u32)), None);
assert_ok!(AssignedSlots::assign_perm_parachain_slot(
RuntimeOrigin::root(),
ParaId::from(1_u32),
));
// Para is a lease holding parachain for PermanentSlotLeasePeriodLength * LeasePeriod
// blocks
while block < 9 {
println!("block #{}", block);
assert_eq!(TestRegistrar::<Test>::is_parachain(ParaId::from(1_u32)), true);
assert_eq!(assigned_slots::PermanentSlotCount::<Test>::get(), 1);
assert_eq!(AssignedSlots::has_permanent_slot(ParaId::from(1_u32)), true);
assert_eq!(
assigned_slots::PermanentSlots::<Test>::get(ParaId::from(1_u32)),
Some((0, 3))
);
assert_eq!(Slots::already_leased(ParaId::from(1_u32), 0, 2), true);