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
// 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::{
Dispatch, DispatchKind, GasLimit, Message, Packet, Payload, StoredDispatch, StoredMessage,
Value,
},
};
use scale_info::{
scale::{Decode, Encode},
TypeInfo,
};
/// Message for Handle entry point.
/// Represents a standard message that sends between actors.
#[derive(Clone, Default, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct HandleMessage {
/// Message id.
id: MessageId,
/// Message destination.
destination: ProgramId,
/// Message payload.
payload: Payload,
/// Message optional gas limit.
gas_limit: Option<GasLimit>,
/// Message value.
value: Value,
}
impl HandleMessage {
/// Create HandleMessage from HandlePacket.
pub fn from_packet(id: MessageId, packet: HandlePacket) -> Self {
Self {
id,
destination: packet.destination,
payload: packet.payload,
gas_limit: packet.gas_limit,
value: packet.value,
}
}
/// Convert HandleMessage into Message.
pub fn into_message(self, source: ProgramId) -> Message {
Message::new(
self.id,
source,
self.destination,
self.payload,
self.gas_limit,
self.value,
None,
)
}
/// Convert HandleMessage into StoredMessage.
pub fn into_stored(self, source: ProgramId) -> StoredMessage {
self.into_message(source).into()
}
/// Convert HandleMessage into Dispatch.
pub fn into_dispatch(self, source: ProgramId) -> Dispatch {
Dispatch::new(DispatchKind::Handle, self.into_message(source))
}
/// Convert HandleMessage into StoredDispatch.
pub fn into_stored_dispatch(self, source: ProgramId) -> StoredDispatch {
self.into_dispatch(source).into()
}
/// Message id.
pub fn id(&self) -> MessageId {
self.id
}
/// 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
}
}
/// Handle message packet.
///
/// This structure is preparation for future HandleMessage sending. Has no message id.
#[derive(Clone, Default, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Decode, Encode, TypeInfo)]
pub struct HandlePacket {
/// Packet destination.
destination: ProgramId,
/// Packet payload.
payload: Payload,
/// Packet optional gas limit.
gas_limit: Option<GasLimit>,
/// Packet value.
value: Value,
}
impl HandlePacket {
/// Create new packet without gas.
pub fn new(destination: ProgramId, payload: Payload, value: Value) -> Self {
Self {
destination,
payload,
gas_limit: None,
value,
}
}
/// Create new packet with gas.
pub fn new_with_gas(
destination: ProgramId,
payload: Payload,
gas_limit: GasLimit,
value: Value,
) -> Self {
Self {
destination,
payload,
gas_limit: Some(gas_limit),
value,
}
}
/// Create new packet with optional gas.
pub fn maybe_with_gas(
destination: ProgramId,
payload: Payload,
gas_limit: Option<GasLimit>,
value: Value,
) -> Self {
match gas_limit {
None => Self::new(destination, payload, value),
Some(gas_limit) => Self::new_with_gas(destination, payload, gas_limit, value),
}
}
/// Prepend payload.
pub(super) fn try_prepend(&mut self, mut data: Payload) -> Result<(), Payload> {
if data.try_extend_from_slice(self.payload_bytes()).is_err() {
Err(data)
} else {
self.payload = data;
Ok(())
}
}
/// Packet destination.
pub fn destination(&self) -> ProgramId {
self.destination
}
}
impl Packet for HandlePacket {
fn payload_bytes(&self) -> &[u8] {
self.payload.inner()
}
fn payload_len(&self) -> u32 {
self.payload.len_u32()
}
fn gas_limit(&self) -> Option<GasLimit> {
self.gas_limit
}
fn value(&self) -> Value {
self.value
}
fn kind() -> DispatchKind {
DispatchKind::Handle
}
}