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

Document safety constraints of pallet-scheduler #14715

Closed
kianenigma opened this issue Aug 4, 2023 · 2 comments · Fixed by #14740
Closed

Document safety constraints of pallet-scheduler #14715

kianenigma opened this issue Aug 4, 2023 · 2 comments · Fixed by #14740
Labels
I6-documentation Documentation needs fixing, improving or augmenting. Z6-mentor An easy task where a mentor is available. Please indicate in the issue who the mentor could be.

Comments

@kianenigma
Copy link
Contributor

kianenigma commented Aug 4, 2023

There is a lot of insider information, spread mostly in forum posts like https://forum.polkadot.network/t/pallet-idea-safe-scheduler/1009 that the existing scheduler pallet is unsafe, and should only be used internally by the runtime. In other words, scheduling operations should not be allowed by arbitrary external users.

I am worried that, similar to offchain workers, this pallet it as first glance a silver bullet that might lead to someone designing an application with the wrong assumption, thinking that this pallet is going magically schedule things for them across blocks, while it won't, and it can easily lead a parachain to stall.

This information is vital and should be in the source docs of the pallet, not the heads of a few.

Additionally, a warning about the change of decoding for stored calls is also a good point to be mentioned.

Update https://paritytech.github.io/substrate/master/pallet_scheduler/index.html to be aligned with the house pallet documentation guidelines, and make sure this point is also covered.

@kianenigma
Copy link
Contributor Author

@sam0x17 given your work on #14329 will to some extent solve a similar problem, this might be a good one for you.

Else, anyone wishing to work on documentation of pallets (wink @sacha-l @aaronbassett) can pick this up.

@kianenigma kianenigma added the I6-documentation Documentation needs fixing, improving or augmenting. label Aug 4, 2023
@snowmead
Copy link
Contributor

snowmead commented Aug 4, 2023

Hey @kianenigma, I will take this.

@kianenigma kianenigma added the Z6-mentor An easy task where a mentor is available. Please indicate in the issue who the mentor could be. label Aug 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
I6-documentation Documentation needs fixing, improving or augmenting. Z6-mentor An easy task where a mentor is available. Please indicate in the issue who the mentor could be.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants