Skip to content
This repository has been archived by the owner on Oct 21, 2022. It is now read-only.
/ parity-wasm Public archive

WebAssembly serialization/deserialization in rust

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

paritytech/parity-wasm

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b760a74 · Oct 1, 2022
Sep 13, 2021
Jul 28, 2021
Nov 21, 2021
May 21, 2022
May 21, 2022
Nov 21, 2021
Nov 1, 2017
Dec 15, 2018
Sep 13, 2021
Oct 1, 2022
Apr 4, 2017
Oct 18, 2018
Oct 1, 2022
Jul 28, 2021
Jul 28, 2021

parity-wasm

⚠️ This repository/crate is deprecated and unmaintained: If you interested in maintaining this crate consider forking it. We can provide a link to the most promising forks here.

Low-level WebAssembly format library.

Build Status crates.io link

Documentation

Rust WebAssembly format serializing/deserializing

Add to Cargo.toml

[dependencies]
parity-wasm = "0.42"

and then

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

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

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

Wabt Test suite

parity-wasm supports full wasm testsuite, running asserts that involves deserialization.

To run testsuite:

  • checkout with submodules (git submodule update --init --recursive)
  • run cargo test --release --workspace

Decoder can be fuzzed with cargo-fuzz using wasm-opt:

  • 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 (still requires allocator though):

[dependencies]
parity-wasm = { version = "0.41", default-features = false }

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.