lib.rs 1.9 KB
Newer Older
Shawn Tabrizi's avatar
Shawn Tabrizi committed
1
// Copyright 2017-2020 Parity Technologies (UK) Ltd.
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
// This file is part of Polkadot.

// Polkadot 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.

// Polkadot 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 Polkadot.  If not, see <http://www.gnu.org/licenses/>.

//! Defines primitive types for creating or validating a parachain.
//!
//! When compiled with standard library support, this crate exports a `wasm`
//! module that can be used to validate parachain WASM.
//!
//! ## Parachain WASM
//!
//! Polkadot parachain WASM is in the form of a module which imports a memory
25
//! instance and exports a function `validate_block`.
26
27
//!
//! `validate` accepts as input two `i32` values, representing a pointer/length pair
28
//! respectively, that encodes [`ValidationParams`].
29
//!
30
31
//! `validate` returns an `u64` which is a pointer to an `u8` array and its length.
//! The data in the array is expected to be a SCALE encoded [`ValidationResult`].
32
33
34
35
//!
//! ASCII-diagram demonstrating the return data format:
//!
//! ```ignore
36
37
38
//! [pointer][length]
//!   32bit   32bit
//!         ^~~ returned pointer & length
39
40
//! ```
//!
41
42
//! The wasm-api (enabled only when `std` feature is not enabled and `wasm-api` feature is enabled)
//! provides utilities for setting up a parachain WASM module in Rust.
43
44
45
46

#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(feature = "std")]
47
pub mod wasm_executor;
48
pub mod primitives;
49

50
mod wasm_api;
51

52
53
#[cfg(all(not(feature = "std"), feature = "wasm-api"))]
pub use wasm_api::*;