Struct pallet_treasury::pallet::Pallet

pub struct Pallet<T, I = ()>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn propose_spend( origin: OriginFor<T>, value: BalanceOf<T, I>, beneficiary: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult

👎Deprecated: propose_spend will be removed in February 2024. Use spend instead.

Put forward a suggestion for spending.

Dispatch Origin

Must be signed.

Details

A deposit proportional to the value is reserved and slashed if the proposal is rejected. It is returned once the proposal is awarded.

Complexity

• O(1)

Events

Emits Event::Proposed if successful.

pub fn reject_proposal( origin: OriginFor<T>, proposal_id: ProposalIndex ) -> DispatchResult

👎Deprecated: reject_proposal will be removed in February 2024. Use spend instead.

Reject a proposed spend.

Dispatch Origin

Must be Config::RejectOrigin.

Details

The original deposit will be slashed.

Complexity

• O(1)

Events

Emits Event::Rejected if successful.

pub fn approve_proposal( origin: OriginFor<T>, proposal_id: ProposalIndex ) -> DispatchResult

👎Deprecated: approve_proposal will be removed in February 2024. Use spend instead.

Approve a proposal.

Dispatch Origin

Must be Config::ApproveOrigin.

Details

At a later time, the proposal will be allocated to the beneficiary and the original deposit will be returned.

Complexity

• O(1).

Events

No events are emitted from this dispatch.

pub fn spend_local( origin: OriginFor<T>, amount: BalanceOf<T, I>, beneficiary: <<T as Config>::Lookup as StaticLookup>::Source ) -> DispatchResult

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: OriginFor<T>, proposal_id: ProposalIndex ) -> DispatchResult

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: OriginFor<T>, asset_kind: Box<T::AssetKind>, amount: AssetBalanceOf<T, I>, beneficiary: Box<<<T as Config<I>>::BeneficiaryLookup as StaticLookup>::Source>, valid_from: Option<BlockNumberFor<T>> ) -> DispatchResult

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: OriginFor<T>, index: SpendIndex) -> DispatchResult

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: OriginFor<T>, index: SpendIndex ) -> DispatchResultWithPostInfo

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: OriginFor<T>, index: SpendIndex) -> DispatchResult

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: Config<I>, I: 'static> Pallet<T, I>

pub fn proposal_count() -> ProposalIndex

An auto-generated getter for ProposalCount.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn proposals<KArg>( k: KArg ) -> Option<Proposal<T::AccountId, BalanceOf<T, I>>>

where KArg: EncodeLike<ProposalIndex>,

An auto-generated getter for Proposals.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn approvals() -> BoundedVec<ProposalIndex, T::MaxApprovals>

An auto-generated getter for Approvals.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn account_id() -> T::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 spend_funds() -> Weight

Spend some money! returns number of approvals before spend.

pub fn pot() -> BalanceOf<T, I>

Return the amount of money in the pot.

Trait Implementations

impl<T: Config<I>, I: 'static> BeforeAllRuntimeMigrations for Pallet<T, I>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::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: Config<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_initialize(n: BlockNumberFor<T>) -> 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: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

See Hooks::integrity_test.

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

fn offchain_worker(n: BlockNumberFor<T>)

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

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

fn on_finalize(n: BlockNumberFor<T>)

See Hooks::on_finalize.

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

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

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

See Hooks::on_idle.

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

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

See Hooks::on_initialize.

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

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

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

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

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

fn on_nonzero_unbalanced(amount: NegativeImbalanceOf<T, I>)

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

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

where Imbalance: Imbalance<B>,

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: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

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<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

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

fn eq(&self, other: &Self) -> 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: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

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