Template Cairo Repo

Title

Website | Docs

Content

• Overview
• Dependencies
• Installation
• Getting help
• Build and Test
• Audit
• Security

Overview

This a template repo for new Cairo projects, use this repo as a start. You can fork the repo or start a new repo and do the following:

In this repo run

git clone https://github.com/starkware-libs/template-cairo-repo.git
cd template-cairo-repo
git log --oneline
git format-patch -1 <commit_hash>

This will create a file like 0001-Your-commit-message.patch.

In the new repo run

git clone https://github.com/username/new-repo.git
cd new-repo
git am ../template-cairo-repo/0001-Your-commit-message.patch
git push origin dev

Make sure to edit Scarb.toml to define workspace in this repo.

Smart contract	Description
Smart Contract 1	Smart contract 1 description
Smart Contract 2	Smart contract 2 description
ETC...	Etc...

Dependencies

• Cairo dependencies such as Scarb and Starknet foundry - install using starkup.

Installation

Clone the repo and from within the projects root folder run:

curl --proto '=https' --tlsv1.2 -sSf https://sh.starkup.dev | sh

Getting help

Reach out to the maintainer at any of the following:

• GitHub Discussions
• Contact options listed on this GitHub profile

Build and Test

Build the contracts from the repo root:

scarb build

To run the tests, execute:

scarb test

Audit

Find the latest audit report in docs/audit.

Security

This repo follows good practices of security, but 100% security cannot be assured. This repo is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.