Struct Pallet

pub struct Pallet<T>(/* private fields */);

Pallet messenger used to communicate between chains and other blockchains.

Implementations

impl<T: Config> Pallet<T>

pub fn get_block_messages() -> BlockMessagesWithStorageKey

impl<T: Config> Pallet<T>

pub fn initiate_channel( origin: OriginFor<T>, dst_chain_id: ChainId, params: InitiateChannelParams, ) -> DispatchResult

A new Channel is initiated with a foreign chain. Next Channel ID is used to assign the new channel. Channel is set to initiated and do not accept or receive any messages.

pub fn close_channel( origin: OriginFor<T>, chain_id: ChainId, channel_id: ChannelId, ) -> DispatchResult

An open channel is closed with a foreign chain. Channel is set to Closed and do not accept or receive any messages.

pub fn relay_message( origin: OriginFor<T>, msg: CrossDomainMessage<BlockNumberFor<T>, T::Hash, T::MmrHash>, ) -> DispatchResult

Receives an Inbox message that needs to be validated and processed.

pub fn relay_message_response( origin: OriginFor<T>, msg: CrossDomainMessage<BlockNumberFor<T>, T::Hash, T::MmrHash>, ) -> DispatchResult

Receives a response from the dst_chain for a message in Outbox.

pub fn update_consensus_chain_allowlist( origin: OriginFor<T>, update: ChainAllowlistUpdate, ) -> DispatchResult

A call to update consensus chain allow list.

pub fn initiate_domain_update_chain_allowlist( origin: OriginFor<T>, domain_id: DomainId, update: ChainAllowlistUpdate, ) -> DispatchResult

A call to initiate chain allowlist update on domains

pub fn update_domain_allowlist( origin: OriginFor<T>, updates: DomainAllowlistUpdates, ) -> DispatchResult

An inherent call to update allowlist for domain.

impl<T: Config> Pallet<T>

pub fn get_open_channel_for_chain( dst_chain_id: ChainId, ) -> Option<(ChannelId, FeeModel<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>)>

Returns the last open channel for a given chain.

pub fn validate_relay_message( xdm: &CrossDomainMessage<BlockNumberFor<T>, T::Hash, T::MmrHash>, pre_dispatch: bool, consensus_state_root: <<T as Config>::Hashing as Hash>::Output, ) -> Result<ValidatedRelayMessage, TransactionValidityError>

pub fn validate_relay_message_response( xdm: &CrossDomainMessage<BlockNumberFor<T>, T::Hash, T::MmrHash>, pre_dispatch: bool, consensus_state_root: <<T as Config>::Hashing as Hash>::Output, ) -> Result<ValidatedRelayMessage, TransactionValidityError>

pub fn outbox_storage_key(message_key: MessageKey) -> Vec<u8>

pub fn inbox_response_storage_key(message_key: MessageKey) -> Vec<u8>

pub fn channel_storage_key(chain_id: ChainId, channel_id: ChannelId) -> Vec<u8>

pub fn domain_chains_allowlist_update( domain_id: DomainId, ) -> Option<DomainAllowlistUpdates>

pub fn domain_allow_list_update_storage_key(domain_id: DomainId) -> Vec<u8>

pub fn updated_channels() -> BTreeSet<(ChainId, ChannelId)>

pub fn pre_dispatch_with_trusted_mmr_proof( call: &Call<T>, ) -> Result<(), TransactionValidityError>

impl<T: Config> Pallet<T>

pub fn next_channel_id<KArg>(k: KArg) -> ChannelId

where KArg: EncodeLike<ChainId>,

An auto-generated getter for NextChannelId.

impl<T: Config> Pallet<T>

pub fn channels<KArg1, KArg2>( k1: KArg1, k2: KArg2, ) -> Option<Channel<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance, T::AccountId>>

where KArg1: EncodeLike<ChainId>, KArg2: EncodeLike<ChannelId>,

An auto-generated getter for Channels.

impl<T: Config> Pallet<T>

pub fn inbox() -> Option<Message<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>>

An auto-generated getter for Inbox.

impl<T: Config> Pallet<T>

pub fn inbox_fees<KArg>( k: KArg, ) -> Option<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>

where KArg: EncodeLike<(ChainId, MessageId)>,

An auto-generated getter for InboxFee.

impl<T: Config> Pallet<T>

pub fn outbox_fees<KArg>( k: KArg, ) -> Option<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>

