Enum pallet_asset_index::pallet::Call[−][src]

pub enum Call<T: Config> {
Show 13 variants    add_asset {
        asset_id: T::AssetId,
        units: T::Balance,
        amount: T::Balance,
    },
    force_add_asset {
        asset_id: T::AssetId,
        units: T::Balance,
        amount: T::Balance,
        recipient: T::AccountId,
    },
    remove_asset {
        asset_id: T::AssetId,
        units: T::Balance,
        recipient: Option<T::AccountId>,
    },
    force_remove_asset {
        who: T::AccountId,
        asset_id: T::AssetId,
        units: T::Balance,
        recipient: Option<T::AccountId>,
    },
    register_asset {
        asset_id: T::AssetId,
        availability: AssetAvailability,
    },
    set_deposit_range {
        new_range: DepositRange<T::Balance>,
    },
    update_redemption_fees {
        new_range: RedemptionFeeRange<T::BlockNumber>,
    },
    set_lockup_period {
        lockup_period: T::BlockNumber,
    },
    set_metadata {
        id: T::AssetId,
        name: Vec<u8>,
        symbol: Vec<u8>,
        decimals: u8,
    },
    deposit {
        asset_id: T::AssetId,
        units: T::Balance,
    },
    withdraw {
        amount: T::Balance,
    },
    complete_withdraw {},
    unlock {},
    // some variants omitted
}

Expand description

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

add_asset

Callable by the governance committee to add new liquid assets to the index and mint the given amount IndexToken. The amount of PINT minted and awarded to the LP is specified as part of the associated proposal Caller’s balance is updated to allocate the correct amount of the IndexToken. The given amount of assets must already exist in the caller’s account, they are then transferred to the treasury account.

The Governance committee decides the tokens that comprise the index, as well as the allocation of each and their value.

Fields of add_asset

asset_id: T::AssetIdunits: T::Balanceamount: T::Balance

force_add_asset

Add liquid asset with root origin, see add_asset

Fields of force_add_asset

asset_id: T::AssetIdunits: T::Balanceamount: T::Balancerecipient: T::AccountId

remove_asset

Dispatches transfer to move assets out of the index’s account, if a liquid asset is specified Callable by an admin.

Updates the index to reflect the removed assets (units) by burning index token accordingly. If the given asset is liquid, an xcm transfer will be dispatched to transfer the given units into the sovereign account of either:

the given recipient if provided
the caller’s account if recipient is None

Fields of remove_asset

asset_id: T::AssetIdunits: T::Balancerecipient: Option<T::AccountId>

force_remove_asset

Remove liquid asset with root origin

Fields of force_remove_asset

who: T::AccountIdasset_id: T::AssetIdunits: T::Balancerecipient: Option<T::AccountId>

register_asset

Registers a new asset in the index together with its availability

Only callable by the admin origin and for assets that are not yet registered.

Fields of register_asset

asset_id: T::AssetIdavailability: AssetAvailability

set_deposit_range

Updates the range for how much a deposit must be worth in index token in order to be accpedted. Only callable by the admin origin

Parameters:

new_range: The new valid range for deposits.

Fields of set_deposit_range

new_range: DepositRange<T::Balance>

update_redemption_fees

Updates the range for redemption fee

Only callable by the admin origin

Parameters:

new_range: The new valid range for redemption fee.

Fields of update_redemption_fees

new_range: RedemptionFeeRange<T::BlockNumber>

set_lockup_period

Updates the lockup period

Only callable by the admin origin

Parameters:

lockup_period: how long will the depositing assets will be locked

Fields of set_lockup_period

lockup_period: T::BlockNumber

set_metadata

Force the metadata for an asset to some value.

Origin must be ForceOrigin.

Any deposit is left alone.

id: The identifier of the asset to update.
name: The user friendly name of this asset. Limited in length by StringLimit.
symbol: The exchange symbol for this asset. Limited in length by StringLimit.
decimals: The number of decimals this asset uses to represent one unit.

Emits MetadataSet.

Weight: O(N + S) where N and S are the length of the name and symbol respectively.

Fields of set_metadata

id: T::AssetIdname: Vec<u8>symbol: Vec<u8>decimals: u8

deposit

Initiate a transfer from the user’s sovereign account into the index.

This will withdraw the given amount from the user’s sovereign account and mints PINT proportionally using the latest available price pairs

Fields of deposit

asset_id: T::AssetIdunits: T::Balance

withdraw

Starts the withdraw process for the given amount of PINT to redeem for a distribution of underlying assets.

All withdrawals undergo an unlocking period after which the assets can be withdrawn. A withdrawal fee will be deducted from the PINT being redeemed by the LP depending on how long the assets remained in the index. The remaining PINT will be burned to match the new NAV after this withdrawal.

The distribution of the underlying assets will be equivalent to the ratio of the liquid assets in the index.

Fields of withdraw

amount: T::Balance

complete_withdraw

Attempts to complete all currently pending redemption processes started by the withdraw extrinsic.

