1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361
// This file is part of Gear.
// Copyright (C) 2022-2024 Gear Technologies Inc.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
// This program 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.
// This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
use crate::{
ids::{MessageId, ProgramId},
message::{
DispatchKind, GasLimit, Payload, StoredDelayedDispatch, StoredDispatch, StoredMessage,
Value,
},
};
use core::ops::Deref;
use gear_core_errors::{ReplyCode, SignalCode};
use scale_info::{
scale::{Decode, Encode},
TypeInfo,
};
/// An entity that is used for interaction between actors.
/// Can transfer value and executes by programs in corresponding function: init, handle or handle_reply.
#[derive(Clone, Default, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct Message {
/// Message id.
id: MessageId,
/// Message source.
source: ProgramId,
/// Message destination.
destination: ProgramId,
/// Message payload.
payload: Payload,
/// Message optional gas limit.
gas_limit: Option<GasLimit>,
/// Message value.
value: Value,
/// Message details like reply message ID, status code, etc.
details: Option<MessageDetails>,
}
impl From<Message> for StoredMessage {
fn from(message: Message) -> StoredMessage {
StoredMessage::new(
message.id,
message.source,
message.destination,
message.payload,
message.value,
message.details,
)
}
}
impl Message {
/// Create new message.
pub fn new(
id: MessageId,
source: ProgramId,
destination: ProgramId,
payload: Payload,
gas_limit: Option<GasLimit>,
value: Value,
details: Option<MessageDetails>,
) -> Self {
Self {
id,
source,
destination,
payload,
gas_limit,
value,
details,
}
}
/// Into parts.
pub fn into_parts(
self,
) -> (
MessageId,
ProgramId,
ProgramId,
Payload,
Option<GasLimit>,
Value,
Option<MessageDetails>,
) {
(
self.id,
self.source,
self.destination,
self.payload,
self.gas_limit,
self.value,
self.details,
)
}
/// Convert Message into gasless StoredMessage.
pub fn into_stored(self) -> StoredMessage {
self.into()
}
/// Message id.
pub fn id(&self) -> MessageId {
self.id
}
/// Message source.
pub fn source(&self) -> ProgramId {
self.source
}
/// Message destination.
pub fn destination(&self) -> ProgramId {
self.destination
}
/// Message payload bytes.
pub fn payload_bytes(&self) -> &[u8] {
self.payload.inner()
}
/// Message optional gas limit.
pub fn gas_limit(&self) -> Option<GasLimit> {
self.gas_limit
}
/// Message value.
pub fn value(&self) -> Value {
self.value
}
/// Message reply.
pub fn reply_details(&self) -> Option<ReplyDetails> {
self.details.and_then(|d| d.to_reply_details())
}
/// Message signal.
pub fn signal_details(&self) -> Option<SignalDetails> {
self.details.and_then(|d| d.to_signal_details())
}
/// Returns bool defining if message is error reply.
pub fn is_error_reply(&self) -> bool {
self.details.map(|d| d.is_error_reply()).unwrap_or(false)
}
/// Returns bool defining if message is reply.
pub fn is_reply(&self) -> bool {
self.reply_details().is_some()
}
}
/// Message details data.
#[derive(
Clone,
Copy,
Debug,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
Decode,
Encode,
TypeInfo,
derive_more::From,
)]
#[cfg_attr(feature = "std", derive(serde::Serialize, serde::Deserialize))]
pub enum MessageDetails {
/// Reply details.
Reply(ReplyDetails),
/// Message details.
Signal(SignalDetails),
}
impl MessageDetails {
/// Returns bool defining if message is error reply.
pub fn is_error_reply(&self) -> bool {
self.to_reply_details()
.map(|d| d.code.is_error())
.unwrap_or(false)
}
/// Check if kind is reply.
pub fn is_reply_details(&self) -> bool {
matches!(self, Self::Reply(_))
}
/// Returns reply details.
pub fn to_reply_details(self) -> Option<ReplyDetails> {
match self {
MessageDetails::Reply(reply) => Some(reply),
MessageDetails::Signal(_) => None,
}
}
/// Check if kind is signal.
pub fn is_signal_details(&self) -> bool {
matches!(self, Self::Signal(_))
}
/// Reply signal details.
pub fn to_signal_details(self) -> Option<SignalDetails> {
match self {
MessageDetails::Reply(_) => None,
MessageDetails::Signal(signal) => Some(signal),
}
}
}
/// Reply details data.
///
/// Part of [`ReplyMessage`](crate::message::ReplyMessage) logic, containing data about on which message id
/// this replies and its status code.
#[derive(
Clone, Copy, Default, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo,
)]
#[cfg_attr(feature = "std", derive(serde::Serialize, serde::Deserialize))]
pub struct ReplyDetails {
/// Message id, this message replies on.
to: MessageId,
/// Reply code.
code: ReplyCode,
}
impl ReplyDetails {
/// Constructor for details.
pub fn new(to: MessageId, code: ReplyCode) -> Self {
Self { to, code }
}
/// Returns message id replied to.
pub fn to_message_id(&self) -> MessageId {
self.to
}
/// Returns reply code of reply details.
pub fn to_reply_code(&self) -> ReplyCode {
self.code
}
/// Destructs details into parts.
pub fn into_parts(self) -> (MessageId, ReplyCode) {
(self.to, self.code)
}
}
/// Signal details data.
#[derive(
Clone, Copy, Default, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo,
)]
#[cfg_attr(feature = "std", derive(serde::Serialize, serde::Deserialize))]
pub struct SignalDetails {
/// Message id, which issues signal.
to: MessageId,
/// Signal code.
code: SignalCode,
}
impl SignalDetails {
/// Constructor for details.
pub fn new(to: MessageId, code: SignalCode) -> Self {
Self { to, code }
}
/// Returns message id signal sent from.
pub fn to_message_id(&self) -> MessageId {
self.to
}
/// Returns signal code of signal details.
pub fn to_signal_code(&self) -> SignalCode {
self.code
}
/// Destructs details into parts.
pub fn into_parts(self) -> (MessageId, SignalCode) {
(self.to, self.code)
}
}
/// Message with entry point.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct Dispatch {
/// Entry point for the message.
kind: DispatchKind,
/// Message.
message: Message,
}
impl From<Dispatch> for StoredDispatch {
fn from(dispatch: Dispatch) -> StoredDispatch {
StoredDispatch::new(dispatch.kind, dispatch.message.into(), None)
}
}
impl From<Dispatch> for StoredDelayedDispatch {
fn from(dispatch: Dispatch) -> StoredDelayedDispatch {
StoredDelayedDispatch::new(dispatch.kind, dispatch.message.into())
}
}
impl From<Dispatch> for (DispatchKind, Message) {
fn from(dispatch: Dispatch) -> (DispatchKind, Message) {
(dispatch.kind, dispatch.message)
}
}
impl Dispatch {
/// Create new Dispatch.
pub fn new(kind: DispatchKind, message: Message) -> Self {
Self { kind, message }
}
/// Convert Dispatch into gasless StoredDispatch with empty previous context.
pub fn into_stored(self) -> StoredDispatch {
self.into()
}
/// Convert Dispatch into gasless StoredDelayedDispatch.
pub fn into_stored_delayed(self) -> StoredDelayedDispatch {
self.into()
}
/// Decompose Dispatch for it's components: DispatchKind and Message.
pub fn into_parts(self) -> (DispatchKind, Message) {
self.into()
}
/// Entry point for the message.
pub fn kind(&self) -> DispatchKind {
self.kind
}
/// Dispatch message reference.
pub fn message(&self) -> &Message {
&self.message
}
}
impl Deref for Dispatch {
type Target = Message;
fn deref(&self) -> &Self::Target {
self.message()
}
}