Skip to content

migrate alliance, fast-unstake and bags list to use derive-impl #1636

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

Merged
kianenigma merged 16 commits into from
Oct 1, 2023
Merged

migrate alliance, fast-unstake and bags list to use derive-impl #1636

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
49b6757
migrate alliance, fast-unstake and bags list to use derive-impl
kianenigma Sep 19, 2023
e9b5626
Update substrate/frame/alliance/src/mock.rs
kianenigma Sep 20, 2023
b304cfd
switch default MockBlock to be u32
kianenigma Sep 20, 2023
cd8513b
Merge branch 'kiz-migrat-some-pallet-to-default-config' of github.com…
kianenigma Sep 20, 2023
b3ae7ce
Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…
kianenigma Sep 20, 2023
a319f93
Revert "switch default MockBlock to be u32"
kianenigma Sep 20, 2023
97f953e
update
kianenigma Sep 20, 2023
e652c54
update XCM builder as well
kianenigma Sep 20, 2023
5965703
Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…
kianenigma Sep 21, 2023
3c74110
master.into()
kianenigma Sep 25, 2023
bfcb62d
update
kianenigma Sep 25, 2023
917f54f
Merge branch 'master' into kiz-migrat-some-pallet-to-default-config
kianenigma Sep 25, 2023
ed28c1c
Merge branch 'master' into kiz-migrat-some-pallet-to-default-config
kianenigma Sep 26, 2023
8f99359
Update substrate/frame/bags-list/src/tests.rs
kianenigma Sep 26, 2023
581e218
fix
kianenigma Sep 26, 2023
38f196f
Merge branch 'master' into kiz-migrat-some-pallet-to-default-config
kianenigma Sep 30, 2023
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
25 changes: 3 additions & 22 deletions substrate/frame/alliance/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ pub use sp_runtime::{
use sp_std::convert::{TryFrom, TryInto};

pub use frame_support::{
assert_noop, assert_ok, ord_parameter_types, parameter_types,
assert_noop, assert_ok, derive_impl, ord_parameter_types, parameter_types,
traits::{EitherOfDiverse, SortedMembers},
BoundedVec,
};
Expand All @@ -45,30 +45,11 @@ parameter_types! {
pub BlockWeights: frame_system::limits::BlockWeights =
frame_system::limits::BlockWeights::simple_max(Weight::MAX);
}

#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Test {
type BaseCallFilter = frame_support::traits::Everything;
type BlockWeights = BlockWeights;
type BlockLength = ();
type RuntimeOrigin = RuntimeOrigin;
type RuntimeCall = RuntimeCall;
type Nonce = u64;
type Hash = H256;
type Hashing = BlakeTwo256;
type AccountId = AccountId;
type Lookup = IdentityLookup<Self::AccountId>;
type Block = Block;
type RuntimeEvent = RuntimeEvent;
type BlockHashCount = BlockHashCount;
type DbWeight = ();
type Version = ();
type PalletInfo = PalletInfo;
type AccountData = pallet_balances::AccountData<AccountId>;
type OnNewAccount = ();
type OnKilledAccount = ();
type SystemWeightInfo = ();
type SS58Prefix = ();
type OnSetCode = ();
type MaxConsumers = frame_support::traits::ConstU32<16>;
}

parameter_types! {
Expand Down
26 changes: 3 additions & 23 deletions substrate/frame/bags-list/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@
use super::*;
use crate::{self as bags_list};
use frame_election_provider_support::VoteWeight;
use frame_support::parameter_types;
use frame_support::{derive_impl, parameter_types};
use sp_runtime::BuildStorage;
use std::collections::HashMap;

pub type AccountId = u32;
pub type AccountId = <Runtime as frame_system::Config>::AccountId;
pub type Balance = u32;

parameter_types! {
Expand All @@ -48,30 +48,10 @@ impl frame_election_provider_support::ScoreProvider<AccountId> for StakingMock {
}
}

#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Runtime {
type SS58Prefix = ();
type BaseCallFilter = frame_support::traits::Everything;
type RuntimeOrigin = RuntimeOrigin;
type Nonce = u64;
type RuntimeCall = RuntimeCall;
type Hash = sp_core::H256;
type Hashing = sp_runtime::traits::BlakeTwo256;
type AccountId = AccountId;
type Lookup = sp_runtime::traits::IdentityLookup<Self::AccountId>;
type Block = Block;
type RuntimeEvent = RuntimeEvent;
type BlockHashCount = ();
type DbWeight = ();
type BlockLength = ();
type BlockWeights = ();
type Version = ();
type PalletInfo = PalletInfo;
type AccountData = pallet_balances::AccountData<Balance>;
type OnNewAccount = ();
type OnKilledAccount = ();
type SystemWeightInfo = ();
type OnSetCode = ();
type MaxConsumers = frame_support::traits::ConstU32<16>;
}

