Optimistic Project Funding #5162

ndkazu · 2024-07-27T03:25:53Z

Description

This PR is related to this issue .
Through the introduction of the OPF pallet and the DISTRIBUTION pallet, we are handling 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 nominations are handled by the OPF Pallet, while the project rewards distribution is handled by the Distribution Pallet.
The Distribution Pallet receives the 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).

User’s conviction has been implemented.

The voting round timeline is described below for someone voting for a project with no conviction round_0 and
for another project with a conviction of 1x in round_1:

|----------Voting_Round_0-----------|----------Voting_Round_1-----------|
|----user_votes----|--funds0_locked-|----user_votes----|--funds1_locked-|
|------------------|--Distribution--|------------------|--Distribution--|

Integration

Review Notes

Terminology

The constants available in the runtime for the OPF Pallet:

MaxWhitelistedProjects: Maximum number of Whitelisted projects that can be handled by the pallet.
VoteLockingPeriod: Period during which voting is disabled.
VotingPeriod: Period during which voting is enabled.
TemporaryRewards: For test purposes only ⇒ used as a substitute for the inflation portion used for the rewards.

The constants available in the runtime for the Distribution Pallet:

PotId: Pot containing the funds used to pay the rewards.
BufferPeriod: minimum required buffer time period between project nomination and reward claim.

Checklist

pallet-distribution

pallet-opf

marcuspang

Do you mind writing briefly how the voting would work? I feel this is quite a big deviation from what I had in mind

substrate/frame/distribution/src/lib.rs

substrate/frame/distribution/src/types.rs

substrate/frame/distribution/src/functions.rs

substrate/frame/distribution/src/types.rs

substrate/frame/distribution/src/lib.rs

umbrella/Cargo.toml

substrate/frame/distribution/src/functions.rs

Co-authored-by: Marcus Pang Yu Yang <[email protected]>

ndkazu · 2024-07-30T03:49:17Z

Do you mind writing briefly how the voting would work? I feel this is quite a big deviation from what I had in mind

The Voting Logic would be managed in a different pallet (pallet_vote for example).
The main difference is that the result of the voting process would be a whitelisted project of type ProjectInfo (which is defined in pallet_distribution). Then, through coupling of pallet_vote & pallet_distribution (this would be done in the Pallet::Config of pallet_vote), pallet_vote could populate the storage Projects found in pallet_distribution.

lolmcshizz · 2024-07-30T09:29:20Z

Do you mind writing briefly how the voting would work? I feel this is quite a big deviation from what I had in mind

The Voting Logic would be managed in a different pallet (pallet_vote for example). The main difference is that the result of the voting process would be a whitelisted project of type ProjectInfo (which is defined in pallet_distribution). Then, through coupling of pallet_vote & pallet_distribution (this would be done in the Pallet::Config of pallet_vote), pallet_vote could populate the storage Projects found in pallet_distribution.

Just to be clear here - "whitelisting" a project is done via OpenGov and creates a list of "projects" (addresses) that can be funded via OPF.

"Voting" as part of OPF implementation is users locking their DOT at some conviction to allocate funding to projects that are on the whitelist - this is not done through OpenGov and should be handled through the implementation of OPF.

Is this what you are implementing?

substrate/frame/distribution/src/functions.rs

kianenigma · 2024-10-25T13:17:09Z

substrate/frame/distribution/src/functions.rs

+		let pot_id = T::PotId::get();
+		pot_id.into_account_truncating()
+	}
+


Suggested change

kianenigma · 2024-10-25T13:21:01Z

substrate/frame/distribution/src/types.rs

+	/// The block number from which the spend can be claimed(24h after SpendStatus Creation).
+	pub valid_from: BlockNumberFor<T>,
+	/// Corresponding project id
+	pub whitelisted_project: Option<AccountIdOf<T>>,


Why is this an option?

kianenigma

I am now thinking that this idea can probably be better implemented as a smart contract? should be possible within the next 6-12 months in Kusama/Polkadot.

Managing the merge of this, in the midst of moving the governance apparatus around is also likely not a great idea.

Given the idea having been approved via W4C, once EVM contracts are present, one can implement a contract equivalent of thie distribution pallet.

