njelich / cargo-near

Cargo extension for building Rust smart contracts on NEAR

cargo-near

Cargo extension for building near-sdk-rs smart contracts and ABI schemas on NEAR

Release notes

Release notes and unreleased changes can be found in the CHANGELOG

Installation

Install prebuilt binaries via shell script (Linux, macOS)

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/near/cargo-near/releases/latest/download/cargo-near-installer.sh | sh

Install prebuilt binaries via powershell script (Windows)

irm https://github.com/near/cargo-near/releases/latest/download/cargo-near-installer.ps1 | iex

Install prebuilt binaries into your npm project

npm install cargo-near

Compile latest released version from source code

cargo install cargo-near

Compile latest development version from source code

$ git clone https://github.com/near/cargo-near
$ cargo install --path cargo-near

Usage

See cargo near --help for a complete list of available commands or run cargo near to dive into interactive mode. Help is also available for each individual command with a --help flag, e.g. cargo near build --help.

cargo near

Starts interactive mode that will allow to explore all the available commands.

cargo near build

Builds a NEAR smart contract along with its ABI (while in the directory containing contract's Cargo.toml).

You can also make this command embed ABI into your WASM artifact by adding --embed-abi parameter. Once deployed, this will allow you to call a view function __contract_abi to retrieve a ZST-compressed ABI.

cargo near abi

Generates NEAR smart contract's ABI (while in the directory containing contract's Cargo.toml).

cargo near create-dev-account

Guides you through creation of a new NEAR account on testnet.

cargo near deploy

Builds the smart contract (equivalent to cargo near build) and guides you to deploy it to the blockchain.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.