where KArg: EncodeLike<(ChainId, MessageId)>,

An auto-generated getter for OutboxFee.

impl<T: Config> Pallet<T>

pub fn inbox_responses<KArg>( k: KArg, ) -> Option<Message<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>>

where KArg: EncodeLike<(ChainId, ChannelId, Nonce)>,

An auto-generated getter for InboxResponses.

impl<T: Config> Pallet<T>

pub fn outbox<KArg>( k: KArg, ) -> Option<Message<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>>

where KArg: EncodeLike<(ChainId, ChannelId, Nonce)>,

An auto-generated getter for Outbox.

impl<T: Config> Pallet<T>

pub fn outbox_responses() -> Option<Message<<<T as Config>::Currency as Inspect<<T as Config>::AccountId>>::Balance>>

An auto-generated getter for OutboxResponses.

impl<T: Config> Pallet<T>

pub fn message_weight_tags() -> Option<MessageWeightTags>

An auto-generated getter for MessageWeightTags.

impl<T: Config> Pallet<T>

pub fn chain_allowlist() -> BTreeSet<ChainId>

An auto-generated getter for ChainAllowlist.

impl<T: Config> Pallet<T>

pub fn domain_chain_allowlist_updates<KArg>( k: KArg, ) -> Option<DomainAllowlistUpdates>

where KArg: EncodeLike<DomainId>,

An auto-generated getter for DomainChainAllowlistUpdate.

impl<T> Pallet<T>

where T: Config + SendTransactionTypes<Call<T>>,

pub fn outbox_message_unsigned( msg: CrossDomainMessage<BlockNumberFor<T>, T::Hash, T::MmrHash>, ) -> Option<T::Extrinsic>

pub fn inbox_response_message_unsigned( msg: CrossDomainMessage<BlockNumberFor<T>, T::Hash, T::MmrHash>, ) -> Option<T::Extrinsic>

pub fn should_relay_outbox_message( dst_chain_id: ChainId, msg_id: MessageId, ) -> bool

Returns true if the outbox message has not received the response yet.

pub fn should_relay_inbox_message_response( dst_chain_id: ChainId, msg_id: MessageId, ) -> bool

Returns true if the inbox message response has not received acknowledgement yet.

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

type RuntimeCall = 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> DomainBundleSubmitted for Pallet<T>

fn domain_bundle_submitted(domain_id: DomainId)

Called in the next block initialisation if there was a domain bundle in the previous block. This hook if called for domain represents that there is a new domain block for parent consensus block.

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

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

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.

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

fn on_initialize(_n: BlockNumberFor<T>) -> 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 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: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

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

fn offchain_worker(n: BlockNumberFor<T>)

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

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

fn on_domain_instantiated(domain_id: DomainId)

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

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.

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

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

See [Hooks::on_idle].

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

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

See [Hooks::on_initialize].

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

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.

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

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

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.

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

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

const INHERENT_IDENTIFIER: InherentIdentifier = INHERENT_IDENTIFIER

The inherent identifier used by this inherent.

type Call = Call<T>

The call type of the pallet.

type Error = InherentError

The error returned by check_inherent.

fn create_inherent(data: &InherentData) -> Option<Self::Call>

Create an inherent out of the given InherentData.

fn is_inherent_required( data: &InherentData, ) -> Result<Option<Self::Error>, Self::Error>

Determines whether this inherent is required in this block.

fn check_inherent( call: &Self::Call, data: &InherentData, ) -> Result<(), Self::Error>

Check whether the given inherent is valid. Checking the inherent is optional and can be omitted by using the default implementation.

fn is_inherent(call: &Self::Call) -> bool

Return whether the call is an inherent call.

impl<T: Config> Sender<<T as Config>::AccountId> for Pallet<T>

type MessageId = (U256, U256)

Unique Id of the message between dst_chain and src_chain.

fn send_message( sender: &T::AccountId, dst_chain_id: ChainId, req: EndpointRequest, ) -> Result<Self::MessageId, DispatchError>

Sends a message to dst_chain_id.

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

fn storage_info() -> Vec<StorageInfo>

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

fn validate_unsigned( _source: TransactionSource, call: &Self::Call, ) -> TransactionValidity

Validate unsigned call to this module.

type Call = Call<T>

The call to validate

fn pre_dispatch(call: &Self::Call) -> Result<(), TransactionValidityError>

Validate the call right before dispatch.

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.

impl<T> Eq for Pallet<T>