Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MaxTipAmount for pallet-tips #1709

Merged
merged 4 commits into from
Sep 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions polkadot/runtime/rococo/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -630,6 +630,7 @@ impl pallet_tips::Config for Runtime {
type TipCountdown = TipCountdown;
type TipFindersFee = TipFindersFee;
type TipReportDepositBase = TipReportDepositBase;
type MaxTipAmount = ConstU128<{ 500 * UNITS }>;
type RuntimeEvent = RuntimeEvent;
type WeightInfo = weights::pallet_tips::WeightInfo<Runtime>;
}
Expand Down
1 change: 1 addition & 0 deletions substrate/bin/node/runtime/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1288,6 +1288,7 @@ impl pallet_tips::Config for Runtime {
type TipCountdown = TipCountdown;
type TipFindersFee = TipFindersFee;
type TipReportDepositBase = TipReportDepositBase;
type MaxTipAmount = ConstU128<{ 500 * DOLLARS }>;
type WeightInfo = pallet_tips::weights::SubstrateWeight<Runtime>;
}

Expand Down
1 change: 1 addition & 0 deletions substrate/docs/Upgrading-2.0-to-3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,7 @@ impl pallet_tips::Config for Runtime {
type TipCountdown = TipCountdown;
type TipFindersFee = TipFindersFee;
type TipReportDepositBase = TipReportDepositBase;
type MaxTipAmount = MaxTipAmount;
type WeightInfo = pallet_tips::weights::SubstrateWeight<Runtime>;
}
```
Expand Down
14 changes: 13 additions & 1 deletion substrate/frame/tips/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,10 @@ pub mod pallet {
#[pallet::constant]
type TipReportDepositBase: Get<BalanceOf<Self, I>>;

/// The maximum amount for a single tip.
#[pallet::constant]
type MaxTipAmount: Get<BalanceOf<Self, I>>;

/// Origin from which tippers must come.
///
/// `ContainsLengthBound::max_len` must be cost free (i.e. no storage read or heavy
Expand Down Expand Up @@ -208,6 +212,8 @@ pub mod pallet {
AlreadyKnown,
/// The tip hash is unknown.
UnknownTip,
/// The tip given was too generous.
MaxTipAmountExceeded,
/// The account attempting to retract the tip is not the finder of the tip.
NotFinder,
/// The tip cannot be claimed/closed because there are not enough tippers yet.
Expand Down Expand Up @@ -336,10 +342,13 @@ pub mod pallet {
let tipper = ensure_signed(origin)?;
let who = T::Lookup::lookup(who)?;
ensure!(T::Tippers::contains(&tipper), BadOrigin);

let reason_hash = T::Hashing::hash(&reason[..]);
ensure!(!Reasons::<T, I>::contains_key(&reason_hash), Error::<T, I>::AlreadyKnown);
let hash = T::Hashing::hash_of(&(&reason_hash, &who));

ensure!(T::MaxTipAmount::get() >= tip_value, Error::<T, I>::MaxTipAmountExceeded);
AurevoirXavier marked this conversation as resolved.
Show resolved Hide resolved

let hash = T::Hashing::hash_of(&(&reason_hash, &who));
Reasons::<T, I>::insert(&reason_hash, &reason);
Self::deposit_event(Event::NewTip { tip_hash: hash });
let tips = vec![(tipper.clone(), tip_value)];
Expand Down Expand Up @@ -388,6 +397,9 @@ pub mod pallet {
ensure!(T::Tippers::contains(&tipper), BadOrigin);

let mut tip = Tips::<T, I>::get(hash).ok_or(Error::<T, I>::UnknownTip)?;

ensure!(T::MaxTipAmount::get() >= tip_value, Error::<T, I>::MaxTipAmountExceeded);
AurevoirXavier marked this conversation as resolved.
Show resolved Hide resolved

if Self::insert_tip_and_check_closing(&mut tip, tipper, tip_value) {
Self::deposit_event(Event::TipClosing { tip_hash: hash });
}
Expand Down
19 changes: 19 additions & 0 deletions substrate/frame/tips/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ impl Config for Test {
type TipFindersFee = TipFindersFee;
type TipReportDepositBase = ConstU64<1>;
type DataDepositPerByte = ConstU64<1>;
type MaxTipAmount = ConstU64<10_000_000>;
type RuntimeEvent = RuntimeEvent;
type WeightInfo = ();
}
Expand All @@ -183,6 +184,7 @@ impl Config<Instance1> for Test {
type TipFindersFee = TipFindersFee;
type TipReportDepositBase = ConstU64<1>;
type DataDepositPerByte = ConstU64<1>;
type MaxTipAmount = ConstU64<10_000_000>;
type RuntimeEvent = RuntimeEvent;
type WeightInfo = ();
}
Expand Down Expand Up @@ -396,6 +398,23 @@ fn tip_median_calculation_works() {
});
}

#[test]
fn tip_large_should_fail() {
new_test_ext().execute_with(|| {
Balances::make_free_balance_be(&Treasury::account_id(), 101);
assert_ok!(Tips::tip_new(RuntimeOrigin::signed(10), b"awesome.dot".to_vec(), 3, 0));
let h = tip_hash();
assert_noop!(
Tips::tip(
RuntimeOrigin::signed(12),
h,
<<Test as Config>::MaxTipAmount as Get<u64>>::get() + 1
),
Error::<Test>::MaxTipAmountExceeded
);
});
}

#[test]
fn tip_changing_works() {
new_test_ext().execute_with(|| {
Expand Down
Loading