This repository contains the source of "The Cairo Programming Language" book, a comprehensive documentation of the Cairo 1 programming language. This documentation is your go-to resource for mastering Cairo, created and maintained by the Starknet community. You can read the book online.
-
Rust related packages:
cargo install mdbook mdbook-i18n-helpers mdbook-last-changed -
Host machine packages:
- Install gettext for translations, usually available with regular package manager:
sudo apt install gettext. - Install mdbook-quiz-cairo following the instructions here to be able to add interactive quizzes.
- Install gettext for translations, usually available with regular package manager:
-
Clone this repository.
-
Install mdbook-cairo to process references and labels, and custom tags.
cargo install --git https://github.com/enitrat/mdbook-cairoRead the CONTRIBUTING.md file for more details on the style guide and guidelines for contributions to the book.
All the Markdown files MUST be edited in english. To work locally:
-
Start a local server with
mdbook serveand visit localhost:3000 to view the book. You can use the--openflag to open the browser automatically:mdbook serve --open. -
Make changes to the book and refresh the browser to see the changes.
-
Open a PR with your changes.
The cairo-listings CLI tool is designed to wrap all Cairo and Starknet plugins for quickly verifying Cairo programs. You can verify that listings are correct with the verify argument, and generate the corresponding output with the output argument.
Install this tool with:
Firstly, you need to have scarb resolved in your path. See here for more details.
To run the cairo-listings helper tool and verify Cairo programs, ensure that you are at the root of the repository (same directory of this README.md file).
Install the tool with:
cargo install --git https://github.com/enitrat/cairo-listings --lockedand then run:
cairo-listings verifyThe tool scans for all *.cairo files in the specified directory and performs the following actions:
For a Starknet contract:
scarb build- If it has tests:
scarb test
Cairo program:
- If it has a
mainfunction:scarb cairo-run --available-gas=200000000 - Else,
scarb build - If it has tests:
scarb test scarb fmt -c
To specify which tests to run, you can add a comment at the top of your file with the following format:
// TAG: <tag1>
// TAGS: <tag1>, <tag2>Here is a list of available tags:
does_not_compile: don't runscarb builddoes_not_run: don't runscarb cairo-run --available-gas=200000000ignore_fmt: don't runscarb fmttests_fail: don't runscarb test
The mdbook-cairo is a mdbook preprocessor that only removes the // TAG lines in code blocks.