31 releases (19 stable)
new 1.7.0 | Nov 26, 2024 |
---|---|
1.6.1 | Sep 28, 2024 |
1.4.2 | Jul 2, 2024 |
1.1.1 | Feb 12, 2024 |
0.1.2 | Mar 13, 2022 |
#50 in #gear
1,236 downloads per month
Used in 4 crates
560KB
12K
SLoC
Gear WASM Builder
This is a helper crate that can be used in build scripts for building Gear programs.
Usage
- Add the
gear-wasm-builder
crate as a build dependency to theCargo.toml
:
# ...
[build-dependencies]
gear-wasm-builder = "0.1.2"
# ...
- Create a
build.rs
file and place it at the directory withCargo.toml
:
fn main() {
gear_wasm_builder::build();
}
- Use
cargo
as usually:
cargo clean
cargo build
cargo build --release
cargo test
cargo test --release
- Find the built WASM binaries in
target/wasm32-unknown-unknown/<profile>
directory:
.wasm
— original WASM built from the source files.opt.wasm
— optimised WASM binary to be submitted to the blockchain.meta.wasm
— metadata providing WASM binary for auxiliary purposes
- Also, you can include a generated
wasm_binary.rs
source file to use the WASM code while e.g. writing tests. When doing this, you need to use some feature which will be excluded from passing it down to the build process triggered by the build script. By default, this is thestd
feature. If you want to use a custom feature for that, use one of the thebuild_XXX_custom
functions in yourbuild.rs
#[cfg(feature = "std")]
mod code {
include!(concat!(env!("OUT_DIR"), "/wasm_binary.rs"));
}
#[test]
fn debug_wasm() {
assert_eq!(
std::fs::read("target/wasm32-unknown-unknown/debug/test_program.wasm").unwrap(),
code::WASM_BINARY,
);
assert_eq!(
std::fs::read("target/wasm32-unknown-unknown/debug/test_program.opt.wasm").unwrap(),
code::WASM_BINARY_OPT,
);
assert_eq!(
std::fs::read("target/wasm32-unknown-unknown/debug/test_program.meta.wasm").unwrap(),
code::WASM_BINARY_META,
);
}
License
Source code is licensed under GPL-3.0-or-later WITH Classpath-exception-2.0
.
Dependencies
~11–26MB
~366K SLoC