Blazingly fast testing framework for Starknet contracts development inspired by Foundry ๐ฆ ๐ฅ
This repo contains highly experimental code. Expect rapid iteration & frequent breaking changes.
Flow Diagram:
Objective: match Foundry and/or Protostar utils functions
Cairo-Foundry is a blazingly fast toolkit for Starknet application development. It is comprised of:
- โ A testing framework ๐ฆ
- ๐๏ธ (long-term plan) A modular CLI/SDK to interact with Starknet smart contracts, sending transactions and getting chain data.
- ๐๏ธ (long-term plan) A local Starknet node wrapper
The short-term goal is to build an efficient test runner for Cairo smart contract development in Rust. Good comparisons are Protostar test suite (written in Python, for Cairo) or - though less comparable - Jest (written in Javascript, for Javascript) and Pytest (written in Python, for Python).
-
Cairo-Foundry uses Rust as its main programming language. To install it ๐ฆ, follow the install steps for the Rust programming language.
-
For now, Cairo-Foundry relies on
cairo-compile
, a Starkware program used to compile Cairo. To installcairo-compile
, you'll need to installcairo-lang
as a python package on your local machine. Follow the install steps for the Cairo programming language.a. For Mac M1 users, if the install does not work, you may need to refer to this issue linked to the M1 chip and
fast-ecdsa
, acairo-lang
dependency package. TL;DR:-
brew install gmp
to install the latest version of the GNU Multiple Precision Arithmetic Library. -
Anytime you interact with pip3, or some python package manager that interacts with
cairo-lang
, you'll need specific flags active. Example for installing dependency package forcairo-lang
:CFLAGS=-I`brew --prefix gmp`/include LDFLAGS=-L`brew --prefix gmp`/lib pip3 install ecdsa fastecdsa sympy
-
- fork the repository
- create a clone of your fork locally:
git clone https://github.com/<YOUR_HANDLE>/cairo-foundry
- if need be, run
poetry install
1 to synchronise the python packages, though you shouldn't have to if you followed to steps from the Cairo programming language set-up guide, i.e:python3.9 -m venv ~/cairo_venv
source ~/cairo_venv/bin/activate
pip3 install cairo-lang
- You're all set! Run:
cargo run
to compile projectcargo test
to run the repository's tests
Coming soon! ๐ท
Coming soon! ๐ท
Pull requests are welcome, please check our contribution guidelines.
Cairo-Foundry is released under the MIT.