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.

Sign up for GitHub

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

Jump to bottom

Use Consideration ticket for holding Proxy pallet deposits #1837

Closed
wants to merge 5 commits into from
Closed

Use Consideration ticket for holding Proxy pallet deposits #1837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
23a1a22
wip
liamaharon Oct 4, 2023
101dbb7
default storage wip
liamaharon Oct 10, 2023
cf52972
+ Default
liamaharon Oct 10, 2023
47e3bcf
remove commented code
liamaharon Oct 10, 2023
a84a16f
remove unused error varient
liamaharon Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 95 additions & 106 deletions substrate/frame/proxy/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ use codec::{Decode, Encode, MaxEncodedLen};
use frame_support::{
dispatch::GetDispatchInfo,
ensure,
traits::{Currency, Get, InstanceFilter, IsSubType, IsType, OriginTrait, ReservableCurrency},
traits::{Consideration, Footprint, Get, InstanceFilter, IsSubType, IsType, OriginTrait},
};
use frame_system::{self as system, ensure_signed, pallet_prelude::BlockNumberFor};
pub use pallet::*;
Expand All @@ -52,11 +52,12 @@ pub use weights::WeightInfo;

type CallHashOf<T> = <<T as Config>::CallHasher as Hash>::Output;

type BalanceOf<T> =
<<T as Config>::Currency as Currency<<T as frame_system::Config>::AccountId>>::Balance;

type AccountIdLookupOf<T> = <<T as frame_system::Config>::Lookup as StaticLookup>::Source;

type AnnoucementTicketOf<T> = <T as Config>::AnnoucementConsideration;

type ProxyTicketOf<T> = <T as Config>::ProxyConsideration;

/// The parameters under which a particular account has a proxy relationship with some other
/// account.
#[derive(
Expand Down Expand Up @@ -93,7 +94,7 @@ pub struct Announcement<AccountId, Hash, BlockNumber> {
height: BlockNumber,
}

