Backport: Nomination Pools (#10694)

Cargo.toml

@@ -109,6 +109,8 @@ members = [
  "frame/offences",
  "frame/preimage",
  "frame/proxy",
+ "frame/nomination-pools",
+ "frame/nomination-pools/benchmarking",
  "frame/randomness-collective-flip",
  "frame/recovery",
  "frame/referenda",

bin/node/cli/src/chain_spec.rs

@@ -363,6 +363,7 @@ pub fn testnet_genesis(
  gilt: Default::default(),
  transaction_storage: Default::default(),
  transaction_payment: Default::default(),
+ nomination_pools: Default::default(),
  }
 }
 

bin/node/runtime/Cargo.toml

@@ -76,6 +76,8 @@ pallet-lottery = { version = "4.0.0-dev", default-features = false, path = "../.
 pallet-membership = { version = "4.0.0-dev", default-features = false, path = "../../../frame/membership" }
 pallet-mmr = { version = "4.0.0-dev", default-features = false, path = "../../../frame/merkle-mountain-range" }
 pallet-multisig = { version = "4.0.0-dev", default-features = false, path = "../../../frame/multisig" }
+pallet-nomination-pools = { version = "1.0.0", default-features = false, path = "../../../frame/nomination-pools"}
+pallet-nomination-pools-benchmarking = { version = "1.0.0", default-features = false, optional = true, path = "../../../frame/nomination-pools/benchmarking" }
 pallet-offences = { version = "4.0.0-dev", default-features = false, path = "../../../frame/offences" }
 pallet-offences-benchmarking = { version = "4.0.0-dev", path = "../../../frame/offences/benchmarking", default-features = false, optional = true }
 pallet-preimage = { version = "4.0.0-dev", default-features = false, path = "../../../frame/preimage" }
@@ -139,6 +141,7 @@ std = [
  "pallet-membership/std",
  "pallet-mmr/std",
  "pallet-multisig/std",
+ "pallet-nomination-pools/std",
  "pallet-identity/std",
  "pallet-scheduler/std",
  "node-primitives/std",
@@ -208,6 +211,7 @@ runtime-benchmarks = [
  "pallet-membership/runtime-benchmarks",
  "pallet-mmr/runtime-benchmarks",
  "pallet-multisig/runtime-benchmarks",
+ "pallet-nomination-pools-benchmarking",
  "pallet-offences-benchmarking",
  "pallet-preimage/runtime-benchmarks",
  "pallet-proxy/runtime-benchmarks",

bin/node/runtime/src/lib.rs

@@ -537,6 +537,7 @@ impl pallet_staking::BenchmarkingConfig for StakingBenchmarkingConfig {
 impl pallet_staking::Config for Runtime {
  type MaxNominations = MaxNominations;
  type Currency = Balances;
+ type CurrencyBalance = Balance;
  type UnixTime = Timestamp;
  type CurrencyToVote = U128CurrencyToVote;
  type RewardRemainder = Treasury;
@@ -560,6 +561,7 @@ impl pallet_staking::Config for Runtime {
  type GenesisElectionProvider = onchain::UnboundedExecution<OnChainSeqPhragmen>;
  type VoterList = BagsList;
  type MaxUnlockingChunks = ConstU32<32>;
+ type OnStakerSlash = NominationPools;
  type WeightInfo = pallet_staking::weights::SubstrateWeight<Runtime>;
  type BenchmarkingConfig = StakingBenchmarkingConfig;
 }
@@ -701,6 +703,38 @@ impl pallet_bags_list::Config for Runtime {
  type Score = VoteWeight;
 }
 
+parameter_types! {
+ pub const PostUnbondPoolsWindow: u32 = 4;
+ pub const NominationPoolsPalletId: PalletId = PalletId(*b"py/npols");
+}
+
+use sp_runtime::traits::Convert;
+pub struct BalanceToU256;
+impl Convert<Balance, sp_core::U256> for BalanceToU256 {
+ fn convert(balance: Balance) -> sp_core::U256 {
+ sp_core::U256::from(balance)
+ }
+}
+pub struct U256ToBalance;
+impl Convert<sp_core::U256, Balance> for U256ToBalance {
+ fn convert(n: sp_core::U256) -> Balance {
+ n.try_into().unwrap_or(Balance::max_value())
+ }
+}
+
+impl pallet_nomination_pools::Config for Runtime {
+ type WeightInfo = ();
+ type Event = Event;
+ type Currency = Balances;
+ type BalanceToU256 = BalanceToU256;
+ type U256ToBalance = U256ToBalance;
+ type StakingInterface = pallet_staking::Pallet<Self>;
+ type PostUnbondingPoolsWindow = PostUnbondPoolsWindow;
+ type MaxMetadataLen = ConstU32<256>;
+ type MaxUnbonding = ConstU32<8>;
+ type PalletId = NominationPoolsPalletId;
+}
+
 parameter_types! {
  pub const VoteLockingPeriod: BlockNumber = 30 * DAYS;
 }
@@ -1459,6 +1493,7 @@ construct_runtime!(
  Referenda: pallet_referenda,
  ConvictionVoting: pallet_conviction_voting,
  Whitelist: pallet_whitelist,
+ NominationPools: pallet_nomination_pools,
  }
 );
 
@@ -1543,6 +1578,7 @@ mod benches {
  [pallet_membership, TechnicalMembership]
  [pallet_mmr, Mmr]
  [pallet_multisig, Multisig]
+ [pallet_nomination_pools, NominationPoolsBench::<Runtime>]
  [pallet_offences, OffencesBench::<Runtime>]
  [pallet_preimage, Preimage]
  [pallet_proxy, Proxy]
@@ -1856,6 +1892,7 @@ impl_runtime_apis! {
  use pallet_election_provider_support_benchmarking::Pallet as EPSBench;
  use frame_system_benchmarking::Pallet as SystemBench;
  use baseline::Pallet as BaselineBench;
+ use pallet_nomination_pools_benchmarking::Pallet as NominationPoolsBench;
 
  let mut list = Vec::<BenchmarkList>::new();
  list_benchmarks!(list, extra);
@@ -1878,12 +1915,14 @@ impl_runtime_apis! {
  use pallet_election_provider_support_benchmarking::Pallet as EPSBench;
  use frame_system_benchmarking::Pallet as SystemBench;
  use baseline::Pallet as BaselineBench;
+ use pallet_nomination_pools_benchmarking::Pallet as NominationPoolsBench;
 
  impl pallet_session_benchmarking::Config for Runtime {}
  impl pallet_offences_benchmarking::Config for Runtime {}
  impl pallet_election_provider_support_benchmarking::Config for Runtime {}
  impl frame_system_benchmarking::Config for Runtime {}
  impl baseline::Config for Runtime {}
+ impl pallet_nomination_pools_benchmarking::Config for Runtime {}
 
  let whitelist: Vec<TrackedStorageKey> = vec![
  // Block Number

bin/node/testing/src/genesis.rs

@@ -92,5 +92,6 @@ pub fn config_endowed(code: Option<&[u8]>, extra_endowed: Vec<AccountId>) -> Gen
  gilt: Default::default(),
  transaction_storage: Default::default(),
  transaction_payment: Default::default(),
+ nomination_pools: Default::default(),
  }
 }

frame/babe/src/mock.rs

@@ -186,6 +186,7 @@ impl pallet_staking::Config for Test {
  type CurrencyToVote = frame_support::traits::SaturatingCurrencyToVote;
  type Event = Event;
  type Currency = Balances;
+ type CurrencyBalance = <Self as pallet_balances::Config>::Balance;
  type Slash = ();
  type Reward = ();
  type SessionsPerEra = SessionsPerEra;
@@ -202,6 +203,7 @@ impl pallet_staking::Config for Test {
  type GenesisElectionProvider = Self::ElectionProvider;
  type VoterList = pallet_staking::UseNominatorsAndValidatorsMap<Self>;
  type MaxUnlockingChunks = ConstU32<32>;
+ type OnStakerSlash = ();
  type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
  type WeightInfo = ();
 }

frame/bags-list/src/benchmarks.rs

@@ -179,10 +179,10 @@ frame_benchmarking::benchmarks! {
  vec![heavier, lighter, heavier_prev, heavier_next]
  )
  }
-}
 
-frame_benchmarking::impl_benchmark_test_suite!(
- Pallet,
- crate::mock::ExtBuilder::default().skip_genesis_ids().build(),
- crate::mock::Runtime
-);
+ impl_benchmark_test_suite!(
+ Pallet,
+ crate::mock::ExtBuilder::default().skip_genesis_ids().build(),
+ crate::mock::Runtime
+ );
+}

frame/grandpa/src/mock.rs

@@ -194,6 +194,7 @@ impl pallet_staking::Config for Test {
  type CurrencyToVote = frame_support::traits::SaturatingCurrencyToVote;
  type Event = Event;
  type Currency = Balances;
+ type CurrencyBalance = <Self as pallet_balances::Config>::Balance;
  type Slash = ();
  type Reward = ();
  type SessionsPerEra = SessionsPerEra;
@@ -210,6 +211,7 @@ impl pallet_staking::Config for Test {
  type GenesisElectionProvider = Self::ElectionProvider;
  type VoterList = pallet_staking::UseNominatorsAndValidatorsMap<Self>;
  type MaxUnlockingChunks = ConstU32<32>;
+ type OnStakerSlash = ();
  type BenchmarkingConfig = pallet_staking::TestBenchmarkingConfig;
  type WeightInfo = ();
 }

frame/nomination-pools/Cargo.toml

@@ -0,0 +1,44 @@
+[package]
+name = "pallet-nomination-pools"
+version = "1.0.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2021"
+license = "Apache-2.0"
+homepage = "https://substrate.io"
+repository = "https:/paritytech/substrate/"
+description = "FRAME nomination pools pallet"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+# parity
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
+scale-info = { version = "2.0.1", default-features = false, features = ["derive"] }
+
+# FRAME
+frame-support = { version = "4.0.0-dev", default-features = false, path = "../support" }
+frame-system = { version = "4.0.0-dev", default-features = false, path = "../system" }
+sp-runtime = { version = "6.0.0", default-features = false, path = "../../primitives/runtime" }
+sp-std = { version = "4.0.0", default-features = false, path = "../../primitives/std" }
+sp-staking = { version = "4.0.0-dev", default-features = false, path = "../../primitives/staking" }
+sp-core = { version = "6.0.0", default-features = false, path = "../../primitives/core" }
+
+[dev-dependencies]
+pallet-balances = { version = "4.0.0-dev", path = "../balances" }
+sp-io = { version = "6.0.0", path = "../../primitives/io" }
+sp-tracing = { version = "5.0.0", path = "../../primitives/tracing" }
+
+[features]
+runtime-benchmarks = []
+default = ["std"]
+std = [
+ "codec/std",
+ "scale-info/std",
+ "frame-support/std",
+ "frame-system/std",
+ "sp-runtime/std",
+ "sp-std/std",
+ "sp-staking/std",
+ "sp-core/std",
+]

frame/nomination-pools/benchmarking/Cargo.toml

@@ -0,0 +1,55 @@
+[package]
+name = "pallet-nomination-pools-benchmarking"
+version = "1.0.0"
+authors = ["Parity Technologies <[email protected]>"]
+edition = "2021"
+license = "Apache-2.0"
+homepage = "https://substrate.io"
+repository = "https:/paritytech/substrate/"
+description = "FRAME nomination pools pallet benchmarking"
+readme = "README.md"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+# parity
+codec = { package = "parity-scale-codec", version = "3.0.0", default-features = false, features = ["derive"] }
+scale-info = { version = "2.0.1", default-features = false, features = ["derive"] }
+
+# FRAME
+frame-benchmarking = { version = "4.0.0-dev", default-features = false, path = "../../benchmarking" }
+frame-election-provider-support = { version = "4.0.0-dev", default-features = false, path = "../../election-provider-support" }
+frame-support = { version = "4.0.0-dev", default-features = false, path = "../../support" }
+frame-system = { version = "4.0.0-dev", default-features = false, path = "../../system" }
+pallet-bags-list = { version = "4.0.0-dev", default-features = false, features = ["runtime-benchmarks"], path = "../../bags-list" }
+pallet-staking = { version = "4.0.0-dev", default-features = false, features = ["runtime-benchmarks"], path = "../../staking" }
+pallet-nomination-pools = { version = "1.0.0", default-features = false, path = "../", features = ["runtime-benchmarks"] }
+
+# Substrate Primitives
+sp-runtime = { version = "6.0.0", default-features = false, path = "../../../primitives/runtime" }
+sp-staking = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/staking" }
+sp-std = { version = "4.0.0", default-features = false, path = "../../../primitives/std" }
+
+[dev-dependencies]
+pallet-balances = { version = "4.0.0-dev", default-features = false, path = "../../balances" }
+pallet-timestamp = { version = "4.0.0-dev", path = "../../timestamp" }
+pallet-staking-reward-curve = { version = "4.0.0-dev", path = "../../staking/reward-curve" }
+sp-core = { version = "6.0.0", path = "../../../primitives/core" }
+sp-io = { version = "6.0.0", path = "../../../primitives/io" }
+
+[features]
+default = ["std"]
+std = [
+ "frame-benchmarking/std",
+ "frame-election-provider-support/std",
+ "frame-support/std",
+ "frame-system/std",
+ "pallet-bags-list/std",
+ "pallet-staking/std",
+ "pallet-nomination-pools/std",
+ "sp-runtime/std",
+ "sp-staking/std",
+ "sp-std/std",
+ "pallet-balances/std",
+]