mirror of
https://github.com/fluencelabs/parity-wasm
synced 2025-05-21 11:41:30 +00:00
52 lines
2.1 KiB
Markdown
52 lines
2.1 KiB
Markdown
# parity-wasm
|
|
|
|
Low-level WebAssembly format library.
|
|
|
|
[](https://travis-ci.org/paritytech/parity-wasm)
|
|
[](https://crates.io/crates/parity-wasm)
|
|
|
|
[Documentation](https://paritytech.github.io/parity-wasm/parity_wasm/)
|
|
|
|
## Rust WebAssembly format serializing/deserializing
|
|
|
|
```rust
|
|
|
|
extern crate parity_wasm;
|
|
|
|
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 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`
|
|
|
|
# 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. |