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.

Sign up for GitHub

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

Jump to bottom

Deprecate scheduler traits v1 and v2 #3718

Merged
merged 10 commits into from
Mar 28, 2024
Merged

Deprecate scheduler traits v1 and v2 #3718

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5af5c13
add deprecated tag to schedule trait v1 and v2
chungquantin Mar 17, 2024
ae03822
Merge branch 'master' into chugnquantin/deprecated_schedule_trait
chungquantin Mar 17, 2024
038a98e
Follow deprecation convetion
chungquantin Mar 17, 2024
b8ddcd8
add `#[allow(deprecated)]` attribute
chungquantin Mar 17, 2024
54cd332
Update deprecated note
chungquantin Mar 18, 2024
d4e5ef7
Update deprecated note
chungquantin Mar 18, 2024
2c2bebf
Remove v3 migration TODO
chungquantin Mar 18, 2024
d211104
Create pr_3718.prdoc
chungquantin Mar 18, 2024
306af35
Merge branch 'master' into chugnquantin/deprecated_schedule_trait
chungquantin Mar 18, 2024
93d1dfe
Merge branch 'master' into chugnquantin/deprecated_schedule_trait
liamaharon Mar 28, 2024
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
3 changes: 3 additions & 0 deletions substrate/frame/scheduler/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1435,6 +1435,7 @@ impl<T: Config> Pallet<T> {
}
}

#[allow(deprecated)]
impl<T: Config> schedule::v2::Anon<BlockNumberFor<T>, <T as Config>::RuntimeCall, T::PalletsOrigin>
for Pallet<T>
{
Expand Down Expand Up @@ -1469,6 +1470,8 @@ impl<T: Config> schedule::v2::Anon<BlockNumberFor<T>, <T as Config>::RuntimeCall
}
}

// TODO: migrate `schedule::v2::Anon` to `v3`
#[allow(deprecated)]
impl<T: Config> schedule::v2::Named<BlockNumberFor<T>, <T as Config>::RuntimeCall, T::PalletsOrigin>
for Pallet<T>
{
Expand Down
18 changes: 16 additions & 2 deletions substrate/frame/support/src/traits/schedule.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ impl<T: Decode, H> MaybeHashed<T, H> {
}
}

// TODO: deprecate
#[deprecated(note = "Use `v3` instead. Will be removed after September 2024.")]
pub mod v1 {
use super::*;

Expand Down Expand Up @@ -218,10 +218,12 @@ pub mod v1 {
fn next_dispatch_time(id: Vec<u8>) -> Result<BlockNumber, ()>;
}

#[allow(deprecated)]
impl<T, BlockNumber, Call, RuntimeOrigin> Anon<BlockNumber, Call, RuntimeOrigin> for T
where
T: v2::Anon<BlockNumber, Call, RuntimeOrigin>,
{
#[allow(deprecated)]
type Address = T::Address;

fn schedule(
Expand All @@ -232,29 +234,36 @@ pub mod v1 {
call: Call,
) -> Result<Self::Address, DispatchError> {
let c = MaybeHashed::<Call, T::Hash>::Value(call);

#[allow(deprecated)]
T::schedule(when, maybe_periodic, priority, origin, c)
}

fn cancel(address: Self::Address) -> Result<(), ()> {
#[allow(deprecated)]
T::cancel(address)
}

fn reschedule(
address: Self::Address,
when: DispatchTime<BlockNumber>,
) -> Result<Self::Address, DispatchError> {
#[allow(deprecated)]
T::reschedule(address, when)
}

fn next_dispatch_time(address: Self::Address) -> Result<BlockNumber, ()> {
#[allow(deprecated)]
T::next_dispatch_time(address)
}
}

#[allow(deprecated)]
impl<T, BlockNumber, Call, RuntimeOrigin> Named<BlockNumber, Call, RuntimeOrigin> for T
where
T: v2::Named<BlockNumber, Call, RuntimeOrigin>,
{
#[allow(deprecated)]
type Address = T::Address;

fn schedule_named(
Expand All @@ -266,27 +275,31 @@ pub mod v1 {
call: Call,
) -> Result<Self::Address, ()> {
let c = MaybeHashed::<Call, T::Hash>::Value(call);
#[allow(deprecated)]
T::schedule_named(id, when, maybe_periodic, priority, origin, c)
}

fn cancel_named(id: Vec<u8>) -> Result<(), ()> {
#[allow(deprecated)]
T::cancel_named(id)
}

fn reschedule_named(
id: Vec<u8>,
when: DispatchTime<BlockNumber>,
) -> Result<Self::Address, DispatchError> {
#[allow(deprecated)]
T::reschedule_named(id, when)
}

fn next_dispatch_time(id: Vec<u8>) -> Result<BlockNumber, ()> {
#[allow(deprecated)]
T::next_dispatch_time(id)
}
}
}

// TODO: deprecate
#[deprecated(note = "Use `v3` instead. Will be removed after September 2024.")]
pub mod v2 {
use super::*;

Expand Down Expand Up @@ -478,4 +491,5 @@ pub mod v3 {
}
}

#[allow(deprecated)]
pub use v1::*;
Loading