https://github.com/software-mansion/protostar
Protostar is a toolchain for developing and testing Starknet contracts
https://github.com/software-mansion/protostar
cairo cairo-lang starknet testing toolchain
Last synced: 4 months ago
JSON representation
Protostar is a toolchain for developing and testing Starknet contracts
- Host: GitHub
- URL: https://github.com/software-mansion/protostar
- Owner: software-mansion
- License: mit
- Created: 2022-01-31T13:34:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T11:45:53.000Z (about 2 years ago)
- Last Synced: 2024-05-01T09:43:37.114Z (over 1 year ago)
- Topics: cairo, cairo-lang, starknet, testing, toolchain
- Language: Python
- Homepage: https://docs.swmansion.com/protostar/
- Size: 10 MB
- Stars: 249
- Watchers: 8
- Forks: 48
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
⚠️ WARNING ⚠️
This project is now considered legacy!
If you want to use Cairo 2.0 contracts, consider migrating to starknet-foundry developed by Software Mansion in collaboration with Foundry Foundation.
New features will not be added to this project.
https://github.com/foundry-rs/starknet-foundry
---
Starknet smart contract development toolchain
---
Protostar helps with writing, deploying, and testing your smart contracts. It is loosely inspired by [Foundry](https://github.com/foundry-rs/foundry).
Protostar is actively developed :hammer: . We release every two weeks. Our [roadmap is public](https://github.com/orgs/software-mansion-labs/projects/3/views/3), see what is coming soon!
Install with
```shell
curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash
```
[Documentation :page_facing_up:](https://docs.swmansion.com/protostar/)
## Table of contents
- [Additional resources](#additional-resources)
- [Installation](#installation)
- [Development](#development)
- [Setting up environment](#setting-up-environment)
- [Bumping cairo bindings version](#bumping-cairo-bindings-version)
- [Caveats:](#caveats)
- [Submodules development](#submodules-development)
- [Git hooks](#git-hooks)
- [Updating website/docs](#updating-websitedocs)
## Additional resources
- [Testing Starknet contracts made easy with Protostar](https://blog.swmansion.com/testing-starknet-contracts-made-easy-with-protostar-2ecdad3c9133)
## Installation
To install Protostar, run:
```shell
curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash
```
If you want to specify a version, run the following command with the requested version:
```console
curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash -s -- -v 0.3.2
```
---
## Development
### Setting up environment
1. Install Python version management tool: [pyenv](https://github.com/pyenv/pyenv) or [asdf](https://github.com/asdf-vm/asdf)
1. Install `Python 3.9.14` using the Python version management tool and activate that version
- To be able to build Protostar, set the following environmental variable before installing Python: `PYTHON_CONFIGURE_OPTS="--enable-shared"`
1. Clone this repository
1. Verify the active Python version: `python -V`
1. [Install Poetry](https://python-poetry.org/docs/#installation) — a dependency manager
1. Create Python virtual environment in the project directory: `poetry env use 3.9`
1. Activate environment: `poetry shell`
1. Upgrade pip: `pip install --upgrade pip`
1. Install project dependencies: `poetry install`
- MacBook M1/M2: `CFLAGS=-I/opt/homebrew/opt/gmp/include LDFLAGS=-L/opt/homebrew/opt/gmp/lib poetry install`
1. Install bindings for the rust tools used by protostar:
- [install rust](https://www.rust-lang.org/tools/install)
- `poetry run poe install_all_bindings`
1. Patch the git's config by always allowing file transport: `git config --global protocol.file.allow always` (needed for some tests to pass)
1. Verify the setup by running tests: `poe test`
1. Build Protostar: `poe build`
- You can find the newly created binary at `dist/protostar/protostar`
#### Bumping cairo bindings version
To bump cairo bindings version to the latest commit on fork (master branch), run:
```shell
poetry run poe bump_cairo_bindings
```
After this, you can pull & rebuild your local version of bindings by running:
```shell
poetry run poe install_all_bindings
```
##### Caveats:
Remember to have your working tree clean, since it creates a commit on the current branch.
The command will check if the tracking branch is master, so you don't commit/push to master by accident (would be rejected by branch protection).
#### Submodules development
You can use submodules from a different branch than main. Run commands
```shell
git submodule set-branch --branch
poetry run poe install_all_bindings
```
Remember to not push those changes to the repository.
#### Git hooks
Run the following script to enable lint checks and automatic formatting before commit/push.
```shell
./scripts/apply_hooks.sh
```
## Updating website/docs
Please read [website/README.md](./website/README.md).