mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-02 19:57:24 +00:00
Svyatoslav Nikolsky
9414c0d6fe
* emit dispatch message when whole message (payload) has invalid encoding * DispatchMessage::dispatch accepts Result
50 lines
1.9 KiB
Rust
50 lines
1.9 KiB
Rust
// Copyright 2019-2020 Parity Technologies (UK) Ltd.
|
|
// This file is part of Parity Bridges Common.
|
|
|
|
// Parity Bridges Common is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// Parity Bridges Common is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Parity Bridges Common. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! A common interface for all Bridge Message Dispatch modules.
|
|
|
|
#![cfg_attr(not(feature = "std"), no_std)]
|
|
#![warn(missing_docs)]
|
|
|
|
use bp_runtime::InstanceId;
|
|
|
|
/// Message dispatch weight.
|
|
pub type Weight = u64;
|
|
|
|
/// A generic trait to dispatch arbitrary messages delivered over the bridge.
|
|
pub trait MessageDispatch<MessageId> {
|
|
/// A type of the message to be dispatched.
|
|
type Message: codec::Decode;
|
|
|
|
/// Estimate dispatch weight.
|
|
///
|
|
/// This function must: (1) be instant and (2) return correct upper bound
|
|
/// of dispatch weight.
|
|
fn dispatch_weight(message: &Self::Message) -> Weight;
|
|
|
|
/// Dispatches the message internally.
|
|
///
|
|
/// `bridge` indicates instance of deployed bridge where the message came from.
|
|
///
|
|
/// `id` is a short unique identifier of the message.
|
|
///
|
|
/// If message is `Ok`, then it should be dispatched. If it is `Err`, then it's just
|
|
/// a sign that some other component has rejected the message even before it has
|
|
/// reached `dispatch` method (right now this may only be caused if we fail to decode
|
|
/// the whole message).
|
|
fn dispatch(bridge: InstanceId, id: MessageId, message: Result<Self::Message, ()>);
|
|
}
|