Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

Better error for when origin filter prevent the call to be dispatched #10134

Merged
merged 9 commits into from
Nov 2, 2021
Merged
Show file tree
Hide file tree
Changes from 3 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
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,15 @@ use syn::Ident;

pub fn expand_outer_dispatch(
runtime: &Ident,
system_pallet: &Pallet,
pallet_decls: &[Pallet],
scrate: &TokenStream,
) -> TokenStream {
let mut variant_defs = TokenStream::new();
let mut variant_patterns = Vec::new();
let mut query_call_part_macros = Vec::new();
let mut pallet_names = Vec::new();
let system_path = &system_pallet.path;

let pallets_with_call = pallet_decls.iter().filter(|decl| decl.exists_part("Call"));

Expand Down Expand Up @@ -106,7 +108,9 @@ pub fn expand_outer_dispatch(
type PostInfo = #scrate::weights::PostDispatchInfo;
fn dispatch(self, origin: Origin) -> #scrate::dispatch::DispatchResultWithPostInfo {
if !<Self::Origin as #scrate::traits::OriginTrait>::filter_call(&origin, &self) {
return #scrate::sp_std::result::Result::Err(#scrate::dispatch::DispatchError::BadOrigin.into());
return #scrate::sp_std::result::Result::Err(
#system_path::Error::<#runtime>::CallFiltered.into()
);
}

#scrate::traits::UnfilteredDispatchable::dispatch_bypass_filter(self, origin)
Expand Down
12 changes: 2 additions & 10 deletions frame/support/procedural/src/construct_runtime/expand/origin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,14 @@
use crate::construct_runtime::{Pallet, SYSTEM_PALLET_NAME};
use proc_macro2::TokenStream;
use quote::quote;
use syn::{token, Generics, Ident};
use syn::{Generics, Ident};

pub fn expand_outer_origin(
runtime: &Ident,
system_pallet: &Pallet,
pallets: &[Pallet],
pallets_token: token::Brace,
scrate: &TokenStream,
) -> syn::Result<TokenStream> {
let system_pallet =
pallets.iter().find(|decl| decl.name == SYSTEM_PALLET_NAME).ok_or_else(|| {
syn::Error::new(
pallets_token.span,
"`System` pallet declaration is missing. \
Please add this line: `System: frame_system::{Pallet, Call, Storage, Config, Event<T>},`",
)
})?;

let mut caller_variants = TokenStream::new();
let mut pallet_conversions = TokenStream::new();
Expand Down
13 changes: 11 additions & 2 deletions frame/support/procedural/src/construct_runtime/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -214,17 +214,26 @@ fn construct_runtime_final_expansion(
pallets_token,
} = definition;

let system_pallet =
pallets.iter().find(|decl| decl.name == SYSTEM_PALLET_NAME).ok_or_else(|| {
syn::Error::new(
pallets_token.span,
"`System` pallet declaration is missing. \
Please add this line: `System: frame_system::{Pallet, Call, Storage, Config, Event<T>},`",
)
})?;

let hidden_crate_name = "construct_runtime";
let scrate = generate_crate_access(&hidden_crate_name, "frame-support");
let scrate_decl = generate_hidden_includes(&hidden_crate_name, "frame-support");

let outer_event = expand::expand_outer_event(&name, &pallets, &scrate)?;

let outer_origin = expand::expand_outer_origin(&name, &pallets, pallets_token, &scrate)?;
let outer_origin = expand::expand_outer_origin(&name, &system_pallet, &pallets, &scrate)?;
let all_pallets = decl_all_pallets(&name, pallets.iter());
let pallet_to_index = decl_pallet_runtime_setup(&name, &pallets, &scrate);

let dispatch = expand::expand_outer_dispatch(&name, &pallets, &scrate);
let dispatch = expand::expand_outer_dispatch(&name, &system_pallet, &pallets, &scrate);
let metadata = expand::expand_runtime_metadata(&name, &pallets, &scrate, &unchecked_extrinsic);
let outer_config = expand::expand_outer_config(&name, &pallets, &scrate);
let inherent =
Expand Down
4 changes: 3 additions & 1 deletion frame/support/test/tests/system.rs
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,9 @@ frame_support::decl_error! {
TestError,
/// Error documentation
/// with multiple lines
AnotherError
AnotherError,
// Required by construct_runtime
CallFiltered,
}
}

Expand Down
2 changes: 2 additions & 0 deletions frame/system/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -560,6 +560,8 @@ pub mod pallet {
NonDefaultComposite,
/// There is a non-zero reference count preventing the account from being purged.
NonZeroRefCount,
/// The origin filter prevent the call to be dispatched.
CallFiltered,
}

/// Exposed trait-generic origin type.
Expand Down