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
// This file is part of Gear.
// Copyright (C) 2021-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/>.
use super::*;
/// Opaque, move-only struct with private field to denote that value has been
/// created without any equal and opposite accounting
#[derive(RuntimeDebug, PartialEq, Eq)]
pub struct PositiveImbalance<Balance: BalanceTrait>(Balance);
impl<Balance: BalanceTrait> PositiveImbalance<Balance> {
/// Create a new positive imbalance from value amount.
pub fn new(amount: Balance) -> Self {
PositiveImbalance(amount)
}
}
impl<Balance: BalanceTrait> Imbalance for PositiveImbalance<Balance> {
type Balance = Balance;
fn peek(&self) -> Self::Balance {
self.0
}
fn apply_to(&self, amount: &mut Option<Balance>) -> Result<(), ImbalanceError> {
let amount_value = amount.unwrap_or_else(Zero::zero);
if let Some(amount_value) = amount_value.checked_add(&self.0) {
*amount = Some(amount_value);
Ok(())
} else {
Err(ImbalanceError)
}
// if self.0 > Balance::max_value() - amount_value {
// return Err(ImbalanceError::Overflow);
// }
// *amount = Some(amount_value + self.0);
// Ok(())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn amount_increases_when_not_overflowing_imbalance_applied() {
let imbalance = PositiveImbalance::<u32>::new(45);
let mut amount = Some(44);
let result = imbalance.apply_to(&mut amount);
assert_eq!(Ok(()), result);
assert_eq!(Some(89), amount);
}
#[test]
fn error_returned_when_overflowing_imbalance_applied() {
let imbalance = PositiveImbalance::<u32>::new(120);
let mut amount = Some(u32::MAX - 100);
let result = imbalance.apply_to(&mut amount);
assert_eq!(Err(ImbalanceError), result);
assert_eq!(Some(u32::MAX - 100), amount);
}
}