As per the W4C, the only change needed in the Polkadot runtime would be to forward a small part of its inflation to this contract.

kianenigma · 2024-10-25T13:29:06Z

substrate/frame/distribution/src/functions.rs

+	// funds for created `SpendInfos`. the function will be use in a hook.
+
+	pub fn begin_block(now: BlockNumberFor<T>) -> Weight {
+		let max_block_weight = T::BlockWeights::get().max_block / 4;


This cannot really work once the govenrance is on AH, as the we cannot afford to use too much of the block space anymore..

In general, in light of moving the governance to AH, it is best to design this pallet as lazy as possible, ideally without using on_initialize: All operations should be triggered via transactions.

kianenigma · 2024-10-25T13:30:47Z

substrate/frame/distribution/src/functions.rs

+			// Update project storage
+			let mut bounded = BoundedVec::<ProjectInfo<T>, T::MaxProjects>::new();
+			Projects::<T>::mutate(|val| {
+				for p in projects {
+					// The number of elements in projects is ALWAYS
+					// egual or below T::MaxProjects at this point.
+					let _ = bounded.try_push(p);
+				}
+				*val = bounded;
+			});


Suggested change

// Update project storage

let mut bounded = BoundedVec::<ProjectInfo<T>, T::MaxProjects>::new();

Projects::<T>::mutate(|val| {

for p in projects {

// The number of elements in projects is ALWAYS

// egual or below T::MaxProjects at this point.

let _ = bounded.try_push(p);

}

*val = bounded;

});

// Update project storage

Projects::<T>::put(BoundedVec::<ProjectInfo<T>, T::MaxProjects>::try_from(projects).defensive())

kianenigma · 2024-10-25T13:30:55Z

substrate/frame/distribution/src/functions.rs

+						}
+						return false;
+					})
+					.map(|x| x.clone())


Suggested change

.map(|x| x.clone())

kianenigma · 2024-10-25T13:31:03Z

substrate/frame/distribution/src/functions.rs

