Enum gsdk::metadata::runtime_types::pallet_treasury::pallet::Call

pub enum Call {
    spend_local {
        amount: u128,
        beneficiary: MultiAddress<AccountId32, ()>,
    },
    remove_approval {
        proposal_id: u32,
    },
    spend {
        asset_kind: Box<()>,
        amount: u128,
        beneficiary: Box<AccountId32>,
        valid_from: Option<u32>,
    },
    payout {
        index: u32,
    },
    check_status {
        index: u32,
    },
    void_spend {
        index: u32,
    },
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

spend_local

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.

Fields

amount: u128

beneficiary: MultiAddress<AccountId32, ()>

remove_approval

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.

Fields

proposal_id: u32

spend

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.

Fields

asset_kind: Box<()>

amount: u128

beneficiary: Box<AccountId32>

valid_from: Option<u32>

payout

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.

Fields

index: u32

check_status

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.

Fields

index: u32

void_spend

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.

Fields

index: u32

Trait Implementations

impl Debug for Call

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

Formats the value using the given formatter.

impl Decode for Call

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

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for Call

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

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

Convert self to a slice and append it to the destination.

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl IntoVisitor for Call

type AnyVisitor<ScaleDecodeTypeResolver: TypeResolver> = Visitor<ScaleDecodeTypeResolver>

The visitor type used to decode SCALE encoded bytes to Self.

fn into_visitor<ScaleDecodeTypeResolver: TypeResolver>() -> Self::AnyVisitor<ScaleDecodeTypeResolver>

A means of obtaining this visitor.

impl EncodeLike for Call