smoldot 0.20.0

Primitives to build a client for Substrate-based blockchains
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

// Smoldot
// Copyright (C) 2019-2022  Parity Technologies (UK) Ltd.
// 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 <http://www.gnu.org/licenses/>.

//! WebAssembly runtime code execution.
//!
//! WebAssembly (often abbreviated *Wasm*) plays a big role in Substrate/Polkadot. The storage of
//! each block in the chain has a special key named `:code` which contains the WebAssembly code
//! of what we call *the runtime*.
//!
//! The runtime is a program (in WebAssembly) that decides, amongst other things, whether
//! transactions are valid and how to apply them on the storage, and whether blocks themselves are
//! valid.
//!
//! This module contains everything necessary to execute runtime code. The highest-level
//! sub-module is [`runtime_call`].

mod allocator; // TODO: make public after refactoring
pub mod host;
pub mod runtime_call;
pub mod storage_diff;
pub mod trie_root_calculator;
pub mod vm;

pub use host::{CoreVersion, CoreVersionError, CoreVersionRef};

/// Default number of heap pages if the storage doesn't specify otherwise.
///
/// # Context
///
/// In order to initialize a [`host::HostVmPrototype`], one needs to pass a certain number of
/// heap pages that are available to the runtime.
///
/// This number is normally found in the storage, at the key `:heappages`. But if it is not
/// specified, then the value of this constant must be used.
pub const DEFAULT_HEAP_PAGES: vm::HeapPages = vm::HeapPages::new(2048);

/// Converts a value of the key `:heappages` found in the storage to an actual number of heap
/// pages.
pub fn storage_heap_pages_to_value(
    storage_value: Option<&[u8]>,
) -> Result<vm::HeapPages, InvalidHeapPagesError> {
    if let Some(storage_value) = storage_value {
        let bytes =
            <[u8; 8]>::try_from(storage_value).map_err(|_| InvalidHeapPagesError::WrongLen)?;
        let num = u64::from_le_bytes(bytes);
        let num = u32::try_from(num).map_err(|_| InvalidHeapPagesError::TooLarge)?;
        Ok(vm::HeapPages::from(num))
    } else {
        Ok(DEFAULT_HEAP_PAGES)
    }
}

/// Error potentially returned by [`storage_heap_pages_to_value`].
#[derive(Debug, derive_more::Display, derive_more::Error, Clone)]
pub enum InvalidHeapPagesError {
    /// Storage value has the wrong length.
    WrongLen,
    /// Number of heap pages is too large.
    TooLarge,
}