Type Alias Module

pub type Module<T, I = ()> = Pallet<T, I>;

👎Deprecated: use Pallet instead

Type alias to Pallet, to be used by construct_runtime.

Generated by pallet attribute macro.

Aliased Type

struct Module<T, I = ()>(/* private fields */);

Implementations

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn set_owner( origin: OriginFor<T>, new_owner: Option<T::AccountId>, ) -> DispatchResult

Change PalletOwner.

May only be called either by root, or by PalletOwner.

pub fn set_operating_mode( origin: OriginFor<T>, operating_mode: MessagesOperatingMode, ) -> DispatchResult

Halt or resume all/some pallet operations.

May only be called either by root, or by PalletOwner.

pub fn receive_messages_proof( origin: OriginFor<T>, relayer_id_at_bridged_chain: AccountIdOf<BridgedChainOf<T, I>>, proof: Box<FromBridgedChainMessagesProof<HashOf<BridgedChainOf<T, I>>, T::LaneId>>, messages_count: u32, dispatch_weight: Weight, ) -> DispatchResultWithPostInfo

Receive messages proof from bridged chain.

The weight of the call assumes that the transaction always brings outbound lane state update. Because of that, the submitter (relayer) has no benefit of not including this data in the transaction, so reward confirmations lags should be minimal.

The call fails if:

• the pallet is halted;

• the call origin is not Signed(_);

• there are too many messages in the proof;

• the proof verification procedure returns an error - e.g. because header used to craft proof is not imported by the associated finality pallet;

• the dispatch_weight argument is not sufficient to dispatch all bundled messages.

The call may succeed, but some messages may not be delivered e.g. if they are not fit into the unrewarded relayers vector.

pub fn receive_messages_delivery_proof( origin: OriginFor<T>, proof: FromBridgedChainMessagesDeliveryProof<HashOf<BridgedChainOf<T, I>>, T::LaneId>, relayers_state: UnrewardedRelayersState, ) -> DispatchResultWithPostInfo

Receive messages delivery proof from bridged chain.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn outbound_message_data( lane: T::LaneId, nonce: MessageNonce, ) -> Option<MessagePayload>

Get stored data of the outbound message with given nonce.

pub fn inbound_message_data( lane: T::LaneId, payload: MessagePayload, outbound_details: OutboundMessageDetails, ) -> InboundMessageDetails

Prepare data, related to given inbound message.

pub fn outbound_lane_data(lane: T::LaneId) -> Option<OutboundLaneData>

Return outbound lane data.

pub fn inbound_lane_data( lane: T::LaneId, ) -> Option<InboundLaneData<AccountIdOf<BridgedChainOf<T, I>>>>

Return inbound lane data.

impl<T: Config<I>, I: 'static> Pallet<T, I>

pub fn do_try_state() -> Result<(), TryRuntimeError>

Ensure the correctness of the state of this pallet.

pub fn do_try_state_for_outbound_lanes() -> Result<(), TryRuntimeError>

Ensure the correctness of the state of outbound lanes.

Trait Implementations

impl<T: Config<I>, I: 'static> BeforeAllRuntimeMigrations for Pallet<T, I>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type RuntimeCall = Call<T, I>

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, I> Debug for Pallet<T, I>

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> DispatchViewFunction for Pallet<T, I>

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

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

type InCodeStorageVersion = StorageVersion

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<I>, I: 'static> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn try_state(_n: BlockNumberFor<T>) -> Result<(), TryRuntimeError>

Execute the sanity checks of this pallet, per block.

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 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: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

See [Hooks::integrity_test].

impl<T, I> MessagesBridge<<T as Config<I>>::OutboundPayload, <T as Config<I>>::LaneId> for Pallet<T, I>

where T: Config<I>, I: 'static,

type Error = Error<T, I>

Error type.

type SendMessageArgs = SendMessageArgs<T, I>

Intermediary structure returned by validate_message().

fn validate_message( lane_id: T::LaneId, message: &T::OutboundPayload, ) -> Result<SendMessageArgs<T, I>, Self::Error>

Check if the message can be sent over the bridge.

fn send_message(args: SendMessageArgs<T, I>) -> SendMessageArtifacts

Send message over the bridge.

impl<T: Config<I>, I: 'static> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn offchain_worker(n: BlockNumberFor<T>)

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

impl<T: Config<I>, I: 'static> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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

See [Hooks::on_idle].

impl<T: Config<I>, I: 'static> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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

See [Hooks::on_initialize].

impl<T: Config<I>, I: 'static> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

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.

impl<T: Config<I>, I: 'static> OwnedBridgeModule<T> for Pallet<T, I>

const LOG_TARGET: &'static str = LOG_TARGET

The target that will be used when publishing logs related to this module.

type OwnerStorage = StorageValue<_GeneratedPrefixForStoragePalletOwner<T, I>, <T as Config>::AccountId>

A storage entry that holds the module Owner account.

type OperatingMode = MessagesOperatingMode

Operating mode type of the pallet.

type OperatingModeStorage = StorageValue<_GeneratedPrefixForStoragePalletOperatingMode<T, I>, MessagesOperatingMode, ValueQuery>

A storage value that holds the pallet operating mode.

fn is_halted() -> bool

Check if the module is halted.

fn ensure_owner_or_root( origin: <T as Config>::RuntimeOrigin, ) -> Result<(), BadOrigin>

Ensure that the origin is either root, or PalletOwner.

fn ensure_not_halted() -> Result<(), OwnedBridgeModuleError>

Ensure that the module is not halted.

fn set_owner( origin: <T as Config>::RuntimeOrigin, maybe_owner: Option<<T as Config>::AccountId>, ) -> Result<(), DispatchError>

Change the owner of the module.

fn set_operating_mode( origin: <T as Config>::RuntimeOrigin, operating_mode: Self::OperatingMode, ) -> Result<(), DispatchError>

Halt or resume all/some module operations.

fn module_owner() -> Option<<T as Config>::AccountId>

Pallet owner has a right to halt all module operations and then resume it. If it is None, then there are no direct ways to halt/resume module operations, but other runtime methods may still be used to do that (i.e. democracy::referendum to update halt flag directly or call the set_operating_mode).

fn operating_mode() -> Self::OperatingMode

The current operating mode of the module. Depending on the mode either all, some, or no transactions will be allowed.

impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

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<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

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, I> PartialEq for Pallet<T, I>

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<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> TryDecodeEntireStorage for Pallet<T, I>

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: Config<I>, I: 'static> TryState<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T, I>

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

Execute the state checks.

impl<T: Config<I>, I: 'static> ViewFunctionIdPrefix for Pallet<T, I>

fn prefix() -> [u8; 16]

impl<T: Config<I>, I: 'static> WhitelistedStorageKeys for Pallet<T, I>

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