Type Alias Module Copy item path

impl<T: Config> Pallet<T>

pub fn unreserve_lease_deposit( origin: OriginFor<T>, block: BlockNumberFor<T>, depositor: Option<T::AccountId>, para_id: ParaId, ) -> DispatchResult

Unreserve the deposit that was taken for creating a crowdloan.

This can be called by any signed origin. It unreserves the lease deposit on the account that won the lease auction. It can be unreserved once all leases expired. Note that it will be called automatically from withdraw_crowdloan_contribution for the matching crowdloan account.

Solo bidder accounts that won lease auctions can use this to unreserve their amount.

pub fn withdraw_crowdloan_contribution( origin: OriginFor<T>, block: BlockNumberFor<T>, depositor: Option<T::AccountId>, para_id: ParaId, ) -> DispatchResult

Withdraw the contribution of a finished crowdloan.

A crowdloan contribution can be withdrawn if either:

The crowdloan failed to in an auction and timed out
Won an auction and all leases expired

Can be called by any signed origin.

pub fn unreserve_crowdloan_reserve( origin: OriginFor<T>, block: BlockNumberFor<T>, depositor: Option<T::AccountId>, para_id: ParaId, ) -> DispatchResult

Unreserve the deposit that was taken for creating a crowdloan.

This can be called once either:

The crowdloan failed to win an auction and timed out
Won an auction, all leases expired and all contributions are withdrawn

Can be called by any signed origin. The condition that all contributions are withdrawn is in place since the reserve acts as a storage deposit.

pub fn migrate_parachain_sovereign_acc( origin: OriginFor<T>, from: T::AccountId, to: T::AccountId, ) -> DispatchResult

Try to migrate a parachain sovereign child account to its respective sibling.

Takes the old and new account and migrates it only if they are as expected. An event of SovereignMigrated will be emitted if the account was migrated successfully.

Callable by any signed origin.

pub fn migrate_parachain_sovereign_derived_acc( origin: OriginFor<T>, from: T::AccountId, to: T::AccountId, derivation: (T::AccountId, DerivationIndex), ) -> DispatchResult

Try to migrate a parachain sovereign child account to its respective sibling.

Takes the old and new account and migrates it only if they are as expected. An event of SovereignMigrated will be emitted if the account was migrated successfully.

Callable by any signed origin.

pub fn force_unreserve( origin: OriginFor<T>, account: T::AccountId, amount: BalanceOf<T>, reason: Option<T::RuntimeHoldReason>, ) -> DispatchResult

Force unreserve a named or unnamed reserve.

impl<T: Config> Pallet<T>

pub fn do_unreserve_lease_deposit( block: BlockNumberFor<T>, depositor: T::AccountId, para_id: ParaId, ) -> Result<(), Error<T>>

pub fn do_withdraw_crowdloan_contribution( block: BlockNumberFor<T>, depositor: T::AccountId, para_id: ParaId, ) -> Result<(), Error<T>>

pub fn do_unreserve_crowdloan_reserve( block: BlockNumberFor<T>, depositor: T::AccountId, para_id: ParaId, ) -> Result<(), Error<T>>

pub fn do_migrate_parachain_sovereign_derived_acc( from: &T::AccountId, to: &T::AccountId, derivation: Option<(T::AccountId, DerivationIndex)>, ) -> Result<(), Error<T>>

pub fn do_force_unreserve( account: T::AccountId, amount: BalanceOf<T>, reason: Option<T::RuntimeHoldReason>, ) -> Result<(), Error<T>>

pub fn try_translate_rc_sovereign_to_ah( from: &AccountId32, ) -> Result<(AccountId32, ParaId), Error<T>>

Try to translate a Parachain sovereign account to the Parachain AH sovereign account.

Returns:

Ok(None) if the account is not a Parachain sovereign account
Ok(Some((ah_account, para_id))) with the translated account and the para id
Err(()) otherwise

The way that this normally works is through the configured SiblingParachainConvertsVia: https://github.com/polkadot-fellows/runtimes/blob/7b096c14c2b16cc81ca4e2188eea9103f120b7a4/system-parachains/asset-hubs/asset-hub-polkadot/src/xcm_config.rs#L93-L94 it passes the Sibling type into it which has type-ID sibl: https://github.com/paritytech/polkadot-sdk/blob/c10e25aaa8b8afd8665b53f0a0b02e4ea44caa77/polkadot/parachain/src/primitives.rs#L272-L274 This type-ID gets used by the converter here: https://github.com/paritytech/polkadot-sdk/blob/7ecf3f757a5d6f622309cea7f788e8a547a5dce8/polkadot/xcm/xcm-builder/src/location_conversion.rs#L314 and eventually ends up in the encoding here https://github.com/paritytech/polkadot-sdk/blob/cdf107de700388a52a17b2fb852c98420c78278e/substrate/primitives/runtime/src/traits/mod.rs#L1997-L1999 The para conversion is likewise with ChildParachainConvertsVia and the para type-ID https://github.com/paritytech/polkadot-sdk/blob/c10e25aaa8b8afd8665b53f0a0b02e4ea44caa77/polkadot/parachain/src/primitives.rs#L162-L164

pub fn try_rc_sovereign_derived_to_ah( from: &AccountId32, parent: &AccountId32, index: DerivationIndex, ) -> Result<(AccountId32, ParaId), Error<T>>

Same as try_translate_rc_sovereign_to_ah but for derived accounts.

Trait Implementations

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

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

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”. Read more

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.

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T> Debug for Pallet<T>

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

Formats the value using the given formatter. Read more

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

fn dispatch_view_function<O: Output>( id: &ViewFunctionId, input: &mut &[u8], output: &mut O, ) -> Result<(), ViewFunctionDispatchError>

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro. Read more

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

fn on_initialize(_n: BlockNumber) -> Weight

Block initialization hook. This is called at the very beginning of block execution. Read more

fn on_finalize(_n: BlockNumber)

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

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

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

A hook to run logic after inherent application. Read more

fn on_runtime_upgrade() -> Weight

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

fn try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block. Read more

fn pre_upgrade() -> Result<Vec<u8>, DispatchError>

Execute some pre-checks prior to a runtime upgrade. Read more

fn post_upgrade(_state: Vec<u8>) -> Result<(), DispatchError>

Execute some post-checks after a runtime upgrade. Read more

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

fn integrity_test()

Check the integrity of this pallet’s configuration. Read more

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

fn integrity_test()

See [Hooks::integrity_test].

fn offchain_worker(n: BlockNumberFor<T>)

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

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

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

fn on_genesis()

Something that should happen at genesis.

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

See [Hooks::on_idle].

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

See [Hooks::on_initialize].

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

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError>

See [Hooks::pre_upgrade].

fn post_upgrade(state: Vec<u8>) -> Result<(), TryRuntimeError>

See [Hooks::post_upgrade].

fn try_on_runtime_upgrade(checks: bool) -> Result<Weight, DispatchError>

The expected and default behavior of this method is to handle executing pre_upgrade -> on_runtime_upgrade -> post_upgrade hooks for a migration. Read more

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

fn count() -> usize

The number of pallets’ information that this type represents. Read more

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

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

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

1.0.0 · Source§

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

fn storage_info() -> Vec<StorageInfo>

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

fn try_decode_entire_state() -> Result<usize, Vec<TryDecodeEntireStorageError>>

Decode the entire data under the given storage, returning Ok(bytes_decoded) if success.

fn try_state( n: BlockNumberFor<T>, _s: TryStateSelect, ) -> Result<(), TryRuntimeError>

Execute the state checks.

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

fn prefix() -> [u8; 16]

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

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.