Clarinet is a clarity runtime packaged as a command line tool, designed to facilitate smart contract understanding, development, testing and deployment.
Clarity is a decidable smart contract language that optimizes for predictability and security, designed by Blockstack. Smart contracts allow developers to encode essential business logic on a blockchain.
Install from brew
Not recommended at this point, but you can install an outdated version with:
$ brew install lgalabru/clarinet/clarinet
Feel free to ⭐️ this repo! With 50+ stars, this package becomes eligible to
homebrew-core, and I'll work on the automation to make sure that the brew is always pointing to the latest and greatest version.
Install from cargo
Assuming you have a working installation of Rust, Clarinet can be also be installed from Cargo as a crate, or from source.
$ cargo install clarinet
Install from source
$ git clone firstname.lastname@example.org:lgalabru/clarinet.git $ cd clarinet $ cargo install --path .
Getting started with clarinet
Create a new project
Once installed, you can use clarinet to create a new project:
$ clarinet new my-project $ cd my-project
Clarinet will be maintaining a working directory with the following directory layout:
$ tree . . ├── Clarinet.toml ├── README.md ├── contracts │ └── bbtc.clar ├── settings │ └── Development.toml └── tests └── bbtc_test.ts
Add a new contract
New contracts can be added manually, or with the following command:
$ clarinet generate contract bbtc
Execute test suite
$ clarinet test
Load contracts in a console
$ clarinet console