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
// 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::{
common::MessageDetails, ContextStore, DispatchKind, GasLimit, IncomingDispatch,
IncomingMessage, Payload, ReplyDetails, Value,
},
};
use core::ops::Deref;
use gear_core_errors::ReplyCode;
use scale_info::{
scale::{Decode, Encode},
TypeInfo,
};
/// Stored message.
///
/// Gasless Message for storing.
#[derive(Clone, Default, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct StoredMessage {
/// Message id.
pub(super) id: MessageId,
/// Message source.
pub(super) source: ProgramId,
/// Message destination.
pub(super) destination: ProgramId,
/// Message payload.
pub(super) payload: Payload,
/// Message value.
#[codec(compact)]
pub(super) value: Value,
/// Message details like reply message ID, status code, etc.
pub(super) details: Option<MessageDetails>,
}
impl StoredMessage {
/// Create new StoredMessage.
pub fn new(
id: MessageId,
source: ProgramId,
destination: ProgramId,
payload: Payload,
value: Value,
details: Option<MessageDetails>,
) -> Self {
Self {
id,
source,
destination,
payload,
value,
details,
}
}
/// Into parts.
pub fn into_parts(
self,
) -> (
MessageId,
ProgramId,
ProgramId,
Payload,
Value,
Option<MessageDetails>,
) {
(
self.id,
self.source,
self.destination,
self.payload,
self.value,
self.details,
)
}
/// Convert StoredMessage into IncomingMessage for program processing.
pub fn into_incoming(self, gas_limit: GasLimit) -> IncomingMessage {
IncomingMessage::new(
self.id,
self.source,
self.payload,
gas_limit,
self.value,
self.details,
)
}
/// 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 value.
pub fn value(&self) -> Value {
self.value
}
/// Message details.
pub fn details(&self) -> Option<MessageDetails> {
self.details
}
/// Message reply.
pub fn reply_details(&self) -> Option<ReplyDetails> {
self.details.and_then(|d| d.to_reply_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.details.map(|d| d.is_reply_details()).unwrap_or(false)
}
/// Returns `ReplyCode` of message if reply.
pub fn reply_code(&self) -> Option<ReplyCode> {
self.details
.and_then(|d| d.to_reply_details().map(|d| d.to_reply_code()))
}
}
/// Stored message with entry point and previous execution context, if exists.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct StoredDispatch {
/// Entry point.
kind: DispatchKind,
/// Stored message.
message: StoredMessage,
/// Previous execution context.
context: Option<ContextStore>,
}
impl From<StoredDispatch> for (DispatchKind, StoredMessage, Option<ContextStore>) {
fn from(dispatch: StoredDispatch) -> (DispatchKind, StoredMessage, Option<ContextStore>) {
(dispatch.kind, dispatch.message, dispatch.context)
}
}
impl StoredDispatch {
/// Create new StoredDispatch.
pub fn new(kind: DispatchKind, message: StoredMessage, context: Option<ContextStore>) -> Self {
Self {
kind,
message,
context,
}
}
/// Convert StoredDispatch into IncomingDispatch for program processing.
pub fn into_incoming(self, gas_limit: GasLimit) -> IncomingDispatch {
IncomingDispatch::new(
self.kind,
self.message.into_incoming(gas_limit),
self.context,
)
}
/// Decompose StoredDispatch for it's components: DispatchKind, StoredMessage and `Option<ContextStore>`.
pub fn into_parts(self) -> (DispatchKind, StoredMessage, Option<ContextStore>) {
self.into()
}
/// Entry point for the message.
pub fn kind(&self) -> DispatchKind {
self.kind
}
/// Dispatch message reference.
pub fn message(&self) -> &StoredMessage {
&self.message
}
/// Previous execution context reference, if exists.
pub fn context(&self) -> &Option<ContextStore> {
&self.context
}
}
impl Deref for StoredDispatch {
type Target = StoredMessage;
fn deref(&self) -> &Self::Target {
self.message()
}
}
impl From<StoredDelayedDispatch> for StoredDispatch {
fn from(dispatch: StoredDelayedDispatch) -> Self {
StoredDispatch::new(dispatch.kind, dispatch.message, None)
}
}
/// Stored message with entry point.
///
/// We could use just [`StoredDispatch`]
/// but delayed messages always don't have [`ContextStore`]
/// so we designate this fact via new type.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct StoredDelayedDispatch {
/// Entry point.
kind: DispatchKind,
/// Stored message.
message: StoredMessage,
}
impl From<StoredDelayedDispatch> for (DispatchKind, StoredMessage) {
fn from(dispatch: StoredDelayedDispatch) -> (DispatchKind, StoredMessage) {
(dispatch.kind, dispatch.message)
}
}
impl StoredDelayedDispatch {
/// Create new StoredDelayedDispatch.
pub fn new(kind: DispatchKind, message: StoredMessage) -> Self {
Self { kind, message }
}
/// Decompose StoredDelayedDispatch for it's components: DispatchKind, StoredMessage.
pub fn into_parts(self) -> (DispatchKind, StoredMessage) {
self.into()
}
/// Entry point for the message.
pub fn kind(&self) -> DispatchKind {
self.kind
}
/// Dispatch message reference.
pub fn message(&self) -> &StoredMessage {
&self.message
}
}
impl Deref for StoredDelayedDispatch {
type Target = StoredMessage;
fn deref(&self) -> &Self::Target {
self.message()
}
}