mirror of
https://github.com/pezkuwichain/wasm-instrument.git
synced 2026-06-12 03:01:03 +00:00
Update README.md to reflect the new package unification
This commit is contained in:
@@ -1,21 +1,29 @@
|
||||
# wasm-utils
|
||||
# pwasm-utils
|
||||
|
||||
[](https://travis-ci.org/paritytech/wasm-utils)
|
||||
|
||||
Collection of WASM utilities used in pwasm-ethereum and substrate contract development
|
||||
A collection of WASM utilities used in pwasm-ethereum and substrate contract development.
|
||||
|
||||
## Build tools for cargo
|
||||
|
||||
Easiest way to use is to install via `cargo install`:
|
||||
This repository contains the package `pwasm-utils` which consists of a library crate
|
||||
and a collection of cli binaries that make use of this library.
|
||||
|
||||
## Installation of cli tools
|
||||
```
|
||||
cargo install pwasm-utils-cli --bin wasm-build
|
||||
cargo install pwasm-utils --features cli
|
||||
```
|
||||
|
||||
This will install the following binaries:
|
||||
* wasm-build
|
||||
* wasm-check
|
||||
* wasm-ext
|
||||
* wasm-gas
|
||||
* wasm-pack
|
||||
* wasm-prune
|
||||
* wasm-stack-height
|
||||
|
||||
## Symbols pruning (wasm-prune)
|
||||
|
||||
```
|
||||
cargo install pwasm-utils-cli --bin wasm-prune
|
||||
wasm-prune <input_wasm_binary.wasm> <output_wasm_binary.wasm>
|
||||
```
|
||||
|
||||
@@ -26,14 +34,9 @@ This will optimize WASM symbols tree to leave only those elements that are used
|
||||
For development puposes, raw WASM contract can be injected with gas counters (the same way as it done by pwasm-ethereum/substrate runtime when running contracts)
|
||||
|
||||
```
|
||||
cargo install pwasm-utils-cli --bin wasm-gas
|
||||
wasm-gas <input_wasm_binary.wasm> <output_wasm_binary.wasm>
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
All executables use corresponding api methods of the root crate and can be combined in other build tools.
|
||||
|
||||
# License
|
||||
|
||||
`wasm-utils` is primarily distributed under the terms of both the MIT
|
||||
|
||||
Reference in New Issue
Block a user