This checks every pending withdrawal within PendingWithdrawal and tries to close it. Completing a withdrawal will succeed if following conditions are met:

the LockupPeriod has passed since the withdrawal was initiated
the treasury can cover the asset transfer to the caller’s account, from which the caller then can initiate an Xcm::Withdraw to remove the assets from the PINT parachain entirely, if xcm transfers are supported.

NOTE: All individual withdrawals that resulted from “Withdraw” will be completed separately, however, the entire record of pending withdrawals will not be fully closed until the last withdrawal is completed. This means that a single AssetWithdrawal will be closed as soon as the aforementioned conditions are met, regardless of whether the other AssetWithdrawals in the same PendingWithdrawal set can also be closed successfully.

Fields of complete_withdraw

unlock

Updates the index token locks of the caller.

This removes expired locks and updates the caller’s index token balance accordingly.

Enum pallet_asset_index::pallet::Call[−][src]

Variants

Fields of add_asset

Fields of force_add_asset

Fields of remove_asset

Fields of force_remove_asset

Fields of register_asset

Fields of set_deposit_range

Fields of update_redemption_fees

Fields of set_lockup_period

Fields of set_metadata

Fields of deposit

Fields of withdraw

Fields of complete_withdraw

Fields of unlock

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_add_asset( asset_id: T::AssetId, units: T::Balance, amount: T::Balance) -> Self

pub fn new_call_variant_force_add_asset( asset_id: T::AssetId, units: T::Balance, amount: T::Balance, recipient: T::AccountId) -> Self

pub fn new_call_variant_remove_asset( asset_id: T::AssetId, units: T::Balance, recipient: Option<T::AccountId>) -> Self

pub fn new_call_variant_force_remove_asset( who: T::AccountId, asset_id: T::AssetId, units: T::Balance, recipient: Option<T::AccountId>) -> Self

pub fn new_call_variant_register_asset( asset_id: T::AssetId, availability: AssetAvailability) -> Self

pub fn new_call_variant_set_deposit_range( new_range: DepositRange<T::Balance>) -> Self

pub fn new_call_variant_update_redemption_fees( new_range: RedemptionFeeRange<T::BlockNumber>) -> Self

pub fn new_call_variant_set_lockup_period(lockup_period: T::BlockNumber) -> Self

pub fn new_call_variant_set_metadata( id: T::AssetId, name: Vec<u8>, symbol: Vec<u8>, decimals: u8) -> Self

pub fn new_call_variant_deposit(asset_id: T::AssetId, units: T::Balance) -> Self

pub fn new_call_variant_withdraw(amount: T::Balance) -> Self

pub fn new_call_variant_complete_withdraw() -> Self

pub fn new_call_variant_unlock() -> Self

Trait Implementations

impl<T: Config> Clone for Call<T>

fn clone(&self) -> Self

fn clone_from(&mut self, source: &Self)

impl<T: Config> Debug for Call<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy) -> Result<Self, Error>

fn skip<I>(input: &mut I) -> Result<(), Error> where I: Input,

fn encoded_fixed_size() -> Option<usize>

impl<T: Config> Encode for Call<T>

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy)

fn size_hint(&self) -> usize

fn encode(&self) -> Vec<u8, Global>

fn using_encoded<R, F>(&self, f: F) -> R where F: FnOnce(&[u8]) -> R,

fn encoded_size(&self) -> usize

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

fn get_call_names() -> &'static [&'static str]

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

impl<T: Config> PartialEq<Call<T>> for Call<T>

fn eq(&self, other: &Self) -> bool

fn ne(&self, other: &Rhs) -> bool

type Identity = Self

fn type_info() -> Type

impl<T: Config> UnfilteredDispatchable for Call<T>

type Origin = OriginFor<T>

fn dispatch_bypass_filter( self, origin: Self::Origin) -> DispatchResultWithPostInfo

impl<T: Config> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Call<T> where T: RefUnwindSafe, <T as Config>::AccountId: RefUnwindSafe, <T as Config>::AssetId: RefUnwindSafe, <T as Config>::Balance: RefUnwindSafe, <T as Config>::BlockNumber: RefUnwindSafe,

impl<T> Send for Call<T> where T: Send,

impl<T> Sync for Call<T> where T: Sync,

impl<T> Unpin for Call<T> where T: Unpin, <T as Config>::AccountId: Unpin, <T as Config>::AssetId: Unpin, <T as Config>::Balance: Unpin, <T as Config>::BlockNumber: Unpin,

impl<T> UnwindSafe for Call<T> where T: UnwindSafe, <T as Config>::AccountId: UnwindSafe, <T as Config>::AssetId: UnwindSafe, <T as Config>::Balance: UnwindSafe, <T as Config>::BlockNumber: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

impl<T> Conv for T

fn conv<T>(self) -> T where Self: Into<T>,

impl<T> Conv for T

pub fn new_call_variant_add_asset(
asset_id: T::AssetId,
units: T::Balance,
amount: T::Balance
) -> Self

