Struct polkadot_runtime_common::crowdloan::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn create(
    origin: OriginFor<T>,
    index: ParaId,
    cap: <<<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    first_period: <<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::LeasePeriod,
    last_period: <<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::LeasePeriod,
    end: T::BlockNumber,
    verifier: Option<MultiSigner>
) -> DispatchResult

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.

pub fn contribute(
    origin: OriginFor<T>,
    index: ParaId,
    value: <<<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    signature: Option<MultiSignature>
) -> DispatchResult

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.

pub fn withdraw(
    origin: OriginFor<T>,
    who: T::AccountId,
    index: ParaId
) -> DispatchResult

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.

pub fn refund(origin: OriginFor<T>, index: ParaId) -> DispatchResultWithPostInfo

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.

pub fn dissolve(origin: OriginFor<T>, index: ParaId) -> DispatchResult

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

pub fn edit(
    origin: OriginFor<T>,
    index: ParaId,
    cap: <<<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    first_period: <<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::LeasePeriod,
    last_period: <<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::LeasePeriod,
    end: T::BlockNumber,
    verifier: Option<MultiSigner>
) -> DispatchResult

Edit the configuration for an in-progress crowdloan.

Can only be called by Root origin.

pub fn add_memo(
    origin: OriginFor<T>,
    index: ParaId,
    memo: Vec<u8>
) -> DispatchResult

Add an optional memo to an existing crowdloan contribution.

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

pub fn poke(origin: OriginFor<T>, index: ParaId) -> DispatchResult

Poke the fund into NewRaise

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

pub fn contribute_all(
    origin: OriginFor<T>,
    index: ParaId,
    signature: Option<MultiSignature>
) -> DispatchResult

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.

impl<T: Config> Pallet<T>

pub fn funds<KArg>(
    k: KArg
) -> Option<FundInfo<T::AccountId, <<<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance, T::BlockNumber, <<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::LeasePeriod>>where
    KArg: EncodeLike<ParaId>,

Info on all of the funds.

impl<T: Config> Pallet<T>

pub fn new_raise() -> Vec<ParaId>

The funds that have had additional contributions during the last block. This is used in order to determine which funds should submit new or updated bids.

impl<T: Config> Pallet<T>

pub fn endings_count() -> u32

The number of auctions that have entered into their ending period so far.

impl<T: Config> Pallet<T>

pub fn next_fund_index() -> u32

Tracker for the next available fund index

impl<T: Config> Pallet<T>

pub fn fund_account_id(index: u32) -> T::AccountId

The account ID of the fund 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 id_from_index(index: u32) -> ChildInfo

pub fn contribution_put(
    index: u32,
    who: &T::AccountId,
    balance: &<<<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance,
    memo: &[u8]
)

pub fn contribution_get(
    index: u32,
    who: &T::AccountId
) -> (<<<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance, Vec<u8>)

pub fn contribution_kill(index: u32, who: &T::AccountId)

pub fn crowdloan_kill(index: u32) -> KillStorageResult

pub fn contribution_iterator(
    index: u32
) -> ChildTriePrefixIterator<(T::AccountId, (<<<T as Config>::Auctioneer as Auctioneer<<T as Config>::BlockNumber>>::Currency as Currency<<T as Config>::AccountId>>::Balance, Vec<u8>))>

Trait Implementations

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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

type Call = Call<T>

impl<T> Clone for Pallet<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> Debug for Pallet<T>

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

Formats the value using the given formatter.

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

fn current_storage_version() -> StorageVersion

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.

impl<T: Config> Hooks<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(num: T::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

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

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

fn integrity_test()

Run integrity test.

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

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

fn offchain_worker(n: <T as Config>::BlockNumber)

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

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

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

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

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

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

fn on_swap(one: ParaId, other: ParaId)

Updates any needed state/references to enact a logical swap of two parachains. Identity, code and head_data remain equivalent for all parachains/threads, however other properties such as leases, deposits held and thread/chain nature are swapped.

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

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq<Pallet<T>> for Pallet<T>

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> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T> Eq for Pallet<T>