Type Alias moonriver_runtime::Treasury

pub type Treasury = Pallet<Runtime>;

Aliased Type

struct Treasury(/* private fields */);

Implementations

impl<T, I> Pallet<T, I>

where T: Config<I>, I: 'static,

pub fn spend_local( origin: <T as Config>::RuntimeOrigin, amount: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance, beneficiary: <<T as Config>::Lookup as StaticLookup>::Source ) -> Result<(), DispatchError>

Propose and approve a spend of treasury funds.

Dispatch Origin

Must be [Config::SpendOrigin] with the Success value being at least amount.

Details

NOTE: For record-keeping purposes, the proposer is deemed to be equivalent to the beneficiary.

Parameters

• amount: The amount to be transferred from the treasury to the beneficiary.
• beneficiary: The destination account for the transfer.

Events

Emits [Event::SpendApproved] if successful.

pub fn remove_approval( origin: <T as Config>::RuntimeOrigin, proposal_id: u32 ) -> Result<(), DispatchError>

Force a previously approved proposal to be removed from the approval queue.

Dispatch Origin

Must be [Config::RejectOrigin].

Details

The original deposit will no longer be returned.

Parameters

• proposal_id: The index of a proposal

Complexity

• O(A) where A is the number of approvals

Errors

• [Error::ProposalNotApproved]: The proposal_id supplied was not found in the approval queue, i.e., the proposal has not been approved. This could also mean the proposal does not exist altogether, thus there is no way it would have been approved in the first place.

pub fn spend( origin: <T as Config>::RuntimeOrigin, asset_kind: Box<<T as Config<I>>::AssetKind>, amount: <<T as Config<I>>::Paymaster as Pay>::Balance, beneficiary: Box<<<T as Config<I>>::BeneficiaryLookup as StaticLookup>::Source>, valid_from: Option<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> ) -> Result<(), DispatchError>

Propose and approve a spend of treasury funds.

Dispatch Origin

Must be [Config::SpendOrigin] with the Success value being at least amount of asset_kind in the native asset. The amount of asset_kind is converted for assertion using the [Config::BalanceConverter].

Details

Create an approved spend for transferring a specific amount of asset_kind to a designated beneficiary. The spend must be claimed using the payout dispatchable within the [Config::PayoutPeriod].

Parameters

• asset_kind: An indicator of the specific asset class to be spent.
• amount: The amount to be transferred from the treasury to the beneficiary.
• beneficiary: The beneficiary of the spend.
• valid_from: The block number from which the spend can be claimed. It can refer to the past if the resulting spend has not yet expired according to the [Config::PayoutPeriod]. If None, the spend can be claimed immediately after approval.

Events

Emits [Event::AssetSpendApproved] if successful.

pub fn payout( origin: <T as Config>::RuntimeOrigin, index: u32 ) -> Result<(), DispatchError>

Claim a spend.

Dispatch Origin

Must be signed

Details

Spends must be claimed within some temporal bounds. A spend may be claimed within one [Config::PayoutPeriod] from the valid_from block. In case of a payout failure, the spend status must be updated with the check_status dispatchable before retrying with the current function.

Parameters

• index: The spend index.

Events

Emits [Event::Paid] if successful.

pub fn check_status( origin: <T as Config>::RuntimeOrigin, index: u32 ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Check the status of the spend and remove it from the storage if processed.

Dispatch Origin

Must be signed.

Details

The status check is a prerequisite for retrying a failed payout. If a spend has either succeeded or expired, it is removed from the storage by this function. In such instances, transaction fees are refunded.

Parameters

• index: The spend index.

Events

Emits [Event::PaymentFailed] if the spend payout has failed. Emits [Event::SpendProcessed] if the spend payout has succeed.

pub fn void_spend( origin: <T as Config>::RuntimeOrigin, index: u32 ) -> Result<(), DispatchError>

Void previously approved spend.

Dispatch Origin

Must be [Config::RejectOrigin].

Details

A spend void is only possible if the payout has not been attempted yet.

Parameters

• index: The spend index.

Events

Emits [Event::AssetSpendVoided] if successful.

impl<T, I> Pallet<T, I>

where T: Config<I>, I: 'static,

pub fn account_id() -> <T as Config>::AccountId

The account ID of the treasury pot.

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 proposal_count() -> u32

Public function to proposal_count storage.

pub fn proposals( index: u32 ) -> Option<Proposal<<T as Config>::AccountId, <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance>>

Public function to proposals storage.

pub fn approvals() -> BoundedVec<u32, <T as Config<I>>::MaxApprovals>

Public function to approvals storage.

pub fn spend_funds() -> Weight

Spend some money! returns number of approvals before spend.

pub fn pot( ) -> <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::Balance

Return the amount of money in the pot.

Trait Implementations

impl<T, I> StorageInfoTrait for Pallet<T, I>

where T: Config<I>, I: 'static,

fn storage_info() -> Vec<StorageInfo>

impl<T, I> PalletInfoAccess for Pallet<T, I>

where T: Config<I>, I: 'static,

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, I> Debug for Pallet<T, I>

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

Formats the value using the given formatter.

impl<T, I> WhitelistedStorageKeys for Pallet<T, I>

where T: Config<I>, I: 'static,

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, I> GetStorageVersion for Pallet<T, I>

where T: Config<I>, I: 'static,

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version( ) -> <Pallet<T, I> as GetStorageVersion>::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T, I> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

where T: Config<I>, I: 'static,

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number )

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

impl<T, I> OnRuntimeUpgrade for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T, I> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight ) -> Weight

See [Hooks::on_idle].

impl<T, I> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number ) -> Weight

Complexity

• O(A) where A is the number of approvals

fn on_finalize(_n: BlockNumber)

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

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]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

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 blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T, I> PalletsInfoAccess for Pallet<T, I>

where T: Config<I>, I: 'static,

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T, I> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number ) -> Weight

See [Hooks::on_initialize].

impl<T, I> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number )

See [Hooks::on_finalize].

impl<T, I> Callable<T> for Pallet<T, I>

where T: Config<I>, I: 'static,

type RuntimeCall = Call<T, I>

impl<T, I> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter )

Code to execute every now and then at the beginning of the block after inherent application.

impl<T, I> OnGenesis for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_genesis()

Something that should happen at genesis.

impl<T, I> OnUnbalanced<<<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::NegativeImbalance> for Pallet<T, I>

where T: Config<I>, I: 'static,

fn on_nonzero_unbalanced( amount: <<T as Config<I>>::Currency as Currency<<T as Config>::AccountId>>::NegativeImbalance )

Actually handle a non-zero imbalance. You probably want to implement this rather than on_unbalanced.

fn on_unbalanceds(amounts: impl Iterator<Item = Imbalance>)

where Imbalance: TryMerge,

Handler for some imbalances. The different imbalances might have different origins or meanings, dependent on the context. Will default to simply calling on_unbalanced for all of them. Infallible.

fn on_unbalanced(amount: Imbalance)

Handler for some imbalance. Infallible.

impl<T, I> PartialEq for Pallet<T, I>

fn eq(&self, other: &Pallet<T, I>) -> bool

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

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, I> Eq for Pallet<T, I>

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Pallet<T, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, I> BeforeAllRuntimeMigrations for Pallet<T, I>

where T: Config<I>, I: 'static,

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T, I> IntegrityTest for Pallet<T, I>

where T: Config<I>, I: 'static,

fn integrity_test()

See [Hooks::integrity_test].