Cargo plugin for ink! contracts

A CLI tool for helping setting up and managing WebAssembly smart contracts written with ink!.

Installation

rust-src is a prerequisite: rustup component add rust-src.

We optimize the resulting contract Wasm using binaryen. You have two options for installing it:

• The preferred way:
  Install binaryen with a version >= 99. Many package managers have it available nowadays:

  • Debian/Ubuntu: apt-get install binaryen
  • Homebrew: brew install binaryen
  • Arch Linux: pacman -S binaryen
  • Windows: binary releases are available

  After you've installed the package execute cargo install --force cargo-contract.

• Build binaryen as a dependency when installing cargo-contract:
  A C++14 compiler and python >= 3.5 is required. Execute cargo install --force --features binaryen-as-dependency cargo-contract.

Usage

cargo-contract 0.11.0
Utilities to develop Wasm smart contracts

USAGE:
    cargo contract <SUBCOMMAND>

OPTIONS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    new                  Setup and create a new smart contract project
    build                Compiles the contract, generates metadata, bundles
                         both together in a `<name>.contract` file
    generate-metadata    Command has been deprecated, use `cargo contract build` instead
    check                Check that the code builds as Wasm; does not output any
                         `<name>.contract` artifact to the `target/` directory
    test                 Test the smart contract off-chain
    deploy               Upload the smart contract code to the chain
    instantiate          Instantiate a deployed smart contract
    help                 Prints this message or the help of the given subcommand(s)

build requires the nightly toolchain

cargo contract build must be run using the nightly toolchain. If you have rustup installed, the simplest way to do so is cargo +nightly contract build. To avoid having to add +nightly you can also create a rust-toolchain file in your local directory containing nightly. Read more about how to specify the rustup toolchain.

Note

The latest version of cargo-contract supports all nightlies after 2020-07-30, because of a change in the directory structure of the rust-src component.

Features

The deploy and instantiate subcommands are disabled by default, since they are not fully stable yet and increase the build time.

If you want to try them, you need to enable the extrinsics feature:

cargo install --git https://github.com/paritytech/cargo-contract cargo-contract --features extrinsics --force

Once they are stable and the compilation time is acceptable, we will consider removing the extrinsics feature.

License

The entire code within this repository is licensed under the GPLv3. Please contact us if you have questions about the licensing of our products.