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",
@@ -917,6 +919,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 }
@@ -955,6 +958,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 }

docs/sdk/Cargo.toml

@@ -97,6 +97,8 @@ pallet-scheduler = { workspace = true, default-features = true }
 pallet-referenda = { workspace = true, default-features = true }
 pallet-broker = { workspace = true, default-features = true }
 pallet-babe = { workspace = true, default-features = true }
+pallet-distribution = { workspace = true, default-features = true }
+pallet-opf = { workspace = true, default-features = true }
 pallet-grandpa = { workspace = true, default-features = true }
 
 # Primitives

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/bin/node/runtime/src/lib.rs

@@ -2242,6 +2242,41 @@ impl pallet_broker::Config for Runtime {
 	type PriceAdapter = pallet_broker::CenterTargetPrice<Balance>;
 }
 
+parameter_types! {
+	pub const PotId: PalletId = PalletId(*b"py/potid");
+	pub const Period:BlockNumber = 5 * MINUTES;
+	pub const MaxProjects:u32 = 50;
+	pub const EpochDurationBlocks: BlockNumber = EPOCH_DURATION_IN_BLOCKS;
+}
+
+impl pallet_distribution::Config for Runtime {
+	type RuntimeEvent = RuntimeEvent;
+	type NativeBalance = Balances;
+	type PotId = PotId;
+	type RuntimeHoldReason = RuntimeHoldReason;
+	type BufferPeriod = Period;
+	type MaxProjects = MaxProjects;
+	type EpochDurationBlocks = EpochDurationBlocks;
+	type BlockNumberProvider = System;
+	type WeightInfo = pallet_distribution::weights::SubstrateWeight<Runtime>;
+}
+
+parameter_types! {
+	pub const MaxWhitelistedProjects: u32 = 64;
+	pub const TemporaryRewards: Balance = 100000 * DOLLARS;
+	pub const TotalPeriod:BlockNumber = 30 * DAYS;
+	pub const LockPeriod:BlockNumber = 10 * DAYS;
+}
+
+impl pallet_opf::Config for Runtime {
+	type RuntimeEvent = RuntimeEvent;
+	type VoteLockingPeriod = LockPeriod;
+	type VotingPeriod = TotalPeriod;
+	type MaxWhitelistedProjects = MaxWhitelistedProjects;
+	type TemporaryRewards = TemporaryRewards;
+	type WeightInfo = pallet_opf::weights::SubstrateWeight<Runtime>;
+}
+
 parameter_types! {
 	pub const MixnetNumCoverToCurrentBlocks: BlockNumber = 3;
 	pub const MixnetNumRequestsToCurrentBlocks: BlockNumber = 3;
@@ -2587,6 +2622,12 @@ mod runtime {
 
 	#[runtime::pallet_index(81)]
 	pub type VerifySignature = pallet_verify_signature::Pallet<Runtime>;
+
+	#[runtime::pallet_index(82)]
+	pub type Distribution = pallet_distribution::Pallet<Runtime>;
+
+	#[runtime::pallet_index(83)]
+	pub type OptimisticProjectFunding = pallet_opf::Pallet<Runtime>;
 }
 
 impl TryFrom<RuntimeCall> for pallet_revive::Call<Runtime> {
@@ -2846,6 +2887,8 @@ mod benches {
 		[pallet_safe_mode, SafeMode]
 		[pallet_example_mbm, PalletExampleMbms]
 		[pallet_asset_conversion_ops, AssetConversionMigration]
+		[pallet_distribution, Distribution]
+		[pallet_opf, OptimisticProjectFunding]
 		[pallet_verify_signature, VerifySignature]
 	);
 }

substrate/frame/distribution/Cargo.toml

@@ -0,0 +1,78 @@
+[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 }
+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 }
+
+[dev-dependencies]
+pallet-assets = { workspace = true, default-features = true }
+pallet-balances = { 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-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-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",
+]
+try-runtime = [
+	"frame-support/try-runtime",
+	"frame-system/try-runtime",
+	"pallet-assets/try-runtime",
+	"pallet-balances/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