Enable Merklized Distributions in Assets Pallet #5400
Conversation
This reverts commit 1cfb29f.
Co-authored-by: Ankan <10196091+Ank4n@users.noreply.github.com>
…abrizi/polkadot-sdk into shawntabrizi-proving-trie
|
This PR is blocked because the data structures in |
| @@ -538,4 +538,20 @@ impl<T: frame_system::Config> pallet_assets::WeightInfo for WeightInfo<T> { | |||
| .saturating_add(T::DbWeight::get().reads(1_u64)) | |||
| .saturating_add(T::DbWeight::get().writes(1_u64)) | |||
| } | |||
|
|
|||
| fn mint_distribution() -> Weight { | |||
| Weight::default() | |||
|
|
||
| #[derive(Eq, PartialEq, Copy, Clone, RuntimeDebug, Encode, Decode, TypeInfo, MaxEncodedLen)] | ||
| pub struct DistributionInfo<AssetId, Hash> { | ||
| // The asset id we are distributing. | ||
| pub asset_id: AssetId, | ||
| // The merkle root which represents all the balances to distribute. | ||
| pub merkle_root: Hash, | ||
| // Whether the distribution is still active. | ||
| pub active: bool, | ||
| } |
There was a problem hiding this comment.
| #[derive(Eq, PartialEq, Copy, Clone, RuntimeDebug, Encode, Decode, TypeInfo, MaxEncodedLen)] | |
| pub struct DistributionInfo<AssetId, Hash> { | |
| // The asset id we are distributing. | |
| pub asset_id: AssetId, | |
| // The merkle root which represents all the balances to distribute. | |
| pub merkle_root: Hash, | |
| // Whether the distribution is still active. | |
| pub active: bool, | |
| } | |
| /// Foo bar baz | |
| #[derive(Eq, PartialEq, Copy, Clone, RuntimeDebug, Encode, Decode, TypeInfo, MaxEncodedLen)] | |
| pub struct DistributionInfo<AssetId, Hash> { | |
| /// The asset id we are distributing. | |
| pub asset_id: AssetId, | |
| /// The merkle root which represents all the balances to distribute. | |
| pub merkle_root: Hash, | |
| /// Whether the distribution is still active. | |
| pub active: bool, | |
| } |
| @@ -1798,6 +1848,92 @@ pub mod pallet { | |||
| )?; | |||
| Ok(()) | |||
| } | |||
|
|
|||
| /// Mint a distribution of assets of a particular class. | |||
There was a problem hiding this comment.
Something about this can go into the main top docs and then in https://docs.rs/pallet-assets/latest/pallet_assets/?
| pub(super) fn do_mint_distribution( | ||
| id: T::AssetId, | ||
| merkle_root: DistributionHashOf<T, I>, | ||
| maybe_check_issuer: Option<T::AccountId>, |
There was a problem hiding this comment.
why Option? Is always called with Some() ?
There was a problem hiding this comment.
this is the same pattern used in other functions which allows a low level API to call this function without having to provide the issuer. For example if some low level trait or pallet wanted to call this function without requiring user authorization or anything like that
| if all_refunded { | ||
| Self::deposit_event(Event::<T, I>::DistributionCleaned { distribution_id }); | ||
| // Refund weight only the amount we actually used. | ||
| Ok(Some(T::WeightInfo::destroy_distribution(refund_count)).into()) |
There was a problem hiding this comment.
What is the incentive to clean up state? Shouldn't we refund all fees?
There was a problem hiding this comment.
anyone can clean up state... but yeah we could add a deposit here for doing a distribution
|
|
||
| info.active = false; | ||
|
|
||
| MerklizedDistribution::<T, I>::insert(&distribution_id, info); |
There was a problem hiding this comment.
Is this never cleaned? Would we not just keep bloating state then?
There was a problem hiding this comment.
updated code to remove this at the end
| ) -> DispatchResult { | ||
| let origin = ensure_signed(origin)?; | ||
| let id: T::AssetId = id.into(); | ||
| Self::do_mint_distribution(id, merkle_root, Some(origin))?; |
There was a problem hiding this comment.
Thinking out loud: Should we not take some kind of deposit here (charging for the storage), that is only refunded when state (MerklizedDistributionTracker) is cleaned up? What stops some one to create large number of distributions?
Co-authored-by: Ankan <10196091+Ank4n@users.noreply.github.com>
Depends on: #3881
This PR introduces a way for an asset issuer to distribute their token to many users using a single merkle root.
Users then present a merkle proof which is verified, and triggers the
do_mintfunction.A tracking storage ensures that each user only claims their distribution a single time.
The design allows for multiple distributions per asset id.