This repository has been archived by the owner on Nov 15, 2023. It is now read-only.
Make hooks and call attributes optional in pallet macro #8853
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KiChjang
added
A0-please_review
|
Follow up is to clean any empty call or hooks in existing pallets :) |
shawntabrizi
added
D3-trivial 🧸
coriolinus
approved these changes
May 19, 2021
gui1117
reviewed
May 19, 2021
|
@thiolliere So the reason why I didn't opt for not generating a Call enum is because the expanded code looked as if other code was dependent on it. I just tried applying the following change and it indeed gave me compiler errors: diff --git a/frame/support/procedural/src/pallet/expand/call.rs b/frame/support/procedural/src/pallet/expand/call.rs
index 0d28f5583..aa21576bd 100644
--- a/frame/support/procedural/src/pallet/expand/call.rs
+++ b/frame/support/procedural/src/pallet/expand/call.rs
@@ -15,20 +15,16 @@
// See the License for the specific language governing permissions and
// limitations under the License.
-use crate::pallet::{Def, parse::call::CallDef};
+use crate::pallet::Def;
use frame_support_procedural_tools::clean_type_string;
use syn::spanned::Spanned;
/// * Generate enum call and implement various trait on it.
/// * Implement Callable and call_function on `Pallet`
pub fn expand_call(def: &mut Def) -> proc_macro2::TokenStream {
- let empty_call;
let call = match def.call.as_ref() {
Some(call) => call,
- None => {
- empty_call = CallDef::empty(def.pallet_struct.attr_span);
- &empty_call
- }
+ None => return proc_macro2::TokenStream::new(),
};
let frame_support = &def.frame_support;
let frame_system = &def.frame_system;Errors: |
|
this work to me: diff --git a/frame/support/procedural/src/pallet/expand/call.rs b/frame/support/procedural/src/pallet/expand/call.rs
index 0d28f55839..e5cf2c848b 100644
--- a/frame/support/procedural/src/pallet/expand/call.rs
+++ b/frame/support/procedural/src/pallet/expand/call.rs
@@ -22,12 +22,10 @@ use syn::spanned::Spanned;
/// * Generate enum call and implement various trait on it.
/// * Implement Callable and call_function on `Pallet`
pub fn expand_call(def: &mut Def) -> proc_macro2::TokenStream {
- let empty_call;
let call = match def.call.as_ref() {
Some(call) => call,
None => {
- empty_call = CallDef::empty(def.pallet_struct.attr_span);
- &empty_call
+ return Default::default()
}
};
let frame_support = &def.frame_support;
diff --git a/frame/support/test/tests/pallet_instance.rs b/frame/support/test/tests/pallet_instance.rs
index 846a96a237..08fd636bf6 100644
--- a/frame/support/test/tests/pallet_instance.rs
+++ b/frame/support/test/tests/pallet_instance.rs
@@ -306,8 +306,8 @@ frame_support::construct_runtime!(
Instance1Example: pallet::<Instance1>::{
Pallet, Call, Event<T>, Config, Storage, Inherent, Origin<T>, ValidateUnsigned
},
- Example2: pallet2::{Pallet, Call, Event<T>, Config<T>, Storage},
- Instance1Example2: pallet2::<Instance1>::{Pallet, Call, Event<T>, Config<T>, Storage},
+ Example2: pallet2::{Pallet, Event<T>, Config<T>, Storage},
+ Instance1Example2: pallet2::<Instance1>::{Pallet, Event<T>, Config<T>, Storage},
}
);Pallet without call needs not to have the |
|
Ah ok, looks like the errors come from importing a non-existent Call part. EDIT: Actually, now that I think about it, what's the best way of producing an error message for users trying to use the Call enum in the |
|
Okay, so let me take a step back and think about the workflow of a FRAME developer. Suppose that my requirements at the moment required me to create a new pallet that doesn't contain any calls. Right now, I still have to write an empty implementation under the If we were to not generate the So I guess the question would be whether this is a good default to have. I can definitely see it being a sensible default to not generate unnecessary code, but I'm just wondering if this would come at the expense of development friction. (Ideally speaking, this problem would be solved by #8084 where we would have the logic to decide whether or not to generate the |
|
I agree, there is a tradeoff between:
So I'm ok to generate an empty Call generated here |
gui1117
approved these changes
May 20, 2021
There was a problem hiding this comment.
still minor doc comment #8853 (comment) #8853 (comment)
But it is good to me
|
bot merge |
|
Trying merge. |
ghost
merged commit
nazar-pc
pushed a commit
to autonomys/substrate
that referenced
this pull request
Aug 8, 2021
) * Make #[pallet::hooks] optional * Make #[pallet::call] optional * Remove unused imports * Update UI test expectations * Update UI test expectations * Remove unnecessary HooksDef::empty method * Remove unnecessary CallDef::empty method * Clarify what would happen when no call or hooks are specified in a pallet
6 tasks
This pull request was closed.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #8725.