Skip to content
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.

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

Optimistic Project Funding #6994

Draft
wants to merge 18 commits into
base: master
Choose a base branch
from
Draft

Optimistic Project Funding #6994

wants to merge 18 commits into from

Conversation

ndkazu
Copy link
Contributor

@ndkazu ndkazu commented Dec 24, 2024

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.

Integration

Review Notes

Terminology

The constants available in the runtime for the OPF Pallet:

  • MaxProjects: Maximum number of Whitelisted projects that can be handled by the pallet.
  • VotingPeriod: Period in which people can vote. After the period has ended, the votes are counted (STOP THE COUNT) and then the funds are distributed into Spends.
  • ClaimingPeriod: Time for claiming a Spend. After the period has passed, a spend is thrown away and the funds are available again for distribution in the pot.
  • VoteValidityPeriod: Period after which all the votes are reset.

Functions

  • - register_project: Register by OpenGov, should take AccountId and project Purpose.
  • - unregister_project: Unregister by OpenGov
  • - claim: To claim a spend

Checklist

pallet-opf

  • Pallet Config
  • Helper functions
  • Extrinsics
  • Events & Tests
  • Benchmarking & weights
  • Remove Dev-mode
  • Proper documentation

@ndkazu ndkazu requested a review from a team as a code owner December 24, 2024 12:34
Copy link
Contributor

@gui1117 gui1117 left a comment

Choose a reason for hiding this comment

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

you can open the PR as a draft until it is ready.

Or ping when it is ready.

Comment on lines 20 to 44
pub use super::*;

pub use frame_support::{
pallet_prelude::*,
traits::{
fungible,
fungible::{Inspect, Mutate, MutateHold},
fungibles,
schedule::{
v3::{Anon as ScheduleAnon, Named as ScheduleNamed},
DispatchTime, MaybeHashed,
},
tokens::{Precision, Preservation},
Bounded, DefensiveOption, EnsureOrigin, LockIdentifier, OriginTrait, QueryPreimage,
StorePreimage,
},
transactional, PalletId, Serialize,
};
pub use pallet_conviction_voting::Conviction;
pub use frame_system::{pallet_prelude::*, RawOrigin};
pub use scale_info::prelude::vec::Vec;
pub use sp_runtime::traits::{
AccountIdConversion, BlockNumberProvider, Convert, Dispatchable, Saturating, StaticLookup, Zero,
};
pub use sp_std::boxed::Box;
Copy link
Contributor

Choose a reason for hiding this comment

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

why do we reexport all those types publicly, I think the doc would be more clear if we only export the types specific for the library.

substrate/frame/opf/src/lib.rs Show resolved Hide resolved
substrate/frame/opf/src/function.rs Outdated Show resolved Hide resolved
Comment on lines +19 to +24
pub trait Config: frame_system::Config {
type RuntimeCall: Parameter
+ Dispatchable<RuntimeOrigin = Self::RuntimeOrigin>
+ From<Call<Self>>
+ IsType<<Self as frame_system::Config>::RuntimeCall>
+ From<frame_system::Call<Self>>;
Copy link
Contributor

Choose a reason for hiding this comment

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

we no longer need to introduce a new associated type, you can bound those additional constraint direclty on the system::Config::RuntimeCall

Suggested change
pub trait Config: frame_system::Config {
type RuntimeCall: Parameter
+ Dispatchable<RuntimeOrigin = Self::RuntimeOrigin>
+ From<Call<Self>>
+ IsType<<Self as frame_system::Config>::RuntimeCall>
+ From<frame_system::Call<Self>>;
pub trait Config: frame_system::Config<RuntimeCall: From<Call<Self>> {

substrate/frame/opf/src/lib.rs Outdated Show resolved Hide resolved
@gui1117 gui1117 marked this pull request as draft December 29, 2024 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants