Skip to content

Commit

Permalink
Remove mentions of lambdaworks-felt feature (#1610)
Browse files Browse the repository at this point in the history
  • Loading branch information
fmoletta authored Feb 8, 2024
1 parent 39e8b08 commit 28e055e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 7 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,21 +105,17 @@ You can then activate this environment by running
You can add the following to your rust project's `Cargo.toml`:

```toml
cairo-vm = { version = '0.7.0', features = ["lambdaworks-felt"] }
cairo-vm = { version = '0.7.0'}
```

The `features = ["lambdaworks-felt"]` part adds usage of [`lambdaworks-math`](https://github.com/lambdaclass/lambdaworks) as the backend for `Felt252`. This improves performance by more than 20%, and will be the default in the future.

### Running cairo-vm from CLI

To run programs from the command line, first compile the repository from the cairo-vm-cli folder:

```bash
cd cairo-vm-cli; cargo build --release -F lambdaworks-felt; cd ..
cd cairo-vm-cli; cargo build --release; cd ..
```

The `-F lambdaworks-felt` part adds usage of [`lambdaworks-math`](https://github.com/lambdaclass/lambdaworks) as the backend for `Felt252`. This improves performance by more than 20%, and will be the default in the future.

Once the binary is built, it can be found in `target/release/` under the name `cairo-vm-cli`.

In order to compile Cairo programs you need to activate the environment created while installing dependencies. To start it, run:
Expand Down
1 change: 0 additions & 1 deletion vm/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
//! - `with_mimalloc`: Use [`MiMalloc`](https://crates.io/crates/mimalloc) as the program global allocator.
//! - `cairo-1-hints`: Enable hints that were introduced in Cairo 1. Not enabled by default.
//! - `arbitrary`: Enables implementations of [`arbitrary::Arbitrary`](https://docs.rs/arbitrary/latest/arbitrary/) for some structs. Not enabled by default.
//! - `lambdaworks-felt`: Enables usage of the [**lambdaworks**](https://github.com/lambdaclass/lambdaworks) backend for [`felt::Felt252`]. Not enabled by default.
#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(warnings)]
Expand Down

0 comments on commit 28e055e

Please sign in to comment.