gear-core 1.10.0

Gear core library
Documentation 
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

// This file is part of Gear.

// Copyright (C) 2021-2025 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/>.

//! Gear core.
//!
//! This library provides a runner for dealing with multiple little programs exchanging messages in a deterministic manner.
//! To be used primary in Gear Substrate node implementation, but it is not limited to that.

#![no_std]
#![warn(missing_docs)]
#![doc(html_logo_url = "https://gear-tech.io/logo.png")]
#![doc(html_favicon_url = "https://gear-tech.io/favicon.ico")]
#![cfg_attr(docsrs, feature(doc_cfg))]

extern crate alloc;

pub mod buffer;
pub mod code;
pub mod costs;
pub mod env;
pub mod env_vars;
pub mod gas;
pub mod gas_metering;
pub mod ids;
pub mod limited;
pub mod memory;
pub mod message;
pub mod pages;
pub mod percent;
pub mod program;
pub mod reservation;
pub mod rpc;
pub mod tasks;
pub mod utils {
    //! Utility functions.

    use blake2::{Blake2b, Digest, digest::typenum::U32};

    /// BLAKE2b-256 hasher state.
    type Blake2b256 = Blake2b<U32>;

    /// 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(data: &[u8]) -> [u8; 32] {
        let mut ctx = Blake2b256::new();
        ctx.update(data);
        ctx.finalize().into()
    }

    /// 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_of_array<T: AsRef<[u8]>, const N: usize>(array: [T; N]) -> [u8; 32] {
        let mut ctx = Blake2b256::new();
        for data in array {
            ctx.update(data);
        }
        ctx.finalize().into()
    }
}

// This allows all casts from u32 into usize be safe.
const _: () = assert!(size_of::<u32>() <= size_of::<usize>());