Struct pallet_pool_fees::pallet::Pallet

impl<T: Config> Pallet<T>

pub fn propose_new_fee( origin: OriginFor<T>, pool_id: T::PoolId, bucket: PoolFeeBucket, fee: PoolFeeInfoOf<T> ) -> DispatchResult

Propose to append a new fee to the given (pool, bucket) pair.

Origin must be by pool admin.

pub fn apply_new_fee( origin: OriginFor<T>, pool_id: T::PoolId, change_id: T::Hash ) -> DispatchResultWithPostInfo

Execute a successful fee append proposal for the given (pool, bucket) pair.

Origin unrestriced due to pre-check via proposal gate.

pub fn remove_fee(origin: OriginFor<T>, fee_id: T::FeeId) -> DispatchResult

Remove a fee.

Origin must be the fee editor.

pub fn charge_fee( origin: OriginFor<T>, fee_id: T::FeeId, amount: T::Balance ) -> DispatchResultWithPostInfo

Charge a fee.

Origin must be the fee destination.

pub fn uncharge_fee( origin: OriginFor<T>, fee_id: T::FeeId, amount: T::Balance ) -> DispatchResultWithPostInfo

Cancel a charged fee.

Origin must be the fee destination.

pub fn update_portfolio_valuation( origin: OriginFor<T>, pool_id: T::PoolId ) -> DispatchResultWithPostInfo

Update the negative portfolio valuation via pending amounts of the pool’s active fees. Also updates the latter if the last update happened in the past.

NOTE: There can be fee amounts which are dependent on AssetsUnderManagement. Therefore, we enforce this to have been updated in the current timestamp. In the future, this coupling will be handled by an accounting pallet.

impl<T: Config> Pallet<T>

pub fn account_id() -> T::AccountId

The account ID of the pool fees.

This actually does computation. If you need to keep using it, then make sure you cache the value and only call this once.

pub fn get_active_fee(fee_id: T::FeeId) -> Result<PoolFeeOf<T>, DispatchError>

Retrieve the specified fee from the list of active fees

pub fn update_portfolio_valuation_for_pool( pool_id: T::PoolId, reserve: &mut T::Balance ) -> Result<(T::Balance, u32), DispatchError>

Update the NAV of the specified pool by incrementing each fee by the payable epoch amount based on the fee configuration. As long as the reserve is not empty, increments the disbursement amount of fees following the waterfall. The reserve is sufficient, if all fees can pe paid out by their outstanding payable amount.

The NAV value is the sum all pending amounts which do not include disbursements. Thus, if NAV update is called for an empty reserve, the valuation is maximized at this point in time because each unit of reserve reduces the NAV by reducing pending to disbursment amounts.

NAV(PoolFees) = sum(pending_fee_amount) = sum(epoch_amount - disbursement)

pub fn get_pool_fees( pool_id: T::PoolId ) -> PoolFeesList<T::FeeId, T::AccountId, T::Balance, T::Rate>

impl<T: Config> Pallet<T>

pub fn portfolio_valuation<KArg>( k: KArg ) -> PortfolioValuation<T::Balance, T::FeeId, T::MaxFeesPerPool>
where KArg: EncodeLike<T::PoolId>,

An auto-generated getter for PortfolioValuation.

Trait Implementations§

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter. Read more

impl<T: Config> EpochTransitionHook for Pallet<T>

type Balance = <T as Config>::Balance

type Error = DispatchError

type PoolId = <T as Config>::PoolId

type Time = u64

fn on_closing_mutate_reserve( pool_id: Self::PoolId, assets_under_management: Self::Balance, reserve: &mut Self::Balance ) -> Result<(), Self::Error>

Hook into the closing of an epoch

fn on_execution_pre_fulfillments( pool_id: Self::PoolId ) -> Result<(), Self::Error>

Hook into the execution of an epoch before any investment and redemption fulfillments

impl<T: Config> GetStorageVersion for Pallet<T>

type CurrentStorageVersion = NoStorageVersionSet

This will be filled out by the pallet macro. Read more

fn current_storage_version() -> Self::CurrentStorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution. Read more

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution. Read more

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]). Read more

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by FRAME. Read more

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main wasm runtime. Read more

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced). Read more

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents. Read more

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

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

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> PoolFeesInspect for Pallet<T>

type PoolId = <T as Config>::PoolId

fn get_max_fee_count() -> u32

Returns the maximum number of pool fees required for accurate weights

fn get_max_fees_per_bucket() -> u32

Returns the maximum number of pool fees per bucket required for accurate weights

fn get_pool_fee_bucket_count(pool: Self::PoolId, bucket: PoolFeeBucket) -> u32

Returns the current amount of active fees for the given pool and bucket pair

fn get_pool_fee_count(pool: Self::PoolId) -> u32

Returns the current amount of active fees for the given pool

impl<T: Config> PoolFeesMutate for Pallet<T>

type FeeInfo = PoolFeeInfo<<T as Config>::AccountId, <T as Config>::Balance, <T as Config>::Rate>

type PoolId = <T as Config>::PoolId

fn add_fee( pool_id: Self::PoolId, bucket: PoolFeeBucket, fee: Self::FeeInfo ) -> Result<(), DispatchError>

Add a new fee to the pool and bucket. Read more

impl<T: Config> PoolNAV<<T as Config>::PoolId, <T as Config>::Balance> for Pallet<T>

type ClassId = ()

type RuntimeOrigin = <T as Config>::RuntimeOrigin

fn nav(pool_id: T::PoolId) -> Option<(T::Balance, Seconds)>

fn update_nav(pool_id: T::PoolId) -> Result<T::Balance, DispatchError>

fn initialise(_: OriginFor<T>, _: T::PoolId, _: Self::ClassId) -> DispatchResult

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>

Auto Trait Implementations§

impl<T> RefUnwindSafe for Pallet<T>
where T: RefUnwindSafe,

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

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

impl<T> Unpin for Pallet<T>
where T: Unpin,

impl<T> UnwindSafe for Pallet<T>
where T: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CheckedConversion for T

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

Convert from a value of T into an equivalent instance of Option<Self>. Read more

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

Consume self to return Some equivalent value of Option<T>. Read more

impl<T> Conv for T

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

Converts self into T using Into<T>. Read more

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

fn __clone_box(&self, _: Private) -> *mut ()

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

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

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

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> FmtForward for T

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

Causes self to use its Binary implementation when Debug-formatted.

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

Causes self to use its Display implementation when Debug-formatted.

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

Causes self to use its LowerExp implementation when Debug-formatted.

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

Causes self to use its LowerHex implementation when Debug-formatted.

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

Causes self to use its Octal implementation when Debug-formatted.

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

Causes self to use its Pointer implementation when Debug-formatted.

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

Causes self to use its UpperExp implementation when Debug-formatted.

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

Causes self to use its UpperHex implementation when Debug-formatted.

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> Into2 for T
where U: From2<T>,

fn into2(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more