Type Alias Hrmp

pub type Hrmp = Pallet<Runtime>;

Aliased Type

struct Hrmp(/* private fields */);

Implementations

impl<T> Pallet<T>

where T: Config,

pub fn hrmp_init_open_channel( origin: <T as Config>::RuntimeOrigin, recipient: Id, proposed_max_capacity: u32, proposed_max_message_size: u32, ) -> Result<(), DispatchError>

Initiate opening a channel from a parachain to a given recipient with given channel parameters.

• proposed_max_capacity - specifies how many messages can be in the channel at once.
• proposed_max_message_size - specifies the maximum size of the messages.

These numbers are a subject to the relay-chain configuration limits.

The channel can be opened only after the recipient confirms it and only on a session change.

pub fn hrmp_accept_open_channel( origin: <T as Config>::RuntimeOrigin, sender: Id, ) -> Result<(), DispatchError>

Accept a pending open channel request from the given sender.

The channel will be opened only on the next session boundary.

pub fn hrmp_close_channel( origin: <T as Config>::RuntimeOrigin, channel_id: HrmpChannelId, ) -> Result<(), DispatchError>

Initiate unilateral closing of a channel. The origin must be either the sender or the recipient in the channel being closed.

The closure can only happen on a session change.

pub fn force_clean_hrmp( origin: <T as Config>::RuntimeOrigin, para: Id, num_inbound: u32, num_outbound: u32, ) -> Result<(), DispatchError>

This extrinsic triggers the cleanup of all the HRMP storage items that a para may have. Normally this happens once per session, but this allows you to trigger the cleanup immediately for a specific parachain.

Number of inbound and outbound channels for para must be provided as witness data.

Origin must be the ChannelManager.

pub fn force_process_hrmp_open( origin: <T as Config>::RuntimeOrigin, channels: u32, ) -> Result<(), DispatchError>

Force process HRMP open channel requests.

If there are pending HRMP open channel requests, you can use this function to process all of those requests immediately.

Total number of opening channels must be provided as witness data.

Origin must be the ChannelManager.

pub fn force_process_hrmp_close( origin: <T as Config>::RuntimeOrigin, channels: u32, ) -> Result<(), DispatchError>

Force process HRMP close channel requests.

If there are pending HRMP close channel requests, you can use this function to process all of those requests immediately.

Total number of closing channels must be provided as witness data.

Origin must be the ChannelManager.

pub fn hrmp_cancel_open_request( origin: <T as Config>::RuntimeOrigin, channel_id: HrmpChannelId, open_requests: u32, ) -> Result<(), DispatchError>

This cancels a pending open channel request. It can be canceled by either of the sender or the recipient for that request. The origin must be either of those.

The cancellation happens immediately. It is not possible to cancel the request if it is already accepted.

Total number of open requests (i.e. HrmpOpenChannelRequestsList) must be provided as witness data.

pub fn force_open_hrmp_channel( origin: <T as Config>::RuntimeOrigin, sender: Id, recipient: Id, max_capacity: u32, max_message_size: u32, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Open a channel from a sender to a recipient ParaId. Although opened by governance, the max_capacity and max_message_size are still subject to the Relay Chain’s configured limits.

Expected use is when one (and only one) of the ParaIds involved in the channel is governed by the system, e.g. a system parachain.

Origin must be the ChannelManager.

pub fn establish_system_channel( origin: <T as Config>::RuntimeOrigin, sender: Id, recipient: Id, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Establish an HRMP channel between two system chains. If the channel does not already exist, the transaction fees will be refunded to the caller. The system does not take deposits for channels between system chains, and automatically sets the message number and size limits to the maximum allowed by the network’s configuration.

Arguments:

• sender: A system chain, ParaId.
• recipient: A system chain, ParaId.

Any signed origin can call this function, but both inputs MUST be system chains. If the channel does not exist yet, there is no fee.

pub fn poke_channel_deposits( origin: <T as Config>::RuntimeOrigin, sender: Id, recipient: Id, ) -> Result<(), DispatchError>

Update the deposits held for an HRMP channel to the latest Configuration. Channels with system chains do not require a deposit.

Arguments:

• sender: A chain, ParaId.
• recipient: A chain, ParaId.

Any signed origin can call this function.

pub fn establish_channel_with_system( origin: <T as Config>::RuntimeOrigin, target_system_chain: Id, ) -> Result<PostDispatchInfo, DispatchErrorWithPostInfo<PostDispatchInfo>>

Establish a bidirectional HRMP channel between a parachain and a system chain.

Arguments:

• target_system_chain: A system chain, ParaId.

The origin needs to be the parachain origin.

impl<T> Pallet<T>

where T: Config,

Routines and getters related to HRMP.

pub fn init_open_channel( origin: Id, recipient: Id, proposed_max_capacity: u32, proposed_max_message_size: u32, ) -> Result<(), DispatchError>

Initiate opening a channel from a parachain to a given recipient with given channel parameters. If neither chain is part of the system, then a deposit from the Configuration will be required for origin (the sender) upon opening the request and the recipient upon accepting it.

Basically the same as hrmp_init_open_channel but intended for calling directly from other pallets rather than dispatched.

pub fn accept_open_channel(origin: Id, sender: Id) -> Result<(), DispatchError>

Accept a pending open channel request from the given sender.

Basically the same as hrmp_accept_open_channel but intended for calling directly from other pallets rather than dispatched.

Trait Implementations

impl<T> BeforeAllRuntimeMigrations for Pallet<T>

where T: Config,

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, <T as Config>::RuntimeOrigin: From<Origin>,

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

where T: Config,

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Pallet<T>

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<(), Error>

Formats the value using the given formatter.

impl<T> DispatchViewFunction for Pallet<T>

where T: Config,

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

where O: Output,

impl<T> GetStorageVersion for Pallet<T>

where T: Config,

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

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

where T: Config,

fn on_initialize(_n: BlockNumber) -> Weight

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

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 try_state(_n: BlockNumber) -> Result<(), DispatchError>

Execute the sanity checks of this pallet, per block.

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

Execute some pre-checks prior to a runtime upgrade.

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

Execute some post-checks after a runtime upgrade.

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

where T: Config,

fn integrity_test()

See Hooks::integrity_test.

impl<T> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn offchain_worker( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

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

impl<T> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_finalize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, )

See Hooks::on_finalize.

impl<T> OnGenesis for Pallet<T>

where T: Config,

fn on_genesis()

Something that should happen at genesis.

impl<T> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_idle( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, remaining_weight: Weight, ) -> Weight

See Hooks::on_idle.

impl<T> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_initialize( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, ) -> Weight

See Hooks::on_initialize.

impl<T> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn on_poll( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, weight: &mut WeightMeter, )

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

impl<T> OnRuntimeUpgrade for Pallet<T>

where T: Config,

fn on_runtime_upgrade() -> Weight

See Hooks::on_runtime_upgrade.

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

See Hooks::pre_upgrade.

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

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.

impl<T> PalletInfoAccess for Pallet<T>

where T: Config,

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

where T: Config,

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

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

where T: Config,

fn storage_info() -> Vec<StorageInfo>

impl<T> TryDecodeEntireStorage for Pallet<T>

where T: Config,

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

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

impl<T> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

where T: Config,

fn try_state( n: <<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number, _s: Select, ) -> Result<(), DispatchError>

Execute the state checks.

impl<T> ViewFunctionIdPrefix for Pallet<T>

where T: Config,

fn prefix() -> [u8; 16]

impl<T> WhitelistedStorageKeys for Pallet<T>

where T: Config,

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