+
+				projects = projects
+					.iter()
+					.filter(|project| {


You could rewrite this with .retain

kianenigma · 2024-10-25T13:31:43Z

substrate/frame/distribution/src/mock.rs

+// https://paritytech.github.io/polkadot-sdk/master/frame_support/attr.derive_impl.html
+#[derive_impl(frame_system::config_preludes::TestDefaultConfig)]
+impl frame_system::Config for Test {
+	type BaseCallFilter = frame_support::traits::Everything;


a lot of the lines here can be removed as per TestDefaultConfig

substrate/frame/distribution/src/mock.rs

Co-authored-by: Kian Paimani <[email protected]>

ndkazu · 2024-10-29T08:19:38Z

I am now thinking that this idea can probably be better implemented as a smart contract? should be possible within the next 6-12 months in Kusama/Polkadot.

Managing the merge of this, in the midst of moving the governance apparatus around is also likely not a great idea.

Given the idea having been approved via W4C, once EVM contracts are present, one can implement a contract equivalent of thie distribution pallet.

As per the W4C, the only change needed in the Polkadot runtime would be to forward a small part of its inflation to this contract.

Roger that, I will still apply the corrections but keep in mind that the smart contract route might be adopted instead.

ndkazu added 6 commits July 23, 2024 18:25

Started with the pallet structure

8537c9e

changed Cargo.toml

dcaa52c

Basic pallet structure

b781695

Types, Storages, and naming

527787b

Basic pallet structure

f6b8fa8

Update

c1c442d

ndkazu requested a review from a team as a code owner July 27, 2024 03:25

Helper functions

674c5f1

ndkazu marked this pull request as draft July 27, 2024 08:06

ndkazu added 4 commits July 28, 2024 21:41

Spnedings creation from projects list

8f42432

Spending status change

8667321

Funds unlock and transfer

5fb830e

Added an Event

08a56f5

marcuspang reviewed Jul 30, 2024

View reviewed changes

ndkazu and others added 8 commits July 30, 2024 11:24

Preparation for testing and minor corrections

100c26b

Update substrate/frame/distribution/src/lib.rs

2be7fb9

Co-authored-by: Marcus Pang Yu Yang <[email protected]>

Update substrate/frame/distribution/src/lib.rs

76fe14b

Co-authored-by: Marcus Pang Yu Yang <[email protected]>

Update substrate/frame/distribution/src/lib.rs

5d0f7ba

Co-authored-by: Marcus Pang Yu Yang <[email protected]>

Update substrate/frame/distribution/src/lib.rs

503f3d3

Co-authored-by: Marcus Pang Yu Yang <[email protected]>

Update substrate/frame/distribution/src/types.rs

aaea1fe

Co-authored-by: Marcus Pang Yu Yang <[email protected]>

Update umbrella/Cargo.toml

01c826c

Co-authored-by: Marcus Pang Yu Yang <[email protected]>

Made some corrections

a305d80

ndkazu and others added 6 commits July 30, 2024 15:15

First test

c4e6ae4

Additional event & testing

9ba1083

Merge branch 'paritytech:master' into Optimist

0268623

Update branch

dab155d

Second test: funds locked

990a2f6

Minor corrections

119206a

ndkazu and others added 10 commits October 20, 2024 16:57

License

b2cfb12

Weights & benchmarking

6babd82

Merge branch 'master' into Optimist

1572c9a

weights

4b94347

Merge branch 'master' into Optimist

d4f865c

try to fix feature-propagation error

b8f19f2

Merge branch 'master' into Optimist

576c530

fix CI errors

aea7890

Merge branch 'Optimist' of github.com:ndkazu/polkadot-sdk into Optimist

0b9977c

Merge branch 'master' into Optimist

673e991

kianenigma reviewed Oct 25, 2024

View reviewed changes

substrate/frame/distribution/src/functions.rs Outdated Show resolved Hide resolved

kianenigma reviewed Oct 25, 2024

View reviewed changes

substrate/frame/distribution/src/mock.rs Show resolved Hide resolved

ndkazu and others added 4 commits October 26, 2024 10:08

Update substrate/frame/distribution/src/functions.rs

597d6b5

Co-authored-by: Kian Paimani <[email protected]>

Preparation for scheduler use instead of on_initialize

4d177b3

Added RuntimeCall to distribution Config

78848a1

Replaced on_initialize, need to re-write tests

76175ab

ndkazu and others added 5 commits October 29, 2024 17:28

Some code clean up

75dda7b

Merge branch 'master' into Optimist

7678a81

Fixing tests

4f3962a

2 more tests to fix

5d11ffe

Merge branch 'master' into Optimist

e494e5a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Optimistic Project Funding #5162

Optimistic Project Funding #5162

ndkazu commented Jul 27, 2024 •

edited

Loading

marcuspang left a comment

ndkazu commented Jul 30, 2024 •

edited

Loading

lolmcshizz commented Jul 30, 2024

kianenigma Oct 25, 2024

kianenigma Oct 25, 2024

kianenigma left a comment

kianenigma Oct 25, 2024

kianenigma Oct 25, 2024

kianenigma Oct 25, 2024

kianenigma Oct 25, 2024

kianenigma Oct 25, 2024

ndkazu commented Oct 29, 2024

Optimistic Project Funding #5162

Are you sure you want to change the base?

Optimistic Project Funding #5162

Conversation

ndkazu commented Jul 27, 2024 • edited Loading

Description

Integration

Review Notes

Terminology

Checklist

pallet-distribution

pallet-opf

marcuspang left a comment

Choose a reason for hiding this comment

ndkazu commented Jul 30, 2024 • edited Loading

lolmcshizz commented Jul 30, 2024

kianenigma Oct 25, 2024

Choose a reason for hiding this comment

kianenigma Oct 25, 2024

Choose a reason for hiding this comment

kianenigma left a comment

Choose a reason for hiding this comment

kianenigma Oct 25, 2024

Choose a reason for hiding this comment

kianenigma Oct 25, 2024

Choose a reason for hiding this comment

kianenigma Oct 25, 2024

Choose a reason for hiding this comment

kianenigma Oct 25, 2024

Choose a reason for hiding this comment

kianenigma Oct 25, 2024

Choose a reason for hiding this comment

ndkazu commented Oct 29, 2024

ndkazu commented Jul 27, 2024 •

edited

Loading

ndkazu commented Jul 30, 2024 •

edited

Loading