Merge branch 'main' into opt-felt252_div-compilation

Author: FrancoGiachetta

.github/workflows/publish.yml

@@ -37,6 +37,8 @@ jobs:
           keys-asc: https://apt.llvm.org/llvm-snapshot.gpg.key
       - name: Install LLVM
         run: sudo apt-get install llvm-19 llvm-19-dev llvm-19-runtime clang-19 clang-tools-19 lld-19 libpolly-19-dev libmlir-19-dev mlir-19-tools
+      - name: publish starknet-native-compile
+        run: cargo publish --token ${CRATES_TOKEN} --all-features -p starknet-native-compile
       - name: publish sierra emu
         run: cargo publish --token ${CRATES_TOKEN} --all-features -p sierra-emu
       - name: publish cairo native

Cargo.lock

@@ -15,7 +15,7 @@ members = [
 ]
 
 [workspace.package]
-version = "0.7.0"
+version = "0.7.1"
 edition = "2021"
 license = "Apache-2.0"
 repository = "https://github.com/lambdaclass/cairo_native"
@@ -74,7 +74,7 @@ sec1 = "0.7.3"
 serde = "1.0.0"
 serde_json = "1.0.128"
 sha2 = "0.10.8"
-sierra-emu = { path = "debug_utils/sierra-emu", version = "0.7.0" }
+sierra-emu = { path = "debug_utils/sierra-emu", version = "0.7.1" }
 smallvec = "1.13.2"
 starknet-crypto = "0.8.1"
 starknet-curve = "0.6.0"

Cargo.toml

@@ -42,7 +42,7 @@ often so use it at your own risk. 🚧
 
 For versions under `1.0` `cargo` doesn't comply with
 [semver](https://semver.org/), so we advise to pin the version you
-use. This can be done by adding `cairo-native = "0.7.0"` to your Cargo.toml
+use. This can be done by adding `cairo-native = "0.7.1"` to your Cargo.toml
 
 ## Getting Started
 

README.md

@@ -1,6 +1,11 @@
 [package]
 name = "starknet-native-compile"
+readme = "README.md"
+description = "A binary for compiling Sierra contracts with Cairo Native"
+version.workspace = true
 edition.workspace = true
+license.workspace = true
+repository.workspace = true
 
 [dependencies]
 anyhow.workspace = true

binaries/starknet-native-compile/Cargo.toml

@@ -0,0 +1,17 @@
+# Starknet Native Compile
+
+A binary for compiling Sierra contracts with [Cairo Native](https://lambdaclass.github.io/cairo_native/cairo_native/).
+
+## Requirements
+
+See [Cairo Native's instructions](https://lambdaclass.github.io/cairo_native/cairo_native/#getting-started) on how to build this binary properly.
+
+## Usage
+
+First, compile a sierra contract class with starknet-native-compile. The contract class format should be compatible with [cairo_lang_starknet_classes::contract_class::ContractClass](https://docs.rs/cairo-lang-starknet-classes/*/cairo_lang_starknet_classes/contract_class/struct.ContractClass.html).
+
+```bash
+starknet-native-compile <CONTRACT_CLASS> <OUTPUT_LIBRARY>
+```
+
+Then, load and execute the shared library with [cairo_native::executor::AotContractExecutor](https://lambdaclass.github.io/cairo_native/cairo_native/executor/struct.AotContractExecutor.html).