paritytech/parity-wasm

Name: parity-wasm

Owner: Parity Technologies

Description: WebAssembly serialization/deserialization in rust

Created: 2017-03-29 15:17:40.0

Updated: 2018-05-24 10:31:02.0

Pushed: 2018-05-24 10:40:23.0

Homepage:

Size: 13513

Language: WebAssembly

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

parity-wasm

Low-level WebAssembly format library.

Documentation

Rust WebAssembly format serializing/deserializing

Add to Cargo.toml

endencies]
ty-wasm = "0.31"

and then

rn crate parity_wasm;

module = parity_wasm::deserialize_file("./res/cases/v1/hello.wasm").unwrap();
rt!(module.code_section().is_some());

code_section = module.code_section().unwrap(); // Part of the module with functions code

tln!("Function count in wasm file: {}", code_section.bodies().len());

Wabt Test suite

parity-wasm supports full wabt testsuite (https://github.com/WebAssembly/testsuite), running asserts that invloves deserialization.

To run testsuite:

• make sure you have all prerequisites to build wabt (since parity-wasm builds it internally using wabt-rs, see https://github.com/WebAssembly/wabt)
• checkout with submodules (git submodule update --init --recursive)
• run cargo test --release --manifest-path=spec/Cargo.toml

Decoder can be fuzzed with cargo-fuzz using wasm-opt (https://github.com/WebAssembly/binaryen):

• make sure you have all prerequisites to build binaryen and cargo-fuzz (cmake and a C++11 toolchain)
• checkout with submodules (git submodule update --init --recursive)
• install cargo fuzz subcommand with cargo install cargo-fuzz
• set rustup to use a nightly toolchain, because cargo fuzz uses a rust compiler plugin: rustup override set nightly
• run cargo fuzz run deserialize

no_std crates

This crate has a feature, std, that is enabled by default. To use this crate in a no_std context, add the following to your Cargo.toml:

endencies]
ty-wasm = { version = "0.31", default-features = false }

Until allocator api is stabilized, this type of use is limited to nightly Rust.

License

parity-wasm is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), at your choice.

See LICENSE-APACHE, and LICENSE-MIT for details.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in parity-wasm by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.