Enum Call

pub enum Call<T: Config> {
    create {
        index: Id,
        cap: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance,
        first_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod,
        last_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod,
        end: BlockNumberFor<T>,
        verifier: Option<MultiSigner>,
    },
    contribute {
        index: Id,
        value: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance,
        signature: Option<MultiSignature>,
    },
    withdraw {
        who: T::AccountId,
        index: Id,
    },
    refund {
        index: Id,
    },
    dissolve {
        index: Id,
    },
    edit {
        index: Id,
        cap: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance,
        first_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod,
        last_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod,
        end: BlockNumberFor<T>,
        verifier: Option<MultiSigner>,
    },
    add_memo {
        index: Id,
        memo: Vec<u8>,
    },
    poke {
        index: Id,
    },
    contribute_all {
        index: Id,
        signature: Option<MultiSignature>,
    },
    // some variants omitted
}

Contains a variant per dispatchable extrinsic that this pallet has.

Variants

create

Create a new crowdloaning campaign for a parachain slot with the given lease period range.

This applies a lock to your parachain configuration, ensuring that it cannot be changed by the parachain manager.

Fields

index: Id

cap: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance

first_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod

last_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod

end: BlockNumberFor<T>

verifier: Option<MultiSigner>

contribute

Contribute to a crowd sale. This will transfer some balance over to fund a parachain slot. It will be withdrawable when the crowdloan has ended and the funds are unused.

Fields

index: Id

value: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance

signature: Option<MultiSignature>

withdraw

Withdraw full balance of a specific contributor.

Origin must be signed, but can come from anyone.

The fund must be either in, or ready for, retirement. For a fund to be in retirement, then the retirement flag must be set. For a fund to be ready for retirement, then:

• it must not already be in retirement;
• the amount of raised funds must be bigger than the free balance of the account;
• and either:
  • the block number must be at least end; or
  • the current lease period must be greater than the fund’s last_period.

In this case, the fund’s retirement flag is set and its end is reset to the current block number.

• who: The account whose contribution should be withdrawn.
• index: The parachain to whose crowdloan the contribution was made.

Fields

who: T::AccountId

index: Id

refund

Automatically refund contributors of an ended crowdloan. Due to weight restrictions, this function may need to be called multiple times to fully refund all users. We will refund RemoveKeysLimit users at a time.

Origin must be signed, but can come from anyone.

Fields

index: Id

dissolve

Remove a fund after the retirement period has ended and all funds have been returned.

Fields

index: Id

edit

Edit the configuration for an in-progress crowdloan.

Can only be called by Root origin.

Fields

index: Id

cap: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance

first_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod

last_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod

end: BlockNumberFor<T>

verifier: Option<MultiSigner>

add_memo

Add an optional memo to an existing crowdloan contribution.

Origin must be Signed, and the user must have contributed to the crowdloan.

Fields

index: Id

memo: Vec<u8>

poke

Poke the fund into NewRaise

Origin must be Signed, and the fund has non-zero raise.

Fields

index: Id

contribute_all

Contribute your entire balance to a crowd sale. This will transfer the entire balance of a user over to fund a parachain slot. It will be withdrawable when the crowdloan has ended and the funds are unused.

Fields

index: Id

signature: Option<MultiSignature>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_create( index: ParaId, cap: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance, first_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod, last_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod, end: BlockNumberFor<T>, verifier: Option<MultiSigner>, ) -> Self

Create a call with the variant create.

pub fn new_call_variant_contribute( index: ParaId, value: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance, signature: Option<MultiSignature>, ) -> Self

Create a call with the variant contribute.

pub fn new_call_variant_withdraw(who: T::AccountId, index: ParaId) -> Self

Create a call with the variant withdraw.

pub fn new_call_variant_refund(index: ParaId) -> Self

Create a call with the variant refund.

pub fn new_call_variant_dissolve(index: ParaId) -> Self

Create a call with the variant dissolve.

pub fn new_call_variant_edit( index: ParaId, cap: <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance, first_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod, last_period: <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod, end: BlockNumberFor<T>, verifier: Option<MultiSigner>, ) -> Self

Create a call with the variant edit.

pub fn new_call_variant_add_memo(index: ParaId, memo: Vec<u8>) -> Self

Create a call with the variant add_memo.

pub fn new_call_variant_poke(index: ParaId) -> Self

Create a call with the variant poke.

pub fn new_call_variant_contribute_all( index: ParaId, signature: Option<MultiSignature>, ) -> Self

Create a call with the variant contribute_all.

Trait Implementations

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

fn authorize( &self, source: TransactionSource, ) -> Option<Result<(ValidTransaction, Weight), TransactionValidityError>>

The authorize function.

fn weight_of_authorize(&self) -> Weight

The weight of the authorization function.

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

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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<T: Config> Encode for Call<T>

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<T: Config> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

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

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

Return the function name of the Call.

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

Return all function names in the same order as [GetCallIndex].

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

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

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

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> TypeInfo for Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance: HasCompact, <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod: HasCompact, BlockNumberFor<T>: HasCompact, T::AccountId: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

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

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

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

Dispatch this call but do not check the filter in origin.

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

where T::AccountId: DecodeWithMemTracking, <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance: HasCompact, <<<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::Currency as Currency<<T as Config>::AccountId>>::Balance as HasCompact>::Type: DecodeWithMemTracking, <<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod: HasCompact, <<<T as Config>::Auctioneer as Auctioneer<BlockNumberFor<T>>>::LeasePeriod as HasCompact>::Type: DecodeWithMemTracking, BlockNumberFor<T>: HasCompact, <BlockNumberFor<T> as HasCompact>::Type: DecodeWithMemTracking,

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

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