https://github.com/paritytech/parity-wasm
WebAssembly serialization/deserialization in rust
https://github.com/paritytech/parity-wasm
rust wasm wasm-bytecode webassembly
Last synced: 6 months ago
JSON representation
WebAssembly serialization/deserialization in rust
- Host: GitHub
- URL: https://github.com/paritytech/parity-wasm
- Owner: paritytech
- License: apache-2.0
- Archived: true
- Created: 2017-03-29T15:17:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-10-01T17:07:51.000Z (about 3 years ago)
- Last Synced: 2025-04-30T12:26:15.606Z (6 months ago)
- Topics: rust, wasm, wasm-bytecode, webassembly
- Language: Rust
- Homepage:
- Size: 13.2 MB
- Stars: 398
- Watchers: 27
- Forks: 96
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-substrate - parity-wasm, WebAssembly serialization/deserialization in Rust
README
# parity-wasm
> :warning: **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.
[](https://travis-ci.org/paritytech/parity-wasm)
[](https://crates.io/crates/parity-wasm)
[Documentation](https://docs.rs/parity-wasm)
## Rust WebAssembly format serializing/deserializing
Add to Cargo.toml
```toml
[dependencies]
parity-wasm = "0.42"
```
and then
```rust
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](https://github.com/WebAssembly/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`](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` (still requires allocator though):
```toml
[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.