Optimistic Project Funding

Cargo.toml

@@ -341,6 +341,7 @@ members = [
 	"substrate/frame/core-fellowship",
 	"substrate/frame/delegated-staking",
 	"substrate/frame/democracy",
+	"substrate/frame/distribution",
 	"substrate/frame/election-provider-multi-phase",
 	"substrate/frame/election-provider-multi-phase/test-staking-e2e",
 	"substrate/frame/election-provider-support",
@@ -389,6 +390,7 @@ members = [
 	"substrate/frame/nomination-pools/test-transfer-stake",
 	"substrate/frame/offences",
 	"substrate/frame/offences/benchmarking",
+	"substrate/frame/opf",
 	"substrate/frame/paged-list",
 	"substrate/frame/paged-list/fuzzer",
 	"substrate/frame/parameters",
@@ -925,6 +927,7 @@ pallet-default-config-example = { path = "substrate/frame/examples/default-confi
 pallet-delegated-staking = { path = "substrate/frame/delegated-staking", default-features = false }
 pallet-democracy = { path = "substrate/frame/democracy", default-features = false }
 pallet-dev-mode = { path = "substrate/frame/examples/dev-mode", default-features = false }
+pallet-distribution = { path = "substrate/frame/distribution", default-features = false }
 pallet-election-provider-multi-phase = { path = "substrate/frame/election-provider-multi-phase", default-features = false }
 pallet-election-provider-support-benchmarking = { path = "substrate/frame/election-provider-support/benchmarking", default-features = false }
 pallet-elections-phragmen = { path = "substrate/frame/elections-phragmen", default-features = false }
@@ -963,6 +966,7 @@ pallet-nomination-pools-benchmarking = { path = "substrate/frame/nomination-pool
 pallet-nomination-pools-runtime-api = { path = "substrate/frame/nomination-pools/runtime-api", default-features = false }
 pallet-offences = { path = "substrate/frame/offences", default-features = false }
 pallet-offences-benchmarking = { path = "substrate/frame/offences/benchmarking", default-features = false }
+pallet-opf = { path = "substrate/frame/opf", default-features = false }
 pallet-paged-list = { path = "substrate/frame/paged-list", default-features = false }
 pallet-parachain-template = { path = "templates/parachain/pallets/template", default-features = false }
 pallet-parameters = { path = "substrate/frame/parameters", default-features = false }

prdoc/pr_5162.prdoc

@@ -0,0 +1,23 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: "Optimistic Project Funding"
+
+doc:
+  - audience: Runtime Dev
+    description: |
+      the combination of the OPF pallet and the DISTRIBUTION pallet handles the Optimistic Project Funding. 
+      It allows users to nominate projects (whitelisted in OpenGov) with their DOT. This mechanism will be funded with a constant stream of DOT taken directly from inflation and distributed to projects based on the proportion of DOT that has nominated them.
+      The project rewards distribution is handled by the **Distribution Pallet**
+
+crates:
+  - name: pallet-distribution
+    bump: patch
+  - name: pallet-opf
+    bump: patch
+  - name: frame-support
+    bump: none
+  - name: polkadot-sdk
+    bump: patch
+  - name: polkadot
+    bump: none

substrate/frame/distribution/Cargo.toml

@@ -0,0 +1,89 @@
+[package]
+authors.workspace = true
+description = "FRAME pallet to distribute funds to whitelisted projects"
+edition.workspace = true
+homepage = "https://substrate.io"
+license = "Apache-2.0"
+name = "pallet-distribution"
+readme = "README.md"
+repository.workspace = true
+version = "0.1.0"
+
+[lints]
+workspace = true
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]
+
+[dependencies]
+codec = { workspace = true, default-features = false }
+frame-benchmarking = { optional = true, workspace = true, default-features = false }
+frame-support = { workspace = true, default-features = false }
+frame-system = { workspace = true, default-features = false }
+log = { workspace = true }
+pallet-scheduler = { workspace = true, default-features = false }
+scale-info = { features = [
+	"derive",
+], workspace = true, default-features = false }
+sp-core = { workspace = true, default-features = false }
+sp-io = { workspace = true, default-features = false }
+sp-runtime = { workspace = true, default-features = false }
+sp-std = { workspace = true, default-features = false }
+
+[dev-dependencies]
+pallet-assets = { workspace = true, default-features = true }
+pallet-balances = { workspace = true, default-features = true }
+pallet-preimage = { workspace = true, default-features = true }
+pallet-scheduler = { workspace = true, default-features = true }
+pallet-sudo = { workspace = true, default-features = true }
+pallet-timestamp = { workspace = true, default-features = true }
+pallet-transaction-payment = { workspace = true, default-features = true }
+pallet-transaction-payment-rpc-runtime-api = { workspace = true }
+
+[features]
+default = ["std"]
+runtime-benchmarks = [
+	"frame-benchmarking/runtime-benchmarks",
+	"frame-support/runtime-benchmarks",
+	"frame-system/runtime-benchmarks",
+	"pallet-assets/runtime-benchmarks",
+	"pallet-balances/runtime-benchmarks",
+	"pallet-preimage/runtime-benchmarks",
+	"pallet-scheduler/runtime-benchmarks",
+	"pallet-sudo/runtime-benchmarks",
+	"pallet-timestamp/runtime-benchmarks",
+	"pallet-transaction-payment/runtime-benchmarks",
+	"sp-runtime/runtime-benchmarks",
+]
+std = [
+	"codec/std",
+	"frame-benchmarking?/std",
+	"frame-support/std",
+	"frame-system/std",
+	"log/std",
+	"pallet-assets/std",
+	"pallet-balances/std",
+	"pallet-preimage/std",
+	"pallet-scheduler/std",
+	"pallet-sudo/std",
+	"pallet-timestamp/std",
+	"pallet-transaction-payment-rpc-runtime-api/std",
+	"pallet-transaction-payment/std",
+	"scale-info/std",
+	"sp-core/std",
+	"sp-io/std",
+	"sp-runtime/std",
+	"sp-std/std",
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"pallet-assets/try-runtime",
+	"pallet-balances/try-runtime",
+	"pallet-preimage/try-runtime",
+	"pallet-scheduler/try-runtime",
+	"pallet-sudo/try-runtime",
+	"pallet-timestamp/try-runtime",
+	"pallet-transaction-payment/try-runtime",
+	"sp-runtime/try-runtime",
+]

substrate/frame/distribution/README.md

@@ -0,0 +1,32 @@
+# Distribution Pallet
+## Overview
+
+The **Distribution Pallet** handles the distribution of whitelisted projects rewards.
+
+For now only one reward distribution pattern has been implemented, but the pallet could be extended
+to offer to the user claiming rewards for a project, a choice between more than one distribution pattern.
+
+The **Distribution Pallet** receives a list of Whitelisted/Nominated Projects with
+their respective calculated rewards. For each project, it will create a corresponding
+spend that will be stored until the project reward can be claimed.
+At the moment, the reward claim period start corresponds to:
+[beginning of an ***Epoch_Block*** + ***BufferPeriod***] (The ***BufferPeriod*** can be configured in the runtime).
+
+### Terminology
+
+- **PotId:** Pot containing the funds used to pay the rewards.
+- **BufferPeriod:** minimum required buffer time period between project nomination and reward claim.
+
+## Interface
+
+### Dispatchable Functions
+
+#### Public
+
+These calls can be made from any externally held account capable of creating
+a signed extrinsic.
+
+Basic actions:
+- `claim_reward_for` - From this extrinsic any user can claim a reward for a nominated/whitelisted project.
+
+License: Apache-2.0

substrate/frame/distribution/src/benchmarking.rs

@@ -0,0 +1,115 @@
+// This file is part of Substrate.
+
+// Copyright (C) Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Distribution pallet benchmarking.
+
+#![cfg(feature = "runtime-benchmarks")]
+
+use super::*;
+
+use crate::Pallet as Distribution;
+use frame_benchmarking::{
+	v1::{account, BenchmarkError},
+	v2::*,
+};
+use frame_support::ensure;
+use frame_system::RawOrigin;
+use sp_runtime::traits::One;
+
+const SEED: u32 = 0;
+
+fn run_to_block<T: Config>(n: frame_system::pallet_prelude::BlockNumberFor<T>) {
+	while T::BlockNumberProvider::current_block_number() < n {
+		crate::Pallet::<T>::on_finalize(T::BlockNumberProvider::current_block_number());
+		frame_system::Pallet::<T>::on_finalize(T::BlockNumberProvider::current_block_number());
+		frame_system::Pallet::<T>::set_block_number(
+			T::BlockNumberProvider::current_block_number() + One::one(),
+		);
+		frame_system::Pallet::<T>::on_initialize(T::BlockNumberProvider::current_block_number());
+		crate::Pallet::<T>::on_initialize(T::BlockNumberProvider::current_block_number());
+	}
+}
+
+fn create_project<T: Config>(project_id: AccountIdOf<T>, amount: BalanceOf<T>) {
+	let submission_block = T::BlockNumberProvider::current_block_number();
+	let project: types::ProjectInfo<T> = ProjectInfo { project_id, submission_block, amount };
+	Projects::<T>::mutate(|value| {
+		let mut val = value.clone();
+		let _ = val.try_push(project);
+		*value = val;
+	});
+}
+
+/*fn assert_last_event<T: Config>(generic_event: <T as Config>::RuntimeEvent) {
+	frame_system::Pallet::<T>::assert_last_event(generic_event.into());
+}*/
+
+fn create_parameters<T: Config>(n: u32) -> (AccountIdOf<T>, BalanceOf<T>) {
+	let project_id = account("project", n, SEED);
+	let value: BalanceOf<T> = T::NativeBalance::minimum_balance() * 100u32.into() * (n + 1).into();
+	let _ = T::NativeBalance::set_balance(&project_id, value);
+	(project_id, value)
+}
+
+fn setup_pot_account<T: Config>() -> AccountIdOf<T> {
+	let pot_account = Distribution::<T>::pot_account();
+	let value = T::NativeBalance::minimum_balance().saturating_mul(1_000_000_000u32.into());
+	let _ = T::NativeBalance::set_balance(&pot_account, value);
+	pot_account
+}
+
+fn add_projects<T: Config>(r: u32) -> Result<(), &'static str> {
+	for i in 0..r {
+		let (project_id, amount) = create_parameters::<T>(i);
+		create_project::<T>(project_id, amount);
+	}
+
+	Ok(())
+}
+
+#[benchmarks]
+mod benchmarks {
+	use super::*;
+
+	#[benchmark]
+	fn claim_reward_for(r: Linear<1, { T::MaxProjects::get() }>) -> Result<(), BenchmarkError> {
+		/* setup initial state */
+		add_projects::<T>(r)?;
+
+		ensure!(<Projects<T>>::get().len() as u32 == r, "Project list setting failed !!");
+		let index: usize = (r - 1).try_into().unwrap();
+		let project = &<Projects<T>>::get()[index];
+		let _pot = setup_pot_account::<T>();
+		let caller: T::AccountId = whitelisted_caller();
+		let epoch = T::EpochDurationBlocks::get();
+		let mut when = T::BlockNumberProvider::current_block_number().saturating_add(epoch);
+		run_to_block::<T>(when);
+		/* execute extrinsic or function */
+
+		let project_id = &project.project_id;
+		let spend = <Spends<T>>::get(&project_id);
+		when = when.saturating_add(spend.unwrap().valid_from);
+		run_to_block::<T>(when);
+
+		#[extrinsic_call]
+		_(RawOrigin::Signed(caller.clone()), project_id.clone());
+
+		Ok(())
+	}
+
+	impl_benchmark_test_suite!(Distribution, crate::mock::new_test_ext(), crate::mock::Test);
+}