#[frame_support::pallet]
#[frame_support::pallet(dev_mode)]
pub mod pallet {
use super::{DispatchResult, *};
use frame_support::pallet_prelude::*;
Expand All @@ -116,9 +117,6 @@ pub mod pallet {
+ IsSubType<Call<Self>>
+ IsType<<Self as frame_system::Config>::RuntimeCall>;

/// The currency mechanism.
type Currency: ReservableCurrency<Self::AccountId>;

/// A kind of proxy; specified with the proxy and passed in to the `IsProxyable` fitler.
/// The instance filter determines whether a given call may be proxied under this type.
///
Expand All @@ -131,20 +129,11 @@ pub mod pallet {
+ Default
+ MaxEncodedLen;

/// The base amount of currency needed to reserve for creating a proxy.
///
/// This is held for an additional storage item whose value size is
/// `sizeof(Balance)` bytes and whose key size is `sizeof(AccountId)` bytes.
#[pallet::constant]
type ProxyDepositBase: Get<BalanceOf<Self>>;
/// A means of providing some cost for storing annoucement data on-chain.
type AnnoucementConsideration: Consideration<Self::AccountId> + Default;

/// The amount of currency needed per proxy added.
///
/// This is held for adding 32 bytes plus an instance of `ProxyType` more into a
/// pre-existing storage value. Thus, when configuring `ProxyDepositFactor` one should take
/// into account `32 + proxy_type.encode().len()` bytes of data.
#[pallet::constant]
type ProxyDepositFactor: Get<BalanceOf<Self>>;
/// A means of providing some cost for storing proxy data on-chain.
type ProxyConsideration: Consideration<Self::AccountId> + Default;

/// The maximum amount of proxies allowed for a single account.
#[pallet::constant]
Expand All @@ -159,20 +148,15 @@ pub mod pallet {

/// The type of hash used for hashing the call.
type CallHasher: Hash;
}

/// The base amount of currency needed to reserve for creating an announcement.
///
/// This is held when a new storage item holding a `Balance` is created (typically 16
/// bytes).
#[pallet::constant]
type AnnouncementDepositBase: Get<BalanceOf<Self>>;

/// The amount of currency needed per announcement made.
///
/// This is held for adding an `AccountId`, `Hash` and `BlockNumber` (typically 68 bytes)
/// into a pre-existing storage value.
#[pallet::constant]
type AnnouncementDepositFactor: Get<BalanceOf<Self>>;
/// Reasons the pallet may place funds on hold.
#[pallet::composite_enum]
pub enum HoldReason {
/// The funds are held as storage deposit for a pure Proxy.
Proxy,
/// The funds are held as storage deposit for an announcement.
Annoucement,
}

#[pallet::call]
Expand Down Expand Up @@ -303,10 +287,12 @@ pub mod pallet {
let bounded_proxies: BoundedVec<_, T::MaxProxies> =
vec![proxy_def].try_into().map_err(|_| Error::<T>::TooMany)?;

let deposit = T::ProxyDepositBase::get() + T::ProxyDepositFactor::get();
T::Currency::reserve(&who, deposit)?;
let ticket = T::ProxyConsideration::new(
&who,
Footprint::from_parts(1, Self::proxy_def_size_bytes()),
)?;

Proxies::<T>::insert(&pure, (bounded_proxies, deposit));
Proxies::<T>::insert(&pure, (bounded_proxies, ticket));
Self::deposit_event(Event::PureCreated {
pure,
who,
Expand Down Expand Up @@ -350,8 +336,8 @@ pub mod pallet {
let proxy = Self::pure_account(&spawner, &proxy_type, index, Some(when));
ensure!(proxy == who, Error::<T>::NoPermission);

let (_, deposit) = Proxies::<T>::take(&who);
T::Currency::unreserve(&spawner, deposit);
let (_, ticket) = Proxies::<T>::take(&who);
let _ = ticket.drop(&who);

Ok(())
}
Expand Down Expand Up @@ -392,20 +378,24 @@ pub mod pallet {
height: system::Pallet::<T>::block_number(),
};

Announcements::<T>::try_mutate(&who, |(ref mut pending, ref mut deposit)| {
pending.try_push(announcement).map_err(|_| Error::<T>::TooMany)?;
Self::rejig_deposit(
&who,
*deposit,
T::AnnouncementDepositBase::get(),
T::AnnouncementDepositFactor::get(),
pending.len(),
)
.map(|d| {
d.expect("Just pushed; pending.len() > 0; rejig_deposit returns Some; qed")
})
.map(|d| *deposit = d)
})?;
Announcements::<T>::try_mutate(
&who,
|(ref mut pending, ref mut ticket): &mut (
BoundedVec<
Announcement<T::AccountId, CallHashOf<T>, BlockNumberFor<T>>,
T::MaxPending,
>,
AnnoucementTicketOf<T>,
)| {
pending.try_push(announcement).map_err(|_| Error::<T>::TooMany)?;
*ticket = ticket.clone().update(
&who,
Footprint::from_parts(pending.len(), Self::annoucement_size_bytes()),
)?;

Ok::<(), DispatchError>(())
},
)?;
Self::deposit_event(Event::Announced { real, proxy: who, call_hash });

Ok(())
Expand Down Expand Up @@ -565,6 +555,22 @@ pub mod pallet {
NoSelfProxy,
}

// WIP: Playing with the idea of overriding the default value of the storage item.
//
// #[pallet::type_value]
// pub fn ProxiesDefault<T: Config>() -> (
// BoundedVec<ProxyDefinition<T::AccountId, T::ProxyType, BlockNumberFor<T>>, T::MaxProxies>,
// ProxyTicketOf<T>,
// ) {
// let default_vec = BoundedVec::default();
// let empty_ticket = T::ProxyConsideration::new(
// &<T as frame_system::Config>::AccountId::default(),
// Footprint::from_parts(0, 0),
// )
// .expect("cannot fail to create zero footprint; qed");
// (default_vec, empty_ticket)
// }

/// The set of account proxies. Maps the account which has delegated to the accounts
/// which are being delegated to, together with the amount held on deposit.
#[pallet::storage]
Expand All @@ -578,9 +584,10 @@ pub mod pallet {
ProxyDefinition<T::AccountId, T::ProxyType, BlockNumberFor<T>>,
T::MaxProxies,
>,
BalanceOf<T>,
ProxyTicketOf<T>,
),
ValueQuery,
// ProxiesDefault<T>, // WIP: Playing with the idea of overriding the default value of the storage item.
>;

/// The announcements made by the proxy (key).
Expand All @@ -592,13 +599,21 @@ pub mod pallet {
T::AccountId,
(
BoundedVec<Announcement<T::AccountId, CallHashOf<T>, BlockNumberFor<T>>, T::MaxPending>,
BalanceOf<T>,
AnnoucementTicketOf<T>,
),
ValueQuery,
>;
}

impl<T: Config> Pallet<T> {
const fn annoucement_size_bytes() -> usize {
sp_std::mem::size_of::<Announcement<T::AccountId, CallHashOf<T>, BlockNumberFor<T>>>()
}

const fn proxy_def_size_bytes() -> usize {
sp_std::mem::size_of::<ProxyDefinition<T::AccountId, T::ProxyType, BlockNumberFor<T>>>()
}

/// Calculate the address of an pure account.
///
/// - `who`: The spawner account.
Expand Down Expand Up @@ -643,21 +658,20 @@ impl<T: Config> Pallet<T> {
delay: BlockNumberFor<T>,
) -> DispatchResult {
ensure!(delegator != &delegatee, Error::<T>::NoSelfProxy);
Proxies::<T>::try_mutate(delegator, |(ref mut proxies, ref mut deposit)| {
Proxies::<T>::try_mutate(delegator, |(ref mut proxies, ref mut ticket)| {
let proxy_def = ProxyDefinition {
delegate: delegatee.clone(),
proxy_type: proxy_type.clone(),
delay,
};
let i = proxies.binary_search(&proxy_def).err().ok_or(Error::<T>::Duplicate)?;
proxies.try_insert(i, proxy_def).map_err(|_| Error::<T>::TooMany)?;
let new_deposit = Self::deposit(proxies.len() as u32);
if new_deposit > *deposit {
T::Currency::reserve(delegator, new_deposit - *deposit)?;
} else if new_deposit < *deposit {
T::Currency::unreserve(delegator, *deposit - new_deposit);
}
*deposit = new_deposit;

*ticket = ticket.clone().update(
delegator,
Footprint::from_parts(proxies.len(), Self::proxy_def_size_bytes()),
)?;

Self::deposit_event(Event::<T>::ProxyAdded {
delegator: delegator.clone(),
delegatee,
Expand All @@ -683,22 +697,23 @@ impl<T: Config> Pallet<T> {
delay: BlockNumberFor<T>,
) -> DispatchResult {
Proxies::<T>::try_mutate_exists(delegator, |x| {
let (mut proxies, old_deposit) = x.take().ok_or(Error::<T>::NotFound)?;
let (mut proxies, ticket) = x.take().ok_or(Error::<T>::NotFound)?;
let proxy_def = ProxyDefinition {
delegate: delegatee.clone(),
proxy_type: proxy_type.clone(),
delay,
};
let i = proxies.binary_search(&proxy_def).ok().ok_or(Error::<T>::NotFound)?;
proxies.remove(i);
let new_deposit = Self::deposit(proxies.len() as u32);
if new_deposit > old_deposit {
T::Currency::reserve(delegator, new_deposit - old_deposit)?;
} else if new_deposit < old_deposit {
T::Currency::unreserve(delegator, old_deposit - new_deposit);
}

// If this was the last proxy, the ticket will be updated to 0.
let new_ticket = ticket.update(
delegator,
Footprint::from_parts(proxies.len(), Self::proxy_def_size_bytes()),
)?;

if !proxies.is_empty() {
*x = Some((proxies, new_deposit))
*x = Some((proxies, new_ticket))
}
Self::deposit_event(Event::<T>::ProxyRemoved {
delegator: delegator.clone(),
Expand All @@ -710,50 +725,24 @@ impl<T: Config> Pallet<T> {
})
}

pub fn deposit(num_proxies: u32) -> BalanceOf<T> {
if num_proxies == 0 {
Zero::zero()
} else {
T::ProxyDepositBase::get() + T::ProxyDepositFactor::get() * num_proxies.into()
}
}

fn rejig_deposit(
who: &T::AccountId,
old_deposit: BalanceOf<T>,
base: BalanceOf<T>,
factor: BalanceOf<T>,
len: usize,
) -> Result<Option<BalanceOf<T>>, DispatchError> {
let new_deposit =
if len == 0 { BalanceOf::<T>::zero() } else { base + factor * (len as u32).into() };
if new_deposit > old_deposit {
T::Currency::reserve(who, new_deposit - old_deposit)?;
} else if new_deposit < old_deposit {
T::Currency::unreserve(who, old_deposit - new_deposit);
}
Ok(if len == 0 { None } else { Some(new_deposit) })
}

fn edit_announcements<
F: FnMut(&Announcement<T::AccountId, CallHashOf<T>, BlockNumberFor<T>>) -> bool,
>(
delegate: &T::AccountId,
f: F,
) -> DispatchResult {
Announcements::<T>::try_mutate_exists(delegate, |x| {
let (mut pending, old_deposit) = x.take().ok_or(Error::<T>::NotFound)?;
let (mut pending, ticket) = x.take().ok_or(Error::<T>::NotFound)?;
let orig_pending_len = pending.len();
pending.retain(f);
ensure!(orig_pending_len > pending.len(), Error::<T>::NotFound);
*x = Self::rejig_deposit(

let new_ticket = ticket.update(
delegate,
old_deposit,
T::AnnouncementDepositBase::get(),
T::AnnouncementDepositFactor::get(),
pending.len(),
)?
.map(|deposit| (pending, deposit));
Footprint::from_parts(pending.len(), Self::annoucement_size_bytes()),
)?;
*x = Some((pending, new_ticket));

Ok(())
})
}
Expand Down Expand Up @@ -804,7 +793,7 @@ impl<T: Config> Pallet<T> {
/// Parameters:
/// - `delegator`: The delegator account.
pub fn remove_all_proxy_delegates(delegator: &T::AccountId) {
let (_, old_deposit) = Proxies::<T>::take(&delegator);
T::Currency::unreserve(&delegator, old_deposit);
let (_, ticket) = Proxies::<T>::take(&delegator);
let _ = ticket.drop(&delegator);
}
}
Loading
Loading