{"id":28708386,"url":"https://github.com/software-mansion/protostar","last_synced_at":"2025-06-14T18:11:22.562Z","repository":{"id":37083923,"uuid":"454019012","full_name":"software-mansion/protostar","owner":"software-mansion","description":"Protostar is a toolchain for developing and testing Starknet contracts","archived":false,"fork":false,"pushed_at":"2023-07-19T11:45:53.000Z","size":10534,"stargazers_count":249,"open_issues_count":72,"forks_count":48,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-05-01T09:43:37.114Z","etag":null,"topics":["cairo","cairo-lang","starknet","testing","toolchain"],"latest_commit_sha":null,"homepage":"https://docs.swmansion.com/protostar/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/software-mansion.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2022-01-31T13:34:34.000Z","updated_at":"2024-04-29T04:42:59.000Z","dependencies_parsed_at":"2022-08-08T19:01:58.000Z","dependency_job_id":null,"html_url":"https://github.com/software-mansion/protostar","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/software-mansion/protostar","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-mansion%2Fprotostar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-mansion%2Fprotostar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-mansion%2Fprotostar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-mansion%2Fprotostar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/software-mansion","download_url":"https://codeload.github.com/software-mansion/protostar/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/software-mansion%2Fprotostar/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259860438,"owners_count":22922990,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cairo","cairo-lang","starknet","testing","toolchain"],"created_at":"2025-06-14T18:11:18.362Z","updated_at":"2025-06-14T18:11:22.548Z","avatar_url":"https://github.com/software-mansion.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n    \u003ch2\u003e⚠️ WARNING ⚠️\u003c/h2\u003e\n    \u003ch2\u003e This project is now considered legacy!\u003c/h2\u003e\n    \u003cspan\u003eIf you want to use Cairo 2.0 contracts, consider migrating to \u003ca href=\"https://github.com/foundry-rs/starknet-foundry\"\u003e\u003ccode\u003estarknet-foundry\u003c/code\u003e\u003c/a\u003e developed by Software Mansion in collaboration with Foundry Foundation.\u003c/span\u003e\n    \u003cbr\u003e\n    \u003cspan\u003eNew features will not be added to this project.\u003c/span\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://github.com/foundry-rs/starknet-foundry\"\u003ehttps://github.com/foundry-rs/starknet-foundry\u003c/a\u003e\n\u003c/div\u003e\n\n---\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"./readme/protostar-logo--light.svg#gh-light-mode-only\" width=300 alt=\"protostar-logo\" /\u003e\n  \u003cimg src=\"./readme/protostar-logo--dark.svg#gh-dark-mode-only\" width=300 alt=\"protostar-logo\" /\u003e\n\n  \u003ch4\u003eStarknet smart contract development toolchain\u003c/h4\u003e\n\n\u003c/div\u003e\n\n---\nProtostar helps with writing, deploying, and testing your smart contracts. It is loosely inspired by [Foundry](https://github.com/foundry-rs/foundry).\n\nProtostar 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!\n\nInstall with\n```shell\ncurl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash\n```\n\n[Documentation :page_facing_up:](https://docs.swmansion.com/protostar/)\n\n\n## Table of contents \u003c!-- omit in toc --\u003e\n- [Additional resources](#additional-resources)\n- [Installation](#installation)\n- [Development](#development)\n  - [Setting up environment](#setting-up-environment)\n    - [Bumping cairo bindings version](#bumping-cairo-bindings-version)\n      - [Caveats:](#caveats)\n    - [Submodules development](#submodules-development)\n    - [Git hooks](#git-hooks)\n- [Updating website/docs](#updating-websitedocs)\n\n\n\n## Additional resources\n- [Testing Starknet contracts made easy with Protostar](https://blog.swmansion.com/testing-starknet-contracts-made-easy-with-protostar-2ecdad3c9133)\n\n## Installation\n\nTo install Protostar, run:\n\n```shell\ncurl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash\n```\n\nIf you want to specify a version, run the following command with the requested version:\n\n```console\ncurl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash -s -- -v 0.3.2\n```\n\n---\n\n## Development\n\n### Setting up environment\n\n1. Install Python version management tool: [pyenv](https://github.com/pyenv/pyenv) or [asdf](https://github.com/asdf-vm/asdf)\n1. Install `Python 3.9.14` using the Python version management tool and activate that version\n   - To be able to build Protostar, set the following environmental variable before installing Python: `PYTHON_CONFIGURE_OPTS=\"--enable-shared\"`\n1. Clone this repository\n1. Verify the active Python version: `python -V`\n1. [Install Poetry](https://python-poetry.org/docs/#installation) — a dependency manager\n1. Create Python virtual environment in the project directory: `poetry env use 3.9`\n1. Activate environment: `poetry shell`\n1. Upgrade pip: `pip install --upgrade pip`\n1. Install project dependencies: `poetry install`\n    - MacBook M1/M2: `CFLAGS=-I/opt/homebrew/opt/gmp/include LDFLAGS=-L/opt/homebrew/opt/gmp/lib poetry install`\n1. Install bindings for the rust tools used by protostar:\n    - [install rust](https://www.rust-lang.org/tools/install)\n    - `poetry run poe install_all_bindings`\n1. Patch the git's config by always allowing file transport: `git config --global protocol.file.allow always` (needed for some tests to pass) \n1. Verify the setup by running tests: `poe test`\n1. Build Protostar: `poe build`\n    - You can find the newly created binary at `dist/protostar/protostar`\n\n#### Bumping cairo bindings version\nTo bump cairo bindings version to the latest commit on fork (master branch), run: \n\n```shell\npoetry run poe bump_cairo_bindings\n```\n\nAfter this, you can pull \u0026 rebuild your local version of bindings by running:\n```shell\npoetry run poe install_all_bindings\n```\n\n##### Caveats:\nRemember to have your working tree clean, since it creates a commit on the current branch.\n\nThe 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).\n\n\n#### Submodules development \nYou can use submodules from a different branch than main. Run commands\n```shell\ngit submodule set-branch --branch \u003cyour-branch\u003e\npoetry run poe install_all_bindings\n```\nRemember to not push those changes to the repository.\n\n#### Git hooks\n\nRun the following script to enable lint checks and automatic formatting before commit/push.\n\n```shell\n./scripts/apply_hooks.sh\n```\n\n## Updating website/docs\nPlease read [website/README.md](./website/README.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftware-mansion%2Fprotostar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsoftware-mansion%2Fprotostar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsoftware-mansion%2Fprotostar/lists"}