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
// This file is part of Gear.
// Copyright (C) 2022-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
// This program 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.
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
//! Internal details of Gear Pallet implementation.
use crate::{
AccountIdOf, Config, CostsPerBlockOf, CurrencyOf, DispatchStashOf, Event, ExtManager,
GasBalanceOf, GasHandlerOf, GasNodeIdOf, GearBank, MailboxOf, Pallet, QueueOf,
SchedulingCostOf, TaskPoolOf, WaitlistOf,
};
use alloc::collections::BTreeSet;
use common::{
event::{
MessageWaitedReason, MessageWaitedRuntimeReason::*, MessageWokenReason, Reason::*,
UserMessageReadReason,
},
gas_provider::{GasNodeId, Imbalance},
scheduler::*,
storage::*,
GasTree, LockId, LockableTree, Origin,
};
use core::cmp::{Ord, Ordering};
use frame_support::traits::{Currency, ExistenceRequirement};
use frame_system::pallet_prelude::BlockNumberFor;
use gear_core::{
ids::{MessageId, ProgramId, ReservationId},
message::{
Dispatch, DispatchKind, Message, ReplyMessage, StoredDispatch, UserMessage,
UserStoredMessage,
},
};
use sp_runtime::traits::{Get, One, SaturatedConversion, Saturating, UniqueSaturatedInto, Zero};
/// [`HoldBound`] builder
#[derive(Clone, Debug)]
pub(crate) struct HoldBoundBuilder<T: Config> {
storage_type: StorageType,
cost: SchedulingCostOf<T>,
}
#[allow(unused)]
impl<T: Config> HoldBoundBuilder<T> {
/// Creates a builder
pub fn new(storage_type: StorageType) -> Self {
Self {
storage_type,
cost: CostsPerBlockOf::<T>::by_storage_type(storage_type),
}
}
/// Creates bound to specific given block number.
pub fn at(self, expected: BlockNumberFor<T>) -> HoldBound<T> {
HoldBound {
cost: self.cost,
expected,
lock_id: self.storage_type.try_into().ok(),
}
}
/// Creates bound to specific given deadline block number.
pub fn deadline(self, deadline: BlockNumberFor<T>) -> HoldBound<T> {
let expected = deadline.saturating_sub(CostsPerBlockOf::<T>::reserve_for());
self.at(expected)
}
/// Creates bound for given duration since current block.
pub fn duration(self, duration: BlockNumberFor<T>) -> HoldBound<T> {
let expected = Pallet::<T>::block_number().saturating_add(duration);
self.at(expected)
}
/// Creates maximal available bound for given gas limit.
pub fn maximum_for(self, gas: GasBalanceOf<T>) -> HoldBound<T> {
let deadline_duration = gas
.saturating_div(self.cost.max(One::one()))
.saturated_into::<BlockNumberFor<T>>();
let deadline = Pallet::<T>::block_number().saturating_add(deadline_duration);
self.deadline(deadline)
}
/// Creates maximal available bound for given message id,
/// by querying it's gas limit.
pub fn maximum_for_message(self, message_id: MessageId) -> HoldBound<T> {
// Querying gas limit. Fails in cases of `GasTree` invalidations.
let gas_limit = GasHandlerOf::<T>::get_limit(message_id)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
self.maximum_for(gas_limit)
}
// Zero-duration hold bound.
pub fn zero(self) -> HoldBound<T> {
self.at(Pallet::<T>::block_number())
}
}
/// Hold bound, specifying cost of storage, expected block number for task to
/// create on it, deadlines and durations of holding.
#[derive(Clone, Debug, Eq, PartialEq)]
pub(crate) struct HoldBound<T: Config> {
/// Cost of storing per block.
cost: SchedulingCostOf<T>,
/// Expected block number task to be processed.
expected: BlockNumberFor<T>,
/// Appropriate lock id, if exists for storage type
lock_id: Option<LockId>,
}
// `unused` allowed because some fns may be used in future, but clippy
// doesn't allow this due to `pub(crate)` visibility.
#[allow(unused)]
impl<T: Config> HoldBound<T> {
/// Returns cost of storing per block, related to current hold bound.
pub fn cost(&self) -> SchedulingCostOf<T> {
self.cost
}
/// Returns expected block number task to be processed.
pub fn expected(&self) -> BlockNumberFor<T> {
self.expected
}
/// Appropriate lock id for the HoldBound.
pub fn lock_id(&self) -> Option<LockId> {
self.lock_id
}
/// Returns expected duration before task will be processed, since now.
pub fn expected_duration(&self) -> BlockNumberFor<T> {
self.expected.saturating_sub(Pallet::<T>::block_number())
}
/// Returns the deadline for tasks to be processed.
///
/// This deadline is exactly sum of expected block number and `reserve_for`
/// safety duration from task pool overflow within the single block.
pub fn deadline(&self) -> BlockNumberFor<T> {
self.expected
.saturating_add(CostsPerBlockOf::<T>::reserve_for())
}
/// Returns deadline duration before task will be processed, since now.
pub fn deadline_duration(&self) -> BlockNumberFor<T> {
self.deadline().saturating_sub(Pallet::<T>::block_number())
}
/// Returns amount of gas should be locked for rent of the hold afterward.
pub fn lock_amount(&self) -> GasBalanceOf<T> {
self.deadline_duration()
.saturated_into::<GasBalanceOf<T>>()
.saturating_mul(self.cost())
}
}
impl<T: Config> PartialOrd for HoldBound<T> {
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
Some(self.cmp(other))
}
}
impl<T: Config> Ord for HoldBound<T>
where
BlockNumberFor<T>: PartialOrd,
{
fn cmp(&self, other: &Self) -> Ordering {
self.expected.cmp(&other.expected)
}
}
// Internal functionality implementation.
impl<T: Config> Pallet<T>
where
T::AccountId: Origin,
{
// Reset of all storages.
#[cfg(feature = "runtime-benchmarks")]
pub(crate) fn reset() {
use common::{CodeStorage, GasProvider, PausedProgramStorage, ProgramStorage};
<<T as Config>::ProgramStorage as PausedProgramStorage>::reset();
<<T as Config>::ProgramStorage as ProgramStorage>::reset();
<T as Config>::CodeStorage::reset();
<T as Config>::GasProvider::reset();
<T as Config>::Scheduler::reset();
<T as Config>::Messenger::reset();
}
/// Spends given amount of gas from given `MessageId` in `GasTree`.
///
/// Represents logic of burning gas by transferring gas from
/// current `GasTree` owner to actual block producer.
pub(crate) fn spend_burned(id: impl Into<GasNodeIdOf<T>>, amount: GasBalanceOf<T>) {
Self::spend_gas(None, id, amount)
}
pub fn spend_gas(
to: Option<AccountIdOf<T>>,
id: impl Into<GasNodeIdOf<T>>,
amount: GasBalanceOf<T>,
) {
let id = id.into();
// If amount is zero, nothing to do.
if amount.is_zero() {
return;
}
// Spending gas amount from `GasNode`.
GasHandlerOf::<T>::spend(id, amount)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Querying external id. Fails in cases of `GasTree` invalidations.
let (external, multiplier, _) = GasHandlerOf::<T>::get_origin_node(id)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Transferring reserved funds from external user to destination.
let result = if let Some(account_id) = to {
GearBank::<T>::spend_gas_to(&account_id, &external, amount, multiplier)
} else {
GearBank::<T>::spend_gas(&external, amount, multiplier)
};
result.unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
}
/// Consumes message by given `MessageId` or gas reservation by `ReservationId`.
///
/// Updates currency and balances data on imbalance creation.
pub(crate) fn consume_and_retrieve(id: impl Into<GasNodeIdOf<T>>) {
let id = id.into();
// Consuming `GasNode`, returning optional outcome with imbalance.
let outcome = GasHandlerOf::<T>::consume(id)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Unreserving funds, if imbalance returned.
if let Some((imbalance, multiplier, external)) = outcome {
// Peeking numeric value from negative imbalance.
let gas_left = imbalance.peek();
// Unreserving funds, if left non-zero amount of gas.
if !gas_left.is_zero() {
log::debug!(
"Consumed message {id}. Unreserving {gas_left} (gas) from {external:?}"
);
GearBank::<T>::withdraw_gas(&external, gas_left, multiplier)
.unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
}
}
}
/// Charges for holding in some storage. In order to be placed into a holding storage
/// a message must lock some funds as a deposit to "book" the storage until some time
/// in the future.
/// Basic invariant is that we can't charge for storing an item more than had been deposited,
/// regardless whether storage costs or the safety margin have changed in the meantime
/// (via storage migration). The actual "prepaid" amount is determined through releasing
/// the lock corresponding to the `storage_type` inside the function.
///
/// `id` - parameter convertible to the respective gas node id;
/// `hold_interval` - determines the time interval to charge rent for;
/// `storage_type` - storage type that determines the lock and the cost for holding a message.
pub(crate) fn charge_for_hold(
id: impl Into<GasNodeIdOf<T>>,
hold_interval: Interval<BlockNumberFor<T>>,
storage_type: StorageType,
) {
let id = id.into();
// Current block number.
let current = Self::block_number();
// Deadline of the task.
//
// NOTE: the `ReserveFor` value may have changed due to storage migration thereby
// leading to a mismatch between the amount due and the amount deposited upfront.
let deadline = hold_interval
.finish
.saturating_add(CostsPerBlockOf::<T>::reserve_for());
// The block number, which was the last paid for hold.
//
// Outdated tasks can end up being store for free - this case has to be controlled by
// a correct selection of the `ReserveFor` constant.
let paid_until = current.min(deadline);
// Holding duration.
let duration: u64 = paid_until
.saturating_sub(hold_interval.start)
.unique_saturated_into();
// Cost per block based on the storage used for holding
let cost = CostsPerBlockOf::<T>::by_storage_type(storage_type);
// Amount of gas to be charged for holding.
// Note: unlocking of all funds that had been locked under the respective lock defines
// the maximum amount that can be charged for using storage.
let amount = storage_type.try_into().map_or_else(
|_| duration.saturating_mul(cost),
|lock_id| {
let prepaid = GasHandlerOf::<T>::unlock_all(id, lock_id)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
prepaid.min(duration.saturating_mul(cost))
},
);
// Spending gas, if need.
if !amount.is_zero() {
// Spending gas for rent to the rent pool if any.
// If there is no rent pool id then funds will be spent to the block author.
Self::spend_gas(<T as Config>::RentPoolId::get(), id, amount)
}
}
/// Adds dispatch into waitlist, deposits event and adds task for waking it.
pub(crate) fn wait_dispatch(
dispatch: StoredDispatch,
duration: Option<BlockNumberFor<T>>,
reason: MessageWaitedReason,
) {
// `HoldBound` builder.
let hold_builder = HoldBoundBuilder::<T>::new(StorageType::Waitlist);
// Maximal hold bound for the message.
let maximal_hold = hold_builder.clone().maximum_for_message(dispatch.id());
// Figuring out correct hold bound.
let hold = if let Some(duration) = duration {
hold_builder.duration(duration).min(maximal_hold)
} else {
maximal_hold
};
// Validating duration.
if hold.expected_duration().is_zero() {
// TODO: Replace with unreachable call after:
// - `HoldBound` safety usage stabilized;
log::error!("Failed to figure out correct wait hold bound");
return;
}
// Locking funds for holding.
let lock_id = hold.lock_id().unwrap_or_else(|| {
unreachable!("Waitlist storage is guaranteed to have an associated lock id")
});
GasHandlerOf::<T>::lock(dispatch.id(), lock_id, hold.lock_amount())
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Querying origin message id. Fails in cases of `GasTree` invalidations.
let origin_msg = GasHandlerOf::<T>::get_origin_key(GasNodeId::Node(dispatch.id()))
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
match reason {
Runtime(WaitForCalled | WaitUpToCalledFull) => {
let expected = hold.expected();
let task = ScheduledTask::WakeMessage(dispatch.destination(), dispatch.id());
if !TaskPoolOf::<T>::contains(&expected, &task) {
TaskPoolOf::<T>::add(expected, task)
.unwrap_or_else(|e| unreachable!("Scheduling logic invalidated! {:?}", e));
}
}
Runtime(WaitCalled | WaitUpToCalled) => {
TaskPoolOf::<T>::add(
hold.expected(),
ScheduledTask::RemoveFromWaitlist(dispatch.destination(), dispatch.id()),
)
.unwrap_or_else(|e| unreachable!("Scheduling logic invalidated! {:?}", e));
}
System(reason) => match reason {},
}
// Depositing appropriate event.
Self::deposit_event(Event::MessageWaited {
id: dispatch.id(),
origin: origin_msg.ne(&dispatch.id().into()).then_some(origin_msg),
expiration: hold.expected(),
reason,
});
// Adding message in waitlist.
WaitlistOf::<T>::insert(dispatch, hold.expected())
.unwrap_or_else(|e| unreachable!("Waitlist corrupted! {:?}", e));
}
/// Wakes dispatch from waitlist, permanently charged for hold with
/// appropriate event depositing, if found.
pub(crate) fn wake_dispatch(
program_id: ProgramId,
message_id: MessageId,
reason: MessageWokenReason,
) -> Option<StoredDispatch> {
// Removing dispatch from waitlist, doing wake requirements if found.
WaitlistOf::<T>::remove(program_id, message_id)
.map(|v| Self::wake_dispatch_requirements(v, reason))
.ok()
}
/// Charges and deposits event for already taken from waitlist dispatch.
pub(crate) fn wake_dispatch_requirements(
(waitlisted, hold_interval): (StoredDispatch, Interval<BlockNumberFor<T>>),
reason: MessageWokenReason,
) -> StoredDispatch {
// Expected block number to finish task.
let expected = hold_interval.finish;
// Charging for holding.
Self::charge_for_hold(waitlisted.id(), hold_interval, StorageType::Waitlist);
// Depositing appropriate event.
Pallet::<T>::deposit_event(Event::MessageWoken {
id: waitlisted.id(),
reason,
});
// Delete task, if exists.
let _ = TaskPoolOf::<T>::delete(
expected,
ScheduledTask::RemoveFromWaitlist(waitlisted.destination(), waitlisted.id()),
);
waitlisted
}
/// Removes message from mailbox, permanently charged for hold with
/// appropriate event depositing, if found.
///
/// Note: message consumes automatically.
pub(crate) fn read_message(
user_id: T::AccountId,
message_id: MessageId,
reason: UserMessageReadReason,
) -> Option<UserStoredMessage> {
// Removing message from mailbox, doing read requirements if found.
MailboxOf::<T>::remove(user_id, message_id)
.map(|v| Self::read_message_requirements(v, reason))
.ok()
}
/// Charges and deposits event for already taken from mailbox message.
///
/// Note: message auto-consumes, if reason is claim or reply.
pub(crate) fn read_message_requirements(
(mailboxed, hold_interval): (UserStoredMessage, Interval<BlockNumberFor<T>>),
reason: UserMessageReadReason,
) -> UserStoredMessage {
// Expected block number to finish task.
let expected = hold_interval.finish;
// Charging for holding.
Self::charge_for_hold(mailboxed.id(), hold_interval, StorageType::Mailbox);
// Consuming message.
Self::consume_and_retrieve(mailboxed.id());
// Taking data for funds transfer.
let user_id = mailboxed.destination().cast();
let from = mailboxed.source().cast();
// Transferring reserved funds, associated with the message.
GearBank::<T>::transfer_value(&from, &user_id, mailboxed.value().unique_saturated_into())
.unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
// Depositing appropriate event.
Pallet::<T>::deposit_event(Event::UserMessageRead {
id: mailboxed.id(),
reason,
});
// Delete task, if exists.
let _ = TaskPoolOf::<T>::delete(
expected,
ScheduledTask::RemoveFromMailbox(user_id, mailboxed.id()),
);
mailboxed
}
/// Delays dispatch sending.
///
/// This function adds message into `TaskPool`.
///
/// Function creates gas node for message.
///
/// On processing task at defined block, we check destination, in case of
/// user and absence of gas node, we don't append message into any storage,
/// propagating `UserMessageSent` event only.
pub(crate) fn send_delayed_dispatch(
origin_msg: MessageId,
dispatch: Dispatch,
delay: u32,
to_user: bool,
reservation: Option<ReservationId>,
) {
// Validating delay.
if delay.is_zero() {
unreachable!("Delayed sending with zero delay appeared");
}
// Validating stash from duplicates.
if DispatchStashOf::<T>::contains_key(&dispatch.id()) {
unreachable!("Stash logic invalidated!")
}
// Validating dispatch wasn't sent from system with delay.
if dispatch.is_error_reply() || matches!(dispatch.kind(), DispatchKind::Signal) {
unreachable!("Scheduling logic invalidated");
}
// Indicates that message goes to mailbox and gas should be charged for holding
let mut to_mailbox = false;
// Sender node of the dispatch.
let sender_node = reservation
.map(GasNodeId::Reservation)
.unwrap_or_else(|| origin_msg.into());
// Taking data for funds manipulations.
let from = dispatch.source().cast();
let value = dispatch.value().unique_saturated_into();
// `HoldBound` builder.
let hold_builder = HoldBoundBuilder::<T>::new(StorageType::DispatchStash);
// Calculating correct gas amount for delay.
let delay_hold = hold_builder.duration(delay.saturated_into());
let gas_for_delay = delay_hold.lock_amount();
let interval_finish = if to_user {
// Querying `MailboxThreshold`, that represents minimal amount of gas
// for message to be added to mailbox.
let threshold = T::MailboxThreshold::get();
// Figuring out gas limit for insertion.
//
// In case of sending with gas, we use applied gas limit, otherwise
// finding available funds and trying to take threshold from them.
let gas_limit = dispatch
.gas_limit()
.or_else(|| {
// Querying gas limit. Fails in cases of `GasTree` invalidations.
let gas_limit = GasHandlerOf::<T>::get_limit(sender_node)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// If available gas is greater then threshold,
// than threshold can be used.
//
// Here we subtract gas for delay from gas limit to prevent
// case when gasless message steal threshold from gas for
// delay payment and delay payment becomes insufficient.
(gas_limit.saturating_sub(gas_for_delay) >= threshold).then_some(threshold)
})
.unwrap_or_default();
// Message is going to be inserted into mailbox.
//
// No hold bound checks required, because gas_limit isn't less than threshold.
to_mailbox = !dispatch.is_reply() && gas_limit >= threshold;
let gas_amount = if to_mailbox {
// Cutting gas for storing in mailbox.
gas_for_delay.saturating_add(gas_limit)
} else {
gas_for_delay
};
GasHandlerOf::<T>::cut(sender_node, dispatch.id(), gas_amount)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Generating gas node for future auto reply.
// TODO: use `sender_node` (e.g. reservation case) as first argument after #1828.
if !to_mailbox {
Self::split_with_value(
origin_msg,
MessageId::generate_reply(dispatch.id()),
0,
true,
);
}
// TODO: adapt this line if gasful sending appears for reservations (#1828)
if let Some(reservation_id) = reservation {
Self::remove_gas_reservation_with_task(dispatch.source(), reservation_id);
}
// Locking funds for holding.
let lock_id = delay_hold.lock_id().unwrap_or_else(|| {
unreachable!("DispatchStash storage is guaranteed to have an associated lock id")
});
GasHandlerOf::<T>::lock(dispatch.id(), lock_id, delay_hold.lock_amount())
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
if delay_hold.expected_duration().is_zero() {
unreachable!("Hold duration cannot be zero");
}
delay_hold.expected()
} else {
match (dispatch.gas_limit(), reservation) {
(Some(gas_limit), None) => Self::split_with_value(
sender_node,
dispatch.id(),
gas_limit.saturating_add(gas_for_delay),
dispatch.is_reply(),
),
(None, None) => Self::split(sender_node, dispatch.id(), dispatch.is_reply()),
(Some(_gas_limit), Some(_reservation_id)) => {
// TODO: #1828
unreachable!(
"Sending dispatch with gas limit from reservation \
is currently unimplemented and there is no way to send such dispatch"
);
}
(None, Some(reservation_id)) => {
Self::split(reservation_id, dispatch.id(), dispatch.is_reply());
Self::remove_gas_reservation_with_task(dispatch.source(), reservation_id);
}
}
// Locking funds for holding.
let lock_id = delay_hold.lock_id().unwrap_or_else(|| {
unreachable!("DispatchStash storage is guaranteed to have an associated lock id")
});
GasHandlerOf::<T>::lock(dispatch.id(), lock_id, delay_hold.lock_amount())
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
if delay_hold.expected_duration().is_zero() {
unreachable!("Hold duration cannot be zero");
}
delay_hold.expected()
};
if !dispatch.value().is_zero() {
// Reserving value from source for future transfer or unreserve.
GearBank::<T>::deposit_value(&from, value, false)
.unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
}
// Saving id to allow moving dispatch further.
let message_id = dispatch.id();
// Add block number of insertion.
let start_bn = Self::block_number();
let delay_interval = Interval {
start: start_bn,
finish: interval_finish,
};
// Adding message into the stash.
DispatchStashOf::<T>::insert(message_id, (dispatch.into_stored_delayed(), delay_interval));
let task = if to_user {
ScheduledTask::SendUserMessage {
message_id,
to_mailbox,
}
} else {
ScheduledTask::SendDispatch(message_id)
};
// Adding removal request in task pool.
let task_bn = Self::block_number().saturating_add(delay.unique_saturated_into());
TaskPoolOf::<T>::add(task_bn, task)
.unwrap_or_else(|e| unreachable!("Scheduling logic invalidated! {:?}", e));
}
/// Sends message to user.
///
/// It may be added to mailbox, if apply requirements.
pub(crate) fn send_user_message(
origin_msg: MessageId,
message: Message,
reservation: Option<ReservationId>,
) {
// Querying `MailboxThreshold`, that represents minimal amount of gas
// for message to be added to mailbox.
let threshold = T::MailboxThreshold::get();
let msg_id = reservation
.map(GasNodeId::Reservation)
.unwrap_or_else(|| origin_msg.into());
// Figuring out gas limit for insertion.
//
// In case of sending with gas, we use applied gas limit, otherwise
// finding available funds and trying to take threshold from them.
let gas_limit = message
.gas_limit()
.or_else(|| {
// Querying gas limit. Fails in cases of `GasTree` invalidations.
let gas_limit = GasHandlerOf::<T>::get_limit(msg_id)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// If available gas is greater then threshold,
// than threshold can be used.
(gas_limit >= threshold).then_some(threshold)
})
.unwrap_or_default();
// Converting message into stored one and user one.
let message = message.into_stored();
let message: UserMessage = message
.try_into()
.unwrap_or_else(|_| unreachable!("Signal message sent to user"));
// Taking data for funds manipulations.
let from = message.source().cast();
let to = message.destination().cast();
let value = message.value().unique_saturated_into();
// If gas limit can cover threshold, message will be added to mailbox,
// task created and funds reserved.
let expiration = if message.details().is_none() && gas_limit >= threshold {
// Figuring out hold bound for given gas limit.
let hold = HoldBoundBuilder::<T>::new(StorageType::Mailbox).maximum_for(gas_limit);
// Validating holding duration.
if hold.expected_duration().is_zero() {
unreachable!("Threshold for mailbox invalidated")
}
// Cutting gas for storing in mailbox.
GasHandlerOf::<T>::cut(msg_id, message.id(), gas_limit)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Reserving value from source for future transfer or unreserve.
GearBank::<T>::deposit_value(&from, value, false)
.unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
// Lock the entire `gas_limit` since the only purpose of it is payment for storage.
GasHandlerOf::<T>::lock(message.id(), LockId::Mailbox, gas_limit)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Inserting message in mailbox.
let message_id = message.id();
let message: UserStoredMessage = message
.clone()
.try_into()
.unwrap_or_else(|_| unreachable!("Replies are never added into mailbox"));
MailboxOf::<T>::insert(message, hold.expected())
.unwrap_or_else(|e| unreachable!("Mailbox corrupted! {:?}", e));
// Adding removal request in task pool.
TaskPoolOf::<T>::add(
hold.expected(),
ScheduledTask::RemoveFromMailbox(to, message_id),
)
.unwrap_or_else(|e| unreachable!("Scheduling logic invalidated! {:?}", e));
// Real expiration block.
Some(hold.expected())
} else {
// Permanently transferring funds.
CurrencyOf::<T>::transfer(&from, &to, value, ExistenceRequirement::AllowDeath)
.unwrap_or_else(|e| unreachable!("Failed to transfer value: {:?}", e));
if message.details().is_none() {
// Creating auto reply message.
let reply_message = ReplyMessage::auto(message.id());
// Creating `GasNode` for the auto reply.
// TODO: use `msg_id` (e.g. reservation case) as first argument after #1828.
Self::split_with_value(origin_msg, reply_message.id(), 0, true);
// Converting reply message into appropriate type for queueing.
let reply_dispatch = reply_message.into_stored_dispatch(
message.destination(),
message.source(),
message.id(),
);
// Queueing dispatch.
QueueOf::<T>::queue(reply_dispatch)
.unwrap_or_else(|e| unreachable!("Message queue corrupted! {:?}", e));
}
// No expiration block due to absence of insertion in storage.
None
};
// TODO: adapt if gasful sending appears for reservations (#1828)
if let Some(reservation_id) = reservation {
Self::remove_gas_reservation_with_task(message.source(), reservation_id);
}
// Depositing appropriate event.
Self::deposit_event(Event::UserMessageSent {
message,
expiration,
});
}
/// Sends user message, once delay reached.
pub(crate) fn send_user_message_after_delay(message: UserMessage, to_mailbox: bool) {
// Taking data for funds manipulations.
let from = message.source().cast();
let to = message.destination().cast();
let value = message.value().unique_saturated_into();
// If gas limit can cover threshold, message will be added to mailbox,
// task created and funds reserved.
let expiration = if to_mailbox {
// Querying gas limit. Fails in cases of `GasTree` invalidations.
let gas_limit = GasHandlerOf::<T>::get_limit(message.id())
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Figuring out hold bound for given gas limit.
let hold = HoldBoundBuilder::<T>::new(StorageType::Mailbox).maximum_for(gas_limit);
// Validating holding duration.
if hold.expected_duration().is_zero() {
unreachable!("Threshold for mailbox invalidated")
}
// Lock the entire `gas_limit` since the only purpose of it is payment for storage.
GasHandlerOf::<T>::lock(message.id(), LockId::Mailbox, gas_limit)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
// Inserting message in mailbox.
let message_id = message.id();
let message: UserStoredMessage = message
.clone()
.try_into()
.unwrap_or_else(|_| unreachable!("Replies are never added into mailbox"));
MailboxOf::<T>::insert(message, hold.expected())
.unwrap_or_else(|e| unreachable!("Mailbox corrupted! {:?}", e));
// Adding removal request in task pool.
TaskPoolOf::<T>::add(
hold.expected(),
ScheduledTask::RemoveFromMailbox(to, message_id),
)
.unwrap_or_else(|e| unreachable!("Scheduling logic invalidated! {:?}", e));
// Real expiration block.
Some(hold.expected())
} else {
// Transferring reserved funds.
GearBank::<T>::transfer_value(&from, &to, value)
.unwrap_or_else(|e| unreachable!("Gear bank error: {e:?}"));
// Message is never reply here, because delayed reply sending forbidden.
if message.details().is_none() {
// Creating reply message.
let reply_message = ReplyMessage::auto(message.id());
// `GasNode` was created on send already.
// Converting reply message into appropriate type for queueing.
let reply_dispatch = reply_message.into_stored_dispatch(
message.destination(),
message.source(),
message.id(),
);
// Queueing dispatch.
QueueOf::<T>::queue(reply_dispatch)
.unwrap_or_else(|e| unreachable!("Message queue corrupted! {:?}", e));
}
Self::consume_and_retrieve(message.id());
// No expiration block due to absence of insertion in storage.
None
};
// Depositing appropriate event.
Self::deposit_event(Event::UserMessageSent {
message,
expiration,
});
}
pub(crate) fn remove_gas_reservation_with_task(
program_id: ProgramId,
reservation_id: ReservationId,
) {
let slot = ExtManager::<T>::remove_gas_reservation_impl(program_id, reservation_id);
let _ = TaskPoolOf::<T>::delete(
BlockNumberFor::<T>::from(slot.finish),
ScheduledTask::RemoveGasReservation(program_id, reservation_id),
);
}
pub(crate) fn inheritor_for(program_id: ProgramId) -> ProgramId {
let mut inheritor = program_id;
let mut visited_ids: BTreeSet<_> = [program_id].into();
while let Some(id) =
Self::exit_inheritor_of(inheritor).or_else(|| Self::termination_inheritor_of(inheritor))
{
if !visited_ids.insert(id) {
break;
}
inheritor = id
}
inheritor
}
/// This fn and [`split_with_value`] works the same: they call api of gas
/// handler to split (optionally with value) for all cases except reply
/// sent and contains deposit in storage.
pub(crate) fn split(
key: impl Into<GasNodeIdOf<T>>,
new_key: impl Into<GasNodeIdOf<T>> + Clone,
is_reply: bool,
) {
if !is_reply || !GasHandlerOf::<T>::exists_and_deposit(new_key.clone()) {
GasHandlerOf::<T>::split(key, new_key)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
}
}
/// See ['split'].
pub(crate) fn split_with_value(
key: impl Into<GasNodeIdOf<T>>,
new_key: impl Into<GasNodeIdOf<T>> + Clone,
amount: GasBalanceOf<T>,
is_reply: bool,
) {
if !is_reply || !GasHandlerOf::<T>::exists_and_deposit(new_key.clone()) {
GasHandlerOf::<T>::split_with_value(key, new_key, amount)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
}
}
/// See ['split'].
pub(crate) fn create(
origin: T::AccountId,
key: impl Into<GasNodeIdOf<T>> + Clone,
amount: GasBalanceOf<T>,
is_reply: bool,
) {
let multiplier = <T as pallet_gear_bank::Config>::GasMultiplier::get();
if !is_reply || !GasHandlerOf::<T>::exists_and_deposit(key.clone()) {
GasHandlerOf::<T>::create(origin, multiplier, key, amount)
.unwrap_or_else(|e| unreachable!("GasTree corrupted! {:?}", e));
}
}
}