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
// 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/>.
//! Base identifiers for messaging primitives.
use blake2_rfc::blake2b;
use core::convert::TryInto;
use scale_info::{
scale::{Decode, Encode},
TypeInfo,
};
/// Hash length used in gear protocol.
pub const HASH_LENGTH: usize = 32;
/// Hash type used in gear protocol.
pub type Hash = [u8; HASH_LENGTH];
/// Creates a unique identifier by passing given argument to blake2b hash-function.
///
/// # SAFETY: DO NOT ADJUST HASH FUNCTION, BECAUSE MESSAGE ID IS SENSITIVE FOR IT.
pub fn hash(argument: &[u8]) -> Hash {
let blake2b_hash = blake2b::blake2b(HASH_LENGTH, &[], argument);
blake2b_hash
.as_bytes()
.try_into()
.expect("we set hash len; qed")
}
/// Declares data type for storing any kind of id for gear-core,
/// which stores 32 bytes under the hood.
#[macro_export]
macro_rules! declare_id {
($name:ident: $doc: literal) => {
#[doc=$doc]
#[derive(
Clone,
Copy,
Default,
Eq,
Hash,
Ord,
PartialEq,
PartialOrd,
Decode,
Encode,
parity_scale_codec::MaxEncodedLen,
derive_more::From,
TypeInfo,
)]
pub struct $name($crate::ids::Hash);
impl $name {
/// Creates new id.
///
/// Never use it in production!
pub const fn test_new(hash: $crate::ids::Hash) -> Self {
Self(hash)
}
/// Returns id as bytes array.
pub fn into_bytes(self) -> $crate::ids::Hash {
self.0
}
}
impl From<$name> for $crate::ids::Hash {
fn from(val: $name) -> $crate::ids::Hash {
val.0
}
}
impl From<u64> for $name {
fn from(v: u64) -> Self {
let mut id = Self(Default::default());
id.0[0..8].copy_from_slice(&v.to_le_bytes()[..]);
id
}
}
impl AsRef<[u8]> for $name {
fn as_ref(&self) -> &[u8] {
self.0.as_ref()
}
}
impl AsMut<[u8]> for $name {
fn as_mut(&mut self) -> &mut [u8] {
self.0.as_mut()
}
}
impl From<&[u8]> for $name {
fn from(slice: &[u8]) -> Self {
if slice.len() != $crate::ids::HASH_LENGTH {
panic!("Identifier must be 32 length");
}
let mut arr: $crate::ids::Hash = Default::default();
arr[..].copy_from_slice(slice);
Self(arr)
}
}
impl core::fmt::Display for $name {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
let len = self.0.len();
let median = (len + 1) / 2;
let mut e1 = median;
let mut s2 = median;
if let Some(precision) = f.precision() {
if precision < median {
e1 = precision;
s2 = len - precision;
}
}
let p1 = hex::encode(&self.0[..e1]);
let p2 = hex::encode(&self.0[s2..]);
let sep = e1.ne(&s2).then_some("..").unwrap_or_default();
if f.alternate() {
write!(f, "{}(0x{p1}{sep}{p2})", stringify!($name))
} else {
write!(f, "0x{p1}{sep}{p2}")
}
}
}
impl core::fmt::Debug for $name {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
core::fmt::Display::fmt(self, f)
}
}
};
}
declare_id!(CodeId: "Code identifier");
impl CodeId {
/// Generate CodeId from given code
pub fn generate(code: &[u8]) -> Self {
hash(code).into()
}
}
declare_id!(MessageId: "Message identifier");
impl MessageId {
/// Generate MessageId for non-program outgoing message
pub fn generate_from_user(
block_number: u32,
user_id: ProgramId,
local_nonce: u128,
) -> MessageId {
const SALT: &[u8] = b"external";
let argument = [
SALT,
&block_number.to_le_bytes(),
user_id.as_ref(),
&local_nonce.to_le_bytes(),
]
.concat();
hash(&argument).into()
}
/// Generate MessageId for program outgoing message
pub fn generate_outgoing(origin_msg_id: MessageId, local_nonce: u32) -> MessageId {
const SALT: &[u8] = b"outgoing";
let argument = [SALT, origin_msg_id.as_ref(), &local_nonce.to_le_bytes()].concat();
hash(&argument).into()
}
/// Generate MessageId for reply message depend on status code
///
/// # SAFETY: DO NOT ADJUST REPLY MESSAGE ID GENERATION,
/// BECAUSE AUTO-REPLY LOGIC DEPENDS ON PRE-DEFINED REPLY ID.
pub fn generate_reply(origin_msg_id: MessageId) -> MessageId {
const SALT: &[u8] = b"reply";
let argument = [SALT, origin_msg_id.as_ref()].concat();
hash(&argument).into()
}
/// Generate MessageId for signal message depend on status code
pub fn generate_signal(origin_msg_id: MessageId) -> MessageId {
const SALT: &[u8] = b"signal";
let argument = [SALT, origin_msg_id.as_ref()].concat();
hash(&argument).into()
}
}
declare_id!(ProgramId: "Program identifier");
impl ProgramId {
/// System program ID
pub const SYSTEM: Self = Self(*b"geargeargeargeargeargeargeargear");
/// Generate ProgramId from given CodeId and salt
pub fn generate_from_user(code_id: CodeId, salt: &[u8]) -> Self {
const SALT: &[u8] = b"program_from_user";
let argument = [SALT, code_id.as_ref(), salt].concat();
hash(&argument).into()
}
/// Generate ProgramId from given CodeId, MessageId and salt
pub fn generate_from_program(code_id: CodeId, salt: &[u8], message_id: MessageId) -> Self {
const SALT: &[u8] = b"program_from_wasm";
let argument = [SALT, message_id.as_ref(), code_id.as_ref(), salt].concat();
hash(&argument).into()
}
}
declare_id!(ReservationId: "Reservation identifier");
impl ReservationId {
/// Create a new reservation ID
pub fn generate(msg_id: MessageId, nonce: u64) -> Self {
const SALT: &[u8] = b"reservation";
let argument = [SALT, msg_id.as_ref(), &nonce.to_le_bytes()].concat();
hash(&argument).into()
}
}
#[test]
fn formatting_test() {
use alloc::format;
let code_id = CodeId::generate(&[0, 1, 2]);
let id = ProgramId::generate_from_user(code_id, &[2, 1, 0]);
// `Debug`/`Display`.
assert_eq!(
format!("{id:?}"),
"0x6a519a19ffdfd8f45c310b44aecf156b080c713bf841a8cb695b0ea5f765ed3e"
);
// `Debug`/`Display` with precision 0.
assert_eq!(format!("{id:.0?}"), "0x..");
// `Debug`/`Display` with precision 1.
assert_eq!(format!("{id:.1?}"), "0x6a..3e");
// `Debug`/`Display` with precision 2.
assert_eq!(format!("{id:.2?}"), "0x6a51..ed3e");
// `Debug`/`Display` with precision 4.
assert_eq!(format!("{id:.4?}"), "0x6a519a19..f765ed3e");
// `Debug`/`Display` with precision 15.
assert_eq!(
format!("{id:.15?}"),
"0x6a519a19ffdfd8f45c310b44aecf15..0c713bf841a8cb695b0ea5f765ed3e"
);
// `Debug`/`Display` with precision 30 (the same for any case >= 16).
assert_eq!(
format!("{id:.30?}"),
"0x6a519a19ffdfd8f45c310b44aecf156b080c713bf841a8cb695b0ea5f765ed3e"
);
// Alternate formatter.
assert_eq!(
format!("{id:#}"),
"ProgramId(0x6a519a19ffdfd8f45c310b44aecf156b080c713bf841a8cb695b0ea5f765ed3e)"
);
// Alternate formatter with precision 2.
assert_eq!(format!("{id:#.2}"), "ProgramId(0x6a51..ed3e)");
}