Skip to content

Latest commit

 

History

History
59 lines (45 loc) · 2.11 KB

README_CN.md

File metadata and controls

59 lines (45 loc) · 2.11 KB

ontio-wasm-build

Build Status

English | 中文

ontio-wasm-build是Ontology wasm合约的校验和优化工具，在部署合约到链上前，使用该工具能够对wasm合约的二进制码进行解析校验，同时对合约中无效的信息进行清理删除，缩减合约的大小，减少部署费用。

主要的检查优化项：

  • 合约存在入口函数invoke,参数和返回值均为空;
  • 清理合约中没有使用的函数，导入导出项;
  • 检查合约中的浮点数指令;
  • 检查所有导入项为Ontology runtime api，且输入输出参数完全匹配;
  • 检查合约的内存和Table使用上限是否超过规定的值，防止恶意的合约攻击
  • 清理data section中的零值
  • 清理custom section
  • 检查优化后的合约大小不超过规定值

安装方式

可以使用以下任一种方式进行安装：

  1. 从releases中直接下载二进制
  2. cargo install安装
cargo install --git=https://github.com/ontio/ontio-wasm-build
  1. 源码安装
git clone https://github.com/ontio/ontio-wasm-build
cd ontio-wasm-build
cargo build --release

使用方式

$ ontio-wasm-build --help
ontio-wasm-build 0.1.0

USAGE:
    ontio-wasm-build [FLAGS] <input> <output>

FLAGS:
    -h, --help           Prints help information
        --keep-custom    Keep custom section in output wasm file
    -V, --version        Prints version information

ARGS:
    <input>     Wasm file generated by rustc compiler
    <output>    Output wasm file name

input参数用来指定要优化的wasm合约文件，可使用ontology-wasm-cdt-cpp或者ontology-wasm-cdt-rust开发生成。

output参数用来指定优化后的wasm合约文件名

keep-custom用来设置输出的wasm文件是否保留custom_section,只用于调试用

License

This project is licensed under the MIT license.