pezkuwichain
b6d35f6faf
Updated 4763 files with dual copyright: - Parity Technologies (UK) Ltd. - Dijital Kurdistan Tech Institute
56 lines
2.0 KiB
Rust
56 lines
2.0 KiB
Rust
// Copyright (C) Parity Technologies (UK) Ltd. and Dijital Kurdistan Tech Institute
|
|
// This file is part of Pezkuwi.
|
|
|
|
// Pezkuwi 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.
|
|
|
|
// Pezkuwi 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 Pezkuwi. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! Defines primitive types for creating or validating a teyrchain.
|
|
//!
|
|
//! When compiled with standard library support, this crate exports a `wasm`
|
|
//! module that can be used to validate teyrchain WASM.
|
|
//!
|
|
//! ## Teyrchain WASM
|
|
//!
|
|
//! Pezkuwi teyrchain WASM is in the form of a module which imports a memory
|
|
//! instance and exports a function `validate_block`.
|
|
//!
|
|
//! `validate` accepts as input two `i32` values, representing a pointer/length pair
|
|
//! respectively, that encodes [`ValidationParams`](primitives::ValidationParams).
|
|
//!
|
|
//! `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`](primitives::ValidationResult).
|
|
//!
|
|
//! ASCII-diagram demonstrating the return data format:
|
|
//!
|
|
//! ```ignore
|
|
//! [pointer][length]
|
|
//! 32bit 32bit
|
|
//! ^~~ returned pointer & length
|
|
//! ```
|
|
//!
|
|
//! The wasm-api (enabled only when `std` feature is not enabled and `wasm-api` feature is enabled)
|
|
//! provides utilities for setting up a teyrchain WASM module in Rust.
|
|
|
|
#![cfg_attr(not(feature = "std"), no_std)]
|
|
|
|
pub mod primitives;
|
|
|
|
#[cfg(all(not(feature = "std"), feature = "wasm-api"))]
|
|
mod wasm_api;
|
|
|
|
#[cfg(all(not(feature = "std"), feature = "wasm-api"))]
|
|
pub use wasm_api::*;
|
|
|
|
extern crate alloc;
|