Skip to content

Commit

Permalink
pallet-referenda: Detect incorrect pre-image length (#3850)
Browse files Browse the repository at this point in the history
There has been a case that a referenda failed because the length given
to `submit` was incorrect. The pallet can actually check the length if
the pre-image already exists to ensure that these kind of issues are not
happening again.
  • Loading branch information
bkchr authored Mar 27, 2024
1 parent 597ea92 commit 5d314eb
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
15 changes: 15 additions & 0 deletions prdoc/pr_3850.prdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
title: Detect incorrect pre-image length when submitting a referenda

doc:
- audience: Runtime User
description: |
When submitting a referenda the `proposal` is passed as argument.
The `proposal` is most of the time a reference to a `pre-image` and
which also contains the length of the `pre-image`. This pull request
adds some logic to check that if the `pre-image` already exists and if
it exists, it ensures that the length is passed correctly. This prevents
that the referenda can not be executed because of a mismatch of this
length.

crates:
- name: pallet-referenda
12 changes: 12 additions & 0 deletions substrate/frame/referenda/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -424,6 +424,8 @@ pub mod pallet {
BadStatus,
/// The preimage does not exist.
PreimageNotExist,
/// The preimage is stored with a different length than the one provided.
PreimageStoredWithDifferentLength,
}

#[pallet::hooks]
Expand Down Expand Up @@ -462,6 +464,16 @@ pub mod pallet {
let proposal_origin = *proposal_origin;
let who = T::SubmitOrigin::ensure_origin(origin, &proposal_origin)?;

// If the pre-image is already stored, ensure that it has the same length as given in
// `proposal`.
if let (Some(preimage_len), Some(proposal_len)) =
(proposal.lookup_hash().and_then(|h| T::Preimages::len(&h)), proposal.lookup_len())
{
if preimage_len != proposal_len {
return Err(Error::<T, I>::PreimageStoredWithDifferentLength.into())
}
}

let track =
T::Tracks::track_for(&proposal_origin).map_err(|_| Error::<T, I>::NoTrack)?;
let submission_deposit = Self::take_deposit(who, T::SubmissionDeposit::get())?;
Expand Down
16 changes: 16 additions & 0 deletions substrate/frame/referenda/src/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -666,3 +666,19 @@ fn clear_metadata_works() {
}));
});
}

#[test]
fn detects_incorrect_len() {
ExtBuilder::default().build_and_execute(|| {
let hash = note_preimage(1);
assert_noop!(
Referenda::submit(
RuntimeOrigin::signed(1),
Box::new(RawOrigin::Root.into()),
frame_support::traits::Bounded::Lookup { hash, len: 3 },
DispatchTime::At(1),
),
Error::<Test>::PreimageStoredWithDifferentLength
);
});
}

0 comments on commit 5d314eb

Please sign in to comment.