Go to file
Michael Mueller 91684c25ba
Test thread-safety in CI
2019-06-19 18:11:06 +02:00
.cargo Add ARMv7 as CI test target (#186) 2019-06-18 15:06:16 +02:00
benches rustfmt (#151) 2018-12-11 12:54:06 +01:00
examples rustfmt (#151) 2018-12-11 12:54:06 +01:00
fuzz Travis maintenance (#132) 2018-10-26 15:03:01 +02:00
hfuzz Travis maintenance (#132) 2018-10-26 15:03:01 +02:00
res/fixtures Remove old fixtures. (#54) 2018-02-14 13:33:24 +03:00
src Exclude deadlocking test in thread-safe mode 2019-06-19 18:11:06 +02:00
tests rustfmt (#151) 2018-12-11 12:54:06 +01:00
validation Remove hashbrown and use BTree{Map,Set} from the alloc crate (#187) 2019-06-12 11:30:10 +02:00
.editorconfig Update editorconfig (#155) 2019-01-03 12:38:23 +01:00
.gitignore Add spec tests. 2018-01-22 17:55:43 +03:00
.gitmodules Move spec testsuite into tests. (#56) 2018-02-14 18:03:39 +03:00
.travis.yml Add ARMv7 as CI test target (#186) 2019-06-18 15:06:16 +02:00
Cargo.toml Add feature flag for opt-in thread-safety 2019-06-19 18:11:03 +02:00
LICENSE-APACHE Update copyrights 2018-01-23 19:51:29 +03:00
LICENSE-MIT Update copyrights 2018-01-23 19:51:29 +03:00
README.md Update Readme 2019-06-19 18:11:06 +02:00
check.sh Move spec testsuite into tests. (#56) 2018-02-14 18:03:39 +03:00
doc.sh Add a simple bench (#90) 2018-05-24 16:31:15 +03:00
test.sh Test thread-safety in CI 2019-06-19 18:11:06 +02:00

README.md

crates.io link Build Status

wasmi

wasmi - a Wasm interpreter.

wasmi was conceived as a component of parity-ethereum (ethereum-like contracts in wasm) and substrate. These projects are related to blockchain and require a high degree of correctness, even if that might be over conservative. This specifically means that we are not trying to be involved in any implementation of any of work-in-progress Wasm proposals. We are also trying to be as close as possible to the spec, which means we are trying to avoid features that is not directly supported by the spec. This means that it is flexible on the one hand and on the other hand there shouldn't be a problem migrating to another spec compliant execution engine.

With all that said, wasmi should be a good option for initial prototyping.

Build & Test

As wasmi contains a git submodule, you need to use --recursive for cloning or to checkout the submodule explicitly, otherwise the testing would fail.

git clone https://github.com/paritytech/wasmi.git --recursive
cd wasmi
cargo build
cargo test
cargo test --features threadsafe

no_std support

This crate supports no_std environments. Enable the core feature and disable default features:

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

The core feature requires the core and alloc libraries and a nightly compiler. Also, code related to std::error is disabled.

Floating point operations in no_std use libm, which sometimes panics in debug mode (https://github.com/japaric/libm/issues/4). So make sure to either use release builds or avoid WASM with floating point operations, for example by using deny_floating_point.

Thread-safe support

This crate supports thread-safe environments. Enable the threadsafe feature and Rust's thread-safe data structures will be used.

[dependencies]
parity-wasm = {
	version = "0.31",
	default-features = true,
	features = "threadsafe"
}

License

wasmi 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 wasmi by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.