parameter_types! {
Expand Down
6 changes: 3 additions & 3 deletions substrate/frame/bags-list/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ mod pallet {

assert_eq!(Bag::<Runtime>::get(10).unwrap(), Bag::new(Some(1), Some(3), 10));
assert_eq!(Bag::<Runtime>::get(1_000).unwrap(), Bag::new(Some(2), Some(2), 1_000));
assert_eq!(get_list_as_ids(), vec![2u32, 1, 4, 3]);
assert_eq!(get_list_as_ids(), vec![2u64, 1, 4, 3]);

// when
StakingMock::set_score_of(&2, 10);
Expand Down Expand Up @@ -272,10 +272,10 @@ mod pallet {
// given
assert_eq!(List::<Runtime>::get_bags(), vec![(20, vec![10, 11, 12])]);
// 11 now has more weight than 10 and can be moved before it.
StakingMock::set_score_of(&11u32, 17);
StakingMock::set_score_of(&11u64, 17);

// when
assert_ok!(BagsList::put_in_front_of_other(RuntimeOrigin::signed(42), 11u32, 10));
assert_ok!(BagsList::put_in_front_of_other(RuntimeOrigin::signed(42), 11, 10));
Comment thread
kianenigma marked this conversation as resolved.
Outdated

// then
assert_eq!(List::<Runtime>::get_bags(), vec![(20, vec![11, 10, 12])]);
Expand Down
19 changes: 12 additions & 7 deletions substrate/frame/balances/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ pub mod pallet {
/// Default implementations of [`DefaultConfig`], which can be used to implement [`Config`].
pub mod config_preludes {
use super::*;
use frame_support::derive_impl;
use frame_support::{derive_impl, traits::ConstU64};

pub struct TestDefaultConfig;

Expand All @@ -227,12 +227,17 @@ pub mod pallet {
impl DefaultConfig for TestDefaultConfig {
#[inject_runtime_type]
type RuntimeEvent = ();
#[inject_runtime_type]
type RuntimeHoldReason = ();
Copy link
Copy Markdown
Contributor

@KiChjang KiChjang Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huh, when we have #[inject_runtime_type] here, does it actually mean that the RHS here can be anything we want, and it wouldn't matter?

Copy link
Copy Markdown
Contributor Author

@kianenigma kianenigma Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be any type (as long as it is a valid type identifier) and any type is valid because in DefaultConfig it is merely a type RuntimeHoldReason with no bounds.


type Balance = u64;
type ExistentialDeposit = ConstU64<1>;

type ReserveIdentifier = ();
type FreezeIdentifier = ();

type DustRemoval = ();

type MaxLocks = ();
type MaxReserves = ();
type MaxFreezes = ();
Expand All @@ -249,6 +254,10 @@ pub mod pallet {
type RuntimeEvent: From<Event<Self, I>>
+ IsType<<Self as frame_system::Config>::RuntimeEvent>;

/// The overarching hold reason.
#[pallet::no_default_bounds]
type RuntimeHoldReason: Parameter + Member + MaxEncodedLen + Ord + Copy;

/// Weight information for extrinsics in this pallet.
type WeightInfo: WeightInfo;

Expand All @@ -266,7 +275,7 @@ pub mod pallet {
+ FixedPointOperand;

/// Handler for the unbalanced reduction when removing a dust account.
#[pallet::no_default]
#[pallet::no_default_bounds]
type DustRemoval: OnUnbalanced<CreditOf<Self, I>>;

/// The minimum amount required to keep an account open. MUST BE GREATER THAN ZERO!
Expand All @@ -278,7 +287,7 @@ pub mod pallet {
///
/// Bottom line: Do yourself a favour and make it at least one!
#[pallet::constant]
#[pallet::no_default]
#[pallet::no_default_bounds]
type ExistentialDeposit: Get<Self::Balance>;

/// The means of storing the balances of an account.
Expand All @@ -290,10 +299,6 @@ pub mod pallet {
/// Use of reserves is deprecated in favour of holds. See `https://github.com/paritytech/substrate/pull/12951/`
type ReserveIdentifier: Parameter + Member + MaxEncodedLen + Ord + Copy;

/// The overarching hold reason.
#[pallet::no_default]
type RuntimeHoldReason: Parameter + Member + MaxEncodedLen + Ord + Copy;

/// The ID type for freezes.
type FreezeIdentifier: Parameter + Member + MaxEncodedLen + Ord + Copy;

Expand Down
8 changes: 0 additions & 8 deletions substrate/frame/election-provider-multi-phase/test-staking-e2e/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,14 +89,6 @@ pub(crate) type Moment = u32;
#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Runtime {
type Block = Block;
type BlockHashCount = ConstU32<10>;
type BaseCallFilter = frame_support::traits::Everything;
type RuntimeOrigin = RuntimeOrigin;
type RuntimeCall = RuntimeCall;
type RuntimeEvent = RuntimeEvent;
type PalletInfo = PalletInfo;
type OnSetCode = ();

type AccountData = pallet_balances::AccountData<Balance>;
}

Expand Down
8 changes: 0 additions & 8 deletions substrate/frame/examples/kitchensink/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,7 @@ frame_support::construct_runtime!(
/// details.
#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Test {
type BaseCallFilter = frame_support::traits::Everything;
type Block = Block;
type BlockHashCount = ConstU64<10>;
type RuntimeOrigin = RuntimeOrigin;
type RuntimeCall = RuntimeCall;
type RuntimeEvent = RuntimeEvent;
type PalletInfo = PalletInfo;
type OnSetCode = ();

type AccountData = pallet_balances::AccountData<u64>;
}

Expand Down
7 changes: 0 additions & 7 deletions substrate/frame/examples/split/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,6 @@ frame_support::construct_runtime!(
#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Test {
type Block = Block;
type BlockHashCount = ConstU64<10>;
type BaseCallFilter = frame_support::traits::Everything;
type RuntimeOrigin = RuntimeOrigin;
type RuntimeCall = RuntimeCall;
type RuntimeEvent = RuntimeEvent;
type PalletInfo = PalletInfo;
type OnSetCode = ();
}

impl pallet_template::Config for Test {
Expand Down
28 changes: 5 additions & 23 deletions substrate/frame/fast-unstake/src/mock.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

use crate::{self as fast_unstake};
use frame_support::{
assert_ok,
assert_ok, derive_impl,
pallet_prelude::*,
parameter_types,
traits::{ConstU64, Currency},
Expand All @@ -32,7 +32,6 @@ use pallet_staking::{Exposure, IndividualExposure, StakerStatus};
use sp_std::prelude::*;

pub type AccountId = u128;
pub type Nonce = u32;
pub type BlockNumber = u64;
pub type Balance = u128;
pub type T = Runtime;
Expand All @@ -44,30 +43,13 @@ parameter_types! {
);
}

#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Runtime {
type BaseCallFilter = frame_support::traits::Everything;
type BlockWeights = BlockWeights;
type BlockLength = ();
type DbWeight = ();
type RuntimeOrigin = RuntimeOrigin;
type Nonce = Nonce;
type RuntimeCall = RuntimeCall;
type Hash = sp_core::H256;
type Hashing = sp_runtime::traits::BlakeTwo256;
type AccountId = AccountId;
type Lookup = IdentityLookup<Self::AccountId>;
type Block = Block;
type RuntimeEvent = RuntimeEvent;
type BlockHashCount = ();
type Version = ();
type PalletInfo = PalletInfo;
type AccountData = pallet_balances::AccountData<Balance>;
type OnNewAccount = ();
type OnKilledAccount = ();
type SystemWeightInfo = ();
type SS58Prefix = ();
type OnSetCode = ();
type MaxConsumers = frame_support::traits::ConstU32<16>;
// we use U128 account id in this pallet for a good reason.
Copy link
Copy Markdown
Contributor

@liamaharon liamaharon Sep 21, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the 'good reason'? should we mention it in this comment?

Copy link
Copy Markdown
Contributor Author

@kianenigma kianenigma Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had mixed this in nomination-pools, where we do use u128 such that the process of converting a pool id into account id would work and yield different numbers. I actually don't know the reason for this, and will try and move it to u32.

Copy link
Copy Markdown
Contributor Author

@kianenigma kianenigma Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems to have something to do with iteration order -- with u128, if I insert 1 and 2 into a map and then iter on it, I get it back in the same order, but not with u32.

Copy link
Copy Markdown
Contributor Author

@kianenigma kianenigma Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the right behavior is actually to be agnostic to the order, as the pallet makes no guarantees there.

type AccountId = AccountId;
type Lookup = IdentityLookup<Self::AccountId>;
}

impl pallet_timestamp::Config for Runtime {
Expand Down
13 changes: 2 additions & 11 deletions substrate/frame/multisig/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,24 +43,15 @@ frame_support::construct_runtime!(
impl frame_system::Config for Test {
type Block = Block;
type BlockHashCount = ConstU32<250>;
type RuntimeOrigin = RuntimeOrigin;
type RuntimeCall = RuntimeCall;
type RuntimeEvent = RuntimeEvent;
type BaseCallFilter = TestBaseCallFilter;
type PalletInfo = PalletInfo;
type OnSetCode = ();

type AccountData = pallet_balances::AccountData<u64>;
// This pallet wishes to overwrite this.
Copy link
Copy Markdown
Contributor

@liamaharon liamaharon Sep 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

Copy link
Copy Markdown
Contributor Author

@kianenigma kianenigma Sep 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not aware tbh, but somehow in the test setu they wishes to on;y allow balances and remark transactions. Probably to test that any call filter here cannot be bipassed by being wrapped in a multisig.

type BaseCallFilter = TestBaseCallFilter;
}

#[derive_impl(pallet_balances::config_preludes::TestDefaultConfig as pallet_balances::DefaultConfig)]
impl pallet_balances::Config for Test {
type RuntimeEvent = RuntimeEvent;
type RuntimeHoldReason = ();
type ReserveIdentifier = [u8; 8];
type DustRemoval = ();
type AccountStore = System;
type ExistentialDeposit = ConstU64<1>;
}

pub struct TestBaseCallFilter;
Expand Down
11 changes: 0 additions & 11 deletions substrate/frame/proxy/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,14 @@ frame_support::construct_runtime!(
#[derive_impl(frame_system::config_preludes::TestDefaultConfig as frame_system::DefaultConfig)]
impl frame_system::Config for Test {
type Block = Block;
type BlockHashCount = ConstU64<250>;
type RuntimeOrigin = RuntimeOrigin;
type RuntimeCall = RuntimeCall;
type RuntimeEvent = RuntimeEvent;
type PalletInfo = PalletInfo;
type OnSetCode = ();

type BaseCallFilter = BaseFilter;
type AccountData = pallet_balances::AccountData<u64>;
}

#[derive_impl(pallet_balances::config_preludes::TestDefaultConfig as pallet_balances::DefaultConfig)]
impl pallet_balances::Config for Test {
type RuntimeEvent = RuntimeEvent;
type RuntimeHoldReason = ();
type ReserveIdentifier = [u8; 8];
type DustRemoval = ();
type AccountStore = System;
type ExistentialDeposit = ConstU64<1>;
}

impl pallet_utility::Config for Test {
Expand Down
2 changes: 2 additions & 0 deletions substrate/frame/support/procedural/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -877,6 +877,8 @@ pub fn inject_runtime_type(_: TokenStream, tokens: TokenStream) -> TokenStream {
if item.ident != "RuntimeCall" &&
Copy link
Copy Markdown
Contributor

@liamaharon liamaharon Sep 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd love to see docs on these macros

Copy link
Copy Markdown
Contributor

@gupnik gupnik Sep 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs are available here:

polkadot-sdk/substrate/frame/support/src/lib.rs

Line 844 in cfc6cc6

pub use frame_support_procedural::inject_runtime_type;

item.ident != "RuntimeEvent" &&
item.ident != "RuntimeOrigin" &&
item.ident != "RuntimeHoldReason" &&
item.ident != "RuntimeFreezeReason" &&
Copy link
Copy Markdown
Contributor

@gupnik gupnik Sep 21, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to modify the error message as well.

item.ident != "PalletInfo"
{
return syn::Error::new_spanned(
Expand Down