Skip to content

Commit

Permalink
doc: update doc for casm = true in scarb.toml (#2619)
Browse files Browse the repository at this point in the history
<!-- Reference any GitHub issues resolved by this PR -->

Closes #2472 

## Introduced changes
Add a description about the slow compilation when casm = true in
scarb.toml file

-

## Checklist

- [x] Linked relevant issue
- [x] Updated relevant documentation
- [x] Added relevant tests
- [x] Performed self-review of the code
- [x] Added changes to `CHANGELOG.md`

---------

Co-authored-by: Artur Michałek <[email protected]>
  • Loading branch information
NueloSE and cptartur authored Oct 30, 2024
1 parent 44f3196 commit 370c3ef
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/src/appendix/scarb-toml.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,8 @@ sierra = true

#### `casm`

See more about [CASM contract class generation](https://docs.swmansion.com/scarb/docs/extensions/starknet/contract-target.html#casm-contract-class-generation) in Scarb documentation.
Enabling `casm = true` in Scarb.toml causes unnecessary overhead and should be disabled unless required by other tools. Tools like `snforge` and `sncast` recompile Sierra to CASM separately, resulting in redundant processing. This duplicates CASM generation, significantly impacting performance, especially for large Sierra programs. See more about [CASM contract class generation](https://docs.swmansion.com/scarb/docs/extensions/starknet/contract-target.html#casm-contract-class-generation) in Scarb documentation.


```toml
[[target.starknet-contract]]
Expand Down

0 comments on commit 370c3ef

Please sign in to comment.