Skip to content

doc: improve compiling-starknet-contracts.adoc with stage descriptions and Scarb #9770

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
eytan-starkware wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −2
Draft

doc: improve compiling-starknet-contracts.adoc with stage descriptions and Scarb #9770

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions ...omponents/cairo/modules/getting_started/pages/compiling-starknet-contracts.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
= Compiling Starknet Contracts

Compile a Starknet Contract to a Sierra ContractClass:
Starknet contracts are compiled in two stages: first from Cairo to Sierra, then from Sierra to CASM.

== Cairo to Sierra

`starknet-compile` compiles a Cairo contract to a Sierra ContractClass (a JSON file containing
the contract's Sierra code, ABI, and entry point information):

[source,bash]
----
Expand All @@ -13,9 +18,22 @@ Or specify the contract path if multiple contracts are defined in the same proje
cargo run --bin starknet-compile -- /path/to/crate/ /path/to/output.json --contract-path path::to::contract
----

Compile a Sierra ContractClass into a CompiledClass (CASM):
== Sierra to CASM

`starknet-sierra-compile` compiles a Sierra ContractClass into a CompiledClass (CASM),
which is the executable bytecode format that runs on the Cairo VM:

[source,bash]
----
cargo run --bin starknet-sierra-compile -- /path/to/input.json /path/to/output.casm
----

== Using Scarb

For most projects, link:https://docs.swmansion.com/scarb/[Scarb] (the Cairo package manager)
handles compilation automatically. Running `scarb build` compiles contracts and produces the
Sierra ContractClass JSON files in the `target/` directory.

== See also

- xref:../../language_constructs/pages/contracts.adoc[Contracts] — Writing Starknet contracts in Cairo
Loading