Skip to content

Implement NamedMultiReservableCurrency and NamedBasicReservableCurrency in orml_currencies #743

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

Merged
164 changes: 160 additions & 4 deletions currencies/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ use frame_support::{
pallet_prelude::*,
traits::{
Currency as PalletCurrency, ExistenceRequirement, Get, Imbalance, LockableCurrency as PalletLockableCurrency,
ReservableCurrency as PalletReservableCurrency, WithdrawReasons,
NamedReservableCurrency as PalletNamedReservableCurrency, WithdrawReasons,
},
};
use frame_system::{ensure_root, ensure_signed, pallet_prelude::*};
Expand All @@ -53,6 +53,7 @@ use orml_traits::{
currency::TransferAll,
BalanceStatus, BasicCurrency, BasicCurrencyExtended, BasicLockableCurrency, BasicReservableCurrency,
LockIdentifier, MultiCurrency, MultiCurrencyExtended, MultiLockableCurrency, MultiReservableCurrency,
NamedBasicReservableCurrency, NamedMultiReservableCurrency,
};
use orml_utilities::with_transaction_result;
use sp_runtime::{
Expand Down Expand Up @@ -84,11 +85,13 @@ pub mod module {
type MultiCurrency: TransferAll<Self::AccountId>
+ MultiCurrencyExtended<Self::AccountId>
+ MultiLockableCurrency<Self::AccountId>
+ MultiReservableCurrency<Self::AccountId>;
+ MultiReservableCurrency<Self::AccountId>
+ NamedMultiReservableCurrency<Self::AccountId, ReserveIdentifier = [u8; 8]>;

type NativeCurrency: BasicCurrencyExtended<Self::AccountId, Balance = BalanceOf<Self>, Amount = AmountOf<Self>>
+ BasicLockableCurrency<Self::AccountId, Balance = BalanceOf<Self>>
+ BasicReservableCurrency<Self::AccountId, Balance = BalanceOf<Self>>;
+ BasicReservableCurrency<Self::AccountId, Balance = BalanceOf<Self>>
+ NamedBasicReservableCurrency<Self::AccountId, ReserveIdentifier = [u8; 8], Balance = BalanceOf<Self>>;

#[pallet::constant]
type GetNativeCurrencyId: Get<CurrencyIdOf<Self>>;
Expand Down Expand Up @@ -368,6 +371,76 @@ impl<T: Config> MultiReservableCurrency<T::AccountId> for Pallet<T> {
}
}

impl<T: Config> NamedMultiReservableCurrency<T::AccountId> for Pallet<T> {
type ReserveIdentifier = [u8; 8];

fn slash_reserved_named(
id: &Self::ReserveIdentifier,
currency_id: Self::CurrencyId,
who: &T::AccountId,
value: Self::Balance,
) -> Self::Balance {
if currency_id == T::GetNativeCurrencyId::get() {
T::NativeCurrency::slash_reserved_named(id, who, value)
} else {
T::MultiCurrency::slash_reserved_named(id, currency_id, who, value)
}
}

fn reserved_balance_named(
id: &Self::ReserveIdentifier,
currency_id: Self::CurrencyId,
who: &T::AccountId,
) -> Self::Balance {
if currency_id == T::GetNativeCurrencyId::get() {
T::NativeCurrency::reserved_balance_named(id, who)
} else {
T::MultiCurrency::reserved_balance_named(id, currency_id, who)
}
}

fn reserve_named(
id: &Self::ReserveIdentifier,
currency_id: Self::CurrencyId,
who: &T::AccountId,
value: Self::Balance,
) -> DispatchResult {
if currency_id == T::GetNativeCurrencyId::get() {
T::NativeCurrency::reserve_named(id, who, value)
} else {
T::MultiCurrency::reserve_named(id, currency_id, who, value)
}
}

fn unreserve_named(
id: &Self::ReserveIdentifier,
currency_id: Self::CurrencyId,
who: &T::AccountId,
value: Self::Balance,
) -> Self::Balance {
if currency_id == T::GetNativeCurrencyId::get() {
T::NativeCurrency::unreserve_named(id, who, value)
} else {
T::MultiCurrency::unreserve_named(id, currency_id, who, value)
}
}

fn repatriate_reserved_named(
id: &Self::ReserveIdentifier,
currency_id: Self::CurrencyId,
slashed: &T::AccountId,
beneficiary: &T::AccountId,
value: Self::Balance,
status: BalanceStatus,
) -> result::Result<Self::Balance, DispatchError> {
if currency_id == T::GetNativeCurrencyId::get() {
T::NativeCurrency::repatriate_reserved_named(id, slashed, beneficiary, value, status)
} else {
T::MultiCurrency::repatriate_reserved_named(id, currency_id, slashed, beneficiary, value, status)
}
}
}

pub struct Currency<T, GetCurrencyId>(marker::PhantomData<T>, marker::PhantomData<GetCurrencyId>);

impl<T, GetCurrencyId> BasicCurrency<T::AccountId> for Currency<T, GetCurrencyId>
Expand Down Expand Up @@ -491,6 +564,52 @@ where
}
}

