StarkNet/Cairo development toolbelt
Project description
Disclaimer: this project is deprecated in favor of OpenZeppelin/nile-rs, and is no longer maintained.
OpenZeppelin | Nile ⛵
Overview
Nile is a CLI tool to develop or interact with StarkNet projects written in Cairo. It consists of different components for developing, compiling, testing, and deploying your smart contracts and dApps, providing a CLI for executing tasks, and a Runtime Environment (NRE) for scripting. The package is designed to be extensible and very customizable by using plugins.
Documentation
On our documentation site you can find:
- A Quickstart walkthrough with commands examples
- Guides on how to master development with Nile
- Useful script examples
- Plugins
And more.
Installation
Current supported Python versions are >=3.9 and <3.10.
-
Install
gmp
on your machine (Cairo requirement).sudo apt install -y libgmp3-dev # linux or brew install gmp # mac
If you have any trouble installing it on your Apple M1 computer, here’s a list of potential solutions.
-
Create a folder for your project and cd into it:
mkdir myproject && cd myproject
-
Create a virtualenv and activate it:
python3 -m venv env && source env/bin/activate
-
Install Nile:
pip install cairo-nile
Quickstart
Use nile init
to quickly set up your development environment:
nile init
🗄 Creating project directory tree
⛵️ Nile project ready! Try running:
nile compile
Contribute
OpenZeppelin Nile exists thanks to its contributors. There are many ways you can participate and help build high quality software. Check out the contribution guide!
License
Nile is released under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file cairo-nile-0.14.0.tar.gz
.
File metadata
- Download URL: cairo-nile-0.14.0.tar.gz
- Upload date:
- Size: 163.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed5d40f025b164275dcbccb030f64e0bc228fd2e1db286ee864c6fe2b5d3d379 |
|
MD5 | 341eeb91e7bbd973f9a6a99c6ebb3d03 |
|
BLAKE2b-256 | 4a01431a7ab24a6e616b46db9b55762c73f89c1bf7b1cf7297c9f2ee1c495db8 |
File details
Details for the file cairo_nile-0.14.0-py3-none-any.whl
.
File metadata
- Download URL: cairo_nile-0.14.0-py3-none-any.whl
- Upload date:
- Size: 96.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 830f406493d5e782aa89d04b60c292a0ad313d1c9c43099a336de5e3ab7f201c |
|
MD5 | f4fba6f07a281884816a7ed0a5d2d721 |
|
BLAKE2b-256 | 483089edcff84a33ad681f539dca1143c93af112025180e8d708edf117f93a46 |