pub fn new_call_variant_force_add_asset(
asset_id: T::AssetId,
units: T::Balance,
amount: T::Balance,
recipient: T::AccountId
) -> Self

pub fn new_call_variant_remove_asset(
asset_id: T::AssetId,
units: T::Balance,
recipient: Option<T::AccountId>
) -> Self

pub fn new_call_variant_force_remove_asset(
who: T::AccountId,
asset_id: T::AssetId,
units: T::Balance,
recipient: Option<T::AccountId>
) -> Self

pub fn new_call_variant_register_asset(
asset_id: T::AssetId,
availability: AssetAvailability
) -> Self

pub fn new_call_variant_set_deposit_range(
new_range: DepositRange<T::Balance>
) -> Self

pub fn new_call_variant_update_redemption_fees(
new_range: RedemptionFeeRange<T::BlockNumber>
) -> Self

pub fn new_call_variant_set_metadata(
id: T::AssetId,
name: Vec<u8>,
symbol: Vec<u8>,
decimals: u8
) -> Self

fn decode<CodecInputEdqy: Input>(
codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

fn skip<I>(input: &mut I) -> Result<(), Error> where
I: Input,

fn encode_to<CodecOutputEdqy: Output + ?Sized>(
&self,
codec_dest_edqy: &mut __CodecOutputEdqy
)

fn using_encoded<R, F>(&self, f: F) -> R where
F: FnOnce(&[u8 ]) -> R,

fn get_call_names() -> &'static [&'static str ]

fn dispatch_bypass_filter(
self,
origin: Self::Origin
) -> DispatchResultWithPostInfo

impl<T> RefUnwindSafe for Call<T> where
T: RefUnwindSafe,
<T as Config>::AccountId: RefUnwindSafe,
<T as Config>::AssetId: RefUnwindSafe,
<T as Config>::Balance: RefUnwindSafe,
<T as Config>::BlockNumber: RefUnwindSafe,

impl<T> Send for Call<T> where
T: Send,

impl<T> Sync for Call<T> where
T: Sync,

impl<T> Unpin for Call<T> where
T: Unpin,
<T as Config>::AccountId: Unpin,
<T as Config>::AssetId: Unpin,
<T as Config>::Balance: Unpin,
<T as Config>::BlockNumber: Unpin,

impl<T> UnwindSafe for Call<T> where
T: UnwindSafe,
<T as Config>::AccountId: UnwindSafe,
<T as Config>::AssetId: UnwindSafe,
<T as Config>::Balance: UnwindSafe,
<T as Config>::BlockNumber: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

fn conv<T>(self) -> T where
Self: Into<T>,

fn conv<T>(self) -> T where
Self: Into<T>,

impl<T> DecodeAll for T where
T: Decode,

pub fn decode_all(input: &[u8 ]) -> Result<T, Error>

impl<T> DecodeLimit for T where
T: Decode,

pub fn decode_all_with_depth_limit(limit: u32, input: &[u8 ]) -> Result<T, Error>

pub fn decode_and_advance_with_depth_limit<I>(
limit: u32,
input: &mut I
) -> Result<T, Error> where
I: Input,

pub fn decode_with_depth_limit(limit: u32, input: &[u8 ]) -> Result<T, Error>

impl<T> Downcast for T where
T: Any,

impl<T> DowncastSync for T where
T: Any + Send + Sync,

impl<T> DynClone for T where
T: Clone,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

fn fmt_binary(self) -> FmtBinary<Self> where
Self: Binary,

fn fmt_display(self) -> FmtDisplay<Self> where
Self: Display,

fn fmt_lower_exp(self) -> FmtLowerExp<Self> where
Self: LowerExp,

fn fmt_lower_hex(self) -> FmtLowerHex<Self> where
Self: LowerHex,

fn fmt_octal(self) -> FmtOctal<Self> where
Self: Octal,

fn fmt_pointer(self) -> FmtPointer<Self> where
Self: Pointer,

fn fmt_upper_exp(self) -> FmtUpperExp<Self> where
Self: UpperExp,

fn fmt_upper_hex(self) -> FmtUpperHex<Self> where
Self: UpperHex,

impl<T> Hashable for T where
T: Codec,

pub fn blake2_128(&self) -> [u8 ; 16]

pub fn blake2_256(&self) -> [u8 ; 32]

pub fn twox_128(&self) -> [u8 ; 16]

pub fn twox_256(&self) -> [u8 ; 32]

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

impl<T> KeyedVec for T where
T: Codec,

pub fn to_keyed_vec(&self, prepend_key: &[u8 ]) -> Vec<u8, Global>

impl<T> Pipe for T where
T: ?Sized,

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R where
R: 'a,

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R where
R: 'a,

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R where
Self: Borrow<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R
) -> R where
Self: BorrowMut<B>,
B: 'a + ?Sized,
R: 'a,

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R where
Self: AsRef<U>,
U: 'a + ?Sized,
R: 'a,

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R where
Self: AsMut<U>,
U: 'a + ?Sized,
R: 'a,