impl<T, GetCurrencyId> NamedBasicReservableCurrency<T::AccountId> for Currency<T, GetCurrencyId>
where
T: Config,
GetCurrencyId: Get<CurrencyIdOf<T>>,
{
type ReserveIdentifier = [u8; 8];

fn slash_reserved_named(id: &Self::ReserveIdentifier, who: &T::AccountId, value: Self::Balance) -> Self::Balance {
<Pallet<T> as NamedMultiReservableCurrency<T::AccountId>>::slash_reserved_named(
id,
GetCurrencyId::get(),
who,
value,
)
}

fn reserved_balance_named(id: &Self::ReserveIdentifier, who: &T::AccountId) -> Self::Balance {
<Pallet<T> as NamedMultiReservableCurrency<T::AccountId>>::reserved_balance_named(id, GetCurrencyId::get(), who)
}

fn reserve_named(id: &Self::ReserveIdentifier, who: &T::AccountId, value: Self::Balance) -> DispatchResult {
<Pallet<T> as NamedMultiReservableCurrency<T::AccountId>>::reserve_named(id, GetCurrencyId::get(), who, value)
}

fn unreserve_named(id: &Self::ReserveIdentifier, who: &T::AccountId, value: Self::Balance) -> Self::Balance {
<Pallet<T> as NamedMultiReservableCurrency<T::AccountId>>::unreserve_named(id, GetCurrencyId::get(), who, value)
}

fn repatriate_reserved_named(
id: &Self::ReserveIdentifier,
slashed: &T::AccountId,
beneficiary: &T::AccountId,
value: Self::Balance,
status: BalanceStatus,
) -> result::Result<Self::Balance, DispatchError> {
<Pallet<T> as NamedMultiReservableCurrency<T::AccountId>>::repatriate_reserved_named(
id,
GetCurrencyId::get(),
slashed,
beneficiary,
value,
status,
)
}
}

pub type NativeCurrencyOf<T> = Currency<T, <T as Config>::GetNativeCurrencyId>;

/// Adapt other currency traits implementation to `BasicCurrency`.
Expand Down Expand Up @@ -619,7 +738,7 @@ where
impl<T, AccountId, Currency, Amount, Moment> BasicReservableCurrency<AccountId>
for BasicCurrencyAdapter<T, Currency, Amount, Moment>
where
Currency: PalletReservableCurrency<AccountId>,
Currency: PalletNamedReservableCurrency<AccountId>,
T: Config,
{
fn can_reserve(who: &AccountId, value: Self::Balance) -> bool {
Expand Down Expand Up @@ -653,6 +772,43 @@ where
}
}

// Adapt `frame_support::traits::NamedReservableCurrency`
impl<T, AccountId, Currency, Amount, Moment> NamedBasicReservableCurrency<AccountId>
for BasicCurrencyAdapter<T, Currency, Amount, Moment>
where
Currency: PalletNamedReservableCurrency<AccountId>,
T: Config,
{
type ReserveIdentifier = <Currency as PalletNamedReservableCurrency<AccountId>>::ReserveIdentifier;

fn slash_reserved_named(id: &Self::ReserveIdentifier, who: &AccountId, value: Self::Balance) -> Self::Balance {
let (_, gap) = Currency::slash_reserved_named(id, who, value);
gap
}

fn reserved_balance_named(id: &Self::ReserveIdentifier, who: &AccountId) -> Self::Balance {
Currency::reserved_balance_named(id, who)
}

fn reserve_named(id: &Self::ReserveIdentifier, who: &AccountId, value: Self::Balance) -> DispatchResult {
Currency::reserve_named(id, who, value)
}

fn unreserve_named(id: &Self::ReserveIdentifier, who: &AccountId, value: Self::Balance) -> Self::Balance {
Currency::unreserve_named(id, who, value)
}

fn repatriate_reserved_named(
id: &Self::ReserveIdentifier,
slashed: &AccountId,
beneficiary: &AccountId,
value: Self::Balance,
status: BalanceStatus,
) -> result::Result<Self::Balance, DispatchError> {
Currency::repatriate_reserved_named(id, slashed, beneficiary, value, status)
}
}

impl<T: Config> TransferAll<T::AccountId> for Pallet<T> {
fn transfer_all(source: &T::AccountId, dest: &T::AccountId) -> DispatchResult {
with_transaction_result(|| {
Expand Down
Loading